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