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