f46c04d8b70255255c591e0913bb33615a44c001
[asterisk/asterisk.git] / channels / chan_sip.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20  * \file
21  * \brief Implementation of Session Initiation Protocol
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * See Also:
26  * \arg \ref AstCREDITS
27  *
28  * Implementation of RFC 3261 - without S/MIME, TCP and TLS support
29  * Configuration file \link Config_sip sip.conf \endlink
30  *
31  *
32  * \todo Better support of forking
33  * \todo VIA branch tag transaction checking
34  * \todo Transaction support
35  * \todo We need to test TCP sessions with SIP proxies and in regards
36  *       to the SIP outbound specs.
37  *
38  * \ingroup channel_drivers
39  *
40  * \par Overview of the handling of SIP sessions
41  * The SIP channel handles several types of SIP sessions, or dialogs,
42  * not all of them being "telephone calls".
43  * - Incoming calls that will be sent to the PBX core
44  * - Outgoing calls, generated by the PBX
45  * - SIP subscriptions and notifications of states and voicemail messages
46  * - SIP registrations, both inbound and outbound
47  * - SIP peer management (peerpoke, OPTIONS)
48  * - SIP text messages
49  *
50  * In the SIP channel, there's a list of active SIP dialogs, which includes
51  * all of these when they are active. "sip show channels" in the CLI will
52  * show most of these, excluding subscriptions which are shown by
53  * "sip show subscriptions"
54  *
55  * \par incoming packets
56  * Incoming packets are received in the monitoring thread, then handled by
57  * sipsock_read(). This function parses the packet and matches an existing
58  * dialog or starts a new SIP dialog.
59  * 
60  * sipsock_read sends the packet to handle_incoming(), that parses a bit more.
61  * If it is a response to an outbound request, the packet is sent to handle_response().
62  * If it is a request, handle_incoming() sends it to one of a list of functions
63  * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
64  * sipsock_read locks the ast_channel if it exists (an active call) and
65  * unlocks it after we have processed the SIP message.
66  *
67  * A new INVITE is sent to handle_request_invite(), that will end up
68  * starting a new channel in the PBX, the new channel after that executing
69  * in a separate channel thread. This is an incoming "call".
70  * When the call is answered, either by a bridged channel or the PBX itself
71  * the sip_answer() function is called.
72  *
73  * The actual media - Video or Audio - is mostly handled by the RTP subsystem
74  * in rtp.c 
75  * 
76  * \par Outbound calls
77  * Outbound calls are set up by the PBX through the sip_request_call()
78  * function. After that, they are activated by sip_call().
79  * 
80  * \par Hanging up
81  * The PBX issues a hangup on both incoming and outgoing calls through
82  * the sip_hangup() function
83  */
84
85 /*** MODULEINFO
86         <depend>chan_local</depend>
87  ***/
88
89 /*!  \page sip_session_timers SIP Session Timers in Asterisk Chan_sip
90
91         The SIP Session-Timers is an extension of the SIP protocol that allows end-points and proxies to
92         refresh a session periodically. The sessions are kept alive by sending a RE-INVITE or UPDATE
93         request at a negotiated interval. If a session refresh fails then all the entities that support Session-
94         Timers clear their internal session state. In addition, UAs generate a BYE request in order to clear
95         the state in the proxies and the remote UA (this is done for the benefit of SIP entities in the path
96         that do not support Session-Timers).
97
98         The Session-Timers can be configured on a system-wide, per-user, or per-peer basis. The peruser/
99         per-peer settings override the global settings. The following new parameters have been
100         added to the sip.conf file.
101                 session-timers=["accept", "originate", "refuse"]
102                 session-expires=[integer]
103                 session-minse=[integer]
104                 session-refresher=["uas", "uac"]
105
106         The session-timers parameter in sip.conf defines the mode of operation of SIP session-timers feature in
107         Asterisk. The Asterisk can be configured in one of the following three modes:
108
109         1. Accept :: In the "accept" mode, the Asterisk server honors session-timers requests
110                 made by remote end-points. A remote end-point can request Asterisk to engage
111                 session-timers by either sending it an INVITE request with a "Supported: timer"
112                 header in it or by responding to Asterisk's INVITE with a 200 OK that contains
113                 Session-Expires: header in it. In this mode, the Asterisk server does not 
114                 request session-timers from remote end-points. This is the default mode.
115         2. Originate :: In the "originate" mode, the Asterisk server requests the remote 
116                 end-points to activate session-timers in addition to honoring such requests
117                 made by the remote end-pints. In order to get as much protection as possible
118                 against hanging SIP channels due to network or end-point failures, Asterisk
119                 resends periodic re-INVITEs even if a remote end-point does not support
120                 the session-timers feature.
121         3. Refuse :: In the "refuse" mode, Asterisk acts as if it does not support session-
122                 timers for inbound or outbound requests. If a remote end-point requests
123                 session-timers in a dialog, then Asterisk ignores that request unless it's
124                 noted as a requirement (Require: header), in which case the INVITE is 
125                 rejected with a 420 Bad Extension response.
126
127 */
128
129 #include "asterisk.h"
130
131 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
132
133 #include <ctype.h>
134 #include <sys/ioctl.h>
135 #include <fcntl.h>
136 #include <signal.h>
137 #include <sys/signal.h>
138 #include <regex.h>
139
140 #include "asterisk/network.h"
141 #include "asterisk/paths.h"     /* need ast_config_AST_SYSTEM_NAME */
142
143 #include "asterisk/lock.h"
144 #include "asterisk/channel.h"
145 #include "asterisk/config.h"
146 #include "asterisk/module.h"
147 #include "asterisk/pbx.h"
148 #include "asterisk/sched.h"
149 #include "asterisk/io.h"
150 #include "asterisk/rtp.h"
151 #include "asterisk/udptl.h"
152 #include "asterisk/acl.h"
153 #include "asterisk/manager.h"
154 #include "asterisk/callerid.h"
155 #include "asterisk/cli.h"
156 #include "asterisk/app.h"
157 #include "asterisk/musiconhold.h"
158 #include "asterisk/dsp.h"
159 #include "asterisk/features.h"
160 #include "asterisk/srv.h"
161 #include "asterisk/astdb.h"
162 #include "asterisk/causes.h"
163 #include "asterisk/utils.h"
164 #include "asterisk/file.h"
165 #include "asterisk/astobj.h"
166 #include "asterisk/dnsmgr.h"
167 #include "asterisk/devicestate.h"
168 #include "asterisk/linkedlists.h"
169 #include "asterisk/stringfields.h"
170 #include "asterisk/monitor.h"
171 #include "asterisk/netsock.h"
172 #include "asterisk/localtime.h"
173 #include "asterisk/abstract_jb.h"
174 #include "asterisk/threadstorage.h"
175 #include "asterisk/translate.h"
176 #include "asterisk/ast_version.h"
177 #include "asterisk/event.h"
178 #include "asterisk/tcptls.h"
179
180 #ifndef FALSE
181 #define FALSE    0
182 #endif
183
184 #ifndef TRUE
185 #define TRUE     1
186 #endif
187
188 #define SIPBUFSIZE              512
189
190 #define XMIT_ERROR              -2
191
192 /* #define VOCAL_DATA_HACK */
193
194 #define DEFAULT_DEFAULT_EXPIRY  120
195 #define DEFAULT_MIN_EXPIRY      60
196 #define DEFAULT_MAX_EXPIRY      3600
197 #define DEFAULT_REGISTRATION_TIMEOUT 20
198 #define DEFAULT_MAX_FORWARDS    "70"
199
200 /* guard limit must be larger than guard secs */
201 /* guard min must be < 1000, and should be >= 250 */
202 #define EXPIRY_GUARD_SECS       15                /*!< How long before expiry do we reregister */
203 #define EXPIRY_GUARD_LIMIT      30                /*!< Below here, we use EXPIRY_GUARD_PCT instead of 
204                                                          EXPIRY_GUARD_SECS */
205 #define EXPIRY_GUARD_MIN        500                /*!< This is the minimum guard time applied. If 
206                                                    GUARD_PCT turns out to be lower than this, it 
207                                                    will use this time instead.
208                                                    This is in milliseconds. */
209 #define EXPIRY_GUARD_PCT        0.20                /*!< Percentage of expires timeout to use when 
210                                                     below EXPIRY_GUARD_LIMIT */
211 #define DEFAULT_EXPIRY 900                          /*!< Expire slowly */
212
213 static int min_expiry = DEFAULT_MIN_EXPIRY;        /*!< Minimum accepted registration time */
214 static int max_expiry = DEFAULT_MAX_EXPIRY;        /*!< Maximum accepted registration time */
215 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
216 static int expiry = DEFAULT_EXPIRY;
217
218 #ifndef MAX
219 #define MAX(a,b) ((a) > (b) ? (a) : (b))
220 #endif
221
222 #define CALLERID_UNKNOWN        "Unknown"
223
224 #define DEFAULT_MAXMS                2000             /*!< Qualification: Must be faster than 2 seconds by default */
225 #define DEFAULT_QUALIFYFREQ          60 * 1000        /*!< Qualification: How often to check for the host to be up */
226 #define DEFAULT_FREQ_NOTOK           10 * 1000        /*!< Qualification: How often to check, if the host is down... */
227
228 #define DEFAULT_RETRANS              1000             /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
229 #define MAX_RETRANS                  6                /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
230 #define SIP_TIMER_T1                 500              /* SIP timer T1 (according to RFC 3261) */
231 #define SIP_TRANS_TIMEOUT            64 * SIP_TIMER_T1/*!< SIP request timeout (rfc 3261) 64*T1 
232                                                       \todo Use known T1 for timeout (peerpoke)
233                                                       */
234 #define DEFAULT_TRANS_TIMEOUT        -1               /* Use default SIP transaction timeout */
235 #define MAX_AUTHTRIES                3                /*!< Try authentication three times, then fail */
236
237 #define SIP_MAX_HEADERS              64               /*!< Max amount of SIP headers to read */
238 #define SIP_MAX_LINES                64               /*!< Max amount of lines in SIP attachment (like SDP) */
239 #define SIP_MAX_PACKET               4096             /*!< Also from RFC 3261 (2543), should sub headers tho */
240 #define SIP_MIN_PACKET               1024             /*!< Initialize size of memory to allocate for packets */
241
242 #define INITIAL_CSEQ                 101              /*!< our initial sip sequence number */
243
244 #define DEFAULT_MAX_SE               1800             /*!< Session-Timer Default Session-Expires period (RFC 4028) */
245 #define DEFAULT_MIN_SE               90               /*!< Session-Timer Default Min-SE period (RFC 4028) */
246
247 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
248 static struct ast_jb_conf default_jbconf =
249 {
250         .flags = 0,
251         .max_size = -1,
252         .resync_threshold = -1,
253         .impl = ""
254 };
255 static struct ast_jb_conf global_jbconf;        /*!< Global jitterbuffer configuration */
256
257 static const char config[] = "sip.conf";        /*!< Main configuration file */
258 static const char notify_config[] = "sip_notify.conf";  /*!< Configuration file for sending Notify with CLI commands to reconfigure or reboot phones */
259
260 #define RTP     1
261 #define NO_RTP  0
262
263 /*! \brief Authorization scheme for call transfers 
264 \note Not a bitfield flag, since there are plans for other modes,
265         like "only allow transfers for authenticated devices" */
266 enum transfermodes {
267         TRANSFER_OPENFORALL,            /*!< Allow all SIP transfers */
268         TRANSFER_CLOSED,                /*!< Allow no SIP transfers */
269 };
270
271
272 enum sip_result {
273         AST_SUCCESS = 0,
274         AST_FAILURE = -1,
275 };
276
277 /*! \brief States for the INVITE transaction, not the dialog 
278         \note this is for the INVITE that sets up the dialog
279 */
280 enum invitestates {
281         INV_NONE = 0,           /*!< No state at all, maybe not an INVITE dialog */
282         INV_CALLING = 1,        /*!< Invite sent, no answer */
283         INV_PROCEEDING = 2,     /*!< We got/sent 1xx message */
284         INV_EARLY_MEDIA = 3,    /*!< We got 18x message with to-tag back */
285         INV_COMPLETED = 4,      /*!< Got final response with error. Wait for ACK, then CONFIRMED */
286         INV_CONFIRMED = 5,      /*!< Confirmed response - we've got an ack (Incoming calls only) */
287         INV_TERMINATED = 6,     /*!< Transaction done - either successful (AST_STATE_UP) or failed, but done 
288                                      The only way out of this is a BYE from one side */
289         INV_CANCELLED = 7,      /*!< Transaction cancelled by client or server in non-terminated state */
290 };
291
292 enum xmittype {
293         XMIT_CRITICAL = 2,              /*!< Transmit critical SIP message reliably, with re-transmits.
294                                               If it fails, it's critical and will cause a teardown of the session */
295         XMIT_RELIABLE = 1,              /*!< Transmit SIP message reliably, with re-transmits */
296         XMIT_UNRELIABLE = 0,            /*!< Transmit SIP message without bothering with re-transmits */
297 };
298
299 enum parse_register_result {
300         PARSE_REGISTER_FAILED,
301         PARSE_REGISTER_UPDATE,
302         PARSE_REGISTER_QUERY,
303 };
304
305 enum subscriptiontype { 
306         NONE = 0,
307         XPIDF_XML,
308         DIALOG_INFO_XML,
309         CPIM_PIDF_XML,
310         PIDF_XML,
311         MWI_NOTIFICATION
312 };
313
314 /*! \brief Subscription types that we support. We support
315    - dialoginfo updates (really device status, not dialog info as was the original intent of the standard)
316    - SIMPLE presence used for device status
317    - Voicemail notification subscriptions
318 */
319 static const struct cfsubscription_types {
320         enum subscriptiontype type;
321         const char * const event;
322         const char * const mediatype;
323         const char * const text;
324 } subscription_types[] = {
325         { NONE,            "-",        "unknown",                    "unknown" },
326         /* RFC 4235: SIP Dialog event package */
327         { DIALOG_INFO_XML, "dialog",   "application/dialog-info+xml", "dialog-info+xml" },
328         { CPIM_PIDF_XML,   "presence", "application/cpim-pidf+xml",   "cpim-pidf+xml" },  /* RFC 3863 */
329         { PIDF_XML,        "presence", "application/pidf+xml",        "pidf+xml" },       /* RFC 3863 */
330         { XPIDF_XML,       "presence", "application/xpidf+xml",       "xpidf+xml" },       /* Pre-RFC 3863 with MS additions */
331         { MWI_NOTIFICATION,     "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
332 };
333
334
335 /*! \brief Authentication types - proxy or www authentication 
336         \note Endpoints, like Asterisk, should always use WWW authentication to
337         allow multiple authentications in the same call - to the proxy and
338         to the end point.
339 */
340 enum sip_auth_type {
341         PROXY_AUTH = 407,
342         WWW_AUTH = 401,
343 };
344
345 /*! \brief Authentication result from check_auth* functions */
346 enum check_auth_result {
347         AUTH_DONT_KNOW = -100,  /*!< no result, need to check further */
348                 /* XXX maybe this is the same as AUTH_NOT_FOUND */
349
350         AUTH_SUCCESSFUL = 0,
351         AUTH_CHALLENGE_SENT = 1,
352         AUTH_SECRET_FAILED = -1,
353         AUTH_USERNAME_MISMATCH = -2,
354         AUTH_NOT_FOUND = -3,    /*!< returned by register_verify */
355         AUTH_FAKE_AUTH = -4,
356         AUTH_UNKNOWN_DOMAIN = -5,
357         AUTH_PEER_NOT_DYNAMIC = -6,
358         AUTH_ACL_FAILED = -7,
359 };
360
361 /*! \brief States for outbound registrations (with register= lines in sip.conf */
362 enum sipregistrystate {
363         REG_STATE_UNREGISTERED = 0,     /*!< We are not registred 
364                  *  \note Initial state. We should have a timeout scheduled for the initial
365                  * (or next) registration transmission, calling sip_reregister
366                  */
367
368         REG_STATE_REGSENT,      /*!< Registration request sent 
369                  * \note sent initial request, waiting for an ack or a timeout to
370                  * retransmit the initial request.
371                 */
372
373         REG_STATE_AUTHSENT,     /*!< We have tried to authenticate 
374                  * \note entered after transmit_register with auth info,
375                  * waiting for an ack.
376                  */
377
378         REG_STATE_REGISTERED,   /*!< Registered and done */
379
380         REG_STATE_REJECTED,     /*!< Registration rejected *
381                  * \note only used when the remote party has an expire larger than
382                  * our max-expire. This is a final state from which we do not
383                  * recover (not sure how correctly).
384                  */
385
386         REG_STATE_TIMEOUT,      /*!< Registration timed out *
387                 * \note XXX unused */
388
389         REG_STATE_NOAUTH,       /*!< We have no accepted credentials
390                  * \note fatal - no chance to proceed */
391
392         REG_STATE_FAILED,       /*!< Registration failed after several tries
393                  * \note fatal - no chance to proceed */
394 };
395
396 /*! \brief Modes in which Asterisk can be configured to run SIP Session-Timers */
397 enum st_mode {
398         SESSION_TIMER_MODE_INVALID = 0, /*!< Invalid value */ 
399         SESSION_TIMER_MODE_ACCEPT,      /*!< Honor inbound Session-Timer requests */
400         SESSION_TIMER_MODE_ORIGINATE,   /*!< Originate outbound and honor inbound requests */
401         SESSION_TIMER_MODE_REFUSE       /*!< Ignore inbound Session-Timers requests */
402 };
403
404 /*! \brief The entity playing the refresher role for Session-Timers */
405 enum st_refresher {
406         SESSION_TIMER_REFRESHER_AUTO,    /*!< Negotiated                      */
407         SESSION_TIMER_REFRESHER_UAC,     /*!< Session is refreshed by the UAC */
408         SESSION_TIMER_REFRESHER_UAS      /*!< Session is refreshed by the UAS */
409 };
410
411
412 /*! \brief definition of a sip proxy server
413  *
414  * For outbound proxies, this is allocated in the SIP peer dynamically or
415  * statically as the global_outboundproxy. The pointer in a SIP message is just
416  * a pointer and should *not* be de-allocated.
417  */
418 struct sip_proxy {
419         char name[MAXHOSTNAMELEN];      /*!< DNS name of domain/host or IP */
420         struct sockaddr_in ip;          /*!< Currently used IP address and port */
421         time_t last_dnsupdate;          /*!< When this was resolved */
422         int force;                      /*!< If it's an outbound proxy, Force use of this outbound proxy for all outbound requests */
423         /* Room for a SRV record chain based on the name */
424 };
425
426 /*! \brief States whether a SIP message can create a dialog in Asterisk. */
427 enum can_create_dialog {
428         CAN_NOT_CREATE_DIALOG,
429         CAN_CREATE_DIALOG,
430         CAN_CREATE_DIALOG_UNSUPPORTED_METHOD,
431 };
432
433 /*! \brief SIP Request methods known by Asterisk 
434
435    \note Do _NOT_ make any changes to this enum, or the array following it;
436    if you think you are doing the right thing, you are probably
437    not doing the right thing. If you think there are changes
438    needed, get someone else to review them first _before_
439    submitting a patch. If these two lists do not match properly
440    bad things will happen.
441 */
442
443 enum sipmethod {
444         SIP_UNKNOWN,            /*!< Unknown response */
445         SIP_RESPONSE,           /*!< Not request, response to outbound request */
446         SIP_REGISTER,           /*!< Registration to the mothership, tell us where you are located */
447         SIP_OPTIONS,            /*!< Check capabilities of a device, used for "ping" too */
448         SIP_NOTIFY,             /*!< Status update, Part of the event package standard, result of a SUBSCRIBE or a REFER */
449         SIP_INVITE,             /*!< Set up a session */
450         SIP_ACK,                /*!< End of a three-way handshake started with INVITE. */
451         SIP_PRACK,              /*!< Reliable pre-call signalling. Not supported in Asterisk. */
452         SIP_BYE,                /*!< End of a session */
453         SIP_REFER,              /*!< Refer to another URI (transfer) */
454         SIP_SUBSCRIBE,          /*!< Subscribe for updates (voicemail, session status, device status, presence) */
455         SIP_MESSAGE,            /*!< Text messaging */
456         SIP_UPDATE,             /*!< Update a dialog. We can send UPDATE; but not accept it */
457         SIP_INFO,               /*!< Information updates during a session */
458         SIP_CANCEL,             /*!< Cancel an INVITE */
459         SIP_PUBLISH,            /*!< Not supported in Asterisk */
460         SIP_PING,               /*!< Not supported at all, no standard but still implemented out there */
461 };
462
463 /*! \brief The core structure to setup dialogs. We parse incoming messages by using
464         structure and then route the messages according to the type.
465
466       \note Note that sip_methods[i].id == i must hold or the code breaks */
467 static const struct  cfsip_methods { 
468         enum sipmethod id;
469         int need_rtp;           /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
470         char * const text;
471         enum can_create_dialog can_create;
472 } sip_methods[] = {
473         { SIP_UNKNOWN,   RTP,    "-UNKNOWN-",   CAN_CREATE_DIALOG },
474         { SIP_RESPONSE,  NO_RTP, "SIP/2.0",     CAN_NOT_CREATE_DIALOG },
475         { SIP_REGISTER,  NO_RTP, "REGISTER",    CAN_CREATE_DIALOG },
476         { SIP_OPTIONS,   NO_RTP, "OPTIONS",     CAN_CREATE_DIALOG },
477         { SIP_NOTIFY,    NO_RTP, "NOTIFY",      CAN_CREATE_DIALOG },
478         { SIP_INVITE,    RTP,    "INVITE",      CAN_CREATE_DIALOG },
479         { SIP_ACK,       NO_RTP, "ACK",         CAN_NOT_CREATE_DIALOG },
480         { SIP_PRACK,     NO_RTP, "PRACK",       CAN_NOT_CREATE_DIALOG },
481         { SIP_BYE,       NO_RTP, "BYE",         CAN_NOT_CREATE_DIALOG },
482         { SIP_REFER,     NO_RTP, "REFER",       CAN_CREATE_DIALOG },
483         { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE",   CAN_CREATE_DIALOG },
484         { SIP_MESSAGE,   NO_RTP, "MESSAGE",     CAN_CREATE_DIALOG },
485         { SIP_UPDATE,    NO_RTP, "UPDATE",      CAN_NOT_CREATE_DIALOG },
486         { SIP_INFO,      NO_RTP, "INFO",        CAN_NOT_CREATE_DIALOG },
487         { SIP_CANCEL,    NO_RTP, "CANCEL",      CAN_NOT_CREATE_DIALOG },
488         { SIP_PUBLISH,   NO_RTP, "PUBLISH",     CAN_CREATE_DIALOG_UNSUPPORTED_METHOD },
489         { SIP_PING,      NO_RTP, "PING",        CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
490 };
491
492 /*!  Define SIP option tags, used in Require: and Supported: headers 
493         We need to be aware of these properties in the phones to use 
494         the replace: header. We should not do that without knowing
495         that the other end supports it... 
496         This is nothing we can configure, we learn by the dialog
497         Supported: header on the REGISTER (peer) or the INVITE
498         (other devices)
499         We are not using many of these today, but will in the future.
500         This is documented in RFC 3261
501 */
502 #define SUPPORTED               1
503 #define NOT_SUPPORTED           0
504
505 /* SIP options */
506 #define SIP_OPT_REPLACES        (1 << 0)
507 #define SIP_OPT_100REL          (1 << 1)
508 #define SIP_OPT_TIMER           (1 << 2)
509 #define SIP_OPT_EARLY_SESSION   (1 << 3)
510 #define SIP_OPT_JOIN            (1 << 4)
511 #define SIP_OPT_PATH            (1 << 5)
512 #define SIP_OPT_PREF            (1 << 6)
513 #define SIP_OPT_PRECONDITION    (1 << 7)
514 #define SIP_OPT_PRIVACY         (1 << 8)
515 #define SIP_OPT_SDP_ANAT        (1 << 9)
516 #define SIP_OPT_SEC_AGREE       (1 << 10)
517 #define SIP_OPT_EVENTLIST       (1 << 11)
518 #define SIP_OPT_GRUU            (1 << 12)
519 #define SIP_OPT_TARGET_DIALOG   (1 << 13)
520 #define SIP_OPT_NOREFERSUB      (1 << 14)
521 #define SIP_OPT_HISTINFO        (1 << 15)
522 #define SIP_OPT_RESPRIORITY     (1 << 16)
523 #define SIP_OPT_UNKNOWN         (1 << 17)
524
525
526 /*! \brief List of well-known SIP options. If we get this in a require,
527    we should check the list and answer accordingly. */
528 static const struct cfsip_options {
529         int id;                 /*!< Bitmap ID */
530         int supported;          /*!< Supported by Asterisk ? */
531         char * const text;      /*!< Text id, as in standard */
532 } sip_options[] = {     /* XXX used in 3 places */
533         /* RFC3891: Replaces: header for transfer */
534         { SIP_OPT_REPLACES,     SUPPORTED,      "replaces" },   
535         /* One version of Polycom firmware has the wrong label */
536         { SIP_OPT_REPLACES,     SUPPORTED,      "replace" },    
537         /* RFC3262: PRACK 100% reliability */
538         { SIP_OPT_100REL,       NOT_SUPPORTED,  "100rel" },     
539         /* RFC4028: SIP Session-Timers */
540         { SIP_OPT_TIMER,        SUPPORTED,      "timer" },
541         /* RFC3959: SIP Early session support */
542         { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
543         /* RFC3911: SIP Join header support */
544         { SIP_OPT_JOIN,         NOT_SUPPORTED,  "join" },
545         /* RFC3327: Path support */
546         { SIP_OPT_PATH,         NOT_SUPPORTED,  "path" },
547         /* RFC3840: Callee preferences */
548         { SIP_OPT_PREF,         NOT_SUPPORTED,  "pref" },
549         /* RFC3312: Precondition support */
550         { SIP_OPT_PRECONDITION, NOT_SUPPORTED,  "precondition" },
551         /* RFC3323: Privacy with proxies*/
552         { SIP_OPT_PRIVACY,      NOT_SUPPORTED,  "privacy" },
553         /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
554         { SIP_OPT_SDP_ANAT,     NOT_SUPPORTED,  "sdp-anat" },
555         /* RFC3329: Security agreement mechanism */
556         { SIP_OPT_SEC_AGREE,    NOT_SUPPORTED,  "sec_agree" },
557         /* SIMPLE events:  RFC4662 */
558         { SIP_OPT_EVENTLIST,    NOT_SUPPORTED,  "eventlist" },
559         /* GRUU: Globally Routable User Agent URI's */
560         { SIP_OPT_GRUU,         NOT_SUPPORTED,  "gruu" },
561         /* RFC4538: Target-dialog */
562         { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED,  "tdialog" },
563         /* Disable the REFER subscription, RFC 4488 */
564         { SIP_OPT_NOREFERSUB,   NOT_SUPPORTED,  "norefersub" },
565         /* ietf-sip-history-info-06.txt */
566         { SIP_OPT_HISTINFO,     NOT_SUPPORTED,  "histinfo" },
567         /* ietf-sip-resource-priority-10.txt */
568         { SIP_OPT_RESPRIORITY,  NOT_SUPPORTED,  "resource-priority" },
569 };
570
571
572 /*! \brief SIP Methods we support 
573         \todo This string should be set dynamically. We only support REFER and SUBSCRIBE is we have
574         allowsubscribe and allowrefer on in sip.conf.
575 */
576 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY"
577
578 /*! \brief SIP Extensions we support */
579 #define SUPPORTED_EXTENSIONS "replaces, timer" 
580
581 /*! \brief Standard SIP and TLS port from RFC 3261. DO NOT CHANGE THIS */
582 #define STANDARD_SIP_PORT       5060
583 #define STANDARD_TLS_PORT       5061
584 /*! \note in many SIP headers, absence of a port number implies port 5060,
585  * and this is why we cannot change the above constant.
586  * There is a limited number of places in asterisk where we could,
587  * in principle, use a different "default" port number, but
588  * we do not support this feature at the moment.
589  * You can run Asterisk with SIP on a different port with a configuration
590  * option. If you change this value, the signalling will be incorrect.
591  */
592
593 /*! \name DefaultValues Default values, set and reset in reload_config before reading configuration 
594
595    These are default values in the source. There are other recommended values in the
596    sip.conf.sample for new installations. These may differ to keep backwards compatibility,
597    yet encouraging new behaviour on new installations 
598  */
599 /*@{*/ 
600 #define DEFAULT_CONTEXT         "default"
601 #define DEFAULT_MOHINTERPRET    "default"
602 #define DEFAULT_MOHSUGGEST      ""
603 #define DEFAULT_VMEXTEN         "asterisk"
604 #define DEFAULT_CALLERID        "asterisk"
605 #define DEFAULT_NOTIFYMIME      "application/simple-message-summary"
606 #define DEFAULT_ALLOWGUEST      TRUE
607 #define DEFAULT_CALLCOUNTER     FALSE
608 #define DEFAULT_SRVLOOKUP       TRUE            /*!< Recommended setting is ON */
609 #define DEFAULT_COMPACTHEADERS  FALSE
610 #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. */
611 #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. */
612 #define DEFAULT_TOS_VIDEO       0               /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
613 #define DEFAULT_TOS_TEXT        0               /*!< Text packets should be marked as XXXX XXXX, but the default is 0 to be compatible with previous versions. */
614 #define DEFAULT_COS_SIP         4
615 #define DEFAULT_COS_AUDIO       5
616 #define DEFAULT_COS_VIDEO       6
617 #define DEFAULT_COS_TEXT        5
618 #define DEFAULT_ALLOW_EXT_DOM   TRUE
619 #define DEFAULT_REALM           "asterisk"
620 #define DEFAULT_NOTIFYRINGING   TRUE
621 #define DEFAULT_PEDANTIC        FALSE
622 #define DEFAULT_AUTOCREATEPEER  FALSE
623 #define DEFAULT_QUALIFY         FALSE
624 #define DEFAULT_REGEXTENONQUALIFY FALSE
625 #define DEFAULT_T1MIN           100             /*!< 100 MS for minimal roundtrip time */
626 #define DEFAULT_MAX_CALL_BITRATE (384)          /*!< Max bitrate for video */
627 #ifndef DEFAULT_USERAGENT
628 #define DEFAULT_USERAGENT "Asterisk PBX"        /*!< Default Useragent: header unless re-defined in sip.conf */
629 #define DEFAULT_SDPSESSION "Asterisk PBX"       /*!< Default SDP session name, (s=) header unless re-defined in sip.conf */
630 #define DEFAULT_SDPOWNER "root"         /*!< Default SDP username field in (o=) header unless re-defined in sip.conf */
631 #endif
632 /*@}*/ 
633
634 /*! \name DefaultSettings
635         Default setttings are used as a channel setting and as a default when
636         configuring devices 
637 */
638 /*@{*/ 
639 static char default_context[AST_MAX_CONTEXT];
640 static char default_subscribecontext[AST_MAX_CONTEXT];
641 static char default_language[MAX_LANGUAGE];
642 static char default_callerid[AST_MAX_EXTENSION];
643 static char default_fromdomain[AST_MAX_EXTENSION];
644 static char default_notifymime[AST_MAX_EXTENSION];
645 static int default_qualify;             /*!< Default Qualify= setting */
646 static char default_vmexten[AST_MAX_EXTENSION];
647 static char default_mohinterpret[MAX_MUSICCLASS];  /*!< Global setting for moh class to use when put on hold */
648 static char default_mohsuggest[MAX_MUSICCLASS];    /*!< Global setting for moh class to suggest when putting 
649                                                     *   a bridged channel on hold */
650 static int default_maxcallbitrate;      /*!< Maximum bitrate for call */
651 static struct ast_codec_pref default_prefs;             /*!< Default codec prefs */
652
653 /*! \brief a place to store all global settings for the sip channel driver */
654 struct sip_settings {
655         int peer_rtupdate;      /*!< G: Update database with registration data for peer? */
656         int rtsave_sysname;     /*!< G: Save system name at registration? */
657         int ignore_regexpire;   /*!< G: Ignore expiration of peer  */
658 };
659
660 static struct sip_settings sip_cfg;
661 /*@}*/ 
662
663 /*! \name GlobalSettings
664         Global settings apply to the channel (often settings you can change in the general section
665         of sip.conf
666 */
667 /*@{*/ 
668 static int global_directrtpsetup;       /*!< Enable support for Direct RTP setup (no re-invites) */
669 static int global_limitonpeers;         /*!< Match call limit on peers only */
670 static int global_rtautoclear;          /*!< Realtime ?? */
671 static int global_notifyringing;        /*!< Send notifications on ringing */
672 static int global_notifyhold;           /*!< Send notifications on hold */
673 static int global_alwaysauthreject;     /*!< Send 401 Unauthorized for all failing requests */
674 static int global_srvlookup;            /*!< SRV Lookup on or off. Default is on */
675 static int pedanticsipchecking;         /*!< Extra checking ?  Default off */
676 static int autocreatepeer;              /*!< Auto creation of peers at registration? Default off. */
677 static int global_match_auth_username;          /*!< Match auth username if available instead of From: Default off. */
678 static int global_relaxdtmf;            /*!< Relax DTMF */
679 static int global_rtptimeout;           /*!< Time out call if no RTP */
680 static int global_rtpholdtimeout;       /*!< Time out call if no RTP during hold */
681 static int global_rtpkeepalive;         /*!< Send RTP keepalives */
682 static int global_reg_timeout;  
683 static int global_regattempts_max;      /*!< Registration attempts before giving up */
684 static int global_allowguest;           /*!< allow unauthenticated users/peers to connect? */
685 static int global_callcounter;          /*!< Enable call counters for all devices. This is currently enabled by setting the peer
686                                                 call-limit to 999. When we remove the call-limit from the code, we can make it
687                                                 with just a boolean flag in the device structure */
688 static int global_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 static unsigned int global_tos_sip;             /*!< IP type of service for SIP packets */
691 static unsigned int global_tos_audio;           /*!< IP type of service for audio RTP packets */
692 static unsigned int global_tos_video;           /*!< IP type of service for video RTP packets */
693 static unsigned int global_tos_text;            /*!< IP type of service for text RTP packets */
694 static unsigned int global_cos_sip;             /*!< 802.1p class of service for SIP packets */
695 static unsigned int global_cos_audio;           /*!< 802.1p class of service for audio RTP packets */
696 static unsigned int global_cos_video;           /*!< 802.1p class of service for video RTP packets */
697 static unsigned int global_cos_text;            /*!< 802.1p class of service for text RTP packets */
698 static int compactheaders;              /*!< send compact sip headers */
699 static int recordhistory;               /*!< Record SIP history. Off by default */
700 static int dumphistory;                 /*!< Dump history to verbose before destroying SIP dialog */
701 static char global_realm[MAXHOSTNAMELEN];               /*!< Default realm */
702 static char global_regcontext[AST_MAX_CONTEXT];         /*!< Context for auto-extensions */
703 static char global_useragent[AST_MAX_EXTENSION];        /*!< Useragent for the SIP channel */
704 static char global_sdpsession[AST_MAX_EXTENSION];       /*!< SDP session name for the SIP channel */
705 static char global_sdpowner[AST_MAX_EXTENSION]; /*!< SDP owner name for the SIP channel */
706 static int allow_external_domains;      /*!< Accept calls to external SIP domains? */
707 static int global_callevents;           /*!< Whether we send manager events or not */
708 static int global_t1;                   /*!< T1 time */
709 static int global_t1min;                /*!< T1 roundtrip time minimum */
710 static int global_timer_b;    /*!< Timer B - RFC 3261 Section 17.1.1.2 */
711 static int global_regextenonqualify;  /*!< Whether to add/remove regexten when qualifying peers */
712 static int global_autoframing;          /*!< Turn autoframing on or off. */
713 static enum transfermodes global_allowtransfer; /*!< SIP Refer restriction scheme */
714 static struct sip_proxy global_outboundproxy;   /*!< Outbound proxy */
715 static int global_matchexterniplocally; /*!< Match externip/externhost setting against localnet setting */
716 static int global_qualifyfreq; /*!< Qualify frequency */
717
718
719 /*! \brief Codecs that we support by default: */
720 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
721 static enum st_mode global_st_mode;           /*!< Mode of operation for Session-Timers           */
722 static enum st_refresher global_st_refresher; /*!< Session-Timer refresher                        */
723 static int global_min_se;                     /*!< Lowest threshold for session refresh interval  */
724 static int global_max_se;                     /*!< Highest threshold for session refresh interval */
725
726 /*@}*/ 
727
728 /*! \name Object counters @{
729  * \bug These counters are not handled in a thread-safe way ast_atomic_fetchadd_int()
730  * should be used to modify these values. */
731 static int suserobjs = 0;                /*!< Static users */
732 static int ruserobjs = 0;                /*!< Realtime users */
733 static int speerobjs = 0;                /*!< Static peers */
734 static int rpeerobjs = 0;                /*!< Realtime peers */
735 static int apeerobjs = 0;                /*!< Autocreated peer objects */
736 static int regobjs = 0;                  /*!< Registry objects */
737 /* }@ */
738
739 static struct ast_flags global_flags[2] = {{0}};        /*!< global SIP_ flags */
740 static char used_context[AST_MAX_CONTEXT]; /*!< name of automatically created context for unloading */
741
742
743 AST_MUTEX_DEFINE_STATIC(netlock);
744
745 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
746    when it's doing something critical. */
747
748 AST_MUTEX_DEFINE_STATIC(monlock);
749
750 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
751
752 /*! \brief This is the thread for the monitor which checks for input on the channels
753    which are not currently in use.  */
754 static pthread_t monitor_thread = AST_PTHREADT_NULL;
755
756 static int sip_reloading = FALSE;                       /*!< Flag for avoiding multiple reloads at the same time */
757 static enum channelreloadreason sip_reloadreason;       /*!< Reason for last reload/load of configuration */
758
759 static struct sched_context *sched;     /*!< The scheduling context */
760 static struct io_context *io;           /*!< The IO context */
761 static int *sipsock_read_id;            /*!< ID of IO entry for sipsock FD */
762
763 #define DEC_CALL_LIMIT  0
764 #define INC_CALL_LIMIT  1
765 #define DEC_CALL_RINGING 2
766 #define INC_CALL_RINGING 3
767
768 /*!< Define some SIP transports */
769 enum sip_transport {
770         SIP_TRANSPORT_UDP = 1,
771         SIP_TRANSPORT_TCP = 1 << 1,
772         SIP_TRANSPORT_TLS = 1 << 2,
773 };
774
775 /*!< The SIP socket definition */
776 struct sip_socket {
777         ast_mutex_t *lock;
778         enum sip_transport type;
779         int fd;
780         uint16_t port;
781         struct ast_tcptls_session_instance *ser;
782 };
783
784 /*! \brief sip_request: The data grabbed from the UDP socket
785  *
786  * \verbatim
787  * Incoming messages: we first store the data from the socket in data[],
788  * adding a trailing \0 to make string parsing routines happy.
789  * Then call parse_request() and req.method = find_sip_method();
790  * to initialize the other fields. The \r\n at the end of each line is   
791  * replaced by \0, so that data[] is not a conforming SIP message anymore.
792  * After this processing, rlPart1 is set to non-NULL to remember
793  * that we can run get_header() on this kind of packet.
794  *
795  * parse_request() splits the first line as follows:
796  * Requests have in the first line      method uri SIP/2.0
797  *      rlPart1 = method; rlPart2 = uri;
798  * Responses have in the first line     SIP/2.0 NNN description
799  *      rlPart1 = SIP/2.0; rlPart2 = NNN + description;
800  *
801  * For outgoing packets, we initialize the fields with init_req() or init_resp()
802  * (which fills the first line to "METHOD uri SIP/2.0" or "SIP/2.0 code text"),
803  * and then fill the rest with add_header() and add_line().
804  * The \r\n at the end of the line are still there, so the get_header()
805  * and similar functions don't work on these packets. 
806  * \endverbatim
807  */
808 struct sip_request {
809         char *rlPart1;          /*!< SIP Method Name or "SIP/2.0" protocol version */
810         char *rlPart2;          /*!< The Request URI or Response Status */
811         int len;                /*!< bytes used in data[], excluding trailing null terminator. Rarely used. */
812         int headers;            /*!< # of SIP Headers */
813         int method;             /*!< Method of this request */
814         int lines;              /*!< Body Content */
815         unsigned int sdp_start; /*!< the line number where the SDP begins */
816         unsigned int sdp_end;   /*!< the line number where the SDP ends */
817         char debug;             /*!< print extra debugging if non zero */
818         char has_to_tag;        /*!< non-zero if packet has To: tag */
819         char ignore;            /*!< if non-zero This is a re-transmit, ignore it */
820         char *header[SIP_MAX_HEADERS];
821         char *line[SIP_MAX_LINES];
822         struct ast_str *data;   
823         struct sip_socket socket;       /*!< The socket used for this request */
824 };
825
826 /*! \brief structure used in transfers */
827 struct sip_dual {
828         struct ast_channel *chan1;      /*!< First channel involved */
829         struct ast_channel *chan2;      /*!< Second channel involved */
830         struct sip_request req;         /*!< Request that caused the transfer (REFER) */
831         int seqno;                      /*!< Sequence number */
832 };
833
834 struct sip_pkt;
835
836 /*! \brief Parameters to the transmit_invite function */
837 struct sip_invite_param {
838         int addsipheaders;              /*!< Add extra SIP headers */
839         const char *uri_options;        /*!< URI options to add to the URI */
840         const char *vxml_url;           /*!< VXML url for Cisco phones */
841         char *auth;                     /*!< Authentication */
842         char *authheader;               /*!< Auth header */
843         enum sip_auth_type auth_type;   /*!< Authentication type */
844         const char *replaces;           /*!< Replaces header for call transfers */
845         int transfer;                   /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
846 };
847
848 /*! \brief Structure to save routing information for a SIP session */
849 struct sip_route {
850         struct sip_route *next;
851         char hop[0];
852 };
853
854 /*! \brief Modes for SIP domain handling in the PBX */
855 enum domain_mode {
856         SIP_DOMAIN_AUTO,                /*!< This domain is auto-configured */
857         SIP_DOMAIN_CONFIG,              /*!< This domain is from configuration */
858 };
859
860 /*! \brief Domain data structure. 
861         \note In the future, we will connect this to a configuration tree specific
862         for this domain
863 */
864 struct domain {
865         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
866         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
867         enum domain_mode mode;                  /*!< How did we find this domain? */
868         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
869 };
870
871 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
872
873
874 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
875 struct sip_history {
876         AST_LIST_ENTRY(sip_history) list;
877         char event[0];  /* actually more, depending on needs */
878 };
879
880 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
881
882 /*! \brief sip_auth: Credentials for authentication to other SIP services */
883 struct sip_auth {
884         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
885         char username[256];             /*!< Username */
886         char secret[256];               /*!< Secret */
887         char md5secret[256];            /*!< MD5Secret */
888         struct sip_auth *next;          /*!< Next auth structure in list */
889 };
890
891 /*! \name SIPflags
892         Various flags for the flags field in the pvt structure 
893         Trying to sort these up (one or more of the following):
894         D: Dialog
895         P: Peer/user
896         G: Global flag
897         When flags are used by multiple structures, it is important that
898         they have a common layout so it is easy to copy them.
899 */
900 /*@{*/ 
901 #define SIP_OUTGOING            (1 << 0)        /*!< D: Direction of the last transaction in this dialog */
902 #define SIP_RINGING             (1 << 2)        /*!< D: Have sent 180 ringing */
903 #define SIP_PROGRESS_SENT       (1 << 3)        /*!< D: Have sent 183 message progress */
904 #define SIP_NEEDREINVITE        (1 << 4)        /*!< D: Do we need to send another reinvite? */
905 #define SIP_PENDINGBYE          (1 << 5)        /*!< D: Need to send bye after we ack? */
906 #define SIP_GOTREFER            (1 << 6)        /*!< D: Got a refer? */
907 #define SIP_CALL_LIMIT          (1 << 7)        /*!< D: Call limit enforced for this call */
908 #define SIP_INC_COUNT           (1 << 8)        /*!< D: Did this dialog increment the counter of in-use calls? */
909 #define SIP_INC_RINGING         (1 << 9)        /*!< D: Did this connection increment the counter of in-use calls? */
910 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 10)       /*!< D: Do not hangup at first ast_hangup */
911
912 #define SIP_PROMISCREDIR        (1 << 11)       /*!< DP: Promiscuous redirection */
913 #define SIP_TRUSTRPID           (1 << 12)       /*!< DP: Trust RPID headers? */
914 #define SIP_USEREQPHONE         (1 << 13)       /*!< DP: Add user=phone to numeric URI. Default off */
915 #define SIP_USECLIENTCODE       (1 << 14)       /*!< DP: Trust X-ClientCode info message */
916
917 /* DTMF flags - see str2dtmfmode() and dtmfmode2str() */
918 #define SIP_DTMF                (7 << 15)       /*!< DP: DTMF Support: five settings, uses three bits */
919 #define SIP_DTMF_RFC2833        (0 << 15)       /*!< DP: DTMF Support: RTP DTMF - "rfc2833" */
920 #define SIP_DTMF_INBAND         (1 << 15)       /*!< DP: DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
921 #define SIP_DTMF_INFO           (2 << 15)       /*!< DP: DTMF Support: SIP Info messages - "info" */
922 #define SIP_DTMF_AUTO           (3 << 15)       /*!< DP: DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
923 #define SIP_DTMF_SHORTINFO      (4 << 15)       /*!< DP: DTMF Support: SIP Info messages - "info" - short variant */
924
925 /* NAT settings - see nat2str() */
926 #define SIP_NAT                 (3 << 18)       /*!< DP: four settings, uses two bits */
927 #define SIP_NAT_NEVER           (0 << 18)       /*!< DP: No nat support */
928 #define SIP_NAT_RFC3581         (1 << 18)       /*!< DP: NAT RFC3581 */
929 #define SIP_NAT_ROUTE           (2 << 18)       /*!< DP: NAT Only ROUTE */
930 #define SIP_NAT_ALWAYS          (3 << 18)       /*!< DP: NAT Both ROUTE and RFC3581 */
931
932 /* re-INVITE related settings */
933 #define SIP_REINVITE            (7 << 20)       /*!< DP: four settings, uses three bits */
934 #define SIP_REINVITE_NONE       (0 << 20)       /*!< DP: no reinvite allowed */
935 #define SIP_CAN_REINVITE        (1 << 20)       /*!< DP: allow peers to be reinvited to send media directly p2p */
936 #define SIP_CAN_REINVITE_NAT    (2 << 20)       /*!< DP: allow media reinvite when new peer is behind NAT */
937 #define SIP_REINVITE_UPDATE     (4 << 20)       /*!< DP: use UPDATE (RFC3311) when reinviting this peer */
938
939 /* "insecure" settings - see insecure2str() */
940 #define SIP_INSECURE            (3 << 23)       /*!< DP: three settings, uses two bits */
941 #define SIP_INSECURE_NONE       (0 << 23)       /*!< DP: secure mode */
942 #define SIP_INSECURE_PORT       (1 << 23)       /*!< DP: don't require matching port for incoming requests */
943 #define SIP_INSECURE_INVITE     (1 << 24)       /*!< DP: don't require authentication for incoming INVITEs */
944
945 /* Sending PROGRESS in-band settings */
946 #define SIP_PROG_INBAND         (3 << 25)       /*!< DP: three settings, uses two bits */
947 #define SIP_PROG_INBAND_NEVER   (0 << 25)
948 #define SIP_PROG_INBAND_NO      (1 << 25)
949 #define SIP_PROG_INBAND_YES     (2 << 25)
950
951 #define SIP_SENDRPID            (1 << 29)       /*!< DP: Remote Party-ID Support */
952 #define SIP_G726_NONSTANDARD    (1 << 31)       /*!< DP: Use non-standard packing for G726-32 data */
953
954 /*! \brief Flags to copy from peer/user to dialog */
955 #define SIP_FLAGS_TO_COPY \
956         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
957          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT | SIP_G726_NONSTANDARD | \
958          SIP_USEREQPHONE | SIP_INSECURE)
959 /*@}*/ 
960
961 /*! \name SIPflags2
962         a second page of flags (for flags[1] */
963 /*@{*/ 
964 /* realtime flags */
965 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)        /*!< GP: Should we keep RT objects in memory for extended time? */
966 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)        /*!< GP: Should we clean memory from peers after expiry? */
967 /* Space for addition of other realtime flags in the future */
968 #define SIP_PAGE2_STATECHANGEQUEUE      (1 << 9)        /*!< D: Unsent state pending change exists */
969
970 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 14)       /*!< DP: Video supported if offered? */
971 #define SIP_PAGE2_TEXTSUPPORT           (1 << 15)       /*!< GDP: Global text enable */
972 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< GP: Allow subscriptions from this peer? */
973 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< DP: Allow overlap dialing ? */
974 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< GP: Only issue MWI notification if subscribed to */
975
976 #define SIP_PAGE2_T38SUPPORT            (7 << 20)       /*!< GDP: T38 Fax Passthrough Support */
977 #define SIP_PAGE2_T38SUPPORT_UDPTL      (1 << 20)       /*!< GDP: T38 Fax Passthrough Support */
978 #define SIP_PAGE2_T38SUPPORT_RTP        (2 << 20)       /*!< GDP: T38 Fax Passthrough Support (not implemented) */
979 #define SIP_PAGE2_T38SUPPORT_TCP        (4 << 20)       /*!< GDP: T38 Fax Passthrough Support (not implemented) */
980
981 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< D: Call hold states: */
982 #define SIP_PAGE2_CALL_ONHOLD_ACTIVE    (1 << 23)       /*!< D: Active hold */
983 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (2 << 23)       /*!< D: One directional hold */
984 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (3 << 23)       /*!< D: Inactive hold */
985
986 #define SIP_PAGE2_RFC2833_COMPENSATE    (1 << 25)       /*!< DP: Compensate for buggy RFC2833 implementations */
987 #define SIP_PAGE2_BUGGY_MWI             (1 << 26)       /*!< DP: Buggy CISCO MWI fix */
988 #define SIP_PAGE2_REGISTERTRYING        (1 << 29)       /*!< DP: Send 100 Trying on REGISTER attempts */
989
990 #define SIP_PAGE2_FLAGS_TO_COPY \
991         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_VIDEOSUPPORT | \
992         SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE | SIP_PAGE2_BUGGY_MWI | \
993         SIP_PAGE2_TEXTSUPPORT )
994
995 /*@}*/ 
996
997 /*! \name SIPflagsT38
998         T.38 set of flags */
999
1000 /*@{*/ 
1001 #define T38FAX_FILL_BIT_REMOVAL                 (1 << 0)        /*!< Default: 0 (unset)*/
1002 #define T38FAX_TRANSCODING_MMR                  (1 << 1)        /*!< Default: 0 (unset)*/
1003 #define T38FAX_TRANSCODING_JBIG                 (1 << 2)        /*!< Default: 0 (unset)*/
1004 /* Rate management */
1005 #define T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF   (0 << 3)
1006 #define T38FAX_RATE_MANAGEMENT_LOCAL_TCF        (1 << 3)        /*!< Unset for transferredTCF (UDPTL), set for localTCF (TPKT) */
1007 /* UDP Error correction */
1008 #define T38FAX_UDP_EC_NONE                      (0 << 4)        /*!< two bits, if unset NO t38UDPEC field in T38 SDP*/
1009 #define T38FAX_UDP_EC_FEC                       (1 << 4)        /*!< Set for t38UDPFEC */
1010 #define T38FAX_UDP_EC_REDUNDANCY                (2 << 4)        /*!< Set for t38UDPRedundancy */
1011 /* T38 Spec version */
1012 #define T38FAX_VERSION                          (3 << 6)        /*!< two bits, 2 values so far, up to 4 values max */
1013 #define T38FAX_VERSION_0                        (0 << 6)        /*!< Version 0 */
1014 #define T38FAX_VERSION_1                        (1 << 6)        /*!< Version 1 */
1015 /* Maximum Fax Rate */
1016 #define T38FAX_RATE_2400                        (1 << 8)        /*!< 2400 bps t38FaxRate */
1017 #define T38FAX_RATE_4800                        (1 << 9)        /*!< 4800 bps t38FaxRate */
1018 #define T38FAX_RATE_7200                        (1 << 10)       /*!< 7200 bps t38FaxRate */
1019 #define T38FAX_RATE_9600                        (1 << 11)       /*!< 9600 bps t38FaxRate */
1020 #define T38FAX_RATE_12000                       (1 << 12)       /*!< 12000 bps t38FaxRate */
1021 #define T38FAX_RATE_14400                       (1 << 13)       /*!< 14400 bps t38FaxRate */
1022
1023 /*!< This is default: NO MMR and JBIG transcoding, NO fill bit removal, transferredTCF TCF, UDP FEC, Version 0 and 9600 max fax rate */
1024 static int global_t38_capability = T38FAX_VERSION_0 | T38FAX_RATE_2400 | T38FAX_RATE_4800 | T38FAX_RATE_7200 | T38FAX_RATE_9600;
1025 /*@}*/ 
1026
1027 /*! \brief debugging state
1028  * We store separately the debugging requests from the config file
1029  * and requests from the CLI. Debugging is enabled if either is set
1030  * (which means that if sipdebug is set in the config file, we can
1031  * only turn it off by reloading the config).
1032  */
1033 enum sip_debug_e {
1034         sip_debug_none = 0,
1035         sip_debug_config = 1,
1036         sip_debug_console = 2,
1037 };
1038
1039 static enum sip_debug_e sipdebug;
1040
1041 /*! \brief extra debugging for 'text' related events.
1042  * At thie moment this is set together with sip_debug_console.
1043  * It should either go away or be implemented properly.
1044  */
1045 static int sipdebug_text;
1046
1047 /*! \brief T38 States for a call */
1048 enum t38state {
1049         T38_DISABLED = 0,                /*!< Not enabled */
1050         T38_LOCAL_DIRECT,                /*!< Offered from local */
1051         T38_LOCAL_REINVITE,              /*!< Offered from local - REINVITE */
1052         T38_PEER_DIRECT,                 /*!< Offered from peer */
1053         T38_PEER_REINVITE,               /*!< Offered from peer - REINVITE */
1054         T38_ENABLED                      /*!< Negotiated (enabled) */
1055 };
1056
1057 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
1058 struct t38properties {
1059         struct ast_flags t38support;    /*!< Flag for udptl, rtp or tcp support for this session */
1060         int capability;                 /*!< Our T38 capability */
1061         int peercapability;             /*!< Peers T38 capability */
1062         int jointcapability;            /*!< Supported T38 capability at both ends */
1063         enum t38state state;            /*!< T.38 state */
1064 };
1065
1066 /*! \brief Parameters to know status of transfer */
1067 enum referstatus {
1068         REFER_IDLE,                    /*!< No REFER is in progress */
1069         REFER_SENT,                    /*!< Sent REFER to transferee */
1070         REFER_RECEIVED,                /*!< Received REFER from transferrer */
1071         REFER_CONFIRMED,               /*!< Refer confirmed with a 100 TRYING (unused) */
1072         REFER_ACCEPTED,                /*!< Accepted by transferee */
1073         REFER_RINGING,                 /*!< Target Ringing */
1074         REFER_200OK,                   /*!< Answered by transfer target */
1075         REFER_FAILED,                  /*!< REFER declined - go on */
1076         REFER_NOAUTH                   /*!< We had no auth for REFER */
1077 };
1078
1079 /*! \brief generic struct to map between strings and integers.
1080  * Fill it with x-s pairs, terminate with an entry with s = NULL;
1081  * Then you can call map_x_s(...) to map an integer to a string,
1082  * and map_s_x() for the string -> integer mapping.
1083  */
1084 struct _map_x_s {
1085         int x;
1086         const char *s;
1087 };              
1088
1089 static const struct _map_x_s referstatusstrings[] = {
1090         { REFER_IDLE,           "<none>" },
1091         { REFER_SENT,           "Request sent" },
1092         { REFER_RECEIVED,       "Request received" },
1093         { REFER_CONFIRMED,      "Confirmed" },
1094         { REFER_ACCEPTED,       "Accepted" },
1095         { REFER_RINGING,        "Target ringing" },
1096         { REFER_200OK,          "Done" },
1097         { REFER_FAILED,         "Failed" },
1098         { REFER_NOAUTH,         "Failed - auth failure" },
1099         { -1,                   NULL} /* terminator */
1100 };
1101
1102 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed
1103         \note OEJ: Should be moved to string fields */
1104 struct sip_refer {
1105         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
1106         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
1107         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
1108         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
1109         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
1110         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
1111         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
1112         char replaces_callid[SIPBUFSIZE];                       /*!< Replace info: callid */
1113         char replaces_callid_totag[SIPBUFSIZE/2];               /*!< Replace info: to-tag */
1114         char replaces_callid_fromtag[SIPBUFSIZE/2];             /*!< Replace info: from-tag */
1115         struct sip_pvt *refer_call;                     /*!< Call we are referring. This is just a reference to a
1116                                                          * dialog owned by someone else, so we should not destroy
1117                                                          * it when the sip_refer object goes.
1118                                                          */
1119         int attendedtransfer;                           /*!< Attended or blind transfer? */
1120         int localtransfer;                              /*!< Transfer to local domain? */
1121         enum referstatus status;                        /*!< REFER status */
1122 };
1123
1124
1125 /*! \brief Structure that encapsulates all attributes related to running 
1126  *   SIP Session-Timers feature on a per dialog basis.
1127  */
1128 struct sip_st_dlg {
1129         int st_active;                          /*!< Session-Timers on/off */ 
1130         int st_interval;                        /*!< Session-Timers negotiated session refresh interval */
1131         int st_schedid;                         /*!< Session-Timers ast_sched scheduler id */
1132         enum st_refresher st_ref;               /*!< Session-Timers session refresher */
1133         int st_expirys;                         /*!< Session-Timers number of expirys */
1134         int st_active_peer_ua;                  /*!< Session-Timers on/off in peer UA */
1135         int st_cached_min_se;                   /*!< Session-Timers cached Min-SE */
1136         int st_cached_max_se;                   /*!< Session-Timers cached Session-Expires */
1137         enum st_mode st_cached_mode;            /*!< Session-Timers cached M.O. */
1138         enum st_refresher st_cached_ref;        /*!< Session-Timers cached refresher */
1139 };
1140
1141
1142 /*! \brief Structure that encapsulates all attributes related to configuration 
1143  *   of SIP Session-Timers feature on a per user/peer basis.
1144  */
1145 struct sip_st_cfg {
1146         enum st_mode st_mode_oper;      /*!< Mode of operation for Session-Timers           */
1147         enum st_refresher st_ref;       /*!< Session-Timer refresher                        */
1148         int st_min_se;                  /*!< Lowest threshold for session refresh interval  */
1149         int st_max_se;                  /*!< Highest threshold for session refresh interval */
1150 };
1151
1152
1153
1154
1155 /*! \brief sip_pvt: structures used for each SIP dialog, ie. a call, a registration, a subscribe.
1156  * Created and initialized by sip_alloc(), the descriptor goes into the list of
1157  * descriptors (dialoglist).
1158  */
1159 struct sip_pvt {
1160         struct sip_pvt *next;                   /*!< Next dialog in chain */
1161         ast_mutex_t pvt_lock;                   /*!< Dialog private lock */
1162         enum invitestates invitestate;          /*!< Track state of SIP_INVITEs */
1163         int method;                             /*!< SIP method that opened this dialog */
1164         AST_DECLARE_STRING_FIELDS(
1165                 AST_STRING_FIELD(callid);       /*!< Global CallID */
1166                 AST_STRING_FIELD(randdata);     /*!< Random data */
1167                 AST_STRING_FIELD(accountcode);  /*!< Account code */
1168                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1169                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1170                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1171                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1172                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1173                 AST_STRING_FIELD(from);         /*!< The From: header */
1174                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
1175                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
1176                 AST_STRING_FIELD(context);      /*!< Context for this call */
1177                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
1178                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
1179                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
1180                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
1181                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
1182                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
1183                 AST_STRING_FIELD(todnid);       /*!< DNID of this call (overrides host) */
1184                 AST_STRING_FIELD(language);     /*!< Default language for this call */
1185                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
1186                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
1187                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
1188                 AST_STRING_FIELD(redircause);   /*!< Referring cause */
1189                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
1190                 AST_STRING_FIELD(username);     /*!< [user] name */
1191                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
1192                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
1193                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
1194                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
1195                 AST_STRING_FIELD(peersecret);   /*!< Password */
1196                 AST_STRING_FIELD(peermd5secret);
1197                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
1198                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
1199                 AST_STRING_FIELD(via);          /*!< Via: header */
1200                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
1201                         /* we only store the part in <brackets> in this field. */
1202                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
1203                 AST_STRING_FIELD(rpid);         /*!< Our RPID header */
1204                 AST_STRING_FIELD(rpid_from);    /*!< Our RPID From header */
1205                 AST_STRING_FIELD(url);          /*!< URL to be sent with next message to peer */
1206         );
1207         struct sip_socket socket;               /*!< The socket used for this dialog */
1208         unsigned int ocseq;                     /*!< Current outgoing seqno */
1209         unsigned int icseq;                     /*!< Current incoming seqno */
1210         ast_group_t callgroup;                  /*!< Call group */
1211         ast_group_t pickupgroup;                /*!< Pickup group */
1212         int lastinvite;                         /*!< Last Cseq of invite */
1213         int lastnoninvite;                      /*!< Last Cseq of non-invite */
1214         struct ast_flags flags[2];              /*!< SIP_ flags */
1215
1216         /* boolean or small integers that don't belong in flags */
1217         char do_history;                        /*!< Set if we want to record history */
1218         char alreadygone;                       /*!< already destroyed by our peer */
1219         char needdestroy;                       /*!< need to be destroyed by the monitor thread */
1220         char outgoing_call;                     /*!< this is an outgoing call */
1221         char answered_elsewhere;                /*!< This call is cancelled due to answer on another channel */
1222         char novideo;                           /*!< Didn't get video in invite, don't offer */
1223         char notext;                            /*!< Text not supported  (?) */
1224
1225         int timer_t1;                           /*!< SIP timer T1, ms rtt */
1226         int timer_b;                            /*!< SIP timer B, ms */
1227         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
1228         unsigned int reqsipoptions;             /*!< Required SIP options on the other end */
1229         struct ast_codec_pref prefs;            /*!< codec prefs */
1230         int capability;                         /*!< Special capability (codec) */
1231         int jointcapability;                    /*!< Supported capability at both ends (codecs) */
1232         int peercapability;                     /*!< Supported peer capability */
1233         int prefcodec;                          /*!< Preferred codec (outbound only) */
1234         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
1235         int jointnoncodeccapability;            /*!< Joint Non codec capability */
1236         int redircodecs;                        /*!< Redirect codecs */
1237         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */    
1238         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this dialog */
1239         struct t38properties t38;               /*!< T38 settings */
1240         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
1241         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
1242         int callingpres;                        /*!< Calling presentation */
1243         int authtries;                          /*!< Times we've tried to authenticate */
1244         int expiry;                             /*!< How long we take to expire */
1245         long branch;                            /*!< The branch identifier of this session */
1246         char tag[11];                           /*!< Our tag for this session */
1247         int sessionid;                          /*!< SDP Session ID */
1248         int sessionversion;                     /*!< SDP Session Version */
1249         int sessionversion_remote;              /*!< Remote UA's SDP Session Version */
1250         int session_modify;                     /*!< Session modification request true/false  */
1251         struct sockaddr_in sa;                  /*!< Our peer */
1252         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
1253         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
1254         struct sockaddr_in tredirip;            /*!< Where our Text RTP should be going if not to us */
1255         time_t lastrtprx;                       /*!< Last RTP received */
1256         time_t lastrtptx;                       /*!< Last RTP sent */
1257         int rtptimeout;                         /*!< RTP timeout time */
1258         struct sockaddr_in recv;                /*!< Received as */
1259         struct sockaddr_in ourip;               /*!< Our IP (as seen from the outside) */
1260         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
1261         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
1262         int route_persistant;                   /*!< Is this the "real" route? */
1263         struct sip_auth *peerauth;              /*!< Realm authentication */
1264         int noncecount;                         /*!< Nonce-count */
1265         char lastmsg[256];                      /*!< Last Message sent/received */
1266         int amaflags;                           /*!< AMA Flags */
1267         int pendinginvite;                      /*!< Any pending INVITE or state NOTIFY (in subscribe pvt's) ? (seqno of this) */
1268         struct sip_request initreq;             /*!< Latest request that opened a new transaction
1269                                                         within this dialog.
1270                                                         NOT the request that opened the dialog
1271                                                 */
1272         
1273         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
1274         int waitid;                             /*!< Wait ID for scheduler after 491 or other delays */
1275         int autokillid;                         /*!< Auto-kill ID (scheduler) */
1276         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
1277         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
1278         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
1279         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
1280         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
1281         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
1282         
1283         struct ast_dsp *vad;                    /*!< Inband DTMF Detection dsp */
1284         
1285         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one 
1286                                                         Used in peerpoke, mwi subscriptions */
1287         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
1288         struct ast_rtp *rtp;                    /*!< RTP Session */
1289         struct ast_rtp *vrtp;                   /*!< Video RTP session */
1290         struct ast_rtp *trtp;                   /*!< Text RTP session */
1291         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
1292         struct sip_history_head *history;       /*!< History of this SIP dialog */
1293         size_t history_entries;                 /*!< Number of entires in the history */
1294         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
1295         struct sip_invite_param *options;       /*!< Options for INVITE */
1296         int autoframing;                        /*!< The number of Asters we group in a Pyroflax
1297                                                         before strolling to the Grokyzp√•
1298                                                         (A bit unsure of this, please correct if
1299                                                         you know more) */
1300         struct sip_st_dlg *stimer;              /*!< SIP Session-Timers */              
1301 };
1302
1303
1304 /*! Max entires in the history list for a sip_pvt */
1305 #define MAX_HISTORY_ENTRIES 50
1306
1307 /*!
1308  * Here we implement the container for dialogs (sip_pvt), defining
1309  * generic wrapper functions to ease the transition from the current
1310  * implementation (a single linked list) to a different container.
1311  * In addition to a reference to the container, we need functions to lock/unlock
1312  * the container and individual items, and functions to add/remove
1313  * references to the individual items.
1314  */
1315 static struct sip_pvt *dialoglist = NULL;
1316
1317 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
1318 AST_MUTEX_DEFINE_STATIC(dialoglock);
1319
1320 #ifndef DETECT_DEADLOCKS
1321 /*! \brief hide the way the list is locked/unlocked */
1322 static void dialoglist_lock(void)
1323 {
1324         ast_mutex_lock(&dialoglock);
1325 }
1326
1327 static void dialoglist_unlock(void)
1328 {
1329         ast_mutex_unlock(&dialoglock);
1330 }
1331 #else
1332 /* we don't want to HIDE the information about where the lock was requested if trying to debug 
1333  * deadlocks!  So, just make these macros! */
1334 #define dialoglist_lock(x) ast_mutex_lock(&dialoglock)
1335 #define dialoglist_unlock(x) ast_mutex_unlock(&dialoglock)
1336 #endif
1337
1338 /*!
1339  * when we create or delete references, make sure to use these
1340  * functions so we keep track of the refcounts.
1341  * To simplify the code, we allow a NULL to be passed to dialog_unref().
1342  */
1343 static struct sip_pvt *dialog_ref(struct sip_pvt *p)
1344 {
1345         return p;
1346 }
1347
1348 static struct sip_pvt *dialog_unref(struct sip_pvt *p)
1349 {
1350         return NULL;
1351 }
1352
1353 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission
1354  * Packets are linked in a list, whose head is in the struct sip_pvt they belong to.
1355  * Each packet holds a reference to the parent struct sip_pvt.
1356  * This structure is allocated in __sip_reliable_xmit() and only for packets that
1357  * require retransmissions.
1358  */
1359 struct sip_pkt {
1360         struct sip_pkt *next;                   /*!< Next packet in linked list */
1361         int retrans;                            /*!< Retransmission number */
1362         int method;                             /*!< SIP method for this packet */
1363         int seqno;                              /*!< Sequence number */
1364         char is_resp;                           /*!< 1 if this is a response packet (e.g. 200 OK), 0 if it is a request */
1365         char is_fatal;                          /*!< non-zero if there is a fatal error */
1366         struct sip_pvt *owner;                  /*!< Owner AST call */
1367         int retransid;                          /*!< Retransmission ID */
1368         int timer_a;                            /*!< SIP timer A, retransmission timer */
1369         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1370         int packetlen;                          /*!< Length of packet */
1371         struct ast_str *data;
1372 };      
1373
1374 /*! \brief Structure for SIP user data. User's place calls to us */
1375 struct sip_user {
1376         /* Users who can access various contexts */
1377         ASTOBJ_COMPONENTS(struct sip_user);
1378         char secret[80];                /*!< Password */
1379         char md5secret[80];             /*!< Password in md5 */
1380         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1381         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
1382         char cid_num[80];               /*!< Caller ID num */
1383         char cid_name[80];              /*!< Caller ID name */
1384         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
1385         char language[MAX_LANGUAGE];    /*!< Default language for this user */
1386         char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1387         char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1388         char useragent[256];            /*!< User agent in SIP request */
1389         struct ast_codec_pref prefs;    /*!< codec prefs */
1390         ast_group_t callgroup;          /*!< Call group */
1391         ast_group_t pickupgroup;        /*!< Pickup Group */
1392         unsigned int sipoptions;        /*!< Supported SIP options */
1393         struct ast_flags flags[2];      /*!< SIP_ flags */
1394
1395         /* things that don't belong in flags */
1396         char is_realtime;               /*!< this is a 'realtime' user */
1397
1398         int amaflags;                   /*!< AMA flags for billing */
1399         int callingpres;                /*!< Calling id presentation */
1400         int capability;                 /*!< Codec capability */
1401         int inUse;                      /*!< Number of calls in use */
1402         int call_limit;                 /*!< Limit of concurrent calls */
1403         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1404         struct ast_ha *ha;              /*!< ACL setting */
1405         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
1406         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1407         int autoframing;
1408         struct sip_st_cfg stimer;       /*!< SIP Session-Timers */
1409 };
1410
1411 /*!
1412  * \brief A peer's mailbox
1413  *
1414  * We could use STRINGFIELDS here, but for only two strings, it seems like
1415  * too much effort ...
1416  */
1417 struct sip_mailbox {
1418         char *mailbox;
1419         char *context;
1420         /*! Associated MWI subscription */
1421         struct ast_event_sub *event_sub;
1422         AST_LIST_ENTRY(sip_mailbox) entry;
1423 };
1424
1425 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
1426 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1427 struct sip_peer {
1428         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
1429                                         /*!< peer->name is the unique name of this object */
1430         struct sip_socket socket;       /*!< Socket used for this peer */
1431         char secret[80];                /*!< Password */
1432         char md5secret[80];             /*!< Password in MD5 */
1433         struct sip_auth *auth;          /*!< Realm authentication list */
1434         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1435         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1436         char username[80];              /*!< Temporary username until registration */ 
1437         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1438         int amaflags;                   /*!< AMA Flags (for billing) */
1439         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
1440         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1441         char fromuser[80];              /*!< From: user when calling this peer */
1442         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
1443         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
1444         char cid_num[80];               /*!< Caller ID num */
1445         char cid_name[80];              /*!< Caller ID name */
1446         int callingpres;                /*!< Calling id presentation */
1447         int inUse;                      /*!< Number of calls in use */
1448         int inRinging;                  /*!< Number of calls ringing */
1449         int onHold;                     /*!< Peer has someone on hold */
1450         int call_limit;                 /*!< Limit of concurrent calls */
1451         int busy_level;                 /*!< Level of active channels where we signal busy */
1452         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1453         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1454         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
1455         char mohinterpret[MAX_MUSICCLASS];/*!<  Music on Hold class */
1456         char mohsuggest[MAX_MUSICCLASS];/*!<  Music on Hold class */
1457         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
1458         struct ast_codec_pref prefs;    /*!<  codec prefs */
1459         int lastmsgssent;
1460         unsigned int sipoptions;        /*!<  Supported SIP options */
1461         struct ast_flags flags[2];      /*!<  SIP_ flags */
1462         
1463         /*! Mailboxes that this peer cares about */
1464         AST_LIST_HEAD_NOLOCK(, sip_mailbox) mailboxes;
1465
1466         /* things that don't belong in flags */
1467         char is_realtime;               /*!< this is a 'realtime' peer */
1468         char rt_fromcontact;            /*!< P: copy fromcontact from realtime */
1469         char host_dynamic;              /*!< P: Dynamic Peers register with Asterisk */
1470         char selfdestruct;              /*!< P: Automatic peers need to destruct themselves */
1471
1472         int expire;                     /*!<  When to expire this peer registration */
1473         int capability;                 /*!<  Codec capability */
1474         int rtptimeout;                 /*!<  RTP timeout */
1475         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1476         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1477         ast_group_t callgroup;          /*!<  Call group */
1478         ast_group_t pickupgroup;        /*!<  Pickup group */
1479         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this peer */
1480         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1481         struct sockaddr_in addr;        /*!<  IP address of peer */
1482         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1483         
1484         /* Qualification */
1485         struct sip_pvt *call;           /*!<  Call pointer */
1486         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
1487         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
1488         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
1489         int qualifyfreq;                /*!<  Qualification: How often to check for the host to be up */
1490         struct timeval ps;              /*!<  Time for sending SIP OPTION in sip_pke_peer() */
1491         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
1492         struct ast_ha *ha;              /*!<  Access control list */
1493         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1494         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1495         int autoframing;
1496         struct sip_st_cfg stimer;       /*!<  SIP Session-Timers */
1497         int timer_t1;                   /*!<  The maximum T1 value for the peer */
1498         int timer_b;                    /*!<  The maximum timer B (transaction timeouts) */
1499         int deprecated_username; /*!< If it's a realtime peer, are they using the deprecated "username" instead of "defaultuser" */
1500 };
1501
1502
1503 /*! \brief Registrations with other SIP proxies
1504  * Created by sip_register(), the entry is linked in the 'regl' list,
1505  * and never deleted (other than at 'sip reload' or module unload times).
1506  * The entry always has a pending timeout, either waiting for an ACK to
1507  * the REGISTER message (in which case we have to retransmit the request),
1508  * or waiting for the next REGISTER message to be sent (either the initial one,
1509  * or once the previously completed registration one expires).
1510  * The registration can be in one of many states, though at the moment
1511  * the handling is a bit mixed.
1512  * Note that the entire evolution of sip_registry (transmissions,
1513  * incoming packets and timeouts) is driven by one single thread,
1514  * do_monitor(), so there is almost no synchronization issue.
1515  * The only exception  is the sip_pvt creation/lookup,
1516  * as the dialoglist is also manipulated by other threads.
1517  */
1518 struct sip_registry {
1519         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1520         AST_DECLARE_STRING_FIELDS(
1521                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
1522                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1523                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1524                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1525                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1526                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1527                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
1528                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1529                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
1530                 AST_STRING_FIELD(secret);       /*!< Password in clear text */  
1531                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
1532                 AST_STRING_FIELD(callback);     /*!< Contact extension */
1533                 AST_STRING_FIELD(random);
1534         );
1535         enum sip_transport transport;
1536         int portno;                     /*!<  Optional port override */
1537         int expire;                     /*!< Sched ID of expiration */
1538         int expiry;                     /*!< Value to use for the Expires header */
1539         int regattempts;                /*!< Number of attempts (since the last success) */
1540         int timeout;                    /*!< sched id of sip_reg_timeout */
1541         int refresh;                    /*!< How often to refresh */
1542         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1543         enum sipregistrystate regstate; /*!< Registration state (see above) */
1544         struct timeval regtime;         /*!< Last successful registration time */
1545         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
1546         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
1547         int noncecount;                 /*!< Nonce-count */
1548         char lastmsg[256];              /*!< Last Message sent/received */
1549 };
1550
1551 struct sip_threadinfo {
1552         int stop;
1553         pthread_t threadid;
1554         struct ast_tcptls_session_instance *ser;
1555         enum sip_transport type;        /* We keep a copy of the type here so we can display it in the connection list */
1556         AST_LIST_ENTRY(sip_threadinfo) list;
1557 };
1558
1559 /* --- Linked lists of various objects --------*/
1560
1561 /*! \brief  The thread list of TCP threads */
1562 static AST_LIST_HEAD_STATIC(threadl, sip_threadinfo);
1563
1564 /*! \brief  The user list: Users and friends */
1565 static struct ast_user_list {
1566         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1567 } userl;
1568
1569 /*! \brief  The peer list: Peers and Friends */
1570 static struct ast_peer_list {
1571         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1572 } peerl;
1573
1574 /*! \brief  The register list: Other SIP proxies we register with and place calls to */
1575 static struct ast_register_list {
1576         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1577         int recheck;
1578 } regl;
1579
1580 static int temp_pvt_init(void *);
1581 static void temp_pvt_cleanup(void *);
1582
1583 /*! \brief A per-thread temporary pvt structure */
1584 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1585
1586 /*! \brief Authentication list for realm authentication 
1587  * \todo Move the sip_auth list to AST_LIST */
1588 static struct sip_auth *authl = NULL;
1589
1590
1591 /* --- Sockets and networking --------------*/
1592
1593 /*! \brief Main socket for SIP communication.
1594  *
1595  * sipsock is shared between the SIP manager thread (which handles reload
1596  * requests), the io handler (sipsock_read()) and the user routines that
1597  * issue writes (using __sip_xmit()).
1598  * The socket is -1 only when opening fails (this is a permanent condition),
1599  * or when we are handling a reload() that changes its address (this is
1600  * a transient situation during which we might have a harmless race, see
1601  * below). Because the conditions for the race to be possible are extremely
1602  * rare, we don't want to pay the cost of locking on every I/O.
1603  * Rather, we remember that when the race may occur, communication is
1604  * bound to fail anyways, so we just live with this event and let
1605  * the protocol handle this above us.
1606  */
1607 static int sipsock  = -1;
1608
1609 static struct sockaddr_in bindaddr;     /*!< The address we bind to */
1610
1611 /*! \brief our (internal) default address/port to put in SIP/SDP messages
1612  *  internip is initialized picking a suitable address from one of the
1613  * interfaces, and the same port number we bind to. It is used as the
1614  * default address/port in SIP messages, and as the default address
1615  * (but not port) in SDP messages.
1616  */
1617 static struct sockaddr_in internip;
1618
1619 /*! \brief our external IP address/port for SIP sessions.
1620  * externip.sin_addr is only set when we know we might be behind
1621  * a NAT, and this is done using a variety of (mutually exclusive)
1622  * ways from the config file:
1623  *
1624  * + with "externip = host[:port]" we specify the address/port explicitly.
1625  *   The address is looked up only once when (re)loading the config file;
1626  * 
1627  * + with "externhost = host[:port]" we do a similar thing, but the
1628  *   hostname is stored in externhost, and the hostname->IP mapping
1629  *   is refreshed every 'externrefresh' seconds;
1630  * 
1631  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
1632  *   to the specified server, and store the result in externip.
1633  *
1634  * Other variables (externhost, externexpire, externrefresh) are used
1635  * to support the above functions.
1636  */
1637 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
1638
1639 static char externhost[MAXHOSTNAMELEN];         /*!< External host name */
1640 static time_t externexpire;                     /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1641 static int externrefresh = 10;
1642 static struct sockaddr_in stunaddr;             /*!< stun server address */
1643
1644 /*! \brief  List of local networks
1645  * We store "localnet" addresses from the config file into an access list,
1646  * marked as 'DENY', so the call to ast_apply_ha() will return
1647  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
1648  * (i.e. presumably public) addresses.
1649  */
1650 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
1651
1652 static int ourport_tcp;
1653 static int ourport_tls;
1654 static struct sockaddr_in debugaddr;
1655
1656 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
1657
1658 /*! some list management macros. */
1659  
1660 #define UNLINK(element, head, prev) do {        \
1661         if (prev)                               \
1662                 (prev)->next = (element)->next; \
1663         else                                    \
1664                 (head) = (element)->next;       \
1665         } while (0)
1666
1667 enum t38_action_flag {
1668         SDP_T38_NONE = 0, /*!< Do not modify T38 information at all */
1669         SDP_T38_INITIATE, /*!< Remote side has requested T38 with us */
1670         SDP_T38_ACCEPT,   /*!< Remote side accepted our T38 request */
1671 };
1672
1673 /*---------------------------- Forward declarations of functions in chan_sip.c */
1674 /* Note: This is added to help splitting up chan_sip.c into several files
1675         in coming releases. */
1676
1677 /*--- PBX interface functions */
1678 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1679 static int sip_devicestate(void *data);
1680 static int sip_sendtext(struct ast_channel *ast, const char *text);
1681 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1682 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
1683 static int sip_hangup(struct ast_channel *ast);
1684 static int sip_answer(struct ast_channel *ast);
1685 static struct ast_frame *sip_read(struct ast_channel *ast);
1686 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1687 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1688 static int sip_transfer(struct ast_channel *ast, const char *dest);
1689 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1690 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1691 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
1692 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen);
1693 static const char *sip_get_callid(struct ast_channel *chan);
1694
1695 static int handle_request_do(struct sip_request *req, struct sockaddr_in *sin);
1696 static int sip_standard_port(struct sip_socket s);
1697 static int sip_prepare_socket(struct sip_pvt *p);
1698
1699 /*--- Transmitting responses and requests */
1700 static int sipsock_read(int *id, int fd, short events, void *ignore);
1701 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len);
1702 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int len, int fatal, int sipmethod);
1703 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1704 static int retrans_pkt(const void *data);
1705 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1706 static int transmit_response_using_temp(ast_string_field callid, struct sockaddr_in *sin, int useglobal_nat, const int intended_method, const struct sip_request *req, const char *msg);
1707 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1708 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1709 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1710 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable, int oldsdp);
1711 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1712 static int transmit_response_with_auth(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *rand, enum xmittype reliable, const char *header, int stale);
1713 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1714 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1715 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1716 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1717 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1718 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version, int oldsdp);
1719 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1720 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1721 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1722 static int transmit_refer(struct sip_pvt *p, const char *dest);
1723 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1724 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1725 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1726 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1727 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1728 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1729 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1730 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1731 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
1732
1733 /*--- Dialog management */
1734 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1735                                  int useglobal_nat, const int intended_method);
1736 static int __sip_autodestruct(const void *data);
1737 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1738 static int sip_cancel_destroy(struct sip_pvt *p);
1739 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
1740 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
1741 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1742 static void __sip_pretend_ack(struct sip_pvt *p);
1743 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1744 static int auto_congest(const void *arg);
1745 static int update_call_counter(struct sip_pvt *fup, int event);
1746 static int hangup_sip2cause(int cause);
1747 static const char *hangup_cause2sip(int cause);
1748 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1749 static void free_old_route(struct sip_route *route);
1750 static void list_route(struct sip_route *route);
1751 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1752 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1753                                               struct sip_request *req, char *uri);
1754 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1755 static void check_pendings(struct sip_pvt *p);
1756 static void *sip_park_thread(void *stuff);
1757 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1758 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1759
1760 /*--- Codec handling / SDP */
1761 static void try_suggested_sip_codec(struct sip_pvt *p);
1762 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1763 static const char *get_sdp(struct sip_request *req, const char *name);
1764 static int find_sdp(struct sip_request *req);
1765 static int process_sdp(struct sip_pvt *p, struct sip_request *req, int t38action);
1766 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1767                              struct ast_str **m_buf, struct ast_str **a_buf,
1768                              int debug, int *min_packet_size);
1769 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1770                                 struct ast_str **m_buf, struct ast_str **a_buf,
1771                                 int debug);
1772 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p, int oldsdp);
1773 static void do_setnat(struct sip_pvt *p, int natflags);
1774 static void stop_media_flows(struct sip_pvt *p);
1775
1776 /*--- Authentication stuff */
1777 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1778 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1779 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1780                                          const char *secret, const char *md5secret, int sipmethod,
1781                                          char *uri, enum xmittype reliable, int ignore);
1782 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1783                                               int sipmethod, char *uri, enum xmittype reliable,
1784                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1785 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1786
1787 /*--- Domain handling */
1788 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1789 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1790 static void clear_sip_domains(void);
1791
1792 /*--- SIP realm authentication */
1793 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, const char *configuration, int lineno);
1794 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1795 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1796
1797 /*--- Misc functions */
1798 static int sip_do_reload(enum channelreloadreason reason);
1799 static int reload_config(enum channelreloadreason reason);
1800 static int expire_register(const void *data);
1801 static void *do_monitor(void *data);
1802 static int restart_monitor(void);
1803 static int sip_addrcmp(char *name, struct sockaddr_in *sin);    /* Support for peer matching */
1804 static int sip_refer_allocate(struct sip_pvt *p);
1805 static void ast_quiet_chan(struct ast_channel *chan);
1806 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1807
1808 /*--- Device monitoring and Device/extension state/event handling */
1809 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1810 static int sip_devicestate(void *data);
1811 static int sip_poke_noanswer(const void *data);
1812 static int sip_poke_peer(struct sip_peer *peer);
1813 static void sip_poke_all_peers(void);
1814 static void sip_peer_hold(struct sip_pvt *p, int hold);
1815 static void mwi_event_cb(const struct ast_event *, void *);
1816
1817 /*--- Applications, functions, CLI and manager command helpers */
1818 static const char *sip_nat_mode(const struct sip_pvt *p);
1819 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1820 static char *transfermode2str(enum transfermodes mode) attribute_const;
1821 static const char *nat2str(int nat) attribute_const;
1822 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1823 static char *sip_show_users(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1824 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1825 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1826 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1827 static void  print_group(int fd, ast_group_t group, int crlf);
1828 static const char *dtmfmode2str(int mode) attribute_const;
1829 static int str2dtmfmode(const char *str) attribute_unused;
1830 static const char *insecure2str(int mode) attribute_const;
1831 static void cleanup_stale_contexts(char *new, char *old);
1832 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1833 static const char *domain_mode_to_text(const enum domain_mode mode);
1834 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1835 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1836 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1837 static char *sip_show_user(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1838 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1839 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1840 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1841 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1842 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1843 static char *complete_sip_peer(const char *word, int state, int flags2);
1844 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1845 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1846 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1847 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1848 static char *complete_sip_user(const char *word, int state, int flags2);
1849 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1850 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1851 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1852 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1853 static char *sip_do_debug_ip(int fd, char *arg);
1854 static char *sip_do_debug_peer(int fd, char *arg);
1855 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1856 static char *sip_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1857 static char *sip_do_history_deprecated(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1858 static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1859 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1860 static int sip_addheader(struct ast_channel *chan, void *data);
1861 static int sip_do_reload(enum channelreloadreason reason);
1862 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1863 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
1864
1865 /*--- Debugging 
1866         Functions for enabling debug per IP or fully, or enabling history logging for
1867         a SIP dialog
1868 */
1869 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to debuglog at end of dialog, before destroying data */
1870 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1871 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1872
1873
1874 /*! \brief Append to SIP dialog history 
1875         \return Always returns 0 */
1876 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1877 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1878 static void sip_dump_history(struct sip_pvt *dialog);
1879
1880 /*--- Device object handling */
1881 static struct sip_peer *temp_peer(const char *name);
1882 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1883 static struct sip_user *build_user(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1884 static int update_call_counter(struct sip_pvt *fup, int event);
1885 static void sip_destroy_peer(struct sip_peer *peer);
1886 static void sip_destroy_user(struct sip_user *user);
1887 static int sip_poke_peer(struct sip_peer *peer);
1888 static void set_peer_defaults(struct sip_peer *peer);
1889 static struct sip_peer *temp_peer(const char *name);
1890 static void register_peer_exten(struct sip_peer *peer, int onoff);
1891 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1892 static struct sip_user *find_user(const char *name, int realtime);
1893 static int sip_poke_peer_s(const void *data);
1894 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1895 static void reg_source_db(struct sip_peer *peer);
1896 static void destroy_association(struct sip_peer *peer);
1897 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1898 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1899
1900 /* Realtime device support */
1901 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey, int deprecated_username);
1902 static struct sip_user *realtime_user(const char *username);
1903 static void update_peer(struct sip_peer *p, int expiry);
1904 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1905 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
1906 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1907 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1908
1909 /*--- Internal UA client handling (outbound registrations) */
1910 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us);
1911 static void sip_registry_destroy(struct sip_registry *reg);
1912 static int sip_register(const char *value, int lineno);
1913 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1914 static int sip_reregister(const void *data);
1915 static int __sip_do_register(struct sip_registry *r);
1916 static int sip_reg_timeout(const void *data);
1917 static void sip_send_all_registers(void);
1918
1919 /*--- Parsing SIP requests and responses */
1920 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1921 static int determine_firstline_parts(struct sip_request *req);
1922 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1923 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1924 static int find_sip_method(const char *msg);
1925 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1926 static void parse_request(struct sip_request *req);
1927 static const char *get_header(const struct sip_request *req, const char *name);
1928 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1929 static int method_match(enum sipmethod id, const char *name);
1930 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1931 static char *get_in_brackets(char *tmp);
1932 static const char *find_alias(const char *name, const char *_default);
1933 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1934 static int lws2sws(char *msgbuf, int len);
1935 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1936 static char *remove_uri_parameters(char *uri);
1937 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1938 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1939 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1940 static int set_address_from_contact(struct sip_pvt *pvt);
1941 static void check_via(struct sip_pvt *p, struct sip_request *req);
1942 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1943 static int get_rpid_num(const char *input, char *output, int maxlen);
1944 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1945 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1946 static int get_msg_text(char *buf, int len, struct sip_request *req);
1947 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1948
1949 /*--- Constructing requests and responses */
1950 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1951 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1952 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1953 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1954 static int init_resp(struct sip_request *resp, const char *msg);
1955 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1956 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1957 static void build_via(struct sip_pvt *p);
1958 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1959 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1960 static char *generate_random_string(char *buf, size_t size);
1961 static void build_callid_pvt(struct sip_pvt *pvt);
1962 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1963 static void make_our_tag(char *tagbuf, size_t len);
1964 static int add_header(struct sip_request *req, const char *var, const char *value);
1965 static int add_header_contentLength(struct sip_request *req, int len);
1966 static int add_line(struct sip_request *req, const char *line);
1967 static int add_text(struct sip_request *req, const char *text);
1968 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1969 static int add_vidupdate(struct sip_request *req);
1970 static void add_route(struct sip_request *req, struct sip_route *route);
1971 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1972 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1973 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1974 static void set_destination(struct sip_pvt *p, char *uri);
1975 static void append_date(struct sip_request *req);
1976 static void build_contact(struct sip_pvt *p);
1977 static void build_rpid(struct sip_pvt *p);
1978
1979 /*------Request handling functions */
1980 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1981 static int handle_request_invite(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin, int *recount, char *e, int *nounlock);
1982 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1983 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1984 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1985 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1986 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1987 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1988 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1989 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1990 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin);
1991 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1992 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1993
1994 /*------Response handling functions */
1995 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1996 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1997 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1998 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1999
2000 /*----- RTP interface functions */
2001 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struct ast_rtp *vrtp,  struct ast_rtp *trtp, int codecs, int nat_active);
2002 static enum ast_rtp_get_result sip_get_rtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
2003 static enum ast_rtp_get_result sip_get_vrtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
2004 static enum ast_rtp_get_result sip_get_trtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
2005 static int sip_get_codec(struct ast_channel *chan);
2006 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
2007
2008 /*------ T38 Support --------- */
2009 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); 
2010 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
2011 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
2012 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
2013 static void change_t38_state(struct sip_pvt *p, int state);
2014
2015 /*------ Session-Timers functions --------- */
2016 static void proc_422_rsp(struct sip_pvt *p, struct sip_request *rsp);
2017 static int  proc_session_timer(const void *vp);
2018 static void stop_session_timer(struct sip_pvt *p);
2019 static void start_session_timer(struct sip_pvt *p);
2020 static void restart_session_timer(struct sip_pvt *p);
2021 static const char *strefresher2str(enum st_refresher r);
2022 static int parse_session_expires(const char *p_hdrval, int *const p_interval, enum st_refresher *const p_ref);
2023 static int parse_minse(const char *p_hdrval, int *const p_interval);
2024 static int st_get_se(struct sip_pvt *, int max);
2025 static enum st_refresher st_get_refresher(struct sip_pvt *);
2026 static enum st_mode st_get_mode(struct sip_pvt *);
2027 static struct sip_st_dlg* sip_st_alloc(struct sip_pvt *const p);
2028
2029
2030 /*! \brief Definition of this channel for PBX channel registration */
2031 static const struct ast_channel_tech sip_tech = {
2032         .type = "SIP",
2033         .description = "Session Initiation Protocol (SIP)",
2034         .capabilities = AST_FORMAT_AUDIO_MASK,  /* all audio formats */
2035         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
2036         .requester = sip_request_call,                  /* called with chan unlocked */
2037         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
2038         .call = sip_call,                       /* called with chan locked */
2039         .send_html = sip_sendhtml,
2040         .hangup = sip_hangup,                   /* called with chan locked */
2041         .answer = sip_answer,                   /* called with chan locked */
2042         .read = sip_read,                       /* called with chan locked */
2043         .write = sip_write,                     /* called with chan locked */
2044         .write_video = sip_write,               /* called with chan locked */
2045         .write_text = sip_write,
2046         .indicate = sip_indicate,               /* called with chan locked */
2047         .transfer = sip_transfer,               /* called with chan locked */
2048         .fixup = sip_fixup,                     /* called with chan locked */
2049         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
2050         .send_digit_end = sip_senddigit_end,
2051         .bridge = ast_rtp_bridge,                       /* XXX chan unlocked ? */
2052         .early_bridge = ast_rtp_early_bridge,
2053         .send_text = sip_sendtext,              /* called with chan locked */
2054         .func_channel_read = acf_channel_read,
2055         .queryoption = sip_queryoption,
2056         .get_pvt_uniqueid = sip_get_callid,
2057 };
2058
2059 /*! \brief This version of the sip channel tech has no send_digit_begin
2060  * callback so that the core knows that the channel does not want
2061  * DTMF BEGIN frames.
2062  * The struct is initialized just before registering the channel driver,
2063  * and is for use with channels using SIP INFO DTMF.
2064  */
2065 static struct ast_channel_tech sip_tech_info;
2066
2067 static void *sip_tcp_worker_fn(void *);
2068
2069 static struct ast_tls_config sip_tls_cfg;
2070 static struct ast_tls_config default_tls_cfg;
2071
2072 static struct server_args sip_tcp_desc = {
2073         .accept_fd = -1,
2074         .master = AST_PTHREADT_NULL,
2075         .tls_cfg = NULL,
2076         .poll_timeout = -1,
2077         .name = "sip tcp server",
2078         .accept_fn = ast_tcptls_server_root,
2079         .worker_fn = sip_tcp_worker_fn,
2080 };
2081
2082 static struct server_args sip_tls_desc = {
2083         .accept_fd = -1,
2084         .master = AST_PTHREADT_NULL,
2085         .tls_cfg = &sip_tls_cfg,
2086         .poll_timeout = -1,
2087         .name = "sip tls server",
2088         .accept_fn = ast_tcptls_server_root,
2089         .worker_fn = sip_tcp_worker_fn,
2090 };
2091
2092 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
2093 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
2094
2095 /*! \brief map from an integer value to a string.
2096  * If no match is found, return errorstring
2097  */
2098 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
2099 {
2100         const struct _map_x_s *cur;
2101
2102         for (cur = table; cur->s; cur++)
2103                 if (cur->x == x)
2104                         return cur->s;
2105         return errorstring;
2106 }
2107
2108 /*! \brief map from a string to an integer value, case insensitive.
2109  * If no match is found, return errorvalue.
2110  */
2111 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
2112 {
2113         const struct _map_x_s *cur;
2114
2115         for (cur = table; cur->s; cur++)
2116                 if (!strcasecmp(cur->s, s))
2117                         return cur->x;
2118         return errorvalue;
2119 }
2120
2121
2122 /*! \brief Interface structure with callbacks used to connect to RTP module */
2123 static struct ast_rtp_protocol sip_rtp = {
2124         .type = "SIP",
2125         .get_rtp_info = sip_get_rtp_peer,
2126         .get_vrtp_info = sip_get_vrtp_peer,
2127         .get_trtp_info = sip_get_trtp_peer,
2128         .set_rtp_peer = sip_set_rtp_peer,
2129         .get_codec = sip_get_codec,
2130 };
2131
2132 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *ser);
2133
2134 static void *sip_tcp_helper_thread(void *data)
2135 {
2136         struct sip_pvt *pvt = data;
2137         struct ast_tcptls_session_instance *ser = pvt->socket.ser;
2138
2139         return _sip_tcp_helper_thread(pvt, ser);
2140 }
2141
2142 static void *sip_tcp_worker_fn(void *data)
2143 {
2144         struct ast_tcptls_session_instance *ser = data;
2145
2146         return _sip_tcp_helper_thread(NULL, ser);
2147 }
2148
2149 /*! \brief SIP TCP helper function */
2150 static void *_sip_tcp_helper_thread(struct sip_pvt *pvt, struct ast_tcptls_session_instance *ser) 
2151 {
2152         int res, cl;
2153         struct sip_request req = { 0, } , reqcpy = { 0, };
2154         struct sip_threadinfo *me;
2155         char buf[1024];
2156
2157         me = ast_calloc(1, sizeof(*me));
2158
2159         if (!me)
2160                 goto cleanup2;
2161
2162         me->threadid = pthread_self();
2163         me->ser = ser;
2164         if (ser->ssl)
2165                 me->type = SIP_TRANSPORT_TLS;
2166         else
2167                 me->type = SIP_TRANSPORT_TCP;
2168
2169         AST_LIST_LOCK(&threadl);
2170         AST_LIST_INSERT_TAIL(&threadl, me, list);
2171         AST_LIST_UNLOCK(&threadl);
2172
2173         req.socket.lock = ast_calloc(1, sizeof(*req.socket.lock));
2174
2175         if (!req.socket.lock)
2176                 goto cleanup;
2177
2178         ast_mutex_init(req.socket.lock);
2179         if (!(req.data = ast_str_create(SIP_MIN_PACKET)))
2180                 goto cleanup;
2181         if (!(reqcpy.data = ast_str_create(SIP_MIN_PACKET)))
2182                 goto cleanup;
2183
2184         for (;;) {
2185                 ast_str_reset(req.data);
2186                 ast_str_reset(reqcpy.data);
2187                 req.len = 0;
2188                 req.ignore = 0;
2189
2190                 req.socket.fd = ser->fd;
2191                 if (ser->ssl) {
2192                         req.socket.type = SIP_TRANSPORT_TLS;
2193                         req.socket.port = htons(ourport_tls);
2194                 } else {
2195                         req.socket.type = SIP_TRANSPORT_TCP;
2196                         req.socket.port = htons(ourport_tcp);
2197                 }
2198                 res = ast_wait_for_input(ser->fd, -1);
2199                 if (res < 0) {
2200                         ast_debug(1, "ast_wait_for_input returned %d\n", res);
2201                         goto cleanup;
2202                 }
2203
2204                 /* Read in headers one line at a time */
2205                 while (req.len < 4 || strncmp((char *)&req.data->str + req.len - 4, "\r\n\r\n", 4)) {
2206                         if (req.socket.lock) 
2207                                 ast_mutex_lock(req.socket.lock);
2208                         if (!fgets(buf, sizeof(buf), ser->f)) {
2209                                 ast_mutex_unlock(req.socket.lock);
2210                                 goto cleanup;
2211                         }
2212                         if (req.socket.lock) 
2213                                 ast_mutex_unlock(req.socket.lock);
2214                         if (me->stop) 
2215                                  goto cleanup;
2216                         ast_str_append(&req.data, 0, "%s", buf);
2217                         req.len = req.data->used;
2218                 }
2219                 copy_request(&reqcpy, &req);
2220                 parse_request(&reqcpy);
2221                 if (sscanf(get_header(&reqcpy, "Content-Length"), "%d", &cl)) {
2222                         while (cl > 0) {
2223                                 if (req.socket.lock) 
2224                                         ast_mutex_lock(req.socket.lock);
2225                                 if (!fread(buf, (cl < sizeof(buf)) ? cl : sizeof(buf), 1, ser->f))
2226                                         goto cleanup;
2227                                 if (req.socket.lock) 
2228                                         ast_mutex_unlock(req.socket.lock);
2229                                 if (me->stop)
2230                                         goto cleanup;
2231                                 cl -= strlen(buf);
2232                                 ast_str_append(&req.data, 0, "%s", buf);
2233                                 req.len = req.data->used;
2234                         }
2235                 }
2236                 req.socket.ser = ser;
2237                 handle_request_do(&req, &ser->requestor);
2238         }
2239
2240 cleanup:
2241         AST_LIST_LOCK(&threadl);
2242         AST_LIST_REMOVE(&threadl, me, list);
2243         AST_LIST_UNLOCK(&threadl);
2244         ast_free(me);
2245 cleanup2:
2246         fclose(ser->f);
2247         ser = ast_tcptls_session_instance_destroy(ser);
2248         if (reqcpy.data)
2249                 ast_free(reqcpy.data);
2250         if (req.data)
2251                 ast_free(req.data);
2252
2253         if (req.socket.lock) {
2254                 ast_mutex_destroy(req.socket.lock);
2255                 ast_free(req.socket.lock);
2256                 req.socket.lock = NULL;
2257         }
2258
2259         return NULL;
2260 }
2261
2262 #define sip_pvt_lock(x) ast_mutex_lock(&x->pvt_lock)
2263 #define sip_pvt_trylock(x) ast_mutex_trylock(&x->pvt_lock)
2264 #define sip_pvt_unlock(x) ast_mutex_unlock(&x->pvt_lock)
2265
2266 /*!
2267  * helper functions to unreference various types of objects.
2268  * By handling them this way, we don't have to declare the
2269  * destructor on each call, which removes the chance of errors.
2270  */
2271 static void unref_peer(struct sip_peer *peer)
2272 {
2273         ASTOBJ_UNREF(peer, sip_destroy_peer);
2274 }
2275
2276 static void unref_user(struct sip_user *user)
2277 {
2278         ASTOBJ_UNREF(user, sip_destroy_user);
2279 }
2280
2281 static void *registry_unref(struct sip_registry *reg)
2282 {
2283         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
2284         ASTOBJ_UNREF(reg, sip_registry_destroy);
2285         return NULL;
2286 }
2287
2288 /*! \brief Add object reference to SIP registry */
2289 static struct sip_registry *registry_addref(struct sip_registry *reg)
2290 {
2291         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
2292         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
2293 }
2294
2295 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
2296 static struct ast_udptl_protocol sip_udptl = {
2297         type: "SIP",
2298         get_udptl_info: sip_get_udptl_peer,
2299         set_udptl_peer: sip_set_udptl_peer,
2300 };
2301
2302 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2303         __attribute__ ((format (printf, 2, 3)));
2304
2305
2306 /*! \brief Convert transfer status to string */
2307 static const char *referstatus2str(enum referstatus rstatus)
2308 {
2309         return map_x_s(referstatusstrings, rstatus, "");
2310 }
2311
2312 /*! \brief Initialize the initital request packet in the pvt structure.
2313         This packet is used for creating replies and future requests in
2314         a dialog */
2315 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
2316 {
2317         if (p->initreq.headers)
2318                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
2319         else
2320                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
2321         /* Use this as the basis */
2322         copy_request(&p->initreq, req);
2323         parse_request(&p->initreq);
2324         if (req->debug)
2325                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
2326 }
2327
2328 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
2329 static void sip_alreadygone(struct sip_pvt *dialog)
2330 {
2331         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
2332         dialog->alreadygone = 1;
2333 }
2334
2335 /*! Resolve DNS srv name or host name in a sip_proxy structure */
2336 static int proxy_update(struct sip_proxy *proxy)
2337 {
2338         /* if it's actually an IP address and not a name,
2339            there's no need for a managed lookup */
2340         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
2341                 /* Ok, not an IP address, then let's check if it's a domain or host */
2342                 /* XXX Todo - if we have proxy port, don't do SRV */
2343                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, global_srvlookup ? "_sip._udp" : NULL) < 0) {
2344                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
2345                         return FALSE;
2346                 }
2347         }
2348         proxy->last_dnsupdate = time(NULL);
2349         return TRUE;
2350 }
2351
2352 /*! \brief Allocate and initialize sip proxy */
2353 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
2354 {
2355         struct sip_proxy *proxy;
2356         proxy = ast_calloc(1, sizeof(*proxy));
2357         if (!proxy)
2358                 return NULL;
2359         proxy->force = force;
2360         ast_copy_string(proxy->name, name, sizeof(proxy->name));
2361         proxy->ip.sin_port = htons((!ast_strlen_zero(port) ? atoi(port) : STANDARD_SIP_PORT));
2362         proxy_update(proxy);
2363         return proxy;
2364 }
2365
2366 /*! \brief Get default outbound proxy or global proxy */
2367 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
2368 {
2369         if (peer && peer->outboundproxy) {
2370                 if (sipdebug)
2371                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
2372                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
2373                 return peer->outboundproxy;
2374         }
2375         if (global_outboundproxy.name[0]) {
2376                 if (sipdebug)
2377                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
2378                 append_history(dialog, "OBproxy", "Using global obproxy %s", global_outboundproxy.name);
2379                 return &global_outboundproxy;
2380         }
2381         if (sipdebug)
2382                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
2383         return NULL;
2384 }
2385
2386 /*! \brief returns true if 'name' (with optional trailing whitespace)
2387  * matches the sip method 'id'.
2388  * Strictly speaking, SIP methods are case SENSITIVE, but we do
2389  * a case-insensitive comparison to be more tolerant.
2390  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
2391  */
2392 static int method_match(enum sipmethod id, const char *name)
2393 {
2394         int len = strlen(sip_methods[id].text);
2395         int l_name = name ? strlen(name) : 0;
2396         /* true if the string is long enough, and ends with whitespace, and matches */
2397         return (l_name >= len && name[len] < 33 &&
2398                 !strncasecmp(sip_methods[id].text, name, len));
2399 }
2400
2401 /*! \brief  find_sip_method: Find SIP method from header */
2402 static int find_sip_method(const char *msg)
2403 {
2404         int i, res = 0;
2405         
2406         if (ast_strlen_zero(msg))
2407                 return 0;
2408         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
2409                 if (method_match(i, msg))
2410                         res = sip_methods[i].id;
2411         }
2412         return res;
2413 }
2414
2415 /*! \brief Parse supported header in incoming packet */
2416 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
2417 {
2418         char *next, *sep;
2419         char *temp;
2420         unsigned int profile = 0;
2421         int i, found;
2422
2423         if (ast_strlen_zero(supported) )
2424                 return 0;
2425         temp = ast_strdupa(supported);
2426
2427         if (sipdebug)
2428                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
2429
2430         for (next = temp; next; next = sep) {
2431                 found = FALSE;
2432                 if ( (sep = strchr(next, ',')) != NULL)
2433                         *sep++ = '\0';
2434                 next = ast_skip_blanks(next);
2435                 if (sipdebug)
2436                         ast_debug(3, "Found SIP option: -%s-\n", next);
2437                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
2438                         if (!strcasecmp(next, sip_options[i].text)) {
2439                                 profile |= sip_options[i].id;
2440                                 found = TRUE;
2441                                 if (sipdebug)
2442                                         ast_debug(3, "Matched SIP option: %s\n", next);
2443                                 break;
2444                         }
2445                 }
2446
2447                 /* This function is used to parse both Suported: and Require: headers.
2448                 Let the caller of this function know that an unknown option tag was 
2449                 encountered, so that if the UAC requires it then the request can be 
2450                 rejected with a 420 response. */
2451                 if (!found)
2452                         profile |= SIP_OPT_UNKNOWN;
2453
2454                 if (!found && sipdebug) {
2455                         if (!strncasecmp(next, "x-", 2))
2456                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
2457                         else
2458                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
2459                 }
2460         }
2461
2462         if (pvt)
2463                 pvt->sipoptions = profile;
2464         return profile;
2465 }
2466
2467 /*! \brief See if we pass debug IP filter */
2468 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
2469 {
2470         if (!sipdebug)
2471                 return 0;
2472         if (debugaddr.sin_addr.s_addr) {
2473                 if (((ntohs(debugaddr.sin_port) != 0)
2474                         && (debugaddr.sin_port != addr->sin_port))
2475                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
2476                         return 0;
2477         }
2478         return 1;
2479 }
2480
2481 /*! \brief The real destination address for a write */
2482 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
2483 {
2484         if (p->outboundproxy)
2485                 return &p->outboundproxy->ip;
2486
2487         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
2488 }
2489
2490 /*! \brief Display SIP nat mode */
2491 static const char *sip_nat_mode(const struct sip_pvt *p)
2492 {
2493         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
2494 }
2495
2496 /*! \brief Test PVT for debugging output */
2497 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
2498 {
2499         if (!sipdebug)
2500                 return 0;
2501         return sip_debug_test_addr(sip_real_dst(p));
2502 }
2503
2504 static inline const char *get_transport(enum sip_transport t)
2505 {
2506         switch (t) {
2507         case SIP_TRANSPORT_UDP:
2508                 return "UDP";
2509         case SIP_TRANSPORT_TCP:
2510                 return "TCP";
2511         case SIP_TRANSPORT_TLS:
2512                 return "TLS";
2513         }
2514
2515         return "UNKNOWN";
2516 }
2517
2518 /*! \brief Transmit SIP message 
2519         Sends a SIP request or response on a given socket (in the pvt)
2520         Called by retrans_pkt, send_request, send_response and 
2521         __sip_reliable_xmit
2522 */
2523 static int __sip_xmit(struct sip_pvt *p, struct ast_str *data, int len)
2524 {
2525         int res = 0;
2526         const struct sockaddr_in *dst = sip_real_dst(p);
2527
2528         ast_debug(1, "Trying to put '%.10s' onto %s socket...\n", data->str, get_transport(p->socket.type));
2529
2530         if (sip_prepare_socket(p) < 0)
2531                 return XMIT_ERROR;
2532
2533         if (p->socket.lock)
2534                 ast_mutex_lock(p->socket.lock);
2535
2536         if (p->socket.type & SIP_TRANSPORT_UDP) 
2537                 res = sendto(p->socket.fd, data->str, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
2538         else {
2539                 if (p->socket.ser->f) 
2540                         res = ast_tcptls_server_write(p->socket.ser, data->str, len);
2541                 else
2542                         ast_debug(1, "No p->socket.ser->f len=%d\n", len);
2543         } 
2544
2545         if (p->socket.lock)
2546                 ast_mutex_unlock(p->socket.lock);
2547
2548         if (res == -1) {
2549                 switch (errno) {
2550                         case EBADF:             /* Bad file descriptor - seems like this is generated when the host exist, but doesn't accept the UDP packet */
2551                         case EHOSTUNREACH:      /* Host can't be reached */
2552                         case ENETDOWN:          /* Interface down */
2553                         case ENETUNREACH:       /* Network failure */
2554                                 res = XMIT_ERROR;       /* Don't bother with trying to transmit again */
2555                 }
2556         }
2557         if (res != len)
2558                 ast_log(LOG_WARNING, "sip_xmit of %p (len %d) to %s:%d returned %d: %s\n", data, len, ast_inet_ntoa(dst->sin_addr), ntohs(dst->sin_port), res, strerror(errno));
2559
2560         return res;
2561 }
2562
2563 /*! \brief Build a Via header for a request */
2564 static void build_via(struct sip_pvt *p)
2565 {
2566         /* Work around buggy UNIDEN UIP200 firmware */
2567         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
2568
2569         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
2570         ast_string_field_build(p, via, "SIP/2.0/%s %s:%d;branch=z9hG4bK%08x%s",
2571                         get_transport(p->socket.type),
2572                         ast_inet_ntoa(p->ourip.sin_addr),
2573                         ntohs(p->ourip.sin_port), p->branch, rport);
2574 }
2575
2576 /*! \brief NAT fix - decide which IP address to use for Asterisk server?
2577  *
2578  * Using the localaddr structure built up with localnet statements in sip.conf
2579  * apply it to their address to see if we need to substitute our
2580  * externip or can get away with our internal bindaddr
2581  * 'us' is always overwritten.
2582  */
2583 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us)
2584 {
2585         struct sockaddr_in theirs;
2586         /* Set want_remap to non-zero if we want to remap 'us' to an externally
2587          * reachable IP address and port. This is done if:
2588          * 1. we have a localaddr list (containing 'internal' addresses marked
2589          *    as 'deny', so ast_apply_ha() will return AST_SENSE_DENY on them,
2590          *    and AST_SENSE_ALLOW on 'external' ones);
2591          * 2. either stunaddr or externip is set, so we know what to use as the
2592          *    externally visible address;
2593          * 3. the remote address, 'them', is external;
2594          * 4. the address returned by ast_ouraddrfor() is 'internal' (AST_SENSE_DENY
2595          *    when passed to ast_apply_ha() so it does need to be remapped.
2596          *    This fourth condition is checked later.
2597          */
2598         int want_remap;
2599
2600         *us = internip;         /* starting guess for the internal address */
2601         /* now ask the system what would it use to talk to 'them' */
2602         ast_ouraddrfor(them, &us->sin_addr);
2603         theirs.sin_addr = *them;
2604
2605         want_remap = localaddr &&
2606                 (externip.sin_addr.s_addr || stunaddr.sin_addr.s_addr) &&
2607                 ast_apply_ha(localaddr, &theirs) == AST_SENSE_ALLOW ;
2608
2609         if (want_remap &&
2610             (!global_matchexterniplocally || !ast_apply_ha(localaddr, us)) ) {
2611                 /* if we used externhost or stun, see if it is time to refresh the info */
2612                 if (externexpire && time(NULL) >= externexpire) {
2613                         if (stunaddr.sin_addr.s_addr) {
2614                                 ast_stun_request(sipsock, &stunaddr, NULL, &externip);
2615                         } else {
2616                                 if (ast_parse_arg(externhost, PARSE_INADDR, &externip))
2617                                         ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
2618                         }
2619                         externexpire = time(NULL) + externrefresh;
2620                 }
2621                 if (externip.sin_addr.s_addr)
2622                         *us = externip;
2623                 else
2624                         ast_log(LOG_WARNING, "stun failed\n");
2625                 ast_debug(1, "Target address %s is not local, substituting externip\n", 
2626                         ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
2627         } else if (bindaddr.sin_addr.s_addr) {
2628                 /* no remapping, but we bind to a specific address, so use it. */
2629                 *us = bindaddr;
2630         }
2631 }
2632
2633 /*! \brief Append to SIP dialog history with arg list  */
2634 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
2635 {
2636         char buf[80], *c = buf; /* max history length */
2637         struct sip_history *hist;
2638         int l;
2639
2640         vsnprintf(buf, sizeof(buf), fmt, ap);
2641         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
2642         l = strlen(buf) + 1;
2643         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
2644                 return;
2645         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
2646                 ast_free(hist);
2647                 return;
2648         }
2649         memcpy(hist->event, buf, l);
2650         if (p->history_entries == MAX_HISTORY_ENTRIES) {
2651                 struct sip_history *oldest;
2652                 oldest = AST_LIST_REMOVE_HEAD(p->history, list);
2653                 p->history_entries--;
2654                 ast_free(oldest);
2655         }
2656         AST_LIST_INSERT_TAIL(p->history, hist, list);
2657         p->history_entries++;
2658 }
2659
2660 /*! \brief Append to SIP dialog history with arg list  */
2661 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2662 {
2663         va_list ap;
2664
2665         if (!p)
2666                 return;
2667
2668         if (!p->do_history && !recordhistory && !dumphistory)
2669                 return;
2670
2671         va_start(ap, fmt);
2672         append_history_va(p, fmt, ap);
2673         va_end(ap);
2674
2675         return;
2676 }
2677
2678 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
2679 static int retrans_pkt(const void *data)
2680 {
2681         struct sip_pkt *pkt = (struct sip_pkt *)data, *prev, *cur = NULL;
2682         int reschedule = DEFAULT_RETRANS;
2683         int xmitres = 0;
2684
2685         /* Lock channel PVT */
2686         sip_pvt_lock(pkt->owner);
2687
2688         if (pkt->retrans < MAX_RETRANS) {
2689                 pkt->retrans++;
2690                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
2691                         if (sipdebug)
2692                                 ast_debug(4, "SIP TIMER: Not rescheduling id #%d:%s (Method %d) (No timer T1)\n", pkt->retransid, sip_methods[pkt->method].text, pkt->method);
2693                 } else {
2694                         int siptimer_a;
2695
2696                         if (sipdebug)
2697                                 ast_debug(4, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
2698                         if (!pkt->timer_a)
2699                                 pkt->timer_a = 2 ;
2700                         else
2701                                 pkt->timer_a = 2 * pkt->timer_a;
2702  
2703                         /* For non-invites, a maximum of 4 secs */
2704                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
2705                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
2706                                 siptimer_a = 4000;
2707                 
2708                         /* Reschedule re-transmit */
2709                         reschedule = siptimer_a;
2710                         ast_debug(4, "** SIP timers: Rescheduling retransmission %d to %d ms (t1 %d ms (Retrans id #%d)) \n", pkt->retrans +1, siptimer_a, pkt->timer_t1, pkt->retransid);
2711                 } 
2712
2713                 if (sip_debug_test_pvt(pkt->owner)) {
2714                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
2715                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
2716                                 pkt->retrans, sip_nat_mode(pkt->owner),
2717                                 ast_inet_ntoa(dst->sin_addr),
2718                                 ntohs(dst->sin_port), pkt->data->str);
2719                 }
2720
2721                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data->str);
2722                 xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
2723                 sip_pvt_unlock(pkt->owner);
2724                 if (xmitres == XMIT_ERROR)
2725                         ast_log(LOG_WARNING, "Network error on retransmit in dialog %s\n", pkt->owner->callid);
2726                 else 
2727                         return  reschedule;
2728         } 
2729         /* Too many retries */
2730         if (pkt->owner && pkt->method != SIP_OPTIONS && xmitres == 0) {
2731                 if (pkt->is_fatal || sipdebug)  /* Tell us if it's critical or if we're debugging */
2732                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s)\n",
2733                                 pkt->owner->callid, pkt->seqno,
2734                                 pkt->is_fatal ? "Critical" : "Non-critical", pkt->is_resp ? "Response" : "Request");
2735         } else if (pkt->method == SIP_OPTIONS && sipdebug) {
2736                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
2737
2738         } 
2739         if (xmitres == XMIT_ERROR) {
2740                 ast_log(LOG_WARNING, "Transmit error :: Cancelling transmission on Call ID %s\n", pkt->owner->callid);
2741                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2742         } else 
2743                 append_history(pkt->owner, "MaxRetries", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2744                 
2745         pkt->retransid = -1;
2746
2747         if (pkt->is_fatal) {
2748                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
2749                         sip_pvt_unlock(pkt->owner);     /* SIP_PVT, not channel */
2750                         usleep(1);
2751                         sip_pvt_lock(pkt->owner);
2752                 }
2753
2754                 if (pkt->owner->owner && !pkt->owner->owner->hangupcause) 
2755                         pkt->owner->owner->hangupcause = AST_CAUSE_NO_USER_RESPONSE;
2756                 
2757                 if (pkt->owner->owner) {
2758                         sip_alreadygone(pkt->owner);
2759                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
2760                         ast_queue_hangup(pkt->owner->owner);
2761                         ast_channel_unlock(pkt->owner->owner);
2762                 } else {
2763                         /* If no channel owner, destroy now */
2764
2765                         /* Let the peerpoke system expire packets when the timer expires for poke_noanswer */
2766                         if (pkt->method != SIP_OPTIONS && pkt->method != SIP_REGISTER) {
2767                                 pkt->owner->needdestroy = 1;
2768                                 sip_alreadygone(pkt->owner);
2769                                 append_history(pkt->owner, "DialogKill", "Killing this failed dialog immediately");
2770                         }
2771                 }
2772         }
2773
2774         if (pkt->method == SIP_BYE) {
2775                 /* We're not getting answers on SIP BYE's.  Tear down the call anyway. */
2776                 if (pkt->owner->owner) 
2777                         ast_channel_unlock(pkt->owner->owner);
2778                 append_history(pkt->owner, "ByeFailure", "Remote peer doesn't respond to bye. Destroying call anyway.");
2779                 pkt->owner->needdestroy = 1;
2780         }
2781
2782         /* Remove the packet */
2783         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
2784                 if (cur == pkt) {
2785                         UNLINK(cur, pkt->owner->packets, prev);
2786                         sip_pvt_unlock(pkt->owner);
2787                         if (pkt->data)
2788                                 ast_free(pkt->data);
2789                         ast_free(pkt);
2790                         return 0;
2791                 }
2792         }
2793         /* error case */
2794         ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
2795         sip_pvt_unlock(pkt->owner);
2796         return 0;
2797 }
2798
2799 /*! \brief Transmit packet with retransmits 
2800         \return 0 on success, -1 on failure to allocate packet 
2801 */
2802 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, struct ast_str *data, int len, int fatal, int sipmethod)
2803 {
2804         struct sip_pkt *pkt = NULL;
2805         int siptimer_a = DEFAULT_RETRANS;
2806         int xmitres = 0;
2807
2808         if (sipmethod == SIP_INVITE) {
2809                 /* Note this is a pending invite */
2810                 p->pendinginvite = seqno;
2811         }
2812
2813         /* If the transport is something reliable (TCP or TLS) then don't really send this reliably */
2814         /* I removed the code from retrans_pkt that does the same thing so it doesn't get loaded into the scheduler */
2815         /* According to the RFC some packets need to be retransmitted even if its TCP, so this needs to get revisited */
2816         if (!(p->socket.type & SIP_TRANSPORT_UDP)) {
2817                 xmitres = __sip_xmit(dialog_ref(p), data, len); /* Send packet */
2818                 if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2819                         append_history(p, "XmitErr", "%s", fatal ? "(Critical)" : "(Non-critical)");
2820                         return AST_FAILURE;
2821                 } else
2822                         return AST_SUCCESS;
2823         }
2824
2825         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
2826                 return AST_FAILURE;
2827         /* copy data, add a terminator and save length */
2828         if (!(pkt->data = ast_str_create(len))) {
2829                 ast_free(pkt);
2830                 return AST_FAILURE;
2831         }
2832         ast_str_set(&pkt->data, 0, "%s%s", data->str, "\0");
2833         pkt->packetlen = len;
2834         /* copy other parameters from the caller */
2835         pkt->method = sipmethod;
2836         pkt->seqno = seqno;
2837         pkt->is_resp = resp;
2838         pkt->is_fatal = fatal;
2839         pkt->owner = dialog_ref(p);
2840         pkt->next = p->packets;
2841         p->packets = pkt;       /* Add it to the queue */
2842         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
2843         pkt->retransid = -1;
2844         if (pkt->timer_t1)
2845                 siptimer_a = pkt->timer_t1 * 2;
2846
2847         /* Schedule retransmission */
2848         AST_SCHED_REPLACE_VARIABLE(pkt->retransid, sched, siptimer_a, retrans_pkt, pkt, 1);
2849         if (sipdebug)
2850                 ast_debug(4, "*** SIP TIMER: Initializing retransmit timer on packet: Id  #%d\n", pkt->retransid);
2851
2852         xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);    /* Send packet */
2853
2854         if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2855                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2856                 if (pkt->data)
2857                         ast_free(pkt->data);
2858                 return AST_FAILURE;
2859         } else {
2860                 return AST_SUCCESS;
2861         }
2862 }
2863
2864 /*! \brief Kill a SIP dialog (called only by the scheduler)
2865  * The scheduler has a reference to this dialog when p->autokillid != -1,
2866  * and we are called using that reference. So if the event is not
2867  * rescheduled, we need to call dialog_unref().
2868  */
2869 static int __sip_autodestruct(const void *data)
2870 {
2871         struct sip_pvt *p = (struct sip_pvt *)data;
2872
2873         /* If this is a subscription, tell the phone that we got a timeout */
2874         if (p->subscribed) {
2875                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1, TRUE);   /* Send last notification */
2876                 p->subscribed = NONE;
2877                 append_history(p, "Subscribestatus", "timeout");
2878                 ast_debug(3, "Re-scheduled destruction of SIP subscription %s\n", p->callid ? p->callid : "<unknown>");
2879                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
2880         }
2881
2882         /* If there are packets still waiting for delivery, delay the destruction */
2883         if (p->packets) {
2884                 ast_debug(3, "Re-scheduled destruction of SIP call %s\n", p->callid ? p->callid : "<unknown>");
2885                 append_history(p, "ReliableXmit", "timeout");
2886                 return 10000;
2887         }
2888
2889         if (p->subscribed == MWI_NOTIFICATION)
2890                 if (p->relatedpeer)
2891                         unref_peer(p->relatedpeer);     /* Remove link to peer. If it's realtime, make sure it's gone from memory) */
2892
2893         /* Reset schedule ID */
2894         p->autokillid = -1;
2895
2896         if (p->owner) {
2897                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
2898                 ast_queue_hangup(p->owner);
2899                 dialog_unref(p);
2900         } else if (p->refer) {
2901                 ast_debug(3, "Finally hanging up channel after transfer: %s\n", p->callid);
2902                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2903                 append_history(p, "ReferBYE", "Sending BYE on transferer call leg %s", p->callid);
2904                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
2905                 dialog_unref(p);
2906         } else {
2907                 append_history(p, "AutoDestroy", "%s", p->callid);
2908                 ast_debug(3, "Auto destroying SIP dialog '%s'\n", p->callid);
2909                 sip_destroy(p);         /* Go ahead and destroy dialog. All attempts to recover is done */
2910                 /* sip_destroy also absorbs the reference */
2911         }
2912         return 0;
2913 }
2914
2915 /*! \brief Schedule destruction of SIP dialog */
2916 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2917 {
2918         if (ms < 0) {
2919                 if (p->timer_t1 == 0) {
2920                         p->timer_t1 = global_t1;        /* Set timer T1 if not set (RFC 3261) */
2921                         p->timer_b = global_timer_b;  /* Set timer B if not set (RFC 3261) */
2922                 }
2923                 ms = p->timer_t1 * 64;
2924         }
2925         if (sip_debug_test_pvt(p))
2926                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2927         if (sip_cancel_destroy(p))
2928                 ast_log(LOG_WARNING, "Unable to cancel SIP destruction.  Expect bad things.\n");
2929
2930         if (p->do_history)
2931                 append_history(p, "SchedDestroy", "%d ms", ms);
2932         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, dialog_ref(p));
2933
2934         if (p->stimer && p->stimer->st_active == TRUE && p->stimer->st_schedid > 0)
2935                 stop_session_timer(p);
2936 }
2937
2938 /*! \brief Cancel destruction of SIP dialog.
2939  * Be careful as this also absorbs the reference - if you call it
2940  * from within the scheduler, this might be the last reference.
2941  */
2942 static int sip_cancel_destroy(struct sip_pvt *p)
2943 {
2944         int res = 0;
2945         if (p->autokillid > -1) {
2946                 if (!(res = ast_sched_del(sched, p->autokillid))) {
2947                         append_history(p, "CancelDestroy", "");
2948                         p->autokillid = -1;
2949                 }
2950                 dialog_unref(p);
2951         }
2952         return res;
2953 }
2954
2955 /*! \brief Acknowledges receipt of a packet and stops retransmission 
2956  * called with p locked*/
2957 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2958 {
2959         struct sip_pkt *cur, *prev = NULL;
2960         const char *msg = "Not Found";  /* used only for debugging */
2961
2962         /* If we have an outbound proxy for this dialog, then delete it now since
2963           the rest of the requests in this dialog needs to follow the routing.
2964           If obforcing is set, we will keep the outbound proxy during the whole
2965           dialog, regardless of what the SIP rfc says
2966         */
2967         if (p->outboundproxy && !p->outboundproxy->force)
2968                 p->outboundproxy = NULL;
2969
2970         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2971                 if (cur->seqno != seqno || cur->is_resp != resp)
2972                         continue;
2973                 if (cur->is_resp || cur->method == sipmethod) {
2974                         msg = "Found";
2975                         if (!resp && (seqno == p->pendinginvite)) {
2976                                 ast_debug(1, "Acked pending invite %d\n", p->pendinginvite);
2977                                 p->pendinginvite = 0;
2978                         }
2979                         if (cur->retransid > -1) {
2980                                 if (sipdebug)
2981                                         ast_debug(4, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2982                         }
2983                         /* This odd section is designed to thwart a 
2984                          * race condition in the packet scheduler. There are
2985                          * two conditions under which deleting the packet from the
2986                          * scheduler can fail.
2987                          *
2988                          * 1. The packet has been removed from the scheduler because retransmission
2989                          * is being attempted. The problem is that if the packet is currently attempting
2990                          * retransmission and we are at this point in the code, then that MUST mean
2991                          * that retrans_pkt is waiting on p's lock. Therefore we will relinquish the
2992                          * lock temporarily to allow retransmission.
2993                          *
2994                          * 2. The packet has reached its maximum number of retransmissions and has
2995                          * been permanently removed from the packet scheduler. If this is the case, then
2996                          * the packet's retransid will be set to -1. The atomicity of the setting and checking
2997                          * of the retransid to -1 is ensured since in both cases p's lock is held.
2998                          */
2999                         while (cur->retransid > -1 && ast_sched_del(sched, cur->retransid)) {
3000                                 sip_pvt_unlock(p);
3001                                 usleep(1);
3002                                 sip_pvt_lock(p);
3003                         }
3004                         UNLINK(cur, p->packets, prev);
3005                         dialog_unref(cur->owner);
3006                         if (cur->data)
3007                                 ast_free(cur->data);
3008                         ast_free(cur);
3009                         break;
3010                 }
3011         }
3012         ast_debug(1, "Stopping retransmission on '%s' of %s %d: Match %s\n",
3013                 p->callid, resp ? "Response" : "Request", seqno, msg);
3014 }
3015
3016 /*! \brief Pretend to ack all packets
3017  * called with p locked */
3018 static void __sip_pretend_ack(struct sip_pvt *p)
3019 {
3020         struct sip_pkt *cur = NULL;
3021
3022         while (p->packets) {
3023                 int method;
3024                 if (cur == p->packets) {
3025                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
3026                         return;
3027                 }
3028                 cur = p->packets;
3029                 method = (cur->method) ? cur->method : find_sip_method(cur->data->str);
3030                 __sip_ack(p, cur->seqno, cur->is_resp, method);
3031         }
3032 }
3033
3034 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
3035 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
3036 {
3037         struct sip_pkt *cur;
3038         int res = -1;
3039
3040         for (cur = p->packets; cur; cur = cur->next) {
3041                 if (cur->seqno == seqno && cur->is_resp == resp &&
3042                         (cur->is_resp || method_match(sipmethod, cur->data->str))) {
3043                         /* this is our baby */
3044                         if (cur->retransid > -1) {
3045                                 if (sipdebug)
3046                                         ast_debug(4, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
3047                         }
3048                         AST_SCHED_DEL(sched, cur->retransid);
3049                         res = 0;
3050                         break;
3051                 }
3052         }
3053         ast_debug(1, "(Provisional) Stopping retransmission (but retaining packet) on '%s' %s %d: %s\n", p->callid, resp ? "Response" : "Request", seqno, res == -1 ? "Not Found" : "Found");
3054         return res;
3055 }
3056
3057
3058 /*! \brief Copy SIP request, parse it */
3059 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
3060 {
3061         copy_request(dst, src);
3062         parse_request(dst);
3063 }
3064
3065 /*! \brief add a blank line if no body */
3066 static void add_blank(struct sip_request *req)
3067 {
3068         if (!req->lines) {
3069                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
3070                 ast_str_append(&req->data, 0, "\r\n");
3071                 req->len = req->data->used;
3072         }
3073 }
3074
3075 /*! \brief Transmit response on SIP request*/
3076 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
3077 {
3078         int res;
3079
3080         add_blank(req);
3081         if (sip_debug_test_pvt(p)) {
3082                 const struct sockaddr_in *dst = sip_real_dst(p);
3083
3084                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
3085                         reliable ? "Reliably " : "", sip_nat_mode(p),
3086                         ast_inet_ntoa(dst->sin_addr),
3087                         ntohs(dst->sin_port), req->data->str);
3088         }
3089         if (p->do_history) {
3090                 struct sip_request tmp = { .rlPart1 = NULL, };
3091                 parse_copy(&tmp, req);
3092                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data->str, get_header(&tmp, "CSeq"), 
3093                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
3094                 ast_free(tmp.data);
3095         }
3096         res = (reliable) ?
3097                  __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
3098                 __sip_xmit(p, req->data, req->len);
3099         ast_free(req->data);
3100         if (res > 0)
3101                 return 0;
3102         return res;
3103 }
3104
3105 /*! \brief Send SIP Request to the other part of the dialogue */
3106 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
3107 {
3108         int res;
3109
3110         /* If we have an outbound proxy, reset peer address 
3111                 Only do this once.
3112         */
3113         if (p->outboundproxy) {
3114                 p->sa = p->outboundproxy->ip;
3115         }
3116
3117         add_blank(req);
3118         if (sip_debug_test_pvt(p)) {
3119                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
3120                         ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->recv.sin_addr), ntohs(p->recv.sin_port), req->data->str);
3121                 else
3122                         ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->sa.sin_addr), ntohs(p->sa.sin_port), req->data->str);
3123         }
3124         if (p->do_history) {
3125                 struct sip_request tmp = { .rlPart1 = NULL, };
3126                 parse_copy(&tmp, req);
3127                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data->str, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
3128                 ast_free(tmp.data);
3129         }
3130         res = (reliable) ?
3131                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
3132                 __sip_xmit(p, req->data, req->len);
3133         if (req->data)
3134                 ast_free(req->data);
3135         return res;
3136 }
3137
3138 /*! \brief Query an option on a SIP dialog */
3139 static int sip_queryoption(struct ast_channel *chan, int option, void *data, int *datalen)
3140 {
3141         int res = -1;
3142         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
3143         struct sip_pvt *p = (struct sip_pvt *) chan->tech_pvt;
3144
3145         switch (option) {
3146         case AST_OPTION_T38_STATE:
3147                 /* Make sure we got an ast_t38_state enum passed in */
3148                 if (*datalen != sizeof(enum ast_t38_state)) {
3149                         ast_log(LOG_ERROR, "Invalid datalen for AST_OPTION_T38_STATE option. Expected %d, got %d\n", (int)sizeof(enum ast_t38_state), *datalen);
3150                         return -1;
3151                 }
3152
3153                 sip_pvt_lock(p);
3154
3155                 /* Now if T38 support is enabled we need to look and see what the current state is to get what we want to report back */
3156                 if (ast_test_flag(&p->t38.t38support, SIP_PAGE2_T38SUPPORT)) {
3157                         switch (p->t38.state) {
3158                         case T38_LOCAL_DIRECT:
3159                         case T38_LOCAL_REINVITE:
3160                         case T38_PEER_DIRECT:
3161                         case T38_PEER_REINVITE:
3162                                 state = T38_STATE_NEGOTIATING;
3163                                 break;
3164                         case T38_ENABLED:
3165                                 state = T38_STATE_NEGOTIATED;
3166                                 break;
3167                         default:
3168                                 state = T38_STATE_UNKNOWN;
3169                         }
3170                 }
3171
3172                 sip_pvt_unlock(p);
3173
3174                 *((enum ast_t38_state *) data) = state;
3175                 res = 0;
3176
3177                 break;
3178         default:
3179                 break;
3180         }
3181
3182         return res;
3183 }
3184
3185 /*! \brief Locate closing quote in a string, skipping escaped quotes.
3186  * optionally with a limit on the search.
3187  * start must be past the first quote.
3188  */
3189 static const char *find_closing_quote(const char *start, const char *lim)
3190 {
3191         char last_char = '\0';
3192         const char *s;
3193         for (s = start; *s && s != lim; last_char = *s++) {
3194                 if (*s == '"' && last_char != '\\')
3195                         break;
3196         }
3197         return s;
3198 }
3199
3200 /*! \brief Pick out text in brackets from character string
3201         \return pointer to terminated stripped string
3202         \param tmp input string that will be modified
3203         Examples:
3204 \verbatim
3205         "foo" <bar>     valid input, returns bar
3206         foo             returns the whole string
3207         < "foo ... >    returns the string between brackets
3208         < "foo...       bogus (missing closing bracket), returns the whole string
3209                         XXX maybe should still skip the opening bracket
3210 \endverbatim
3211  */
3212 static char *get_in_brackets(char *tmp)
3213 {
3214         const char *parse = tmp;
3215         char *first_bracket;
3216
3217         /*
3218          * Skip any quoted text until we find the part in brackets.
3219         * On any error give up and return the full string.
3220         */
3221         while ( (first_bracket = strchr(parse, '<')) ) {
3222                 char *first_quote = strchr(parse, '"');
3223
3224                 if (!first_quote || first_quote > first_bracket)
3225                         break; /* no need to look at quoted part */
3226                 /* the bracket is within quotes, so ignore it */
3227                 parse = find_closing_quote(first_quote + 1, NULL);
3228                 if (!*parse) { /* not found, return full string ? */
3229                         /* XXX or be robust and return in-bracket part ? */
3230                         ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
3231                         break;
3232                 }
3233                 parse++;
3234         }
3235         if (first_bracket) {
3236                 char *second_bracket = strchr(first_bracket + 1, '>');
3237                 if (second_bracket) {
3238                         *second_bracket = '\0';
3239                         tmp = first_bracket + 1;
3240                 } else {
3241                         ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
3242                 }
3243         }
3244         
3245         return tmp;
3246 }
3247
3248 /*! \brief * parses a URI in its components.
3249  *
3250  * \note 
3251  * - If scheme is specified, drop it from the top.
3252  * - If a component is not requested, do not split around it.
3253  *
3254  * This means that if we don't have domain, we cannot split
3255  * name:pass and domain:port.
3256  * It is safe to call with ret_name, pass, domain, port
3257  * pointing all to the same place.
3258  * Init pointers to empty string so we never get NULL dereferencing.
3259  * Overwrites the string.
3260  * return 0 on success, other values on error.
3261  * \verbatim 
3262  * general form we are expecting is sip[s]:username[:password][;parameter]@host[:port][;...] 
3263  * \endverbatim
3264  */
3265 static int parse_uri(char *uri, char *scheme,
3266         char **ret_name, char **pass, char **domain, char **port, char **options)
3267 {
3268         char *name = NULL;
3269         int error = 0;
3270
3271         /* init field as required */
3272         if (pass)
3273                 *pass = "";
3274         if (port)
3275                 *port = "";
3276         if (scheme) {
3277                 int l = strlen(scheme);
3278                 if (!strncasecmp(uri, scheme, l))
3279                         uri += l;
3280                 else {
3281                         ast_debug(1, "Missing scheme '%s' in '%s'\n", scheme, uri);
3282                         error = -1;
3283                 }
3284         }
3285         if (!domain) {
3286                 /* if we don't want to split around domain, keep everything as a name,
3287                  * so we need to do nothing here, except remember why.
3288                  */
3289         } else {
3290                 /* store the result in a temp. variable to avoid it being
3291                  * overwritten if arguments point to the same place.
3292                  */
3293                 char *c, *dom = "";
3294
3295                 if ((c = strchr(uri, '@')) == NULL) {
3296                         /* domain-only URI, according to the SIP RFC. */
3297                         dom = uri;
3298                         name = "";
3299                 } else {
3300                         *c++ = '\0';
3301                         dom = c;
3302                         name = uri;
3303                 }
3304
3305                 /* Remove options in domain and name */
3306                 dom = strsep(&dom, ";");
3307                 name = strsep(&name, ";");
3308
3309                 if (port && (c = strchr(dom, ':'))) { /* Remove :port */
3310                         *c++ = '\0';
3311                         *port = c;
3312                 }
3313                 if (pass && (c = strchr(name, ':'))) {  /* user:password */
3314                         *c++ = '\0';
3315                         *pass = c;
3316                 }
3317                 *domain = dom;
3318         }
3319         if (ret_name)   /* same as for domain, store the result only at the end */
3320                 *ret_name = name;
3321         if (options)
3322                 *options = uri ? uri : "";
3323
3324         return error;
3325 }
3326
3327 /*! \brief Send message with Access-URL header, if this is an HTML URL only! */
3328 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen)
3329 {
3330         struct sip_pvt *p = chan->tech_pvt;
3331
3332         if (subclass != AST_HTML_URL)
3333                 return -1;
3334
3335         ast_string_field_build(p, url, "<%s>;mode=active", data);
3336
3337         if (sip_debug_test_pvt(p))
3338                 ast_debug(1, "Send URL %s, state = %d!\n", data, chan->_state);
3339
3340         switch (chan->_state) {
3341         case AST_STATE_RING:
3342                 transmit_response(p, "100 Trying", &p->initreq);
3343                 break;
3344         case AST_STATE_RINGING:
3345                 transmit_response(p, "180 Ringing", &p->initreq);
3346                 break;
3347         case AST_STATE_UP:
3348                 if (!p->pendinginvite) {                /* We are up, and have no outstanding invite */
3349                         transmit_reinvite_with_sdp(p, FALSE, FALSE);
3350                 } else if (!ast_test_flag(&p->flags[0], SIP_PENDINGBYE)) {
3351                         ast_set_flag(&p->flags[0], SIP_NEEDREINVITE);   
3352                 }       
3353                 break;
3354         default:
3355                 ast_log(LOG_WARNING, "Don't know how to send URI when state is %d!\n", chan->_state);
3356         }
3357
3358         return 0;
3359 }
3360
3361 /*! \brief Deliver SIP call ID for the call */
3362 static const char *sip_get_callid(struct ast_channel *chan)
3363 {
3364         return chan->tech_pvt ? ((struct sip_pvt *) chan->tech_pvt)->callid : "";
3365 }
3366
3367 /*! \brief Send SIP MESSAGE text within a call
3368         Called from PBX core sendtext() application */
3369 static int sip_sendtext(struct ast_channel *ast, const char *text)
3370 {
3371         struct sip_pvt *p = ast->tech_pvt;
3372         int debug = sip_debug_test_pvt(p);
3373
3374         if (debug)
3375                 ast_verbose("Sending text %s on %s\n", text, ast->name);
3376         if (!p)
3377                 return -1;
3378         if (ast_strlen_zero(text))
3379                 return 0;
3380         if (debug)
3381                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
3382         transmit_message_with_text(p, text);
3383         return 0;       
3384 }
3385
3386 /*! \brief Update peer object in realtime storage 
3387         If the Asterisk system name is set in asterisk.conf, we will use
3388         that name and store that in the "regserver" field in the sippeers
3389         table to facilitate multi-server setups.
3390 */
3391 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *defaultuser, const char *fullcontact, int expirey, int deprecated_username)
3392 {
3393         char port[10];
3394         char ipaddr[INET_ADDRSTRLEN];
3395         char regseconds[20];
3396         char *tablename = NULL;
3397
3398         const char *sysname = ast_config_AST_SYSTEM_NAME;
3399         char *syslabel = NULL;
3400
3401         time_t nowtime = time(NULL) + expirey;
3402         const char *fc = fullcontact ? "fullcontact" : NULL;
3403
3404         int realtimeregs = ast_check_realtime("sipregs");
3405
3406         tablename = realtimeregs ? "sipregs" : "sippeers";
3407         
3408         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
3409         ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
3410         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
3411         
3412         if (ast_strlen_zero(sysname))   /* No system name, disable this */
3413                 sysname = NULL;
3414         else if (sip_cfg.rtsave_sysname)
3415                 syslabel = "regserver";
3416
3417         if (fc)
3418                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
3419                         "port", port, "regseconds", regseconds,
3420                         deprecated_username ? "username" : "defaultuser", defaultuser, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
3421         else
3422                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
3423                         "port", port, "regseconds", regseconds,
3424                         deprecated_username ? "username" : "defaultuser", defaultuser, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
3425 }
3426
3427 /*! \brief Automatically add peer extension to dial plan */
3428 static void register_peer_exten(struct sip_peer *peer, int onoff)
3429 {
3430         char multi[256];
3431         char *stringp, *ext, *context;
3432         struct pbx_find_info q = { .stacklen = 0 };
3433
3434         /* XXX note that global_regcontext is both a global 'enable' flag and
3435          * the name of the global regexten context, if not specified
3436          * individually.
3437          */
3438         if (ast_strlen_zero(global_regcontext))
3439                 return;
3440
3441         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
3442         stringp = multi;
3443         while ((ext = strsep(&stringp, "&"))) {
3444                 if ((context = strchr(ext, '@'))) {
3445                         *context++ = '\0';      /* split ext@context */
3446                         if (!ast_context_find(context)) {
3447                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
3448                                 continue;
3449                         }
3450                 } else {
3451                         context = global_regcontext;
3452                 }
3453                 if (onoff) {
3454                         ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
3455                                  ast_strdup(peer->name), ast_free_ptr, "SIP");
3456                 } else if (pbx_find_extension(NULL, NULL, &q, context, ext, 1, NULL, "", E_MATCH)) {
3457                         ast_context_remove_extension(context, ext, 1, NULL);
3458                 }
3459         }
3460 }
3461
3462 /*! Destroy mailbox subscriptions */
3463 static void destroy_mailbox(struct sip_mailbox *mailbox)
3464 {
3465         if (mailbox->mailbox)
3466                 ast_free(mailbox->mailbox);
3467         if (mailbox->context)
3468                 ast_free(mailbox->context);
3469         if (mailbox->event_sub)
3470                 ast_event_unsubscribe(mailbox->event_sub);
3471         ast_free(mailbox);
3472 }
3473
3474 /*! Destroy all peer-related mailbox subscriptions */
3475 static void clear_peer_mailboxes(struct sip_peer *peer)
3476 {
3477         struct sip_mailbox *mailbox;
3478
3479         while ((mailbox = AST_LIST_REMOVE_HEAD(&peer->mailboxes, entry)))
3480                 destroy_mailbox(mailbox);
3481 }
3482
3483 /*! \brief Destroy peer object from memory */
3484 static void sip_destroy_peer(struct sip_peer *peer)