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