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