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