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