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