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