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