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