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