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