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