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