This change adds a SIP peer configuration feature to allow the peer's
[asterisk/asterisk.git] / channels / sip / include / sip.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2010, Digium, Inc.
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  */
16
17 /*!
18  * \file
19  * \brief chan_sip header file
20  */
21
22 #ifndef _SIP_H
23 #define _SIP_H
24
25 #include "asterisk.h"
26
27 #include "asterisk/stringfields.h"
28 #include "asterisk/linkedlists.h"
29 #include "asterisk/strings.h"
30 #include "asterisk/tcptls.h"
31 #include "asterisk/test.h"
32 #include "asterisk/channel.h"
33 #include "asterisk/app.h"
34 #include "asterisk/astobj.h"
35 #include "asterisk/indications.h"
36 #include "asterisk/security_events.h"
37 #include "asterisk/features.h"
38 #include "asterisk/http_websocket.h"
39 #include "asterisk/rtp_engine.h"
40
41 #ifndef FALSE
42 #define FALSE    0
43 #endif
44
45 #ifndef TRUE
46 #define TRUE     1
47 #endif
48
49 /* Arguments for sip_find_peer */
50 #define FINDUSERS (1 << 0)
51 #define FINDPEERS (1 << 1)
52 #define FINDALLDEVICES (FINDUSERS | FINDPEERS)
53
54 #define SIPBUFSIZE      512             /*!< Buffer size for many operations */
55
56 #define XMIT_ERROR      -2
57
58 #define SIP_RESERVED    ";/?:@&=+$,# "  /*!< Reserved characters in the username part of the URI */
59
60 #define DEFAULT_DEFAULT_EXPIRY       120
61 #define DEFAULT_MIN_EXPIRY           60
62 #define DEFAULT_MAX_EXPIRY           3600
63 #define DEFAULT_MWI_EXPIRY           3600
64 #define DEFAULT_REGISTRATION_TIMEOUT 20
65 #define DEFAULT_MAX_FORWARDS         70
66
67 #define DEFAULT_AUTHLIMIT            100
68 #define DEFAULT_AUTHTIMEOUT          30
69
70 /* guard limit must be larger than guard secs */
71 /* guard min must be < 1000, and should be >= 250 */
72 #define EXPIRY_GUARD_SECS    15   /*!< How long before expiry do we reregister */
73 #define EXPIRY_GUARD_LIMIT   30   /*!< Below here, we use EXPIRY_GUARD_PCT instead of EXPIRY_GUARD_SECS */
74 #define EXPIRY_GUARD_MIN     500  /*!< This is the minimum guard time applied. If
75                                    *   GUARD_PCT turns out to be lower than this, it
76                                    *   will use this time instead.
77                                    *   This is in milliseconds.
78                                                                    */
79 #define EXPIRY_GUARD_PCT     0.20 /*!< Percentage of expires timeout to use when
80                                    *   below EXPIRY_GUARD_LIMIT */
81 #define DEFAULT_EXPIRY       900  /*!< Expire slowly */
82
83 #define DEFAULT_QUALIFY_GAP   100
84 #define DEFAULT_QUALIFY_PEERS 1
85
86 #define CALLERID_UNKNOWN          "Anonymous"
87 #define FROMDOMAIN_INVALID        "anonymous.invalid"
88
89 #define DEFAULT_MAXMS             2000        /*!< Qualification: Must be faster than 2 seconds by default */
90 #define DEFAULT_QUALIFYFREQ       60 * 1000   /*!< Qualification: How often to check for the host to be up */
91 #define DEFAULT_FREQ_NOTOK        10 * 1000   /*!< Qualification: How often to check, if the host is down... */
92
93 #define DEFAULT_RETRANS           1000        /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
94 #define DEFAULT_TIMER_T1          500         /*!< SIP timer T1 (according to RFC 3261) */
95 #define SIP_TRANS_TIMEOUT         64 * DEFAULT_TIMER_T1 /*!< SIP request timeout (rfc 3261) 64*T1
96                                                          *  \todo Use known T1 for timeout (peerpoke)
97                                                          */
98 #define DEFAULT_TRANS_TIMEOUT     -1     /*!< Use default SIP transaction timeout */
99 #define PROVIS_KEEPALIVE_TIMEOUT  60000  /*!< How long to wait before retransmitting a provisional response (rfc 3261 13.3.1.1) */
100 #define MAX_AUTHTRIES             3      /*!< Try authentication three times, then fail */
101
102 #define SIP_MAX_HEADERS           64     /*!< Max amount of SIP headers to read */
103 #define SIP_MAX_LINES             256    /*!< Max amount of lines in SIP attachment (like SDP) */
104 #define SIP_MIN_PACKET            4096   /*!< Initialize size of memory to allocate for packets */
105 #define MAX_HISTORY_ENTRIES               50     /*!< Max entires in the history list for a sip_pvt */
106
107 #define INITIAL_CSEQ              101    /*!< Our initial sip sequence number */
108
109 #define DEFAULT_MAX_SE            1800   /*!< Session-Timer Default Session-Expires period (RFC 4028) */
110 #define DEFAULT_MIN_SE            90     /*!< Session-Timer Default Min-SE period (RFC 4028) */
111
112 #define SDP_MAX_RTPMAP_CODECS     32     /*!< Maximum number of codecs allowed in received SDP */
113
114 #define RTP     1
115 #define NO_RTP  0
116
117 #define DEC_CALL_LIMIT   0
118 #define INC_CALL_LIMIT   1
119 #define DEC_CALL_RINGING 2
120 #define INC_CALL_RINGING 3
121
122 /*! Define SIP option tags, used in Require: and Supported: headers
123  *  We need to be aware of these properties in the phones to use
124  *  the replace: header. We should not do that without knowing
125  *  that the other end supports it...
126  *  This is nothing we can configure, we learn by the dialog
127  *  Supported: header on the REGISTER (peer) or the INVITE
128  *  (other devices)
129  *  We are not using many of these today, but will in the future.
130  *  This is documented in RFC 3261
131  */
132 #define SUPPORTED       1
133 #define NOT_SUPPORTED   0
134
135 /* SIP options */
136 #define SIP_OPT_REPLACES      (1 << 0)
137 #define SIP_OPT_100REL        (1 << 1)
138 #define SIP_OPT_TIMER         (1 << 2)
139 #define SIP_OPT_EARLY_SESSION (1 << 3)
140 #define SIP_OPT_JOIN          (1 << 4)
141 #define SIP_OPT_PATH          (1 << 5)
142 #define SIP_OPT_PREF          (1 << 6)
143 #define SIP_OPT_PRECONDITION  (1 << 7)
144 #define SIP_OPT_PRIVACY       (1 << 8)
145 #define SIP_OPT_SDP_ANAT      (1 << 9)
146 #define SIP_OPT_SEC_AGREE     (1 << 10)
147 #define SIP_OPT_EVENTLIST     (1 << 11)
148 #define SIP_OPT_GRUU          (1 << 12)
149 #define SIP_OPT_TARGET_DIALOG (1 << 13)
150 #define SIP_OPT_NOREFERSUB    (1 << 14)
151 #define SIP_OPT_HISTINFO      (1 << 15)
152 #define SIP_OPT_RESPRIORITY   (1 << 16)
153 #define SIP_OPT_FROMCHANGE    (1 << 17)
154 #define SIP_OPT_RECLISTINV    (1 << 18)
155 #define SIP_OPT_RECLISTSUB    (1 << 19)
156 #define SIP_OPT_OUTBOUND      (1 << 20)
157 #define SIP_OPT_UNKNOWN       (1 << 21)
158
159 /*! \brief SIP Methods we support
160  *  \todo This string should be set dynamically. We only support REFER and SUBSCRIBE if we have
161  *  allowsubscribe and allowrefer on in sip.conf.
162  */
163 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY, INFO, PUBLISH"
164
165 /*! \brief Standard SIP unsecure port for UDP and TCP from RFC 3261. DO NOT CHANGE THIS */
166 #define STANDARD_SIP_PORT       5060
167 /*! \brief Standard SIP TLS port from RFC 3261. DO NOT CHANGE THIS */
168 #define STANDARD_TLS_PORT       5061
169
170 /*! \note in many SIP headers, absence of a port number implies port 5060,
171  * and this is why we cannot change the above constant.
172  * There is a limited number of places in asterisk where we could,
173  * in principle, use a different "default" port number, but
174  * we do not support this feature at the moment.
175  * You can run Asterisk with SIP on a different port with a configuration
176  * option. If you change this value in the source code, the signalling will be incorrect.
177  *
178  */
179
180 /*! \name DefaultValues Default values, set and reset in reload_config before reading configuration
181
182    These are default values in the source. There are other recommended values in the
183    sip.conf.sample for new installations. These may differ to keep backwards compatibility,
184    yet encouraging new behaviour on new installations
185  */
186 /*@{*/
187 #define DEFAULT_CONTEXT        "default"  /*!< The default context for [general] section as well as devices */
188 #define DEFAULT_RECORD_FEATURE   "automon"  /*!< The default feature specified for use with INFO */
189 #define DEFAULT_MOHINTERPRET   "default"  /*!< The default music class */
190 #define DEFAULT_MOHSUGGEST     ""
191 #define DEFAULT_VMEXTEN        "asterisk" /*!< Default voicemail extension */
192 #define DEFAULT_CALLERID       "asterisk" /*!< Default caller ID */
193 #define DEFAULT_MWI_FROM       ""
194 #define DEFAULT_NOTIFYMIME     "application/simple-message-summary"
195 #define DEFAULT_ALLOWGUEST     TRUE
196 #define DEFAULT_RTPKEEPALIVE   0      /*!< Default RTPkeepalive setting */
197 #define DEFAULT_CALLCOUNTER    FALSE   /*!< Do not enable call counters by default */
198 #define DEFAULT_SRVLOOKUP      TRUE    /*!< Recommended setting is ON */
199 #define DEFAULT_COMPACTHEADERS FALSE  /*!< Send compact (one-character) SIP headers. Default off */
200 #define DEFAULT_TOS_SIP        0      /*!< Call signalling packets should be marked as DSCP CS3, but the default is 0 to be compatible with previous versions. */
201 #define DEFAULT_TOS_AUDIO      0      /*!< Audio packets should be marked as DSCP EF (Expedited Forwarding), but the default is 0 to be compatible with previous versions. */
202 #define DEFAULT_TOS_VIDEO      0      /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
203 #define DEFAULT_TOS_TEXT       0      /*!< Text packets should be marked as XXXX XXXX, but the default is 0 to be compatible with previous versions. */
204 #define DEFAULT_COS_SIP        4      /*!< Level 2 class of service for SIP signalling */
205 #define DEFAULT_COS_AUDIO      5      /*!< Level 2 class of service for audio media  */
206 #define DEFAULT_COS_VIDEO      6      /*!< Level 2 class of service for video media */
207 #define DEFAULT_COS_TEXT       5      /*!< Level 2 class of service for text media (T.140) */
208 #define DEFAULT_ALLOW_EXT_DOM  TRUE    /*!< Allow external domains */
209 #define DEFAULT_REALM          "asterisk" /*!< Realm for HTTP digest authentication */
210 #define DEFAULT_DOMAINSASREALM FALSE    /*!< Use the domain option to guess the realm for registration and invite requests */
211 #define DEFAULT_NOTIFYRINGING  TRUE     /*!< Notify devicestate system on ringing state */
212 #define DEFAULT_NOTIFYCID      DISABLED /*!< Include CID with ringing notifications */
213 #define DEFAULT_PEDANTIC       TRUE     /*!< Follow SIP standards for dialog matching */
214 #define DEFAULT_AUTOCREATEPEER AUTOPEERS_DISABLED    /*!< Don't create peers automagically */
215 #define DEFAULT_MATCHEXTERNADDRLOCALLY FALSE /*!< Match extern IP locally default setting */
216 #define DEFAULT_QUALIFY        FALSE    /*!< Don't monitor devices */
217 #define DEFAULT_KEEPALIVE      0        /*!< Don't send keep alive packets */
218 #define DEFAULT_KEEPALIVE_INTERVAL 60   /*!< Send keep alive packets at 60 second intervals */
219 #define DEFAULT_CALLEVENTS     FALSE    /*!< Extra manager SIP call events */
220 #define DEFAULT_ALWAYSAUTHREJECT  TRUE  /*!< Don't reject authentication requests always */
221 #define DEFAULT_AUTH_OPTIONS  FALSE
222 #define DEFAULT_AUTH_MESSAGE  TRUE
223 #define DEFAULT_ACCEPT_OUTOFCALL_MESSAGE TRUE
224 #define DEFAULT_REGEXTENONQUALIFY FALSE
225 #define DEFAULT_LEGACY_USEROPTION_PARSING FALSE
226 #define DEFAULT_SEND_DIVERSION TRUE
227 #define DEFAULT_T1MIN             100   /*!< 100 MS for minimal roundtrip time */
228 #define DEFAULT_MAX_CALL_BITRATE (384)  /*!< Max bitrate for video */
229 #ifndef DEFAULT_USERAGENT
230 #define DEFAULT_USERAGENT  "Asterisk PBX"  /*!< Default Useragent: header unless re-defined in sip.conf */
231 #define DEFAULT_SDPSESSION "Asterisk PBX"  /*!< Default SDP session name, (s=) header unless re-defined in sip.conf */
232 #define DEFAULT_SDPOWNER   "root"          /*!< Default SDP username field in (o=) header unless re-defined in sip.conf */
233 #define DEFAULT_ENGINE     "asterisk"      /*!< Default RTP engine to use for sessions */
234 #define DEFAULT_STORE_SIP_CAUSE FALSE      /*!< Don't store HASH(SIP_CAUSE,<channel name>) for channels by default */
235 #endif
236 /*@}*/
237
238 /*! \name SIPflags
239         Various flags for the flags field in the pvt structure
240         Trying to sort these up (one or more of the following):
241         D: Dialog
242         P: Peer/user
243         G: Global flag
244         When flags are used by multiple structures, it is important that
245         they have a common layout so it is easy to copy them.
246 */
247 /*@{*/
248 #define SIP_OUTGOING        (1 << 0) /*!< D: Direction of the last transaction in this dialog */
249 #define SIP_OFFER_CC        (1 << 1) /*!< D: Offer CC on subsequent responses */
250 #define SIP_RINGING         (1 << 2) /*!< D: Have sent 180 ringing */
251 #define SIP_PROGRESS_SENT   (1 << 3) /*!< D: Have sent 183 message progress */
252 #define SIP_NEEDREINVITE    (1 << 4) /*!< D: Do we need to send another reinvite? */
253 #define SIP_PENDINGBYE      (1 << 5) /*!< D: Need to send bye after we ack? */
254 #define SIP_GOTREFER        (1 << 6) /*!< D: Got a refer? */
255 #define SIP_CALL_LIMIT      (1 << 7) /*!< D: Call limit enforced for this call */
256 #define SIP_INC_COUNT       (1 << 8) /*!< D: Did this dialog increment the counter of in-use calls? */
257 #define SIP_INC_RINGING     (1 << 9) /*!< D: Did this connection increment the counter of in-use calls? */
258 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 10) /*!< D: Do not hangup at first ast_hangup */
259
260 #define SIP_PROMISCREDIR    (1 << 11) /*!< DP: Promiscuous redirection */
261 #define SIP_TRUSTRPID       (1 << 12) /*!< DP: Trust RPID headers? */
262 #define SIP_USEREQPHONE     (1 << 13) /*!< DP: Add user=phone to numeric URI. Default off */
263 #define SIP_USECLIENTCODE   (1 << 14) /*!< DP: Trust X-ClientCode info message */
264
265 /* DTMF flags - see str2dtmfmode() and dtmfmode2str() */
266 #define SIP_DTMF            (7 << 15) /*!< DP: DTMF Support: five settings, uses three bits */
267 #define SIP_DTMF_RFC2833    (0 << 15) /*!< DP: DTMF Support: RTP DTMF - "rfc2833" */
268 #define SIP_DTMF_INBAND     (1 << 15) /*!< DP: DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
269 #define SIP_DTMF_INFO       (2 << 15) /*!< DP: DTMF Support: SIP Info messages - "info" */
270 #define SIP_DTMF_AUTO       (3 << 15) /*!< DP: DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
271 #define SIP_DTMF_SHORTINFO  (4 << 15) /*!< DP: DTMF Support: SIP Info messages - "info" - short variant */
272
273 /* NAT settings */
274 #define SIP_NAT_FORCE_RPORT     (1 << 18) /*!< DP: Force rport even if not present in the request */
275 #define SIP_NAT_RPORT_PRESENT   (1 << 19) /*!< DP: rport was present in the request */
276
277 /* re-INVITE related settings */
278 #define SIP_REINVITE         (7 << 20) /*!< DP: four settings, uses three bits */
279 #define SIP_REINVITE_NONE    (0 << 20) /*!< DP: no reinvite allowed */
280 #define SIP_DIRECT_MEDIA     (1 << 20) /*!< DP: allow peers to be reinvited to send media directly p2p */
281 #define SIP_DIRECT_MEDIA_NAT (2 << 20) /*!< DP: allow media reinvite when new peer is behind NAT */
282 #define SIP_REINVITE_UPDATE  (4 << 20) /*!< DP: use UPDATE (RFC3311) when reinviting this peer */
283
284 /* "insecure" settings - see insecure2str() */
285 #define SIP_INSECURE         (3 << 23)    /*!< DP: three settings, uses two bits */
286 #define SIP_INSECURE_NONE    (0 << 23)    /*!< DP: secure mode */
287 #define SIP_INSECURE_PORT    (1 << 23)    /*!< DP: don't require matching port for incoming requests */
288 #define SIP_INSECURE_INVITE  (1 << 24)    /*!< DP: don't require authentication for incoming INVITEs */
289
290 /* Sending PROGRESS in-band settings */
291 #define SIP_PROG_INBAND        (3 << 25) /*!< DP: three settings, uses two bits */
292 #define SIP_PROG_INBAND_NEVER  (0 << 25)
293 #define SIP_PROG_INBAND_NO     (1 << 25)
294 #define SIP_PROG_INBAND_YES    (2 << 25)
295
296 #define SIP_SENDRPID         (3 << 29) /*!< DP: Remote Party-ID Support */
297 #define SIP_SENDRPID_NO      (0 << 29)
298 #define SIP_SENDRPID_PAI     (1 << 29) /*!< Use "P-Asserted-Identity" for rpid */
299 #define SIP_SENDRPID_RPID    (2 << 29) /*!< Use "Remote-Party-ID" for rpid */
300 #define SIP_G726_NONSTANDARD (1 << 31) /*!< DP: Use non-standard packing for G726-32 data */
301
302 /*! \brief Flags to copy from peer/user to dialog */
303 #define SIP_FLAGS_TO_COPY \
304         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
305          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT_FORCE_RPORT | SIP_G726_NONSTANDARD | \
306          SIP_USEREQPHONE | SIP_INSECURE)
307 /*@}*/
308
309 /*! \name SIPflags2
310         a second page of flags (for flags[1] */
311 /*@{*/
312 /* realtime flags */
313 #define SIP_PAGE2_RTCACHEFRIENDS            (1 <<  0)   /*!< GP: Should we keep RT objects in memory for extended time? */
314 #define SIP_PAGE2_RTAUTOCLEAR               (1 <<  1)   /*!< GP: Should we clean memory from peers after expiry? */
315 #define SIP_PAGE2_RPID_UPDATE               (1 <<  2)
316 #define SIP_PAGE2_Q850_REASON               (1 <<  3)   /*!< DP: Get/send cause code via Reason header */
317 #define SIP_PAGE2_SYMMETRICRTP              (1 <<  4)   /*!< GDP: Whether symmetric RTP is enabled or not */
318 #define SIP_PAGE2_STATECHANGEQUEUE          (1 <<  5)   /*!< D: Unsent state pending change exists */
319 #define SIP_PAGE2_CONNECTLINEUPDATE_PEND    (1 <<  6)
320 #define SIP_PAGE2_RPID_IMMEDIATE            (1 <<  7)
321 #define SIP_PAGE2_RPORT_PRESENT             (1 <<  8)   /*!< Was rport received in the Via header? */
322 #define SIP_PAGE2_PREFERRED_CODEC           (1 <<  9)   /*!< GDP: Only respond with single most preferred joint codec */
323 #define SIP_PAGE2_VIDEOSUPPORT              (1 << 10)   /*!< DP: Video supported if offered? */
324 #define SIP_PAGE2_TEXTSUPPORT               (1 << 11)   /*!< GDP: Global text enable */
325 #define SIP_PAGE2_ALLOWSUBSCRIBE            (1 << 12)   /*!< GP: Allow subscriptions from this peer? */
326
327 #define SIP_PAGE2_ALLOWOVERLAP              (3 << 13)   /*!< DP: Allow overlap dialing ? */
328 #define SIP_PAGE2_ALLOWOVERLAP_NO           (0 << 13)   /*!< No, terminate with 404 Not found */
329 #define SIP_PAGE2_ALLOWOVERLAP_YES          (1 << 13)   /*!< Yes, using the 484 Address Incomplete response */
330 #define SIP_PAGE2_ALLOWOVERLAP_DTMF         (2 << 13)   /*!< Yes, using the DTMF transmission through Early Media */
331 #define SIP_PAGE2_ALLOWOVERLAP_SPARE        (3 << 13)   /*!< Spare (reserved for another dialling transmission mechanisms like KPML) */
332
333 #define SIP_PAGE2_SUBSCRIBEMWIONLY          (1 << 15)   /*!< GP: Only issue MWI notification if subscribed to */
334 #define SIP_PAGE2_IGNORESDPVERSION          (1 << 16)   /*!< GDP: Ignore the SDP session version number we receive and treat all sessions as new */
335
336 #define SIP_PAGE2_T38SUPPORT                (3 << 17)   /*!< GDP: T.38 Fax Support */
337 #define SIP_PAGE2_T38SUPPORT_UDPTL          (1 << 17)   /*!< GDP: T.38 Fax Support (no error correction) */
338 #define SIP_PAGE2_T38SUPPORT_UDPTL_FEC      (2 << 17)   /*!< GDP: T.38 Fax Support (FEC error correction) */
339 #define SIP_PAGE2_T38SUPPORT_UDPTL_REDUNDANCY   (3 << 17)   /*!< GDP: T.38 Fax Support (redundancy error correction) */
340
341 #define SIP_PAGE2_CALL_ONHOLD               (3 << 19)   /*!< D: Call hold states: */
342 #define SIP_PAGE2_CALL_ONHOLD_ACTIVE        (1 << 19)   /*!< D: Active hold */
343 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR        (2 << 19)   /*!< D: One directional hold */
344 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE      (3 << 19)   /*!< D: Inactive hold */
345
346 #define SIP_PAGE2_RFC2833_COMPENSATE        (1 << 21)   /*!< DP: Compensate for buggy RFC2833 implementations */
347 #define SIP_PAGE2_BUGGY_MWI                 (1 << 22)   /*!< DP: Buggy CISCO MWI fix */
348 #define SIP_PAGE2_DIALOG_ESTABLISHED        (1 << 23)   /*!< 29: Has a dialog been established? */
349
350 #define SIP_PAGE2_FAX_DETECT                (3 << 24)   /*!< DP: Fax Detection support */
351 #define SIP_PAGE2_FAX_DETECT_CNG            (1 << 24)   /*!< DP: Fax Detection support - detect CNG in audio */
352 #define SIP_PAGE2_FAX_DETECT_T38            (2 << 24)   /*!< DP: Fax Detection support - detect T.38 reinvite from peer */
353 #define SIP_PAGE2_FAX_DETECT_BOTH           (3 << 24)   /*!< DP: Fax Detection support - detect both */
354
355 #define SIP_PAGE2_UDPTL_DESTINATION         (1 << 26)   /*!< DP: Use source IP of RTP as destination if NAT is enabled */
356 #define SIP_PAGE2_VIDEOSUPPORT_ALWAYS       (1 << 27)   /*!< DP: Always set up video, even if endpoints don't support it */
357 #define SIP_PAGE2_HAVEPEERCONTEXT           (1 << 28)   /*< Are we associated with a configured peer context? */
358 #define SIP_PAGE2_USE_SRTP                  (1 << 29)   /*!< DP: Whether we should offer (only)  SRTP */
359
360 #define SIP_PAGE2_FLAGS_TO_COPY \
361         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_IGNORESDPVERSION | \
362         SIP_PAGE2_VIDEOSUPPORT | SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE | \
363         SIP_PAGE2_BUGGY_MWI | SIP_PAGE2_TEXTSUPPORT | SIP_PAGE2_FAX_DETECT | \
364         SIP_PAGE2_UDPTL_DESTINATION | SIP_PAGE2_VIDEOSUPPORT_ALWAYS | SIP_PAGE2_PREFERRED_CODEC | \
365         SIP_PAGE2_RPID_IMMEDIATE | SIP_PAGE2_RPID_UPDATE | SIP_PAGE2_SYMMETRICRTP |\
366         SIP_PAGE2_Q850_REASON | SIP_PAGE2_HAVEPEERCONTEXT | SIP_PAGE2_USE_SRTP)
367
368
369 #define SIP_PAGE3_SNOM_AOC               (1 << 0)  /*!< DPG: Allow snom aoc messages */
370 #define SIP_PAGE3_SRTP_TAG_32            (1 << 1)  /*!< DP: Use a 32bit auth tag in INVITE not 80bit */
371 #define SIP_PAGE3_NAT_AUTO_RPORT         (1 << 2)  /*!< DGP: Set SIP_NAT_FORCE_RPORT when NAT is detected */
372 #define SIP_PAGE3_NAT_AUTO_COMEDIA       (1 << 3)  /*!< DGP: Set SIP_PAGE2_SYMMETRICRTP when NAT is detected */
373 #define SIP_PAGE3_DIRECT_MEDIA_OUTGOING  (1 << 4)  /*!< DP: Only send direct media reinvites on outgoing calls */
374 #define SIP_PAGE3_USE_AVPF               (1 << 5)  /*!< DGP: Support a minimal AVPF-compatible profile */
375 #define SIP_PAGE3_ICE_SUPPORT            (1 << 6)  /*!< DGP: Enable ICE support */
376 #define SIP_PAGE3_IGNORE_PREFCAPS        (1 << 7)  /*!< DP: Ignore prefcaps when setting up an outgoing call leg */
377
378 #define SIP_PAGE3_FLAGS_TO_COPY \
379         (SIP_PAGE3_SNOM_AOC | SIP_PAGE3_SRTP_TAG_32 | SIP_PAGE3_NAT_AUTO_RPORT | SIP_PAGE3_NAT_AUTO_COMEDIA | \
380          SIP_PAGE3_DIRECT_MEDIA_OUTGOING | SIP_PAGE3_USE_AVPF | SIP_PAGE3_ICE_SUPPORT | SIP_PAGE3_IGNORE_PREFCAPS )
381
382 #define CHECK_AUTH_BUF_INITLEN   256
383
384 /*@}*/
385
386 /*----------------------------------------------------------*/
387 /*----                    ENUMS                         ----*/
388 /*----------------------------------------------------------*/
389
390 /*! \brief Authorization scheme for call transfers
391  *
392  * \note Not a bitfield flag, since there are plans for other modes,
393  * like "only allow transfers for authenticated devices"
394  */
395 enum transfermodes {
396         TRANSFER_OPENFORALL,            /*!< Allow all SIP transfers */
397         TRANSFER_CLOSED,                /*!< Allow no SIP transfers */
398 };
399
400 /*! \brief The result of a lot of functions */
401 enum sip_result {
402         AST_SUCCESS = 0,                /*!< FALSE means success, funny enough */
403         AST_FAILURE = -1,               /*!< Failure code */
404 };
405
406 /*! \brief The results from handling an invite request
407  *
408  * \note Start at these values so we do not conflict with
409  * check_auth_results values when returning from
410  * handle_request_invite.  check_auth_results only returned during
411  * authentication routines
412  * */
413 enum inv_req_result {
414         INV_REQ_SUCCESS = 11,    /*!< Success code */
415         INV_REQ_FAILED  = 10,    /*!< Failure code */
416         INV_REQ_ERROR   = 9,     /*!< Error code */
417 };
418
419 /*! \brief States for the INVITE transaction, not the dialog
420  *  \note this is for the INVITE that sets up the dialog
421  */
422 enum invitestates {
423         INV_NONE = 0,         /*!< No state at all, maybe not an INVITE dialog */
424         INV_CALLING = 1,      /*!< Invite sent, no answer */
425         INV_PROCEEDING = 2,   /*!< We got/sent 1xx message */
426         INV_EARLY_MEDIA = 3,  /*!< We got 18x message with to-tag back */
427         INV_COMPLETED = 4,    /*!< Got final response with error. Wait for ACK, then CONFIRMED */
428         INV_CONFIRMED = 5,    /*!< Confirmed response - we've got an ack (Incoming calls only) */
429         INV_TERMINATED = 6,   /*!< Transaction done - either successful (AST_STATE_UP) or failed, but done
430                                      The only way out of this is a BYE from one side */
431         INV_CANCELLED = 7,    /*!< Transaction cancelled by client or server in non-terminated state */
432 };
433
434 /*! \brief When sending a SIP message, we can send with a few options, depending on
435  * type of SIP request. UNRELIABLE is moslty used for responses to repeated requests,
436  * where the original response would be sent RELIABLE in an INVITE transaction
437  */
438 enum xmittype {
439         XMIT_CRITICAL = 2,    /*!< Transmit critical SIP message reliably, with re-transmits.
440                                *   If it fails, it's critical and will cause a teardown of the session */
441         XMIT_RELIABLE = 1,    /*!< Transmit SIP message reliably, with re-transmits */
442         XMIT_UNRELIABLE = 0,  /*!< Transmit SIP message without bothering with re-transmits */
443 };
444
445 /*! \brief Results from the parse_register() function */
446 enum parse_register_result {
447         PARSE_REGISTER_DENIED,
448         PARSE_REGISTER_FAILED,
449         PARSE_REGISTER_UPDATE,
450         PARSE_REGISTER_QUERY,
451 };
452
453 /*! \brief Type of subscription, based on the packages we do support, see \ref subscription_types */
454 enum subscriptiontype {
455         NONE = 0,
456         XPIDF_XML,
457         DIALOG_INFO_XML,
458         CPIM_PIDF_XML,
459         PIDF_XML,
460         MWI_NOTIFICATION,
461         CALL_COMPLETION,
462 };
463
464 /*! \brief The number of media types in enum \ref media_type below. */
465 #define OFFERED_MEDIA_COUNT     4
466
467 /*! \brief Media types generate different "dummy answers" for not accepting the offer of 
468         a media stream. We need to add definitions for each RTP profile. Secure RTP is not
469         the same as normal RTP and will require a new definition */
470 enum media_type {
471         SDP_AUDIO,   /*!< RTP/AVP Audio */
472         SDP_VIDEO,   /*!< RTP/AVP Video */
473         SDP_IMAGE,   /*!< Image udptl, not TCP or RTP */
474         SDP_TEXT,    /*!< RTP/AVP Realtime Text */
475         SDP_UNKNOWN, /*!< Unknown media type */
476 };
477
478 /*! \brief Authentication types - proxy or www authentication
479  *  \note Endpoints, like Asterisk, should always use WWW authentication to
480  *  allow multiple authentications in the same call - to the proxy and
481  *  to the end point.
482  */
483 enum sip_auth_type {
484         PROXY_AUTH = 407,
485         WWW_AUTH = 401,
486 };
487
488 /*! \brief Result from get_destination function */
489 enum sip_get_dest_result {
490         SIP_GET_DEST_EXTEN_MATCHMORE = 1,
491         SIP_GET_DEST_EXTEN_FOUND = 0,
492         SIP_GET_DEST_EXTEN_NOT_FOUND = -1,
493         SIP_GET_DEST_REFUSED = -2,
494         SIP_GET_DEST_INVALID_URI = -3,
495 };
496
497 /*! \brief Authentication result from check_auth* functions */
498 enum check_auth_result {
499         AUTH_DONT_KNOW = -100,  /*!< no result, need to check further */
500                 /* XXX maybe this is the same as AUTH_NOT_FOUND */
501         AUTH_SUCCESSFUL = 0,
502         AUTH_CHALLENGE_SENT = 1,
503         AUTH_SECRET_FAILED = -1,
504         AUTH_USERNAME_MISMATCH = -2,
505         AUTH_NOT_FOUND = -3,    /*!< returned by register_verify */
506         AUTH_FAKE_AUTH = -4,
507         AUTH_UNKNOWN_DOMAIN = -5,
508         AUTH_PEER_NOT_DYNAMIC = -6,
509         AUTH_ACL_FAILED = -7,
510         AUTH_BAD_TRANSPORT = -8,
511         AUTH_RTP_FAILED = -9,
512         AUTH_SESSION_LIMIT = -10,
513 };
514
515 /*! \brief States for outbound registrations (with register= lines in sip.conf */
516 enum sipregistrystate {
517         REG_STATE_UNREGISTERED = 0,     /*!< We are not registered
518                  *  \note Initial state. We should have a timeout scheduled for the initial
519                  * (or next) registration transmission, calling sip_reregister
520                  */
521
522         REG_STATE_REGSENT,      /*!< Registration request sent
523                  * \note sent initial request, waiting for an ack or a timeout to
524                  * retransmit the initial request.
525                 */
526
527         REG_STATE_AUTHSENT,     /*!< We have tried to authenticate
528                  * \note entered after transmit_register with auth info,
529                  * waiting for an ack.
530                  */
531
532         REG_STATE_REGISTERED,   /*!< Registered and done */
533
534         REG_STATE_REJECTED,     /*!< Registration rejected
535                  * \note only used when the remote party has an expire larger than
536                  * our max-expire. This is a final state from which we do not
537                  * recover (not sure how correctly).
538                  */
539
540         REG_STATE_TIMEOUT,      /*!< Registration timed out
541                 * \note XXX unused */
542
543         REG_STATE_NOAUTH,       /*!< We have no accepted credentials
544                  * \note fatal - no chance to proceed */
545
546         REG_STATE_FAILED,       /*!< Registration failed after several tries
547                  * \note fatal - no chance to proceed */
548 };
549
550 /*! \brief Modes in which Asterisk can be configured to run SIP Session-Timers */
551 enum st_mode {
552         SESSION_TIMER_MODE_INVALID = 0, /*!< Invalid value */
553         SESSION_TIMER_MODE_ACCEPT,      /*!< Honor inbound Session-Timer requests */
554         SESSION_TIMER_MODE_ORIGINATE,   /*!< Originate outbound and honor inbound requests */
555         SESSION_TIMER_MODE_REFUSE       /*!< Ignore inbound Session-Timers requests */
556 };
557
558 /*! \brief The entity playing the refresher role for Session-Timers */
559 enum st_refresher {
560         SESSION_TIMER_REFRESHER_AUTO, /*!< Negotiated                      */
561         SESSION_TIMER_REFRESHER_US,   /*!< Initially prefer session refresh by Asterisk */
562         SESSION_TIMER_REFRESHER_THEM, /*!< Initially prefer session refresh by the other side */
563 };
564
565 enum st_refresher_param {
566         SESSION_TIMER_REFRESHER_PARAM_UNKNOWN,
567         SESSION_TIMER_REFRESHER_PARAM_UAC,
568         SESSION_TIMER_REFRESHER_PARAM_UAS,
569 };
570
571 /*! \brief Define some implemented SIP transports
572         \note Asterisk does not support SCTP or UDP/DTLS
573 */
574 enum sip_transport {
575         SIP_TRANSPORT_UDP = 1,         /*!< Unreliable transport for SIP, needs retransmissions */
576         SIP_TRANSPORT_TCP = 1 << 1,    /*!< Reliable, but unsecure */
577         SIP_TRANSPORT_TLS = 1 << 2,    /*!< TCP/TLS - reliable and secure transport for signalling */
578         SIP_TRANSPORT_WS  = 1 << 3,    /*!< WebSocket, unsecure */
579         SIP_TRANSPORT_WSS = 1 << 4,    /*!< WebSocket, secure */
580 };
581
582 /*! \brief Automatic peer registration behavior
583 */
584 enum autocreatepeer_mode {
585         AUTOPEERS_DISABLED = 0,         /*!< Automatic peer creation disabled */
586         AUTOPEERS_VOLATILE,                     /*!< Automatic peers dropped on sip reload (pre-1.8 behavior) */
587         AUTOPEERS_PERSIST                       /*!< Automatic peers survive sip configuration reload */
588 };
589
590 /*! \brief States whether a SIP message can create a dialog in Asterisk. */
591 enum can_create_dialog {
592         CAN_NOT_CREATE_DIALOG,
593         CAN_CREATE_DIALOG,
594         CAN_CREATE_DIALOG_UNSUPPORTED_METHOD,
595 };
596
597 /*! \brief SIP Request methods known by Asterisk
598  *
599  * \note Do _NOT_ make any changes to this enum, or the array following it;
600  * if you think you are doing the right thing, you are probably
601  * not doing the right thing. If you think there are changes
602  * needed, get someone else to review them first _before_
603  * submitting a patch. If these two lists do not match properly
604  * bad things will happen.
605  */
606 enum sipmethod {
607         SIP_UNKNOWN,    /*!< Unknown response */
608         SIP_RESPONSE,   /*!< Not request, response to outbound request */
609         SIP_REGISTER,   /*!< Registration to the mothership, tell us where you are located */
610         SIP_OPTIONS,    /*!< Check capabilities of a device, used for "ping" too */
611         SIP_NOTIFY,     /*!< Status update, Part of the event package standard, result of a SUBSCRIBE or a REFER */
612         SIP_INVITE,     /*!< Set up a session */
613         SIP_ACK,        /*!< End of a three-way handshake started with INVITE. */
614         SIP_PRACK,      /*!< Reliable pre-call signalling. Not supported in Asterisk. */
615         SIP_BYE,        /*!< End of a session */
616         SIP_REFER,      /*!< Refer to another URI (transfer) */
617         SIP_SUBSCRIBE,  /*!< Subscribe for updates (voicemail, session status, device status, presence) */
618         SIP_MESSAGE,    /*!< Text messaging */
619         SIP_UPDATE,     /*!< Update a dialog. We can send UPDATE; but not accept it */
620         SIP_INFO,       /*!< Information updates during a session */
621         SIP_CANCEL,     /*!< Cancel an INVITE */
622         SIP_PUBLISH,    /*!< Not supported in Asterisk */
623         SIP_PING,       /*!< Not supported at all, no standard but still implemented out there */
624 };
625
626 /*! \brief Settings for the 'notifycid' option, see sip.conf.sample for details. */
627 enum notifycid_setting {
628         DISABLED       = 0,
629         ENABLED        = 1,
630         IGNORE_CONTEXT = 2,
631 };
632
633 /*! \brief Modes for SIP domain handling in the PBX */
634 enum domain_mode {
635         SIP_DOMAIN_AUTO,      /*!< This domain is auto-configured */
636         SIP_DOMAIN_CONFIG,    /*!< This domain is from configuration */
637 };
638
639 /*! \brief debugging state
640  * We store separately the debugging requests from the config file
641  * and requests from the CLI. Debugging is enabled if either is set
642  * (which means that if sipdebug is set in the config file, we can
643  * only turn it off by reloading the config).
644  */
645 enum sip_debug_e {
646         sip_debug_none = 0,
647         sip_debug_config = 1,
648         sip_debug_console = 2,
649 };
650
651 /*! \brief T38 States for a call */
652 enum t38state {
653         T38_DISABLED = 0,     /*!< Not enabled */
654         T38_LOCAL_REINVITE,   /*!< Offered from local - REINVITE */
655         T38_PEER_REINVITE,    /*!< Offered from peer - REINVITE */
656         T38_ENABLED,          /*!< Negotiated (enabled) */
657         T38_REJECTED          /*!< Refused */
658 };
659
660 /*! \brief Parameters to know status of transfer */
661 enum referstatus {
662         REFER_IDLE,           /*!< No REFER is in progress */
663         REFER_SENT,           /*!< Sent REFER to transferee */
664         REFER_RECEIVED,       /*!< Received REFER from transferrer */
665         REFER_CONFIRMED,      /*!< Refer confirmed with a 100 TRYING (unused) */
666         REFER_ACCEPTED,       /*!< Accepted by transferee */
667         REFER_RINGING,        /*!< Target Ringing */
668         REFER_200OK,          /*!< Answered by transfer target */
669         REFER_FAILED,         /*!< REFER declined - go on */
670         REFER_NOAUTH          /*!< We had no auth for REFER */
671 };
672
673 enum sip_peer_type {
674         SIP_TYPE_PEER = (1 << 0),
675         SIP_TYPE_USER = (1 << 1),
676 };
677
678 enum t38_action_flag {
679         SDP_T38_NONE = 0, /*!< Do not modify T38 information at all */
680         SDP_T38_INITIATE, /*!< Remote side has requested T38 with us */
681         SDP_T38_ACCEPT,   /*!< Remote side accepted our T38 request */
682 };
683
684 enum sip_tcptls_alert {
685         TCPTLS_ALERT_DATA,  /*!< \brief There is new data to be sent out */
686         TCPTLS_ALERT_STOP,  /*!< \brief A request to stop the tcp_handler thread */
687 };
688
689 enum digest_keys {
690         K_RESP,
691         K_URI,
692         K_USER,
693         K_NONCE,
694         K_LAST
695 };
696
697 /*----------------------------------------------------------*/
698 /*----                    STRUCTS                       ----*/
699 /*----------------------------------------------------------*/
700
701 /*! \brief definition of a sip proxy server
702  *
703  * For outbound proxies, a sip_peer will contain a reference to a
704  * dynamically allocated instance of a sip_proxy. A sip_pvt may also
705  * contain a reference to a peer's outboundproxy, or it may contain
706  * a reference to the sip_cfg.outboundproxy.
707  */
708 struct sip_proxy {
709         char name[MAXHOSTNAMELEN];      /*!< DNS name of domain/host or IP */
710         struct ast_sockaddr ip;          /*!< Currently used IP address and port */
711         int port;
712         time_t last_dnsupdate;          /*!< When this was resolved */
713         enum sip_transport transport;
714         int force;                      /*!< If it's an outbound proxy, Force use of this outbound proxy for all outbound requests */
715         /* Room for a SRV record chain based on the name */
716 };
717
718 /*! \brief argument for the 'show channels|subscriptions' callback. */
719 struct __show_chan_arg {
720         int fd;
721         int subscriptions;
722         int numchans;   /* return value */
723 };
724
725 /*! \name GlobalSettings
726         Global settings apply to the channel (often settings you can change in the general section
727         of sip.conf
728 */
729 /*@{*/
730 /*! \brief a place to store all global settings for the sip channel driver
731
732         These are settings that will be possibly to apply on a group level later on.
733         \note Do not add settings that only apply to the channel itself and can't
734               be applied to devices (trunks, services, phones)
735 */
736 struct sip_settings {
737         int peer_rtupdate;          /*!< G: Update database with registration data for peer? */
738         int rtsave_sysname;         /*!< G: Save system name at registration? */
739         int ignore_regexpire;       /*!< G: Ignore expiration of peer  */
740         int rtautoclear;            /*!< Realtime ?? */
741         int directrtpsetup;         /*!< Enable support for Direct RTP setup (no re-invites) */
742         int pedanticsipchecking;    /*!< Extra checking ?  Default off */
743         enum autocreatepeer_mode autocreatepeer;  /*!< Auto creation of peers at registration? Default off. */
744         int srvlookup;              /*!< SRV Lookup on or off. Default is on */
745         int allowguest;             /*!< allow unauthenticated peers to connect? */
746         int alwaysauthreject;       /*!< Send 401 Unauthorized for all failing requests */
747         int auth_options_requests;  /*!< Authenticate OPTIONS requests */
748         int auth_message_requests;  /*!< Authenticate MESSAGE requests */
749         int accept_outofcall_message; /*!< Accept MESSAGE outside of a call */
750         int compactheaders;         /*!< send compact sip headers */
751         int allow_external_domains; /*!< Accept calls to external SIP domains? */
752         int callevents;             /*!< Whether we send manager events or not */
753         int regextenonqualify;      /*!< Whether to add/remove regexten when qualifying peers */
754         int legacy_useroption_parsing; /*!< Whether to strip useroptions in URI via semicolons */
755         int send_diversion;             /*!< Whether to Send SIP Diversion headers */
756         int matchexternaddrlocally;   /*!< Match externaddr/externhost setting against localnet setting */
757         char regcontext[AST_MAX_CONTEXT];  /*!< Context for auto-extensions */
758         char messagecontext[AST_MAX_CONTEXT];  /*!< Default context for out of dialog msgs. */
759         unsigned int disallowed_methods;   /*!< methods that we should never try to use */
760         int notifyringing;          /*!< Send notifications on ringing */
761         int notifyhold;             /*!< Send notifications on hold */
762         enum notifycid_setting notifycid;  /*!< Send CID with ringing notifications */
763         enum transfermodes allowtransfer;  /*!< SIP Refer restriction scheme */
764         int allowsubscribe;         /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE
765                                          the global setting is in globals_flags[1] */
766         char realm[MAXHOSTNAMELEN]; /*!< Default realm */
767         int domainsasrealm;         /*!< Use domains lists as realms */
768         struct sip_proxy outboundproxy; /*!< Outbound proxy */
769         char default_context[AST_MAX_CONTEXT];
770         char default_subscribecontext[AST_MAX_CONTEXT];
771         char default_record_on_feature[FEATURE_MAX_LEN];
772         char default_record_off_feature[FEATURE_MAX_LEN];
773         struct ast_acl_list *contact_acl;  /*! \brief Global list of addresses dynamic peers are not allowed to use */
774         struct ast_format_cap *caps; /*!< Supported codecs */
775         int tcp_enabled;
776         int default_max_forwards;    /*!< Default max forwards (SIP Anti-loop) */
777 };
778
779 /*! \brief The SIP socket definition */
780 struct sip_socket {
781         enum sip_transport type;  /*!< UDP, TCP or TLS */
782         int fd;                   /*!< Filed descriptor, the actual socket */
783         uint16_t port;
784         struct ast_tcptls_session_instance *tcptls_session;  /* If tcp or tls, a socket manager */
785         struct ast_websocket *ws_session; /*! If ws or wss, a WebSocket session */
786 };
787
788 /*! \brief sip_request: The data grabbed from the UDP socket
789  *
790  * \verbatim
791  * Incoming messages: we first store the data from the socket in data[],
792  * adding a trailing \0 to make string parsing routines happy.
793  * Then call parse_request() and req.method = find_sip_method();
794  * to initialize the other fields. The \r\n at the end of each line is
795  * replaced by \0, so that data[] is not a conforming SIP message anymore.
796  * After this processing, rlpart1 is set to non-NULL to remember
797  * that we can run get_header() on this kind of packet.
798  *
799  * parse_request() splits the first line as follows:
800  * Requests have in the first line      method uri SIP/2.0
801  *      rlpart1 = method; rlpart2 = uri;
802  * Responses have in the first line     SIP/2.0 NNN description
803  *      rlpart1 = SIP/2.0; rlpart2 = NNN + description;
804  *
805  * For outgoing packets, we initialize the fields with init_req() or init_resp()
806  * (which fills the first line to "METHOD uri SIP/2.0" or "SIP/2.0 code text"),
807  * and then fill the rest with add_header() and add_line().
808  * The \r\n at the end of the line are still there, so the get_header()
809  * and similar functions don't work on these packets.
810  * \endverbatim
811  */
812 struct sip_request {
813         ptrdiff_t rlpart1;      /*!< Offset of the SIP Method Name or "SIP/2.0" protocol version */
814         ptrdiff_t rlpart2;      /*!< Offset of the Request URI or Response Status */
815         int headers;            /*!< # of SIP Headers */
816         int method;             /*!< Method of this request */
817         int lines;              /*!< Body Content */
818         unsigned int sdp_start; /*!< the line number where the SDP begins */
819         unsigned int sdp_count; /*!< the number of lines of SDP */
820         char debug;             /*!< print extra debugging if non zero */
821         char has_to_tag;        /*!< non-zero if packet has To: tag */
822         char ignore;            /*!< if non-zero This is a re-transmit, ignore it */
823         char authenticated;     /*!< non-zero if this request was authenticated */
824         ptrdiff_t header[SIP_MAX_HEADERS]; /*!< Array of offsets into the request string of each SIP header*/
825         ptrdiff_t line[SIP_MAX_LINES];     /*!< Array of offsets into the request string of each SDP line*/
826         struct ast_str *data;   
827         struct ast_str *content;
828         /* XXX Do we need to unref socket.ser when the request goes away? */
829         struct sip_socket socket;          /*!< The socket used for this request */
830         AST_LIST_ENTRY(sip_request) next;
831         unsigned int reqsipoptions; /*!< Items needed for Required header in responses */
832 };
833
834 /* \brief given a sip_request and an offset, return the char * that resides there
835  *
836  * It used to be that rlpart1, rlpart2, and the header and line arrays were character
837  * pointers. They are now offsets into the ast_str portion of the sip_request structure.
838  * To avoid adding a bunch of redundant pointer arithmetic to the code, this macro is
839  * provided to retrieve the string at a particular offset within the request's buffer
840  */
841 #define REQ_OFFSET_TO_STR(req,offset) (ast_str_buffer((req)->data) + ((req)->offset))
842
843 /*! \brief structure used in transfers */
844 struct sip_dual {
845         struct ast_channel *chan1;   /*!< First channel involved */
846         struct ast_channel *chan2;   /*!< Second channel involved */
847         struct sip_request req;      /*!< Request that caused the transfer (REFER) */
848         uint32_t seqno;              /*!< Sequence number */
849         char *park_exten;
850         char *park_context;
851 };
852
853 /*! \brief Parameters to the transmit_invite function */
854 struct sip_invite_param {
855         int addsipheaders;          /*!< Add extra SIP headers */
856         const char *uri_options;    /*!< URI options to add to the URI */
857         const char *vxml_url;       /*!< VXML url for Cisco phones */
858         char *auth;                 /*!< Authentication */
859         char *authheader;           /*!< Auth header */
860         enum sip_auth_type auth_type;  /*!< Authentication type */
861         const char *replaces;       /*!< Replaces header for call transfers */
862         int transfer;               /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
863         struct sip_proxy *outboundproxy; /*!< Outbound proxy URI */
864 };
865
866 /*! \brief Structure to save routing information for a SIP session */
867 struct sip_route {
868         struct sip_route *next;
869         char hop[0];
870 };
871
872 /*! \brief Structure to store Via information */
873 struct sip_via {
874         char *via;
875         const char *protocol;
876         const char *sent_by;
877         const char *branch;
878         const char *maddr;
879         unsigned int port;
880         unsigned char ttl;
881 };
882
883 /*! \brief Domain data structure.
884         \note In the future, we will connect this to a configuration tree specific
885         for this domain
886 */
887 struct domain {
888         char domain[MAXHOSTNAMELEN];       /*!< SIP domain we are responsible for */
889         char context[AST_MAX_EXTENSION];   /*!< Incoming context for this domain */
890         enum domain_mode mode;             /*!< How did we find this domain? */
891         AST_LIST_ENTRY(domain) list;       /*!< List mechanics */
892 };
893
894 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
895 struct sip_history {
896         AST_LIST_ENTRY(sip_history) list;
897         char event[0];  /* actually more, depending on needs */
898 };
899
900 /*! \brief sip_auth: Credentials for authentication to other SIP services */
901 struct sip_auth {
902         AST_LIST_ENTRY(sip_auth) node;
903         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
904         char username[256];             /*!< Username */
905         char secret[256];               /*!< Secret */
906         char md5secret[256];            /*!< MD5Secret */
907 };
908
909 /*! \brief Container of SIP authentication credentials. */
910 struct sip_auth_container {
911         AST_LIST_HEAD_NOLOCK(, sip_auth) list;
912 };
913
914 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
915 struct t38properties {
916         enum t38state state;            /*!< T.38 state */
917         struct ast_control_t38_parameters our_parms;
918         struct ast_control_t38_parameters their_parms;
919 };
920
921 /*! \brief generic struct to map between strings and integers.
922  * Fill it with x-s pairs, terminate with an entry with s = NULL;
923  * Then you can call map_x_s(...) to map an integer to a string,
924  * and map_s_x() for the string -> integer mapping.
925  */
926 struct _map_x_s {
927         int x;
928         const char *s;
929 };
930
931 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed */
932 struct sip_refer {
933         AST_DECLARE_STRING_FIELDS(
934                 AST_STRING_FIELD(refer_to);             /*!< Place to store REFER-TO extension */
935                 AST_STRING_FIELD(refer_to_domain);      /*!< Place to store REFER-TO domain */
936                 AST_STRING_FIELD(refer_to_urioption);   /*!< Place to store REFER-TO uri options */
937                 AST_STRING_FIELD(refer_to_context);     /*!< Place to store REFER-TO context */
938                 AST_STRING_FIELD(referred_by);          /*!< Place to store REFERRED-BY extension */
939                 AST_STRING_FIELD(refer_contact);        /*!< Place to store Contact info from a REFER extension */
940                 AST_STRING_FIELD(replaces_callid);      /*!< Replace info: callid */
941                 AST_STRING_FIELD(replaces_callid_totag);   /*!< Replace info: to-tag */
942                 AST_STRING_FIELD(replaces_callid_fromtag); /*!< Replace info: from-tag */
943         );
944         struct sip_pvt *refer_call;                     /*!< Call we are referring. This is just a reference to a
945                                                          * dialog owned by someone else, so we should not destroy
946                                                          * it when the sip_refer object goes.
947                                                          */
948         int attendedtransfer;                           /*!< Attended or blind transfer? */
949         int localtransfer;                              /*!< Transfer to local domain? */
950         enum referstatus status;                        /*!< REFER status */
951 };
952
953 /*! \brief Struct to handle custom SIP notify requests. Dynamically allocated when needed */
954 struct sip_notify {
955         struct ast_variable *headers;
956         struct ast_str *content;
957 };
958
959 /*! \brief Structure that encapsulates all attributes related to running
960  *   SIP Session-Timers feature on a per dialog basis.
961  */
962 struct sip_st_dlg {
963         int st_active;                     /*!< Session-Timers on/off */
964         int st_interval;                   /*!< Session-Timers negotiated session refresh interval */
965         enum st_refresher st_ref;          /*!< Session-Timers cached refresher */
966         int st_schedid;                    /*!< Session-Timers ast_sched scheduler id */
967         int st_expirys;                    /*!< Session-Timers number of expirys */
968         int st_active_peer_ua;             /*!< Session-Timers on/off in peer UA */
969         int st_cached_min_se;              /*!< Session-Timers cached Min-SE */
970         int st_cached_max_se;              /*!< Session-Timers cached Session-Expires */
971         enum st_mode st_cached_mode;       /*!< Session-Timers cached M.O. */
972         enum st_refresher st_cached_ref;   /*!< Session-Timers session refresher */
973         unsigned char quit_flag:1;         /*!< Stop trying to lock; just quit */
974 };
975
976
977 /*! \brief Structure that encapsulates all attributes related to configuration
978  *   of SIP Session-Timers feature on a per user/peer basis.
979  */
980 struct sip_st_cfg {
981         enum st_mode st_mode_oper;      /*!< Mode of operation for Session-Timers           */
982         enum st_refresher_param st_ref; /*!< Session-Timer refresher                        */
983         int st_min_se;                  /*!< Lowest threshold for session refresh interval  */
984         int st_max_se;                  /*!< Highest threshold for session refresh interval */
985 };
986
987 /*! \brief Structure for remembering offered media in an INVITE, to make sure we reply
988         to all media streams. */
989 struct offered_media {
990         enum media_type type;           /*!< The type of media that was offered */
991         char *decline_m_line;           /*!< Used if the media type is unknown/unused or a media stream is declined */
992         AST_LIST_ENTRY(offered_media) next;
993 };
994
995 /*! Additional headers to send with MESSAGE method packet. */
996 struct sip_msg_hdr {
997         AST_LIST_ENTRY(sip_msg_hdr) next;
998         /*! Name of header to stick in MESSAGE */
999         const char *name;
1000         /*! Value of header to stick in MESSAGE */
1001         const char *value;
1002         /*! The name and value strings are stuffed here in that order. */
1003         char stuff[0];
1004 };
1005
1006 /*! \brief Structure used for each SIP dialog, ie. a call, a registration, a subscribe.
1007  * Created and initialized by sip_alloc(), the descriptor goes into the list of
1008  * descriptors (dialoglist).
1009  */
1010 struct sip_pvt {
1011         struct sip_pvt *next;                   /*!< Next dialog in chain */
1012         enum invitestates invitestate;          /*!< Track state of SIP_INVITEs */
1013         struct ast_callid *logger_callid;               /*!< Identifier for call used in log messages */
1014         int method;                             /*!< SIP method that opened this dialog */
1015         AST_DECLARE_STRING_FIELDS(
1016                 AST_STRING_FIELD(callid);       /*!< Global CallID */
1017                 AST_STRING_FIELD(initviabranch); /*!< The branch ID from the topmost Via header in the initial request */
1018                 AST_STRING_FIELD(initviasentby); /*!< The sent-by from the topmost Via header in the initial request */
1019                 AST_STRING_FIELD(accountcode);  /*!< Account code */
1020                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1021                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1022                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1023                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1024                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1025                 AST_STRING_FIELD(from);         /*!< The From: header */
1026                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
1027                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
1028                 AST_STRING_FIELD(context);      /*!< Context for this call */
1029                 AST_STRING_FIELD(messagecontext); /*!< Default context for outofcall messages. */
1030                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
1031                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
1032                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
1033                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
1034                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
1035                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
1036                 AST_STRING_FIELD(todnid);       /*!< DNID of this call (overrides host) */
1037                 AST_STRING_FIELD(language);     /*!< Default language for this call */
1038                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
1039                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
1040                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
1041                 AST_STRING_FIELD(redircause);   /*!< Referring cause */
1042                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
1043                 AST_STRING_FIELD(tag);          /*!< Our tag for this session */
1044                 AST_STRING_FIELD(username);     /*!< [user] name */
1045                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
1046                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
1047                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
1048                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
1049                 AST_STRING_FIELD(peersecret);   /*!< Password */
1050                 AST_STRING_FIELD(peermd5secret);
1051                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
1052                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
1053                 AST_STRING_FIELD(cid_tag);      /*!< Caller*ID tag */
1054                 AST_STRING_FIELD(mwi_from);     /*!< Name to place in the From header in outgoing NOTIFY requests */
1055                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
1056                                                 /* we only store the part in <brackets> in this field. */
1057                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
1058                 AST_STRING_FIELD(url);          /*!< URL to be sent with next message to peer */
1059                 AST_STRING_FIELD(parkinglot);   /*!< Parkinglot */
1060                 AST_STRING_FIELD(engine);       /*!< RTP engine to use */
1061                 AST_STRING_FIELD(dialstring);   /*!< The dialstring used to call this SIP endpoint */
1062                 AST_STRING_FIELD(last_presence_subtype);   /*!< The last presence subtype sent for a subscription. */
1063                 AST_STRING_FIELD(last_presence_message);   /*!< The last presence message for a subscription */
1064                 AST_STRING_FIELD(msg_body);     /*!< Text for a MESSAGE body */
1065         );
1066         char via[128];                          /*!< Via: header */
1067         int maxforwards;                        /*!< SIP Loop prevention */
1068         struct sip_socket socket;               /*!< The socket used for this dialog */
1069         uint32_t ocseq;                         /*!< Current outgoing seqno */
1070         uint32_t icseq;                         /*!< Current incoming seqno */
1071         uint32_t init_icseq;                    /*!< Initial incoming seqno from first request */
1072         ast_group_t callgroup;                  /*!< Call group */
1073         ast_group_t pickupgroup;                /*!< Pickup group */
1074         struct ast_namedgroups *named_callgroups;   /*!< Named call group */
1075         struct ast_namedgroups *named_pickupgroups; /*!< Named pickup group */
1076         uint32_t lastinvite;                    /*!< Last seqno of invite */
1077         struct ast_flags flags[3];              /*!< SIP_ flags */
1078
1079         /* boolean flags that don't belong in flags */
1080         unsigned short do_history:1;          /*!< Set if we want to record history */
1081         unsigned short alreadygone:1;         /*!< the peer has sent a message indicating termination of the dialog */
1082         unsigned short needdestroy:1;         /*!< this dialog needs to be destroyed by the monitor thread */
1083         unsigned short final_destruction_scheduled:1; /*!< final dialog destruction is scheduled. Keep dialog
1084                                                        *   around until then to handle retransmits. */
1085         unsigned short outgoing_call:1;       /*!< this is an outgoing call */
1086         unsigned short answered_elsewhere:1;  /*!< This call is cancelled due to answer on another channel */
1087         unsigned short novideo:1;             /*!< Didn't get video in invite, don't offer */
1088         unsigned short notext:1;              /*!< Text not supported  (?) */
1089         unsigned short session_modify:1;      /*!< Session modification request true/false  */
1090         unsigned short route_persistent:1;    /*!< Is this the "real" route? */
1091         unsigned short autoframing:1;         /*!< Whether to use our local configuration for frame sizes (off)
1092                                                *   or respect the other endpoint's request for frame sizes (on)
1093                                                *   for incoming calls
1094                                                */
1095         unsigned short req_secure_signaling:1;/*!< Whether we are required to have secure signaling or not */
1096         unsigned short natdetected:1;         /*!< Whether we detected a NAT when processing the Via */
1097         int timer_t1;                     /*!< SIP timer T1, ms rtt */
1098         int timer_b;                      /*!< SIP timer B, ms */
1099         unsigned int sipoptions;          /*!< Supported SIP options on the other end */
1100         unsigned int reqsipoptions;       /*!< Required SIP options on the other end */
1101         struct ast_codec_pref prefs;      /*!< codec prefs */
1102         struct ast_format_cap *caps;             /*!< Special capability (codec) */
1103         struct ast_format_cap *jointcaps;        /*!< Supported capability at both ends (codecs) */
1104         struct ast_format_cap *peercaps;         /*!< Supported peer capability */
1105         struct ast_format_cap *redircaps;        /*!< Redirect codecs */
1106         struct ast_format_cap *prefcaps;         /*!< Preferred codec (outbound only) */
1107         int noncodeccapability;           /*!< DTMF RFC2833 telephony-event */
1108         int jointnoncodeccapability;      /*!< Joint Non codec capability */
1109         int maxcallbitrate;               /*!< Maximum Call Bitrate for Video Calls */  
1110         int t38_maxdatagram;              /*!< T.38 FaxMaxDatagram override */
1111         int request_queue_sched_id;       /*!< Scheduler ID of any scheduled action to process queued requests */
1112         int provisional_keepalive_sched_id;   /*!< Scheduler ID for provisional responses that need to be sent out to avoid cancellation */
1113         const char *last_provisional;         /*!< The last successfully transmitted provisonal response message */
1114         int authtries;                        /*!< Times we've tried to authenticate */
1115         struct sip_proxy *outboundproxy;      /*!< Outbound proxy for this dialog. Use ref_proxy to set this instead of setting it directly*/
1116         struct t38properties t38;             /*!< T38 settings */
1117         struct ast_sockaddr udptlredirip;     /*!< Where our T.38 UDPTL should be going if not to us */
1118         struct ast_udptl *udptl;              /*!< T.38 UDPTL session */
1119         char zone[MAX_TONEZONE_COUNTRY];      /*!< Default tone zone for channels created by this dialog */
1120         int callingpres;                      /*!< Calling presentation */
1121         int expiry;                         /*!< How long we take to expire */
1122         int sessionversion;                 /*!< SDP Session Version */
1123         int sessionid;                      /*!< SDP Session ID */
1124         long branch;                        /*!< The branch identifier of this session */
1125         long invite_branch;                 /*!< The branch used when we sent the initial INVITE */
1126         int64_t sessionversion_remote;      /*!< Remote UA's SDP Session Version */
1127         unsigned int portinuri:1;           /*!< Non zero if a port has been specified, will also disable srv lookups */
1128         struct ast_sockaddr sa;              /*!< Our peer */
1129         struct ast_sockaddr redirip;         /*!< Where our RTP should be going if not to us */
1130         struct ast_sockaddr vredirip;        /*!< Where our Video RTP should be going if not to us */
1131         struct ast_sockaddr tredirip;        /*!< Where our Text RTP should be going if not to us */
1132         time_t lastrtprx;                   /*!< Last RTP received */
1133         time_t lastrtptx;                   /*!< Last RTP sent */
1134         int rtptimeout;                     /*!< RTP timeout time */
1135         int rtpholdtimeout;                 /*!< RTP timeout time on hold*/
1136         int rtpkeepalive;                   /*!< RTP send packets for keepalive */
1137         struct ast_acl_list *directmediaacl; /*!< Which IPs are allowed to interchange direct media with this peer - copied from sip_peer */
1138         struct ast_sockaddr recv;            /*!< Received as */
1139         struct ast_sockaddr ourip;           /*!< Our IP (as seen from the outside) */
1140         enum transfermodes allowtransfer;   /*!< REFER: restriction scheme */
1141         struct ast_channel *owner;          /*!< Who owns us (if we have an owner) */
1142         struct sip_route *route;            /*!< Head of linked list of routing steps (fm Record-Route) */
1143         struct sip_notify *notify;          /*!< Custom notify type */
1144         struct sip_auth_container *peerauth;/*!< Realm authentication credentials */
1145         int noncecount;                     /*!< Nonce-count */
1146         unsigned int stalenonce:1;          /*!< Marks the current nonce as responded too */
1147         unsigned int ongoing_reinvite:1;    /*!< There is a reinvite in progress that might need to be cleaned up */
1148         char lastmsg[256];                  /*!< Last Message sent/received */
1149         int amaflags;                       /*!< AMA Flags */
1150         uint32_t pendinginvite; /*!< Any pending INVITE or state NOTIFY (in subscribe pvt's) ? (seqno of this) */
1151         uint32_t glareinvite;      /*!< A invite received while a pending invite is already present is stored here.  Its seqno is the
1152                                    value. Since this glare invite's seqno is not the same as the pending invite's, it must be
1153                                    held in order to properly process acknowledgements for our 491 response. */
1154         struct sip_request initreq;         /*!< Latest request that opened a new transaction
1155                                                  within this dialog.
1156                                                  NOT the request that opened the dialog */
1157
1158         int initid;                         /*!< Auto-congest ID if appropriate (scheduler) */
1159         int waitid;                         /*!< Wait ID for scheduler after 491 or other delays */
1160         int reinviteid;                     /*!< Reinvite in case of provisional, but no final response */
1161         int autokillid;                     /*!< Auto-kill ID (scheduler) */
1162         int t38id;                          /*!< T.38 Response ID */
1163         struct sip_refer *refer;            /*!< REFER: SIP transfer data structure */
1164         enum subscriptiontype subscribed;   /*!< SUBSCRIBE: Is this dialog a subscription?  */
1165         int stateid;                        /*!< SUBSCRIBE: ID for devicestate subscriptions */
1166         int laststate;                      /*!< SUBSCRIBE: Last known extension state */
1167         struct ao2_container *last_device_state_info; /*!< SUBSCRIBE: last known extended extension state (take care of refs)*/
1168         struct timeval last_ringing_channel_time; /*!< SUBSCRIBE: channel timestamp of the channel which caused the last early-state notification */
1169         int last_presence_state;            /*!< SUBSCRIBE: Last known presence state */
1170         uint32_t dialogver;                 /*!< SUBSCRIBE: Version for subscription dialog-info */
1171
1172         struct ast_dsp *dsp;                /*!< Inband DTMF or Fax CNG tone Detection dsp */
1173
1174         struct sip_peer *relatedpeer;       /*!< If this dialog is related to a peer, which one
1175                                                  Used in peerpoke, mwi subscriptions */
1176         struct sip_registry *registry;      /*!< If this is a REGISTER dialog, to which registry */
1177         struct ast_rtp_instance *rtp;       /*!< RTP Session */
1178         struct ast_rtp_instance *vrtp;      /*!< Video RTP session */
1179         struct ast_rtp_instance *trtp;      /*!< Text RTP session */
1180         struct sip_pkt *packets;            /*!< Packets scheduled for re-transmission */
1181         struct sip_history_head *history;   /*!< History of this SIP dialog */
1182         size_t history_entries;             /*!< Number of entires in the history */
1183         struct ast_variable *chanvars;      /*!< Channel variables to set for inbound call */
1184         AST_LIST_HEAD_NOLOCK(, sip_msg_hdr) msg_headers; /*!< Additional MESSAGE headers to send. */
1185         AST_LIST_HEAD_NOLOCK(request_queue, sip_request) request_queue; /*!< Requests that arrived but could not be processed immediately */
1186         struct sip_invite_param *options;   /*!< Options for INVITE */
1187         struct sip_st_dlg *stimer;          /*!< SIP Session-Timers */
1188         struct sip_srtp *srtp;              /*!< Structure to hold Secure RTP session data for audio */
1189         struct sip_srtp *vsrtp;             /*!< Structure to hold Secure RTP session data for video */
1190         struct sip_srtp *tsrtp;             /*!< Structure to hold Secure RTP session data for text */
1191
1192         int red;                            /*!< T.140 RTP Redundancy */
1193         int hangupcause;                    /*!< Storage of hangupcause copied from our owner before we disconnect from the AST channel (only used at hangup) */
1194
1195         struct sip_subscription_mwi *mwi;   /*!< If this is a subscription MWI dialog, to which subscription */
1196         /*! The SIP methods supported by this peer. We get this information from the Allow header of the first
1197          * message we receive from an endpoint during a dialog.
1198          */
1199         unsigned int allowed_methods;
1200         /*! Some peers are not trustworthy with their Allow headers, and so we need to override their wicked
1201          * ways through configuration. This is a copy of the peer's disallowed_methods, so that we can apply them
1202          * to the sip_pvt at various stages of dialog establishment
1203          */
1204         unsigned int disallowed_methods;
1205         /*! When receiving an SDP offer, it is important to take note of what media types were offered.
1206          * By doing this, even if we don't want to answer a particular media stream with something meaningful, we can
1207          * still put an m= line in our answer with the port set to 0.
1208          *
1209          * The reason for the length being 4 (OFFERED_MEDIA_COUNT) is that in this branch of Asterisk, the only media types supported are
1210          * image, audio, text, and video. Therefore we need to keep track of which types of media were offered.
1211          * Note that secure RTP defines new types of SDP media.
1212          *
1213          * If we wanted to be 100% correct, we would keep a list of all media streams offered. That way we could respond
1214          * even to unknown media types, and we could respond to multiple streams of the same type. Such large-scale changes
1215          * are not a good idea for released branches, though, so we're compromising by just making sure that for the common cases:
1216          * audio and video, audio and T.38, and audio and text, we give the appropriate response to both media streams.
1217          *
1218          * The large-scale changes would be a good idea for implementing during an SDP rewrite.
1219          */
1220         AST_LIST_HEAD_NOLOCK(, offered_media) offered_media;
1221         struct ast_cc_config_params *cc_params;
1222         struct sip_epa_entry *epa_entry;
1223         int fromdomainport;                 /*!< Domain port to show in from field */
1224
1225         struct ast_rtp_dtls_cfg dtls_cfg;
1226 };
1227
1228 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission
1229  * Packets are linked in a list, whose head is in the struct sip_pvt they belong to.
1230  * Each packet holds a reference to the parent struct sip_pvt.
1231  * This structure is allocated in __sip_reliable_xmit() and only for packets that
1232  * require retransmissions.
1233  */
1234 struct sip_pkt {
1235         struct sip_pkt *next;     /*!< Next packet in linked list */
1236         int retrans;              /*!< Retransmission number */
1237         int method;               /*!< SIP method for this packet */
1238         uint32_t seqno;           /*!< Sequence number */
1239         char is_resp;             /*!< 1 if this is a response packet (e.g. 200 OK), 0 if it is a request */
1240         char is_fatal;            /*!< non-zero if there is a fatal error */
1241         int response_code;        /*!< If this is a response, the response code */
1242         struct sip_pvt *owner;    /*!< Owner AST call */
1243         int retransid;            /*!< Retransmission ID */
1244         int timer_a;              /*!< SIP timer A, retransmission timer */
1245         int timer_t1;             /*!< SIP Timer T1, estimated RTT or 500 ms */
1246         struct timeval time_sent;  /*!< When pkt was sent */
1247         int64_t retrans_stop_time; /*!< Time in ms after 'now' that retransmission must stop */
1248         int retrans_stop;         /*!< Timeout is reached, stop retransmission  */
1249         struct ast_str *data;
1250 };
1251
1252 /*!
1253  * \brief A peer's mailbox
1254  *
1255  * We could use STRINGFIELDS here, but for only two strings, it seems like
1256  * too much effort ...
1257  */
1258 struct sip_mailbox {
1259         /*! Associated MWI subscription */
1260         struct ast_event_sub *event_sub;
1261         AST_LIST_ENTRY(sip_mailbox) entry;
1262         unsigned int delme:1;
1263         char *context;
1264         char mailbox[2];
1265 };
1266
1267 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host)
1268 */
1269 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail, as will astobj2 hashing of the structure */
1270 struct sip_peer {
1271         char name[80];                          /*!< the unique name of this object */
1272         AST_DECLARE_STRING_FIELDS(
1273                 AST_STRING_FIELD(secret);       /*!< Password for inbound auth */
1274                 AST_STRING_FIELD(md5secret);    /*!< Password in MD5 */
1275                 AST_STRING_FIELD(description);  /*!< Description of this peer */
1276                 AST_STRING_FIELD(remotesecret); /*!< Remote secret (trunks, remote devices) */
1277                 AST_STRING_FIELD(context);      /*!< Default context for incoming calls */
1278                 AST_STRING_FIELD(messagecontext); /*!< Default context for outofcall messages. */
1279                 AST_STRING_FIELD(subscribecontext); /*!< Default context for subscriptions */
1280                 AST_STRING_FIELD(username);     /*!< Temporary username until registration */
1281                 AST_STRING_FIELD(accountcode);  /*!< Account code */
1282                 AST_STRING_FIELD(tohost);       /*!< If not dynamic, IP address */
1283                 AST_STRING_FIELD(regexten);     /*!< Extension to register (if regcontext is used) */
1284                 AST_STRING_FIELD(fromuser);     /*!< From: user when calling this peer */
1285                 AST_STRING_FIELD(fromdomain);   /*!< From: domain when calling this peer */
1286                 AST_STRING_FIELD(fullcontact);  /*!< Contact registered with us (not in sip.conf) */
1287                 AST_STRING_FIELD(cid_num);      /*!< Caller ID num */
1288                 AST_STRING_FIELD(cid_name);     /*!< Caller ID name */
1289                 AST_STRING_FIELD(cid_tag);      /*!< Caller ID tag */
1290                 AST_STRING_FIELD(vmexten);      /*!< Dialplan extension for MWI notify message*/
1291                 AST_STRING_FIELD(language);     /*!<  Default language for prompts */
1292                 AST_STRING_FIELD(mohinterpret); /*!<  Music on Hold class */
1293                 AST_STRING_FIELD(mohsuggest);   /*!<  Music on Hold class */
1294                 AST_STRING_FIELD(parkinglot);   /*!<  Parkinglot */
1295                 AST_STRING_FIELD(useragent);    /*!<  User agent in SIP request (saved from registration) */
1296                 AST_STRING_FIELD(mwi_from);     /*!< Name to place in From header for outgoing NOTIFY requests */
1297                 AST_STRING_FIELD(engine);       /*!<  RTP Engine to use */
1298                 AST_STRING_FIELD(unsolicited_mailbox);  /*!< Mailbox to store received unsolicited MWI NOTIFY messages information in */
1299                 AST_STRING_FIELD(zone);         /*!< Tonezone for this device */
1300                 AST_STRING_FIELD(record_on_feature); /*!< Feature to use when receiving INFO with record: on during a call */
1301                 AST_STRING_FIELD(record_off_feature); /*!< Feature to use when receiving INFO with record: off during a call */
1302                 AST_STRING_FIELD(callback); /*!< Callback extension */
1303                 );
1304         struct sip_socket socket;       /*!< Socket used for this peer */
1305         enum sip_transport default_outbound_transport;   /*!< Peer Registration may change the default outbound transport.
1306                                                              If register expires, default should be reset. to this value */
1307         /* things that don't belong in flags */
1308         unsigned short transports:5;    /*!< Transports (enum sip_transport) that are acceptable for this peer */
1309         unsigned short is_realtime:1;   /*!< this is a 'realtime' peer */
1310         unsigned short rt_fromcontact:1;/*!< copy fromcontact from realtime */
1311         unsigned short host_dynamic:1;  /*!< Dynamic Peers register with Asterisk */
1312         unsigned short selfdestruct:1;  /*!< Automatic peers need to destruct themselves */
1313         unsigned short the_mark:1;      /*!< moved out of ASTOBJ into struct proper; That which bears the_mark should be deleted! */
1314         unsigned short autoframing:1;   /*!< Whether to use our local configuration for frame sizes (off)
1315                                          *   or respect the other endpoint's request for frame sizes (on)
1316                                          *   for incoming calls
1317                                          */
1318         unsigned short deprecated_username:1; /*!< If it's a realtime peer, are they using the deprecated "username" instead of "defaultuser" */
1319         struct sip_auth_container *auth;/*!< Realm authentication credentials */
1320         int amaflags;                   /*!< AMA Flags (for billing) */
1321         int callingpres;                /*!< Calling id presentation */
1322         int inuse;                      /*!< Number of calls in use */
1323         int ringing;                    /*!< Number of calls ringing */
1324         int onhold;                     /*!< Peer has someone on hold */
1325         int call_limit;                 /*!< Limit of concurrent calls */
1326         int t38_maxdatagram;            /*!< T.38 FaxMaxDatagram override */
1327         int busy_level;                 /*!< Level of active channels where we signal busy */
1328         int maxforwards;                /*!< SIP Loop prevention */
1329         enum transfermodes allowtransfer;   /*! SIP Refer restriction scheme */
1330         struct ast_codec_pref prefs;    /*!<  codec prefs */
1331         int lastmsgssent;                               /*!< The last known VM message counts (new/old) */
1332         unsigned int sipoptions;        /*!<  Supported SIP options */
1333         struct ast_flags flags[3];      /*!<  SIP_ flags */
1334
1335         /*! Mailboxes that this peer cares about */
1336         AST_LIST_HEAD_NOLOCK(, sip_mailbox) mailboxes;
1337
1338         int maxcallbitrate;             /*!<  Maximum Bitrate for a video call */
1339         int expire;                     /*!<  When to expire this peer registration */
1340         struct ast_format_cap *caps;            /*!<  Codec capability */
1341         int rtptimeout;                 /*!<  RTP timeout */
1342         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1343         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1344         ast_group_t callgroup;          /*!<  Call group */
1345         ast_group_t pickupgroup;        /*!<  Pickup group */
1346         struct ast_namedgroups *named_callgroups;   /*!< Named call group */
1347         struct ast_namedgroups *named_pickupgroups; /*!< Named pickup group */
1348         struct sip_proxy *outboundproxy;/*!< Outbound proxy for this peer */
1349         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1350         struct ast_sockaddr addr;        /*!<  IP address of peer */
1351         unsigned int portinuri:1;       /*!< Whether the port should be included in the URI */
1352         struct sip_pvt *call;           /*!<  Call pointer */
1353         int pokeexpire;                 /*!<  Qualification: When to expire poke (qualify= checking) */
1354         int lastms;                     /*!<  Qualification: How long last response took (in ms), or -1 for no response */
1355         int maxms;                      /*!<  Qualification: Max ms we will accept for the host to be up, 0 to not monitor */
1356         int qualifyfreq;                /*!<  Qualification: Qualification: How often to check for the host to be up */
1357         struct timeval ps;              /*!<  Qualification: Time for sending SIP OPTION in sip_pke_peer() */
1358         int keepalive;                  /*!<  Keepalive: How often to send keep alive packet */
1359         int keepalivesend;              /*!<  Keepalive: Scheduled item for sending keep alive packet */
1360         struct ast_sockaddr defaddr;     /*!<  Default IP address, used until registration */
1361         struct ast_acl_list *acl;              /*!<  Access control list */
1362         struct ast_acl_list *contactacl;       /*!<  Restrict what IPs are allowed in the Contact header (for registration) */
1363         struct ast_acl_list *directmediaacl;   /*!<  Restrict what IPs are allowed to interchange direct media with */
1364         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1365         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1366         struct sip_st_cfg stimer;       /*!<  SIP Session-Timers */
1367         int timer_t1;                   /*!<  The maximum T1 value for the peer */
1368         int timer_b;                    /*!<  The maximum timer B (transaction timeouts) */
1369         int fromdomainport;             /*!<  The From: domain port */
1370
1371         /*XXX Seems like we suddenly have two flags with the same content. Why? To be continued... */
1372         enum sip_peer_type type; /*!< Distinguish between "user" and "peer" types. This is used solely for CLI and manager commands */
1373         unsigned int disallowed_methods;
1374         struct ast_cc_config_params *cc_params;
1375
1376         struct ast_rtp_dtls_cfg dtls_cfg;
1377 };
1378
1379 /*!
1380  * \brief Registrations with other SIP proxies
1381  *
1382  * Created by sip_register(), the entry is linked in the 'regl' list,
1383  * and never deleted (other than at 'sip reload' or module unload times).
1384  * The entry always has a pending timeout, either waiting for an ACK to
1385  * the REGISTER message (in which case we have to retransmit the request),
1386  * or waiting for the next REGISTER message to be sent (either the initial one,
1387  * or once the previously completed registration one expires).
1388  * The registration can be in one of many states, though at the moment
1389  * the handling is a bit mixed.
1390  *
1391  * \todo Convert this to astobj2
1392  */
1393 struct sip_registry {
1394         ASTOBJ_COMPONENTS_FULL(struct sip_registry, 80, 1);
1395         AST_DECLARE_STRING_FIELDS(
1396                 AST_STRING_FIELD(callid);     /*!< Global Call-ID */
1397                 AST_STRING_FIELD(realm);      /*!< Authorization realm */
1398                 AST_STRING_FIELD(nonce);      /*!< Authorization nonce */
1399                 AST_STRING_FIELD(opaque);     /*!< Opaque nonsense */
1400                 AST_STRING_FIELD(qop);        /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1401                 AST_STRING_FIELD(authdomain); /*!< Authorization domain */
1402                 AST_STRING_FIELD(regdomain);  /*!< Registration doamin */
1403                 AST_STRING_FIELD(username);   /*!< Who we are registering as */
1404                 AST_STRING_FIELD(authuser);   /*!< Who we *authenticate* as */
1405                 AST_STRING_FIELD(hostname);   /*!< Domain or host we register to */
1406                 AST_STRING_FIELD(secret);     /*!< Password in clear text */
1407                 AST_STRING_FIELD(md5secret);  /*!< Password in md5 */
1408                 AST_STRING_FIELD(callback);   /*!< Contact extension */
1409                 AST_STRING_FIELD(peername);   /*!< Peer registering to */
1410         );
1411         enum sip_transport transport;   /*!< Transport for this registration UDP, TCP or TLS */
1412         int portno;                     /*!< Optional port override */
1413         int regdomainport;              /*!< Port override for domainport */
1414         int expire;                     /*!< Sched ID of expiration */
1415         int configured_expiry;          /*!< Configured value to use for the Expires header */
1416         int expiry;             /*!< Negotiated value used for the Expires header */
1417         int regattempts;        /*!< Number of attempts (since the last success) */
1418         int timeout;            /*!< sched id of sip_reg_timeout */
1419         int refresh;            /*!< How often to refresh */
1420         struct sip_pvt *call;   /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1421         enum sipregistrystate regstate; /*!< Registration state (see above) */
1422         struct timeval regtime;         /*!< Last successful registration time */
1423         int callid_valid;       /*!< 0 means we haven't chosen callid for this registry yet. */
1424         uint32_t ocseq;         /*!< Sequence number we got to for REGISTERs for this registry */
1425         struct ast_dnsmgr_entry *dnsmgr;  /*!<  DNS refresh manager for register */
1426         struct ast_sockaddr us;  /*!< Who the server thinks we are */
1427         int noncecount;         /*!< Nonce-count */
1428         char lastmsg[256];      /*!< Last Message sent/received */
1429 };
1430
1431 struct tcptls_packet {
1432         AST_LIST_ENTRY(tcptls_packet) entry;
1433         struct ast_str *data;
1434         size_t len;
1435 };
1436 /*! \brief Definition of a thread that handles a socket */
1437 struct sip_threadinfo {
1438         /*! TRUE if the thread needs to kill itself.  (The module is being unloaded.) */
1439         int stop;
1440         int alert_pipe[2];          /*! Used to alert tcptls thread when packet is ready to be written */
1441         pthread_t threadid;
1442         struct ast_tcptls_session_instance *tcptls_session;
1443         enum sip_transport type;    /*!< We keep a copy of the type here so we can display it in the connection list */
1444         AST_LIST_HEAD_NOLOCK(, tcptls_packet) packet_q;
1445 };
1446
1447 /*!
1448  * \brief Definition of an MWI subscription to another server
1449  * 
1450  * \todo Convert this to astobj2.
1451  */
1452 struct sip_subscription_mwi {
1453         ASTOBJ_COMPONENTS_FULL(struct sip_subscription_mwi,1,1);
1454         AST_DECLARE_STRING_FIELDS(
1455                 AST_STRING_FIELD(username);     /*!< Who we are sending the subscription as */
1456                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1457                 AST_STRING_FIELD(hostname);     /*!< Domain or host we subscribe to */
1458                 AST_STRING_FIELD(secret);       /*!< Password in clear text */
1459                 AST_STRING_FIELD(mailbox);      /*!< Mailbox store to put MWI into */
1460                 );
1461         enum sip_transport transport;    /*!< Transport to use */
1462         int portno;                      /*!< Optional port override */
1463         int resub;                       /*!< Sched ID of resubscription */
1464         unsigned int subscribed:1;       /*!< Whether we are currently subscribed or not */
1465         struct sip_pvt *call;            /*!< Outbound subscription dialog */
1466         struct ast_dnsmgr_entry *dnsmgr; /*!< DNS refresh manager for subscription */
1467         struct ast_sockaddr us;           /*!< Who the server thinks we are */
1468 };
1469
1470 /*!
1471  * SIP PUBLISH support!
1472  * PUBLISH support was added to chan_sip due to its use in the call-completion
1473  * event package. In order to suspend and unsuspend monitoring of a called party,
1474  * a PUBLISH message must be sent. Rather than try to hack in PUBLISH transmission
1475  * and reception solely for the purposes of handling call-completion-related messages,
1476  * an effort has been made to create a generic framework for handling PUBLISH messages.
1477  *
1478  * There are two main components to the effort, the event publication agent (EPA) and
1479  * the event state compositor (ESC). Both of these terms appear in RFC 3903, and the
1480  * implementation in Asterisk conforms to the defintions there. An EPA is a UAC that
1481  * transmits PUBLISH requests. An ESC is a UAS that receives PUBLISH requests and
1482  * acts appropriately based on the content of those requests.
1483  *
1484  * ESC:
1485  * The main structure in chan_sip is the event_state_compositor. There is an
1486  * event_state_compositor structure for each event package supported (as of Nov 2009
1487  * this is only the call-completion package). The structure contains data which is
1488  * intrinsic to the event package itself, such as the name of the package and a set
1489  * of callbacks for handling incoming PUBLISH requests. In addition, the
1490  * event_state_compositor struct contains an ao2_container of sip_esc_entries.
1491  *
1492  * A sip_esc_entry corresponds to an entity which has sent a PUBLISH to Asterisk. We are
1493  * able to match the incoming PUBLISH to a sip_esc_entry using the Sip-If-Match header
1494  * of the message. Of course, if none is present, then a new sip_esc_entry will be created.
1495  *
1496  * Once it is determined what type of PUBLISH request has come in (from RFC 3903, it may
1497  * be an initial, modify, refresh, or remove), then the event package-specific callbacks
1498  * may be called. If your event package doesn't need to take any specific action for a
1499  * specific PUBLISH type, it is perfectly safe to not define the callback at all. The callback
1500  * only needs to take care of application-specific information. If there is a problem, it is
1501  * up to the callback to take care of sending an appropriate 4xx or 5xx response code. In such
1502  * a case, the callback should return -1. This will tell the function that called the handler
1503  * that an appropriate error response has been sent. If the callback returns 0, however, then
1504  * the caller of the callback will generate a new entity tag and send a 200 OK response.
1505  *
1506  * ESC entries are reference-counted, however as an implementor of a specific event package,
1507  * this should be transparent, since the reference counts are handled by the general ESC
1508  * framework.
1509  *
1510  * EPA:
1511  * The event publication agent in chan_sip is structured quite a bit differently than the
1512  * ESC. With an ESC, an appropriate entry has to be found based on the contents of an incoming
1513  * PUBLISH message. With an EPA, the application interested in sending the PUBLISH can maintain
1514  * a reference to the appropriate EPA entry instead. Similarly, when matching a PUBLISH response
1515  * to an appropriate EPA entry, the sip_pvt can maintain a reference to the corresponding
1516  * EPA entry. The result of this train of thought is that there is no compelling reason to
1517  * maintain a container of these entries.
1518  *
1519  * Instead, there is only the sip_epa_entry structure. Every sip_epa_entry has an entity tag
1520  * that it maintains so that subsequent PUBLISH requests will be identifiable by the ESC on
1521  * the far end. In addition, there is a static_data field which contains information that is
1522  * common to all sip_epa_entries for a specific event package. This static data includes the
1523  * name of the event package and callbacks for handling specific responses for outgoing PUBLISHes.
1524  * Also, there is a field for pointing to instance-specific data. This can include the current
1525  * published state or other identifying information that is specific to an instance of an EPA
1526  * entry of a particular event package.
1527  *
1528  * When an application wishes to send a PUBLISH request, it simply will call create_epa_entry,
1529  * followed by transmit_publish in order to send the PUBLISH. That's all that is necessary.
1530  * Like with ESC entries, sip_epa_entries are reference counted. Unlike ESC entries, though,
1531  * sip_epa_entries reference counts have to be maintained to some degree by the application making
1532  * use of the sip_epa_entry. The application will acquire a reference to the EPA entry when it
1533  * calls create_epa_entry. When the application has finished using the EPA entry (which may not
1534  * be until after several PUBLISH transactions have taken place) it must use ao2_ref to decrease
1535  * the reference count by 1.
1536  */
1537
1538 /*!
1539  * \brief The states that can be represented in a SIP call-completion PUBLISH
1540  */
1541 enum sip_cc_publish_state {
1542         /*! Closed, i.e. unavailable */
1543         CC_CLOSED,
1544         /*! Open, i.e. available */
1545         CC_OPEN,
1546 };
1547
1548 /*!
1549  * \brief The states that can be represented in a SIP call-completion NOTIFY
1550  */
1551 enum sip_cc_notify_state {
1552         /*! Queued, i.e. unavailable */
1553         CC_QUEUED,
1554         /*! Ready, i.e. available */
1555         CC_READY,
1556 };
1557
1558 /*!
1559  * \brief The types of PUBLISH messages defined in RFC 3903
1560  */
1561 enum sip_publish_type {
1562         /*!
1563          * \brief Unknown
1564          *
1565          * \details
1566          * This actually is not defined in RFC 3903. We use this as a constant
1567          * to indicate that an incoming PUBLISH does not fit into any of the
1568          * other categories and is thus invalid.
1569          */
1570         SIP_PUBLISH_UNKNOWN,
1571         /*!
1572          * \brief Initial
1573          *
1574          * \details
1575          * The first PUBLISH sent. This will contain a non-zero Expires header
1576          * as well as a body that indicates the current state of the endpoint
1577          * that has sent the message. The initial PUBLISH is the only type
1578          * of PUBLISH to not contain a Sip-If-Match header in it.
1579          */
1580         SIP_PUBLISH_INITIAL,
1581         /*!
1582          * \brief Refresh
1583          *
1584          * \details
1585          * Used to keep a published state from expiring. This will contain a
1586          * non-zero Expires header but no body since its purpose is not to
1587          * update state.
1588          */
1589         SIP_PUBLISH_REFRESH,
1590         /*!
1591          * \brief Modify
1592          *
1593          * \details
1594          * Used to change state from its previous value. This will contain
1595          * a body updating the published state. May or may not contain an
1596          * Expires header.
1597          */
1598         SIP_PUBLISH_MODIFY,
1599         /*!
1600          * \brief Remove
1601          * 
1602          * \details
1603          * Used to remove published state from an ESC. This will contain
1604          * an Expires header set to 0 and likely no body.
1605          */
1606         SIP_PUBLISH_REMOVE,
1607 };
1608
1609 /*!
1610  * Data which is the same for all instances of an EPA for a
1611  * particular event package
1612  */
1613 struct epa_static_data {
1614         /*! The event type */
1615         enum subscriptiontype event;
1616         /*!
1617          * The name of the event as it would
1618          * appear in a SIP message
1619          */
1620         const char *name;
1621         /*!
1622          * The callback called when a 200 OK is received on an outbound PUBLISH
1623          */
1624         void (*handle_ok)(struct sip_pvt *, struct sip_request *, struct sip_epa_entry *);
1625         /*!
1626          * The callback called when an error response is received on an outbound PUBLISH
1627          */
1628         void (*handle_error)(struct sip_pvt *, const int resp, struct sip_request *, struct sip_epa_entry *);
1629         /*!
1630          * Destructor to call to clean up instance data
1631          */
1632         void (*destructor)(void *instance_data);
1633 };
1634
1635 /*!
1636  * \brief backend for an event publication agent
1637  */
1638 struct epa_backend {
1639         const struct epa_static_data *static_data;
1640         AST_LIST_ENTRY(epa_backend) next;
1641 };
1642
1643 struct sip_epa_entry {
1644         /*!
1645          * When we are going to send a publish, we need to
1646          * know the type of PUBLISH to send.
1647          */
1648         enum sip_publish_type publish_type;
1649         /*!
1650          * When we send a PUBLISH, we have to be
1651          * sure to include the entity tag that we
1652          * received in the previous response.
1653          */
1654         char entity_tag[SIPBUFSIZE];
1655         /*!
1656          * The destination to which this EPA should send
1657          * PUBLISHes. This may be the name of a SIP peer
1658          * or a hostname.
1659          */
1660         char destination[SIPBUFSIZE];
1661         /*!
1662          * The body of the most recently-sent PUBLISH message.
1663          * This is useful for situations such as authentication,
1664          * in which we must send a message identical to the
1665          * one previously sent
1666          */
1667         char body[SIPBUFSIZE];
1668         /*!
1669          * Every event package has some constant data and
1670          * callbacks that all instances will share. This
1671          * data resides in this field.
1672          */
1673         const struct epa_static_data *static_data;
1674         /*!
1675          * In addition to the static data that all instances
1676          * of sip_epa_entry will have, each instance will
1677          * require its own instance-specific data.
1678          */
1679         void *instance_data;
1680 };
1681
1682 /*!
1683  * \brief Instance data for a Call completion EPA entry
1684  */
1685 struct cc_epa_entry {
1686         /*!
1687          * The core ID of the CC transaction
1688          * for which this EPA entry belongs. This
1689          * essentially acts as a unique identifier
1690          * for the entry and is used in the hash
1691          * and comparison functions
1692          */
1693         int core_id;
1694         /*!
1695          * We keep the last known state of the
1696          * device in question handy in case
1697          * it needs to be known by a third party.
1698          * Also, in the case where for some reason
1699          * we get asked to transmit state that we
1700          * already sent, we can just ignore the
1701          * request.
1702          */
1703         enum sip_cc_publish_state current_state;
1704 };
1705
1706 struct event_state_compositor;
1707
1708 /*!
1709  * \brief common ESC items for all event types
1710  *
1711  * The entity_id field serves as a means by which
1712  * A specific entry may be found.
1713  */
1714 struct sip_esc_entry {
1715         /*!
1716          * The name of the party who
1717          * sent us the PUBLISH. This will more
1718          * than likely correspond to a peer name.
1719          *
1720          * This field's utility isn't really that
1721          * great. It's mainly just a user-recognizable
1722          * handle that can be printed in debug messages.
1723          */
1724         const char *device_name;
1725         /*!
1726          * The event package for which this esc_entry
1727          * exists. Most of the time this isn't really
1728          * necessary since you'll have easy access to the
1729          * ESC which contains this entry. However, in
1730          * some circumstances, we won't have the ESC
1731          * available.
1732          */
1733         const char *event;
1734         /*!
1735          * The entity ID used when corresponding
1736          * with the EPA on the other side. As the
1737          * ESC, we generate an entity ID for each
1738          * received PUBLISH and store it in this
1739          * structure.
1740          */
1741         char entity_tag[30];
1742         /*!
1743          * The ID for the scheduler. We schedule
1744          * destruction of a sip_esc_entry when we
1745          * receive a PUBLISH. The destruction is
1746          * scheduled for the duration received in
1747          * the Expires header.
1748          */
1749         int sched_id;
1750         /*!
1751          * Each ESC entry will be for a specific
1752          * event type. Those entries will need to
1753          * carry data which is intrinsic to the
1754          * ESC entry but which is specific to
1755          * the event package
1756          */
1757         void *event_specific_data;
1758 };
1759
1760 typedef int (* const esc_publish_callback)(struct sip_pvt *, struct sip_request *, struct event_state_compositor *, struct sip_esc_entry *);
1761
1762 /*!
1763  * \brief Callbacks for SIP ESCs
1764  *
1765  * \details
1766  * The names of the callbacks are self-explanatory. The
1767  * corresponding handler is called whenever the specific
1768  * type of PUBLISH is received.
1769  */
1770 struct sip_esc_publish_callbacks {
1771         const esc_publish_callback initial_handler;
1772         const esc_publish_callback refresh_handler;
1773         const esc_publish_callback modify_handler;
1774         const esc_publish_callback remove_handler;
1775 };
1776
1777 struct sip_cc_agent_pvt {
1778         int offer_timer_id;
1779         /* A copy of the original call's Call-ID.
1780          * We use this as a search key when attempting
1781          * to find a particular sip_pvt.
1782          */
1783         char original_callid[SIPBUFSIZE];
1784         /* A copy of the exten called originally.
1785          * We use this to set the proper extension
1786          * to dial during the recall since the incoming
1787          * request URI is one that was generated just
1788          * for the recall
1789          */
1790         char original_exten[SIPBUFSIZE];
1791         /* A reference to the dialog which we will
1792          * be sending a NOTIFY on when it comes time
1793          * to send one
1794          */
1795         struct sip_pvt *subscribe_pvt;
1796         /* When we send a NOTIFY, we include a URI
1797          * that should be used by the caller when he
1798          * wishes to send a PUBLISH or INVITE to us.
1799          * We store that URI here.
1800          */
1801         char notify_uri[SIPBUFSIZE];
1802         /* When we advertise call completion to a caller,
1803          * we provide a URI for the caller to use when
1804          * he sends us a SUBSCRIBE. We store it for matching
1805          * purposes when we receive the SUBSCRIBE from the
1806          * caller.
1807          */
1808         char subscribe_uri[SIPBUFSIZE];
1809         char is_available;
1810 };
1811
1812 struct sip_monitor_instance {
1813         AST_DECLARE_STRING_FIELDS(
1814                 AST_STRING_FIELD(subscribe_uri);
1815                 AST_STRING_FIELD(notify_uri);
1816                 AST_STRING_FIELD(peername);
1817                 AST_STRING_FIELD(device_name);
1818         );
1819         int core_id;
1820         struct sip_pvt *subscription_pvt;
1821         struct sip_epa_entry *suspension_entry;
1822 };
1823
1824 /*!
1825  * \brief uri parameters
1826  *
1827  */
1828
1829 struct uriparams {
1830         char *transport;
1831         char *user;
1832         char *method;
1833         char *ttl;
1834         char *maddr;
1835         int lr;
1836 };
1837
1838 struct contact {
1839         AST_LIST_ENTRY(contact) list;
1840         char *name;
1841         char *user;
1842         char *pass;
1843         char *hostport;
1844         struct uriparams params;
1845         char *headers;
1846         char *expires;
1847         char *q;
1848 };
1849
1850 AST_LIST_HEAD_NOLOCK(contactliststruct, contact);
1851
1852 /*! \brief List of well-known SIP options. If we get this in a require,
1853    we should check the list and answer accordingly. */
1854 static const struct cfsip_options {
1855         int id;             /*!< Bitmap ID */
1856         int supported;      /*!< Supported by Asterisk ? */
1857         char * const text;  /*!< Text id, as in standard */
1858 } sip_options[] = {     /* XXX used in 3 places */
1859         /* RFC3262: PRACK 100% reliability */
1860         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },
1861         /* RFC3959: SIP Early session support */
1862         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
1863         /* SIMPLE events:  RFC4662 */
1864         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
1865         /* RFC 4916- Connected line ID updates */
1866         { SIP_OPT_FROMCHANGE,   NOT_SUPPORTED,  "from-change" },
1867         /* GRUU: Globally Routable User Agent URI's */
1868         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
1869         /* RFC4244 History info */
1870         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
1871         /* RFC3911: SIP Join header support */
1872         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
1873         /* Disable the REFER subscription, RFC 4488 */
1874         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
1875         /* SIP outbound - the final NAT battle - draft-sip-outbound */
1876         { SIP_OPT_OUTBOUND,     NOT_SUPPORTED,  "outbound" },
1877         /* RFC3327: Path support */
1878         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
1879         /* RFC3840: Callee preferences */
1880         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
1881         /* RFC3312: Precondition support */
1882         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
1883         /* RFC3323: Privacy with proxies*/
1884         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
1885         /* RFC-ietf-sip-uri-list-conferencing-02.txt conference invite lists */
1886         { SIP_OPT_RECLISTINV,   NOT_SUPPORTED,  "recipient-list-invite" },
1887         /* RFC-ietf-sip-uri-list-subscribe-02.txt - subscription lists */
1888         { SIP_OPT_RECLISTSUB,   NOT_SUPPORTED,  "recipient-list-subscribe" },
1889         /* RFC3891: Replaces: header for transfer */
1890         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },
1891         /* One version of Polycom firmware has the wrong label */
1892         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },
1893         /* RFC4412 Resource priorities */
1894         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
1895         /* RFC3329: Security agreement mechanism */
1896         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
1897         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
1898         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
1899         /* RFC4028: SIP Session-Timers */
1900         { SIP_OPT_TIMER,        SUPPORTED,      "timer" },
1901         /* RFC4538: Target-dialog */
1902         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
1903 };
1904
1905 struct digestkeys {
1906         const char *key;
1907         const char *s;
1908 };
1909
1910 AST_THREADSTORAGE(check_auth_buf);
1911
1912 /*----------------------------------------------------------*/
1913 /*----                    FUNCTIONS                     ----*/
1914 /*----------------------------------------------------------*/
1915
1916 struct sip_peer *sip_find_peer(const char *peer, struct ast_sockaddr *addr, int realtime, int which_objects, int devstate_only, int transport);
1917 void sip_auth_headers(enum sip_auth_type code, char **header, char **respheader);
1918 const char *sip_get_header(const struct sip_request *req, const char *name);
1919 const char *sip_get_transport(enum sip_transport t);
1920 void *sip_unref_peer(struct sip_peer *peer, char *tag);
1921 struct sip_peer *sip_ref_peer(struct sip_peer *peer, char *tag);
1922
1923 #endif