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