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