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