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