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