Start using Doxygen groupings to group variables and defines.
[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 autokillid;                         /*!< Auto-kill ID (scheduler) */
1136         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
1137         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
1138         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
1139         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
1140         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
1141         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
1142         
1143         struct ast_dsp *vad;                    /*!< Inband DTMF Detection dsp */
1144         
1145         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one 
1146                                                         Used in peerpoke, mwi subscriptions */
1147         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
1148         struct ast_rtp *rtp;                    /*!< RTP Session */
1149         struct ast_rtp *vrtp;                   /*!< Video RTP session */
1150         struct ast_rtp *trtp;                   /*!< Text RTP session */
1151         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
1152         struct sip_history_head *history;       /*!< History of this SIP dialog */
1153         size_t history_entries;                 /*!< Number of entires in the history */
1154         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
1155         struct sip_invite_param *options;       /*!< Options for INVITE */
1156         int autoframing;                        /*!< The number of Asters we group in a Pyroflax
1157                                                         before strolling to the Grokyzp√•
1158                                                         (A bit unsure of this, please correct if
1159                                                         you know more) */
1160 };
1161
1162 /*! Max entires in the history list for a sip_pvt */
1163 #define MAX_HISTORY_ENTRIES 50
1164
1165 /*!
1166  * Here we implement the container for dialogs (sip_pvt), defining
1167  * generic wrapper functions to ease the transition from the current
1168  * implementation (a single linked list) to a different container.
1169  * In addition to a reference to the container, we need functions to lock/unlock
1170  * the container and individual items, and functions to add/remove
1171  * references to the individual items.
1172  */
1173 static struct sip_pvt *dialoglist = NULL;
1174
1175 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
1176 AST_MUTEX_DEFINE_STATIC(dialoglock);
1177
1178 #ifndef DETECT_DEADLOCKS
1179 /*! \brief hide the way the list is locked/unlocked */
1180 static void dialoglist_lock(void)
1181 {
1182         ast_mutex_lock(&dialoglock);
1183 }
1184
1185 static void dialoglist_unlock(void)
1186 {
1187         ast_mutex_unlock(&dialoglock);
1188 }
1189 #else
1190 /* we don't want to HIDE the information about where the lock was requested if trying to debug 
1191  * deadlocks!  So, just make these macros! */
1192 #define dialoglist_lock(x) ast_mutex_lock(&dialoglock)
1193 #define dialoglist_unlock(x) ast_mutex_unlock(&dialoglock)
1194 #endif
1195
1196 /*!
1197  * when we create or delete references, make sure to use these
1198  * functions so we keep track of the refcounts.
1199  * To simplify the code, we allow a NULL to be passed to dialog_unref().
1200  */
1201 static struct sip_pvt *dialog_ref(struct sip_pvt *p)
1202 {
1203         return p;
1204 }
1205
1206 static struct sip_pvt *dialog_unref(struct sip_pvt *p)
1207 {
1208         return NULL;
1209 }
1210
1211 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission
1212  * Packets are linked in a list, whose head is in the struct sip_pvt they belong to.
1213  * Each packet holds a reference to the parent struct sip_pvt.
1214  * This structure is allocated in __sip_reliable_xmit() and only for packets that
1215  * require retransmissions.
1216  */
1217 struct sip_pkt {
1218         struct sip_pkt *next;                   /*!< Next packet in linked list */
1219         int retrans;                            /*!< Retransmission number */
1220         int method;                             /*!< SIP method for this packet */
1221         int seqno;                              /*!< Sequence number */
1222         char is_resp;                           /*!< 1 if this is a response packet (e.g. 200 OK), 0 if it is a request */
1223         char is_fatal;                          /*!< non-zero if there is a fatal error */
1224         struct sip_pvt *owner;                  /*!< Owner AST call */
1225         int retransid;                          /*!< Retransmission ID */
1226         int timer_a;                            /*!< SIP timer A, retransmission timer */
1227         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1228         int packetlen;                          /*!< Length of packet */
1229         char data[0];
1230 };      
1231
1232 /*! \brief Structure for SIP user data. User's place calls to us */
1233 struct sip_user {
1234         /* Users who can access various contexts */
1235         ASTOBJ_COMPONENTS(struct sip_user);
1236         char secret[80];                /*!< Password */
1237         char md5secret[80];             /*!< Password in md5 */
1238         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1239         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
1240         char cid_num[80];               /*!< Caller ID num */
1241         char cid_name[80];              /*!< Caller ID name */
1242         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
1243         char language[MAX_LANGUAGE];    /*!< Default language for this user */
1244         char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1245         char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1246         char useragent[256];            /*!< User agent in SIP request */
1247         struct ast_codec_pref prefs;    /*!< codec prefs */
1248         ast_group_t callgroup;          /*!< Call group */
1249         ast_group_t pickupgroup;        /*!< Pickup Group */
1250         unsigned int sipoptions;        /*!< Supported SIP options */
1251         struct ast_flags flags[2];      /*!< SIP_ flags */
1252
1253         /* things that don't belong in flags */
1254         char is_realtime;               /*!< this is a 'realtime' user */
1255
1256         int amaflags;                   /*!< AMA flags for billing */
1257         int callingpres;                /*!< Calling id presentation */
1258         int capability;                 /*!< Codec capability */
1259         int inUse;                      /*!< Number of calls in use */
1260         int call_limit;                 /*!< Limit of concurrent calls */
1261         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1262         struct ast_ha *ha;              /*!< ACL setting */
1263         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
1264         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1265         int autoframing;
1266 };
1267
1268 /*!
1269  * \brief A peer's mailbox
1270  *
1271  * We could use STRINGFIELDS here, but for only two strings, it seems like
1272  * too much effort ...
1273  */
1274 struct sip_mailbox {
1275         char *mailbox;
1276         char *context;
1277         /*! Associated MWI subscription */
1278         struct ast_event_sub *event_sub;
1279         AST_LIST_ENTRY(sip_mailbox) entry;
1280 };
1281
1282 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
1283 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1284 struct sip_peer {
1285         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
1286                                         /*!< peer->name is the unique name of this object */
1287         char secret[80];                /*!< Password */
1288         char md5secret[80];             /*!< Password in MD5 */
1289         struct sip_auth *auth;          /*!< Realm authentication list */
1290         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1291         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1292         char username[80];              /*!< Temporary username until registration */ 
1293         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1294         int amaflags;                   /*!< AMA Flags (for billing) */
1295         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
1296         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1297         char fromuser[80];              /*!< From: user when calling this peer */
1298         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
1299         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
1300         char cid_num[80];               /*!< Caller ID num */
1301         char cid_name[80];              /*!< Caller ID name */
1302         int callingpres;                /*!< Calling id presentation */
1303         int inUse;                      /*!< Number of calls in use */
1304         int inRinging;                  /*!< Number of calls ringing */
1305         int onHold;                     /*!< Peer has someone on hold */
1306         int call_limit;                 /*!< Limit of concurrent calls */
1307         int busy_level;                 /*!< Level of active channels where we signal busy */
1308         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1309         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1310         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
1311         char mohinterpret[MAX_MUSICCLASS];/*!<  Music on Hold class */
1312         char mohsuggest[MAX_MUSICCLASS];/*!<  Music on Hold class */
1313         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
1314         struct ast_codec_pref prefs;    /*!<  codec prefs */
1315         int lastmsgssent;
1316         unsigned int sipoptions;        /*!<  Supported SIP options */
1317         struct ast_flags flags[2];      /*!<  SIP_ flags */
1318         
1319         /*! Mailboxes that this peer cares about */
1320         AST_LIST_HEAD_NOLOCK(, sip_mailbox) mailboxes;
1321
1322         /* things that don't belong in flags */
1323         char is_realtime;               /*!< this is a 'realtime' peer */
1324         char rt_fromcontact;            /*!< P: copy fromcontact from realtime */
1325         char host_dynamic;              /*!< P: Dynamic Peers register with Asterisk */
1326         char selfdestruct;              /*!< P: Automatic peers need to destruct themselves */
1327
1328         int expire;                     /*!<  When to expire this peer registration */
1329         int capability;                 /*!<  Codec capability */
1330         int rtptimeout;                 /*!<  RTP timeout */
1331         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1332         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1333         ast_group_t callgroup;          /*!<  Call group */
1334         ast_group_t pickupgroup;        /*!<  Pickup group */
1335         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this peer */
1336         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1337         struct sockaddr_in addr;        /*!<  IP address of peer */
1338         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1339         
1340         /* Qualification */
1341         struct sip_pvt *call;           /*!<  Call pointer */
1342         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
1343         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
1344         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
1345         struct timeval ps;              /*!<  Time for sending SIP OPTION in sip_pke_peer() */
1346         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
1347         struct ast_ha *ha;              /*!<  Access control list */
1348         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1349         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1350         int autoframing;
1351 };
1352
1353
1354 /*! \brief Registrations with other SIP proxies
1355  * Created by sip_register(), the entry is linked in the 'regl' list,
1356  * and never deleted (other than at 'sip reload' or module unload times).
1357  * The entry always has a pending timeout, either waiting for an ACK to
1358  * the REGISTER message (in which case we have to retransmit the request),
1359  * or waiting for the next REGISTER message to be sent (either the initial one,
1360  * or once the previously completed registration one expires).
1361  * The registration can be in one of many states, though at the moment
1362  * the handling is a bit mixed.
1363  * Note that the entire evolution of sip_registry (transmissions,
1364  * incoming packets and timeouts) is driven by one single thread,
1365  * do_monitor(), so there is almost no synchronization issue.
1366  * The only exception  is the sip_pvt creation/lookup,
1367  * as the dialoglist is also manipulated by other threads.
1368  */
1369 struct sip_registry {
1370         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1371         AST_DECLARE_STRING_FIELDS(
1372                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
1373                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1374                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1375                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1376                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1377                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1378                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
1379                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1380                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
1381                 AST_STRING_FIELD(secret);       /*!< Password in clear text */  
1382                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
1383                 AST_STRING_FIELD(callback);     /*!< Contact extension */
1384                 AST_STRING_FIELD(random);
1385         );
1386         int portno;                     /*!<  Optional port override */
1387         int expire;                     /*!< Sched ID of expiration */
1388         int expiry;                     /*!< Value to use for the Expires header */
1389         int regattempts;                /*!< Number of attempts (since the last success) */
1390         int timeout;                    /*!< sched id of sip_reg_timeout */
1391         int refresh;                    /*!< How often to refresh */
1392         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1393         enum sipregistrystate regstate; /*!< Registration state (see above) */
1394         struct timeval regtime;         /*!< Last successful registration time */
1395         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
1396         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
1397         struct sockaddr_in us;          /*!< Who the server thinks we are */
1398         int noncecount;                 /*!< Nonce-count */
1399         char lastmsg[256];              /*!< Last Message sent/received */
1400 };
1401
1402 /* --- Linked lists of various objects --------*/
1403
1404 /*! \brief  The user list: Users and friends */
1405 static struct ast_user_list {
1406         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1407 } userl;
1408
1409 /*! \brief  The peer list: Peers and Friends */
1410 static struct ast_peer_list {
1411         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1412 } peerl;
1413
1414 /*! \brief  The register list: Other SIP proxies we register with and place calls to */
1415 static struct ast_register_list {
1416         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1417         int recheck;
1418 } regl;
1419
1420 static int temp_pvt_init(void *);
1421 static void temp_pvt_cleanup(void *);
1422
1423 /*! \brief A per-thread temporary pvt structure */
1424 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1425
1426 /*! \brief Authentication list for realm authentication 
1427  * \todo Move the sip_auth list to AST_LIST */
1428 static struct sip_auth *authl = NULL;
1429
1430
1431 /* --- Sockets and networking --------------*/
1432
1433 /*! \brief Main socket for SIP communication.
1434  * sipsock is shared between the manager thread (which handles reload
1435  * requests), the io handler (sipsock_read()) and the user routines that
1436  * issue writes (using __sip_xmit()).
1437  * The socket is -1 only when opening fails (this is a permanent condition),
1438  * or when we are handling a reload() that changes its address (this is
1439  * a transient situation during which we might have a harmless race, see
1440  * below). Because the conditions for the race to be possible are extremely
1441  * rare, we don't want to pay the cost of locking on every I/O.
1442  * Rather, we remember that when the race may occur, communication is
1443  * bound to fail anyways, so we just live with this event and let
1444  * the protocol handle this above us.
1445  */
1446 static int sipsock  = -1;
1447
1448 static struct sockaddr_in bindaddr;     /*!< The address we bind to */
1449
1450 /*! \brief our (internal) default address/port to put in SIP/SDP messages
1451  *  internip is initialized picking a suitable address from one of the
1452  * interfaces, and the same port number we bind to. It is used as the
1453  * default address/port in SIP messages, and as the default address
1454  * (but not port) in SDP messages.
1455  */
1456 static struct sockaddr_in internip;
1457
1458 /*! \brief our external IP address/port for SIP sessions.
1459  * externip.sin_addr is only set when we know we might be behind
1460  * a NAT, and this is done using a variety of (mutually exclusive)
1461  * ways from the config file:
1462  *
1463  * + with "externip = host[:port]" we specify the address/port explicitly.
1464  *   The address is looked up only once when (re)loading the config file;
1465  * 
1466  * + with "externhost = host[:port]" we do a similar thing, but the
1467  *   hostname is stored in externhost, and the hostname->IP mapping
1468  *   is refreshed every 'externrefresh' seconds;
1469  * 
1470  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
1471  *   to the specified server, and store the result in externip.
1472  *
1473  * Other variables (externhost, externexpire, externrefresh) are used
1474  * to support the above functions.
1475  */
1476 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
1477
1478 static char externhost[MAXHOSTNAMELEN];         /*!< External host name */
1479 static time_t externexpire;                     /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1480 static int externrefresh = 10;
1481 static struct sockaddr_in stunaddr;             /*!< stun server address */
1482
1483 /*! \brief  List of local networks
1484  * We store "localnet" addresses from the config file into an access list,
1485  * marked as 'DENY', so the call to ast_apply_ha() will return
1486  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
1487  * (i.e. presumably public) addresses.
1488  */
1489 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
1490
1491 static struct sockaddr_in debugaddr;
1492
1493 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
1494
1495 /*---------------------------- Forward declarations of functions in chan_sip.c */
1496 /*! \note This is added to help splitting up chan_sip.c into several files
1497         in coming releases */
1498
1499 /*--- PBX interface functions */
1500 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1501 static int sip_devicestate(void *data);
1502 static int sip_sendtext(struct ast_channel *ast, const char *text);
1503 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1504 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
1505 static int sip_hangup(struct ast_channel *ast);
1506 static int sip_answer(struct ast_channel *ast);
1507 static struct ast_frame *sip_read(struct ast_channel *ast);
1508 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1509 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1510 static int sip_transfer(struct ast_channel *ast, const char *dest);
1511 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1512 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1513 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
1514
1515 /*--- Transmitting responses and requests */
1516 static int sipsock_read(int *id, int fd, short events, void *ignore);
1517 static int __sip_xmit(struct sip_pvt *p, char *data, int len);
1518 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod);
1519 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1520 static int retrans_pkt(const void *data);
1521 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1522 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);
1523 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1524 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1525 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1526 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1527 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1528 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);
1529 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1530 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1531 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1532 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1533 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1534 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version);
1535 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1536 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1537 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1538 static int transmit_refer(struct sip_pvt *p, const char *dest);
1539 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1540 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1541 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1542 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1543 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1544 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1545 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1546 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1547 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
1548
1549 /*--- Dialog management */
1550 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1551                                  int useglobal_nat, const int intended_method);
1552 static int __sip_autodestruct(const void *data);
1553 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1554 static void sip_cancel_destroy(struct sip_pvt *p);
1555 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
1556 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
1557 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1558 static void __sip_pretend_ack(struct sip_pvt *p);
1559 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1560 static int auto_congest(const void *arg);
1561 static int update_call_counter(struct sip_pvt *fup, int event);
1562 static int hangup_sip2cause(int cause);
1563 static const char *hangup_cause2sip(int cause);
1564 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1565 static void free_old_route(struct sip_route *route);
1566 static void list_route(struct sip_route *route);
1567 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1568 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1569                                               struct sip_request *req, char *uri);
1570 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1571 static void check_pendings(struct sip_pvt *p);
1572 static void *sip_park_thread(void *stuff);
1573 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1574 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1575
1576 /*--- Codec handling / SDP */
1577 static void try_suggested_sip_codec(struct sip_pvt *p);
1578 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1579 static const char *get_sdp(struct sip_request *req, const char *name);
1580 static int find_sdp(struct sip_request *req);
1581 static int process_sdp(struct sip_pvt *p, struct sip_request *req);
1582 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1583                              struct ast_str **m_buf, struct ast_str **a_buf,
1584                              int debug, int *min_packet_size);
1585 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1586                                 struct ast_str **m_buf, struct ast_str **a_buf,
1587                                 int debug);
1588 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p);
1589 static void do_setnat(struct sip_pvt *p, int natflags);
1590 static void stop_media_flows(struct sip_pvt *p);
1591
1592 /*--- Authentication stuff */
1593 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1594 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1595 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1596                                          const char *secret, const char *md5secret, int sipmethod,
1597                                          char *uri, enum xmittype reliable, int ignore);
1598 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1599                                               int sipmethod, char *uri, enum xmittype reliable,
1600                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1601 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1602
1603 /*--- Domain handling */
1604 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1605 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1606 static void clear_sip_domains(void);
1607
1608 /*--- SIP realm authentication */
1609 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, const char *configuration, int lineno);
1610 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1611 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1612
1613 /*--- Misc functions */
1614 static int sip_do_reload(enum channelreloadreason reason);
1615 static int reload_config(enum channelreloadreason reason);
1616 static int expire_register(const void *data);
1617 static void *do_monitor(void *data);
1618 static int restart_monitor(void);
1619 static int sip_addrcmp(char *name, struct sockaddr_in *sin);    /* Support for peer matching */
1620 static int sip_refer_allocate(struct sip_pvt *p);
1621 static void ast_quiet_chan(struct ast_channel *chan);
1622 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1623
1624 /*--- Device monitoring and Device/extension state/event handling */
1625 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1626 static int sip_devicestate(void *data);
1627 static int sip_poke_noanswer(const void *data);
1628 static int sip_poke_peer(struct sip_peer *peer);
1629 static void sip_poke_all_peers(void);
1630 static void sip_peer_hold(struct sip_pvt *p, int hold);
1631 static void mwi_event_cb(const struct ast_event *, void *);
1632
1633 /*--- Applications, functions, CLI and manager command helpers */
1634 static const char *sip_nat_mode(const struct sip_pvt *p);
1635 static char *sip_show_inuse(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1636 static char *transfermode2str(enum transfermodes mode) attribute_const;
1637 static const char *nat2str(int nat) attribute_const;
1638 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1639 static char *sip_show_users(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1640 static char * _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1641 static char *sip_show_peers(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1642 static char *sip_show_objects(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1643 static void  print_group(int fd, ast_group_t group, int crlf);
1644 static const char *dtmfmode2str(int mode) attribute_const;
1645 static int str2dtmfmode(const char *str) attribute_unused;
1646 static const char *insecure2str(int mode) attribute_const;
1647 static void cleanup_stale_contexts(char *new, char *old);
1648 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1649 static const char *domain_mode_to_text(const enum domain_mode mode);
1650 static char *sip_show_domains(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1651 static char *_sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1652 static char *sip_show_peer(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1653 static char *sip_show_user(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1654 static char *sip_show_registry(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1655 static char *sip_unregister(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1656 static char *sip_show_settings(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1657 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1658 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1659 static char *complete_sip_peer(const char *word, int state, int flags2);
1660 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1661 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1662 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1663 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1664 static char *complete_sip_user(const char *word, int state, int flags2);
1665 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1666 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1667 static char *sip_show_channel(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1668 static char *sip_show_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1669 static char *sip_do_debug_ip(int fd, char *arg);
1670 static char *sip_do_debug_peer(int fd, char *arg);
1671 static char *sip_do_debug(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1672 static char *sip_notify(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1673 static char *sip_do_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1674 static char *sip_no_history(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1675 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1676 static int sip_addheader(struct ast_channel *chan, void *data);
1677 static int sip_do_reload(enum channelreloadreason reason);
1678 static char *sip_reload(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1679 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
1680
1681 /*--- Debugging 
1682         Functions for enabling debug per IP or fully, or enabling history logging for
1683         a SIP dialog
1684 */
1685 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to LOG_DEBUG at end of dialog, before destroying data */
1686 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1687 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1688 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1689 static void sip_dump_history(struct sip_pvt *dialog);
1690
1691 /*--- Device object handling */
1692 static struct sip_peer *temp_peer(const char *name);
1693 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1694 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
1695 static int update_call_counter(struct sip_pvt *fup, int event);
1696 static void sip_destroy_peer(struct sip_peer *peer);
1697 static void sip_destroy_user(struct sip_user *user);
1698 static int sip_poke_peer(struct sip_peer *peer);
1699 static void set_peer_defaults(struct sip_peer *peer);
1700 static struct sip_peer *temp_peer(const char *name);
1701 static void register_peer_exten(struct sip_peer *peer, int onoff);
1702 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1703 static struct sip_user *find_user(const char *name, int realtime);
1704 static int sip_poke_peer_s(const void *data);
1705 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1706 static void reg_source_db(struct sip_peer *peer);
1707 static void destroy_association(struct sip_peer *peer);
1708 static void set_insecure_flags(struct ast_flags *flags, const char *value, int lineno);
1709 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1710
1711 /* Realtime device support */
1712 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey);
1713 static struct sip_user *realtime_user(const char *username);
1714 static void update_peer(struct sip_peer *p, int expiry);
1715 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config);
1716 static const char *get_name_from_variable(struct ast_variable *var, const char *newpeername);
1717 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1718 static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);
1719
1720 /*--- Internal UA client handling (outbound registrations) */
1721 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us);
1722 static void sip_registry_destroy(struct sip_registry *reg);
1723 static int sip_register(const char *value, int lineno);
1724 static const char *regstate2str(enum sipregistrystate regstate) attribute_const;
1725 static int sip_reregister(const void *data);
1726 static int __sip_do_register(struct sip_registry *r);
1727 static int sip_reg_timeout(const void *data);
1728 static void sip_send_all_registers(void);
1729
1730 /*--- Parsing SIP requests and responses */
1731 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1732 static int determine_firstline_parts(struct sip_request *req);
1733 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1734 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1735 static int find_sip_method(const char *msg);
1736 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1737 static void parse_request(struct sip_request *req);
1738 static const char *get_header(const struct sip_request *req, const char *name);
1739 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1740 static int method_match(enum sipmethod id, const char *name);
1741 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1742 static char *get_in_brackets(char *tmp);
1743 static const char *find_alias(const char *name, const char *_default);
1744 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1745 static int lws2sws(char *msgbuf, int len);
1746 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1747 static char *remove_uri_parameters(char *uri);
1748 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1749 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1750 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1751 static int set_address_from_contact(struct sip_pvt *pvt);
1752 static void check_via(struct sip_pvt *p, struct sip_request *req);
1753 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1754 static int get_rpid_num(const char *input, char *output, int maxlen);
1755 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1756 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1757 static int get_msg_text(char *buf, int len, struct sip_request *req);
1758 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1759
1760 /*--- Constructing requests and responses */
1761 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1762 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1763 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1764 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1765 static int init_resp(struct sip_request *resp, const char *msg);
1766 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1767 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1768 static void build_via(struct sip_pvt *p);
1769 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1770 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1771 static char *generate_random_string(char *buf, size_t size);
1772 static void build_callid_pvt(struct sip_pvt *pvt);
1773 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1774 static void make_our_tag(char *tagbuf, size_t len);
1775 static int add_header(struct sip_request *req, const char *var, const char *value);
1776 static int add_header_contentLength(struct sip_request *req, int len);
1777 static int add_line(struct sip_request *req, const char *line);
1778 static int add_text(struct sip_request *req, const char *text);
1779 static int add_digit(struct sip_request *req, char digit, unsigned int duration, int mode);
1780 static int add_vidupdate(struct sip_request *req);
1781 static void add_route(struct sip_request *req, struct sip_route *route);
1782 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1783 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1784 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1785 static void set_destination(struct sip_pvt *p, char *uri);
1786 static void append_date(struct sip_request *req);
1787 static void build_contact(struct sip_pvt *p);
1788 static void build_rpid(struct sip_pvt *p);
1789
1790 /*------Request handling functions */
1791 static int handle_incoming(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1792 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);
1793 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1794 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1795 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1796 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1797 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1798 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1799 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1800 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1801 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin);
1802 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1803 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1804
1805 /*------Response handling functions */
1806 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1807 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1808 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1809 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1810
1811 /*----- RTP interface functions */
1812 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);
1813 static enum ast_rtp_get_result sip_get_rtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1814 static enum ast_rtp_get_result sip_get_vrtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1815 static enum ast_rtp_get_result sip_get_trtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1816 static int sip_get_codec(struct ast_channel *chan);
1817 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
1818
1819 /*------ T38 Support --------- */
1820 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); 
1821 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1822 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1823 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1824
1825 /*! \brief Definition of this channel for PBX channel registration */
1826 static const struct ast_channel_tech sip_tech = {
1827         .type = "SIP",
1828         .description = "Session Initiation Protocol (SIP)",
1829         .capabilities = AST_FORMAT_AUDIO_MASK,  /* all audio formats */
1830         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1831         .requester = sip_request_call,                  /* called with chan unlocked */
1832         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1833         .call = sip_call,                       /* called with chan locked */
1834         .send_html = sip_sendhtml,
1835         .hangup = sip_hangup,                   /* called with chan locked */
1836         .answer = sip_answer,                   /* called with chan locked */
1837         .read = sip_read,                       /* called with chan locked */
1838         .write = sip_write,                     /* called with chan locked */
1839         .write_video = sip_write,               /* called with chan locked */
1840         .write_text = sip_write,
1841         .indicate = sip_indicate,               /* called with chan locked */
1842         .transfer = sip_transfer,               /* called with chan locked */
1843         .fixup = sip_fixup,                     /* called with chan locked */
1844         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1845         .send_digit_end = sip_senddigit_end,
1846         .bridge = ast_rtp_bridge,                       /* XXX chan unlocked ? */
1847         .early_bridge = ast_rtp_early_bridge,
1848         .send_text = sip_sendtext,              /* called with chan locked */
1849         .func_channel_read = acf_channel_read,
1850 };
1851
1852 /*! \brief This version of the sip channel tech has no send_digit_begin
1853  * callback so that the core knows that the channel does not want
1854  * DTMF BEGIN frames.
1855  * The struct is initialized just before registering the channel driver,
1856  * and is for use with channels using SIP INFO DTMF.
1857  */
1858 static struct ast_channel_tech sip_tech_info;
1859
1860 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
1861 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
1862
1863 /*! \brief map from an integer value to a string.
1864  * If no match is found, return errorstring
1865  */
1866 static const char *map_x_s(const struct _map_x_s *table, int x, const char *errorstring)
1867 {
1868         const struct _map_x_s *cur;
1869
1870         for (cur = table; cur->s; cur++)
1871                 if (cur->x == x)
1872                         return cur->s;
1873         return errorstring;
1874 }
1875
1876 /*! \brief map from a string to an integer value, case insensitive.
1877  * If no match is found, return errorvalue.
1878  */
1879 static int map_s_x(const struct _map_x_s *table, const char *s, int errorvalue)
1880 {
1881         const struct _map_x_s *cur;
1882
1883         for (cur = table; cur->s; cur++)
1884                 if (!strcasecmp(cur->s, s))
1885                         return cur->x;
1886         return errorvalue;
1887 }
1888
1889 /**--- some list management macros. **/
1890  
1891 #define UNLINK(element, head, prev) do {        \
1892         if (prev)                               \
1893                 (prev)->next = (element)->next; \
1894         else                                    \
1895                 (head) = (element)->next;       \
1896         } while (0)
1897
1898 /*! \brief Interface structure with callbacks used to connect to RTP module */
1899 static struct ast_rtp_protocol sip_rtp = {
1900         .type = "SIP",
1901         .get_rtp_info = sip_get_rtp_peer,
1902         .get_vrtp_info = sip_get_vrtp_peer,
1903         .get_trtp_info = sip_get_trtp_peer,
1904         .set_rtp_peer = sip_set_rtp_peer,
1905         .get_codec = sip_get_codec,
1906 };
1907
1908 #define sip_pvt_lock(x) ast_mutex_lock(&x->pvt_lock)
1909 #define sip_pvt_unlock(x) ast_mutex_unlock(&x->pvt_lock)
1910
1911 /*!
1912  * helper functions to unreference various types of objects.
1913  * By handling them this way, we don't have to declare the
1914  * destructor on each call, which removes the chance of errors.
1915  */
1916 static void unref_peer(struct sip_peer *peer)
1917 {
1918         ASTOBJ_UNREF(peer, sip_destroy_peer);
1919 }
1920
1921 static void unref_user(struct sip_user *user)
1922 {
1923         ASTOBJ_UNREF(user, sip_destroy_user);
1924 }
1925
1926 static void *registry_unref(struct sip_registry *reg)
1927 {
1928         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
1929         ASTOBJ_UNREF(reg, sip_registry_destroy);
1930         return NULL;
1931 }
1932
1933 /*! \brief Add object reference to SIP registry */
1934 static struct sip_registry *registry_addref(struct sip_registry *reg)
1935 {
1936         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
1937         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
1938 }
1939
1940 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
1941 static struct ast_udptl_protocol sip_udptl = {
1942         type: "SIP",
1943         get_udptl_info: sip_get_udptl_peer,
1944         set_udptl_peer: sip_set_udptl_peer,
1945 };
1946
1947 /*! \brief Append to SIP dialog history 
1948         \return Always returns 0 */
1949 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1950
1951 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1952         __attribute__ ((format (printf, 2, 3)));
1953
1954
1955 /*! \brief Convert transfer status to string */
1956 static const char *referstatus2str(enum referstatus rstatus)
1957 {
1958         return map_x_s(referstatusstrings, rstatus, "");
1959 }
1960
1961 /*! \brief Initialize the initital request packet in the pvt structure.
1962         This packet is used for creating replies and future requests in
1963         a dialog */
1964 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1965 {
1966         if (p->initreq.headers)
1967                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
1968         else
1969                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
1970         /* Use this as the basis */
1971         copy_request(&p->initreq, req);
1972         parse_request(&p->initreq);
1973         if (req->debug)
1974                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1975 }
1976
1977 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
1978 static void sip_alreadygone(struct sip_pvt *dialog)
1979 {
1980         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
1981         dialog->alreadygone = 1;
1982 }
1983
1984 /*! Resolve DNS srv name or host name in a sip_proxy structure */
1985 static int proxy_update(struct sip_proxy *proxy)
1986 {
1987         /* if it's actually an IP address and not a name,
1988            there's no need for a managed lookup */
1989         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
1990                 /* Ok, not an IP address, then let's check if it's a domain or host */
1991                 /* XXX Todo - if we have proxy port, don't do SRV */
1992                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, global_srvlookup ? "_sip._udp" : NULL) < 0) {
1993                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
1994                         return FALSE;
1995                 }
1996         }
1997         proxy->last_dnsupdate = time(NULL);
1998         return TRUE;
1999 }
2000
2001 /*! \brief Allocate and initialize sip proxy */
2002 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
2003 {
2004         struct sip_proxy *proxy;
2005         proxy = ast_calloc(1, sizeof(*proxy));
2006         if (!proxy)
2007                 return NULL;
2008         proxy->force = force;
2009         ast_copy_string(proxy->name, name, sizeof(proxy->name));
2010         proxy->ip.sin_port = htons((!ast_strlen_zero(port) ? atoi(port) : STANDARD_SIP_PORT));
2011         proxy_update(proxy);
2012         return proxy;
2013 }
2014
2015 /*! \brief Get default outbound proxy or global proxy */
2016 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
2017 {
2018         if (peer && peer->outboundproxy) {
2019                 if (sipdebug)
2020                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
2021                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
2022                 return peer->outboundproxy;
2023         }
2024         if (global_outboundproxy.name[0]) {
2025                 if (sipdebug)
2026                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
2027                 append_history(dialog, "OBproxy", "Using global obproxy %s", global_outboundproxy.name);
2028                 return &global_outboundproxy;
2029         }
2030         if (sipdebug)
2031                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
2032         return NULL;
2033 }
2034
2035 /*! \brief returns true if 'name' (with optional trailing whitespace)
2036  * matches the sip method 'id'.
2037  * Strictly speaking, SIP methods are case SENSITIVE, but we do
2038  * a case-insensitive comparison to be more tolerant.
2039  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
2040  */
2041 static int method_match(enum sipmethod id, const char *name)
2042 {
2043         int len = strlen(sip_methods[id].text);
2044         int l_name = name ? strlen(name) : 0;
2045         /* true if the string is long enough, and ends with whitespace, and matches */
2046         return (l_name >= len && name[len] < 33 &&
2047                 !strncasecmp(sip_methods[id].text, name, len));
2048 }
2049
2050 /*! \brief  find_sip_method: Find SIP method from header */
2051 static int find_sip_method(const char *msg)
2052 {
2053         int i, res = 0;
2054         
2055         if (ast_strlen_zero(msg))
2056                 return 0;
2057         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
2058                 if (method_match(i, msg))
2059                         res = sip_methods[i].id;
2060         }
2061         return res;
2062 }
2063
2064 /*! \brief Parse supported header in incoming packet */
2065 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
2066 {
2067         char *next, *sep;
2068         char *temp;
2069         unsigned int profile = 0;
2070         int i, found;
2071
2072         if (ast_strlen_zero(supported) )
2073                 return 0;
2074         temp = ast_strdupa(supported);
2075
2076         if (sipdebug)
2077                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
2078
2079         for (next = temp; next; next = sep) {
2080                 found = FALSE;
2081                 if ( (sep = strchr(next, ',')) != NULL)
2082                         *sep++ = '\0';
2083                 next = ast_skip_blanks(next);
2084                 if (sipdebug)
2085                         ast_debug(3, "Found SIP option: -%s-\n", next);
2086                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
2087                         if (!strcasecmp(next, sip_options[i].text)) {
2088                                 profile |= sip_options[i].id;
2089                                 found = TRUE;
2090                                 if (sipdebug)
2091                                         ast_debug(3, "Matched SIP option: %s\n", next);
2092                                 break;
2093                         }
2094                 }
2095                 if (!found && sipdebug) {
2096                         if (!strncasecmp(next, "x-", 2))
2097                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
2098                         else
2099                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
2100                 }
2101         }
2102
2103         if (pvt)
2104                 pvt->sipoptions = profile;
2105         return profile;
2106 }
2107
2108 /*! \brief See if we pass debug IP filter */
2109 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
2110 {
2111         if (!sipdebug)
2112                 return 0;
2113         if (debugaddr.sin_addr.s_addr) {
2114                 if (((ntohs(debugaddr.sin_port) != 0)
2115                         && (debugaddr.sin_port != addr->sin_port))
2116                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
2117                         return 0;
2118         }
2119         return 1;
2120 }
2121
2122 /*! \brief The real destination address for a write */
2123 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
2124 {
2125         if (p->outboundproxy)
2126                 return &p->outboundproxy->ip;
2127
2128         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
2129 }
2130
2131 /*! \brief Display SIP nat mode */
2132 static const char *sip_nat_mode(const struct sip_pvt *p)
2133 {
2134         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
2135 }
2136
2137 /*! \brief Test PVT for debugging output */
2138 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
2139 {
2140         if (!sipdebug)
2141                 return 0;
2142         return sip_debug_test_addr(sip_real_dst(p));
2143 }
2144
2145 /*! \brief Transmit SIP message */
2146 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
2147 {
2148         int res;
2149         const struct sockaddr_in *dst = sip_real_dst(p);
2150         res = sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
2151
2152         if (res == -1) {
2153                 switch (errno) {
2154                         case EBADF:             /* Bad file descriptor - seems like this is generated when the host exist, but doesn't accept the UDP packet */
2155                         case EHOSTUNREACH:      /* Host can't be reached */
2156                         case ENETDOWN:          /* Interface down */
2157                         case ENETUNREACH:       /* Network failure */
2158                                 res = XMIT_ERROR;       /* Don't bother with trying to transmit again */
2159                 }
2160         }
2161         if (res != len)
2162                 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));
2163         return res;
2164 }
2165
2166
2167 /*! \brief Build a Via header for a request */
2168 static void build_via(struct sip_pvt *p)
2169 {
2170         /* Work around buggy UNIDEN UIP200 firmware */
2171         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
2172
2173         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
2174         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
2175                         ast_inet_ntoa(p->ourip.sin_addr),
2176                         ntohs(p->ourip.sin_port), p->branch, rport);
2177 }
2178
2179 /*! \brief NAT fix - decide which IP address to use for Asterisk server?
2180  *
2181  * Using the localaddr structure built up with localnet statements in sip.conf
2182  * apply it to their address to see if we need to substitute our
2183  * externip or can get away with our internal bindaddr
2184  * 'us' is always overwritten.
2185  */
2186 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us)
2187 {
2188         struct sockaddr_in theirs;
2189         /* Set want_remap to non-zero if we want to remap 'us' to an externally
2190          * reachable IP address and port. This is done if:
2191          * 1. we have a localaddr list (containing 'internal' addresses marked
2192          *    as 'deny', so ast_apply_ha() will return AST_SENSE_DENY on them,
2193          *    and AST_SENSE_ALLOW on 'external' ones);
2194          * 2. either stunaddr or externip is set, so we know what to use as the
2195          *    externally visible address;
2196          * 3. the remote address, 'them', is external;
2197          * 4. the address returned by ast_ouraddrfor() is 'internal' (AST_SENSE_DENY
2198          *    when passed to ast_apply_ha() so it does need to be remapped.
2199          *    This fourth condition is checked later.
2200          */
2201         int want_remap = localaddr &&
2202                 (externip.sin_addr.s_addr || stunaddr.sin_addr.s_addr) &&
2203                 ast_apply_ha(localaddr, &theirs) == AST_SENSE_ALLOW ;
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         if (want_remap &&
2211             (!global_matchexterniplocally || !ast_apply_ha(localaddr, us)) ) {
2212                 /* if we used externhost or stun, see if it is time to refresh the info */
2213                 if (externexpire && time(NULL) >= externexpire) {
2214                         if (stunaddr.sin_addr.s_addr) {
2215                                 ast_stun_request(sipsock, &stunaddr, NULL, &externip);
2216                         } else {
2217                                 if (ast_parse_arg(externhost, PARSE_INADDR, &externip))
2218                                         ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
2219                         }
2220                         externexpire = time(NULL) + externrefresh;
2221                 }
2222                 if (externip.sin_addr.s_addr)
2223                         *us = externip;
2224                 else
2225                         ast_log(LOG_WARNING, "stun failed\n");
2226                 ast_debug(1, "Target address %s is not local, substituting externip\n", 
2227                         ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
2228         } else if (bindaddr.sin_addr.s_addr) {
2229                 /* no remapping, but we bind to a specific address, so use it. */
2230                 *us = bindaddr;
2231         }
2232 }
2233
2234 /*! \brief Append to SIP dialog history with arg list  */
2235 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
2236 {
2237         char buf[80], *c = buf; /* max history length */
2238         struct sip_history *hist;
2239         int l;
2240
2241         vsnprintf(buf, sizeof(buf), fmt, ap);
2242         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
2243         l = strlen(buf) + 1;
2244         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
2245                 return;
2246         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
2247                 ast_free(hist);
2248                 return;
2249         }
2250         memcpy(hist->event, buf, l);
2251         if (p->history_entries == MAX_HISTORY_ENTRIES) {
2252                 struct sip_history *oldest;
2253                 oldest = AST_LIST_REMOVE_HEAD(p->history, list);
2254                 p->history_entries--;
2255                 ast_free(oldest);
2256         }
2257         AST_LIST_INSERT_TAIL(p->history, hist, list);
2258         p->history_entries++;
2259 }
2260
2261 /*! \brief Append to SIP dialog history with arg list  */
2262 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2263 {
2264         va_list ap;
2265
2266         if (!p)
2267                 return;
2268
2269         if (!p->do_history && !recordhistory && !dumphistory)
2270                 return;
2271
2272         va_start(ap, fmt);
2273         append_history_va(p, fmt, ap);
2274         va_end(ap);
2275
2276         return;
2277 }
2278
2279 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
2280 static int retrans_pkt(const void *data)
2281 {
2282         struct sip_pkt *pkt = (struct sip_pkt *)data, *prev, *cur = NULL;
2283         int reschedule = DEFAULT_RETRANS;
2284         int xmitres = 0;
2285
2286         /* Lock channel PVT */
2287         sip_pvt_lock(pkt->owner);
2288
2289         if (pkt->retrans < MAX_RETRANS) {
2290                 pkt->retrans++;
2291                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
2292                         if (sipdebug)
2293                                 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);
2294                 } else {
2295                         int siptimer_a;
2296
2297                         if (sipdebug)
2298                                 ast_debug(4, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
2299                         if (!pkt->timer_a)
2300                                 pkt->timer_a = 2 ;
2301                         else
2302                                 pkt->timer_a = 2 * pkt->timer_a;
2303  
2304                         /* For non-invites, a maximum of 4 secs */
2305                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
2306                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
2307                                 siptimer_a = 4000;
2308                 
2309                         /* Reschedule re-transmit */
2310                         reschedule = siptimer_a;
2311                         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);
2312                 } 
2313
2314                 if (sip_debug_test_pvt(pkt->owner)) {
2315                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
2316                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
2317                                 pkt->retrans, sip_nat_mode(pkt->owner),
2318                                 ast_inet_ntoa(dst->sin_addr),
2319                                 ntohs(dst->sin_port), pkt->data);
2320                 }
2321
2322                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
2323                 xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
2324                 sip_pvt_unlock(pkt->owner);
2325                 if (xmitres == XMIT_ERROR)
2326                         ast_log(LOG_WARNING, "Network error on retransmit in dialog %s\n", pkt->owner->callid);
2327                 else 
2328                         return  reschedule;
2329         } 
2330         /* Too many retries */
2331         if (pkt->owner && pkt->method != SIP_OPTIONS && xmitres == 0) {
2332                 if (pkt->is_fatal || sipdebug)  /* Tell us if it's critical or if we're debugging */
2333                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s)\n",
2334                                 pkt->owner->callid, pkt->seqno,
2335                                 pkt->is_fatal ? "Critical" : "Non-critical", pkt->is_resp ? "Response" : "Request");
2336         } else if (pkt->method == SIP_OPTIONS && sipdebug) {
2337                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
2338
2339         } 
2340         if (xmitres == XMIT_ERROR) {
2341                 ast_log(LOG_WARNING, "Transmit error :: Cancelling transmission on Call ID %s\n", pkt->owner->callid);
2342                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2343         } else 
2344                 append_history(pkt->owner, "MaxRetries", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2345                 
2346         pkt->retransid = -1;
2347
2348         if (pkt->is_fatal) {
2349                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
2350                         sip_pvt_unlock(pkt->owner);     /* SIP_PVT, not channel */
2351                         usleep(1);
2352                         sip_pvt_lock(pkt->owner);
2353                 }
2354
2355                 if (pkt->owner->owner && !pkt->owner->owner->hangupcause) 
2356                         pkt->owner->owner->hangupcause = AST_CAUSE_NO_USER_RESPONSE;
2357                 
2358                 if (pkt->owner->owner) {
2359                         sip_alreadygone(pkt->owner);
2360                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
2361                         ast_queue_hangup(pkt->owner->owner);
2362                         ast_channel_unlock(pkt->owner->owner);
2363                 } else {
2364                         /* If no channel owner, destroy now */
2365
2366                         /* Let the peerpoke system expire packets when the timer expires for poke_noanswer */
2367                         if (pkt->method != SIP_OPTIONS && pkt->method != SIP_REGISTER) {
2368                                 pkt->owner->needdestroy = 1;
2369                                 sip_alreadygone(pkt->owner);
2370                                 append_history(pkt->owner, "DialogKill", "Killing this failed dialog immediately");
2371                         }
2372                 }
2373         }
2374
2375         if (pkt->method == SIP_BYE) {
2376                 /* We're not getting answers on SIP BYE's.  Tear down the call anyway. */
2377                 if (pkt->owner->owner) 
2378                         ast_channel_unlock(pkt->owner->owner);
2379                 append_history(pkt->owner, "ByeFailure", "Remote peer doesn't respond to bye. Destroying call anyway.");
2380                 pkt->owner->needdestroy = 1;
2381         }
2382
2383         /* Remove the packet */
2384         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
2385                 if (cur == pkt) {
2386                         UNLINK(cur, pkt->owner->packets, prev);
2387                         sip_pvt_unlock(pkt->owner);
2388                         ast_free(pkt);
2389                         return 0;
2390                 }
2391         }
2392         /* error case */
2393         ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
2394         sip_pvt_unlock(pkt->owner);
2395         return 0;
2396 }
2397
2398 /*! \brief Transmit packet with retransmits 
2399         \return 0 on success, -1 on failure to allocate packet 
2400 */
2401 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
2402 {
2403         struct sip_pkt *pkt;
2404         int siptimer_a = DEFAULT_RETRANS;
2405         int xmitres = 0;
2406
2407         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
2408                 return AST_FAILURE;
2409         /* copy data, add a terminator and save length */
2410         memcpy(pkt->data, data, len);
2411         pkt->data[len] = '\0';
2412         pkt->packetlen = len;
2413         /* copy other parameters from the caller */
2414         pkt->method = sipmethod;
2415         pkt->seqno = seqno;
2416         pkt->is_resp = resp;
2417         pkt->is_fatal = fatal;
2418         pkt->owner = dialog_ref(p);
2419         pkt->next = p->packets;
2420         p->packets = pkt;
2421         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
2422         if (pkt->timer_t1)
2423                 siptimer_a = pkt->timer_t1 * 2;
2424
2425         /* Schedule retransmission */
2426         pkt->retransid = ast_sched_replace_variable(pkt->retransid, sched, 
2427                 siptimer_a, retrans_pkt, pkt, 1);
2428         if (sipdebug)
2429                 ast_debug(4, "*** SIP TIMER: Initializing retransmit timer on packet: Id  #%d\n", pkt->retransid);
2430         if (sipmethod == SIP_INVITE) {
2431                 /* Note this is a pending invite */
2432                 p->pendinginvite = seqno;
2433         }
2434
2435         xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);    /* Send packet */
2436
2437         if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2438                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2439                 ast_sched_del(sched, pkt->retransid);   /* No more retransmission */
2440                 pkt->retransid = -1;
2441                 return AST_FAILURE;
2442         } else
2443                 return AST_SUCCESS;
2444 }
2445
2446 /*! \brief Kill a SIP dialog (called only by the scheduler)
2447  * The scheduler has a reference to this dialog when p->autokillid != -1,
2448  * and we are called using that reference. So if the event is not
2449  * rescheduled, we need to call dialog_unref().
2450  */
2451 static int __sip_autodestruct(const void *data)
2452 {
2453         struct sip_pvt *p = (struct sip_pvt *)data;
2454
2455         /* If this is a subscription, tell the phone that we got a timeout */
2456         if (p->subscribed) {
2457                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1, TRUE);   /* Send last notification */
2458                 p->subscribed = NONE;
2459                 append_history(p, "Subscribestatus", "timeout");
2460                 ast_debug(3, "Re-scheduled destruction of SIP subscription %s\n", p->callid ? p->callid : "<unknown>");
2461                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
2462         }
2463
2464         /* If there are packets still waiting for delivery, delay the destruction */
2465         if (p->packets) {
2466                 if (option_debug > 2)
2467                         ast_log(LOG_DEBUG, "Re-scheduled destruction of SIP call %s\n", p->callid ? p->callid : "<unknown>");
2468                 append_history(p, "ReliableXmit", "timeout");
2469                 return 10000;
2470         }
2471
2472         if (p->subscribed == MWI_NOTIFICATION)
2473                 if (p->relatedpeer)
2474                         unref_peer(p->relatedpeer);     /* Remove link to peer. If it's realtime, make sure it's gone from memory) */
2475
2476         /* Reset schedule ID */
2477         p->autokillid = -1;
2478
2479         if (p->owner) {
2480                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
2481                 ast_queue_hangup(p->owner);
2482                 dialog_unref(p);
2483         } else if (p->refer) {
2484                 ast_debug(3, "Finally hanging up channel after transfer: %s\n", p->callid);
2485                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2486                 append_history(p, "ReferBYE", "Sending BYE on transferer call leg %s", p->callid);
2487                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
2488                 dialog_unref(p);
2489         } else {
2490                 append_history(p, "AutoDestroy", "%s", p->callid);
2491                 ast_debug(3, "Auto destroying SIP dialog '%s'\n", p->callid);
2492                 sip_destroy(p);         /* Go ahead and destroy dialog. All attempts to recover is done */
2493                 /* sip_destroy also absorbs the reference */
2494         }
2495         return 0;
2496 }
2497
2498 /*! \brief Schedule destruction of SIP dialog */
2499 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2500 {
2501         if (ms < 0) {
2502                 if (p->timer_t1 == 0)
2503                         p->timer_t1 = SIP_TIMER_T1;     /* Set timer T1 if not set (RFC 3261) */
2504                 ms = p->timer_t1 * 64;
2505         }
2506         if (sip_debug_test_pvt(p))
2507                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2508         sip_cancel_destroy(p);
2509         if (p->do_history)
2510                 append_history(p, "SchedDestroy", "%d ms", ms);
2511         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, dialog_ref(p));
2512 }
2513
2514 /*! \brief Cancel destruction of SIP dialog.
2515  * Be careful as this also absorbs the reference - if you call it
2516  * from within the scheduler, this might be the last reference.
2517  */
2518 static void sip_cancel_destroy(struct sip_pvt *p)
2519 {
2520         if (p->autokillid > -1) {
2521                 ast_sched_del(sched, p->autokillid);
2522                 append_history(p, "CancelDestroy", "");
2523                 p->autokillid = -1;
2524                 dialog_unref(p);
2525         }
2526 }
2527
2528 /*! \brief Acknowledges receipt of a packet and stops retransmission */
2529 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2530 {
2531         struct sip_pkt *cur, *prev = NULL;
2532         const char *msg = "Not Found";  /* used only for debugging */
2533
2534         sip_pvt_lock(p);
2535
2536         /* If we have an outbound proxy for this dialog, then delete it now since
2537           the rest of the requests in this dialog needs to follow the routing.
2538           If obforcing is set, we will keep the outbound proxy during the whole
2539           dialog, regardless of what the SIP rfc says
2540         */
2541         if (p->outboundproxy && !p->outboundproxy->force)
2542                 p->outboundproxy = NULL;
2543
2544         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2545                 if (cur->seqno != seqno || cur->is_resp != resp)
2546                         continue;
2547                 if (cur->is_resp || cur->method == sipmethod) {
2548                         msg = "Found";
2549                         if (!resp && (seqno == p->pendinginvite)) {
2550                                 ast_debug(1, "Acked pending invite %d\n", p->pendinginvite);
2551                                 p->pendinginvite = 0;
2552                         }
2553                         if (cur->retransid > -1) {
2554                                 if (sipdebug)
2555                                         ast_debug(4, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2556                                 ast_sched_del(sched, cur->retransid);
2557                                 cur->retransid = -1;
2558                         }
2559                         UNLINK(cur, p->packets, prev);
2560                         dialog_unref(cur->owner);
2561                         ast_free(cur);
2562                         break;
2563                 }
2564         }
2565         sip_pvt_unlock(p);
2566         ast_debug(1, "Stopping retransmission on '%s' of %s %d: Match %s\n",
2567                 p->callid, resp ? "Response" : "Request", seqno, msg);
2568 }
2569
2570 /*! \brief Pretend to ack all packets
2571  * maybe the lock on p is not strictly necessary but there might be a race */
2572 static void __sip_pretend_ack(struct sip_pvt *p)
2573 {
2574         struct sip_pkt *cur = NULL;
2575
2576         while (p->packets) {
2577                 int method;
2578                 if (cur == p->packets) {
2579                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2580                         return;
2581                 }
2582                 cur = p->packets;
2583                 method = (cur->method) ? cur->method : find_sip_method(cur->data);
2584                 __sip_ack(p, cur->seqno, cur->is_resp, method);
2585         }
2586 }
2587
2588 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2589 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2590 {
2591         struct sip_pkt *cur;
2592         int res = -1;
2593
2594         for (cur = p->packets; cur; cur = cur->next) {
2595                 if (cur->seqno == seqno && cur->is_resp == resp &&
2596                         (cur->is_resp || method_match(sipmethod, cur->data))) {
2597                         /* this is our baby */
2598                         if (cur->retransid > -1) {
2599                                 if (sipdebug)
2600                                         ast_debug(4, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2601                                 ast_sched_del(sched, cur->retransid);
2602                                 cur->retransid = -1;
2603                         }
2604                         res = 0;
2605                         break;
2606                 }
2607         }
2608         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");
2609         return res;
2610 }
2611
2612
2613 /*! \brief Copy SIP request, parse it */
2614 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2615 {
2616         memset(dst, 0, sizeof(*dst));
2617         memcpy(dst->data, src->data, sizeof(dst->data));
2618         dst->len = src->len;
2619         parse_request(dst);
2620 }
2621
2622 /*! \brief add a blank line if no body */
2623 static void add_blank(struct sip_request *req)
2624 {
2625         if (!req->lines) {
2626                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2627                 ast_copy_string(req->data + req->len, "\r\n", sizeof(req->data) - req->len);
2628                 req->len += strlen(req->data + req->len);
2629         }
2630 }
2631
2632 /*! \brief Transmit response on SIP request*/
2633 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2634 {
2635         int res;
2636
2637         add_blank(req);
2638         if (sip_debug_test_pvt(p)) {
2639                 const struct sockaddr_in *dst = sip_real_dst(p);
2640
2641                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
2642                         reliable ? "Reliably " : "", sip_nat_mode(p),
2643                         ast_inet_ntoa(dst->sin_addr),
2644                         ntohs(dst->sin_port), req->data);
2645         }
2646         if (p->do_history) {
2647                 struct sip_request tmp;
2648                 parse_copy(&tmp, req);
2649                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), 
2650                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
2651         }
2652         res = (reliable) ?
2653                  __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2654                 __sip_xmit(p, req->data, req->len);
2655         if (res > 0)
2656                 return 0;
2657         return res;
2658 }
2659
2660 /*! \brief Send SIP Request to the other part of the dialogue */
2661 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2662 {
2663         int res;
2664
2665         /* If we have an outbound proxy, reset peer address 
2666                 Only do this once.
2667         */
2668         if (p->outboundproxy) {
2669                 p->sa = p->outboundproxy->ip;
2670         }
2671
2672         add_blank(req);
2673         if (sip_debug_test_pvt(p)) {
2674                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
2675                         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);
2676                 else
2677                         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);
2678         }
2679         if (p->do_history) {
2680                 struct sip_request tmp;
2681                 parse_copy(&tmp, req);
2682                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
2683         }
2684         res = (reliable) ?
2685                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2686                 __sip_xmit(p, req->data, req->len);
2687         return res;
2688 }
2689
2690 /*! \brief Locate closing quote in a string, skipping escaped quotes.
2691  * optionally with a limit on the search.
2692  * start must be past the first quote.
2693  */
2694 static const char *find_closing_quote(const char *start, const char *lim)
2695 {
2696         char last_char = '\0';
2697         const char *s;
2698         for (s = start; *s && s != lim; last_char = *s++) {
2699                 if (*s == '"' && last_char != '\\')
2700                         break;
2701         }
2702         return s;
2703 }
2704
2705 /*! \brief Pick out text in brackets from character string
2706         \return pointer to terminated stripped string
2707         \param tmp input string that will be modified
2708         Examples:
2709 \verbatim
2710         "foo" <bar>     valid input, returns bar
2711         foo             returns the whole string
2712         < "foo ... >    returns the string between brackets
2713         < "foo...       bogus (missing closing bracket), returns the whole string
2714                         XXX maybe should still skip the opening bracket
2715 \endverbatim
2716  */
2717 static char *get_in_brackets(char *tmp)
2718 {
2719         const char *parse = tmp;
2720         char *first_bracket;
2721
2722         /*
2723          * Skip any quoted text until we find the part in brackets.
2724         * On any error give up and return the full string.
2725         */
2726         while ( (first_bracket = strchr(parse, '<')) ) {
2727                 char *first_quote = strchr(parse, '"');
2728
2729                 if (!first_quote || first_quote > first_bracket)
2730                         break; /* no need to look at quoted part */
2731                 /* the bracket is within quotes, so ignore it */
2732                 parse = find_closing_quote(first_quote + 1, NULL);
2733                 if (!*parse) { /* not found, return full string ? */
2734                         /* XXX or be robust and return in-bracket part ? */
2735                         ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
2736                         break;
2737                 }
2738                 parse++;
2739         }
2740         if (first_bracket) {
2741                 char *second_bracket = strchr(first_bracket + 1, '>');
2742                 if (second_bracket) {
2743                         *second_bracket = '\0';
2744                         tmp = first_bracket + 1;
2745                 } else {
2746                         ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
2747                 }
2748         }
2749         return tmp;
2750 }
2751
2752 /*! \brief * parses a URI in its components.
2753  *
2754  * \note 
2755  *- If scheme is specified, drop it from the top.
2756  * - If a component is not requested, do not split around it.
2757  * This means that if we don't have domain, we cannot split
2758  * name:pass and domain:port.
2759  * It is safe to call with ret_name, pass, domain, port
2760  * pointing all to the same place.
2761  * Init pointers to empty string so we never get NULL dereferencing.
2762  * Overwrites the string.
2763  * return 0 on success, other values on error.
2764  * \verbatim 
2765  * general form we are expecting is sip[s]:username[:password][;parameter]@host[:port][;...] 
2766  * \endverbatim
2767  */
2768 static int parse_uri(char *uri, char *scheme,
2769         char **ret_name, char **pass, char **domain, char **port, char **options)
2770 {
2771         char *name = NULL;
2772         int error = 0;
2773
2774         /* init field as required */
2775         if (pass)
2776                 *pass = "";
2777         if (port)
2778                 *port = "";
2779         if (scheme) {
2780                 int l = strlen(scheme);
2781                 if (!strncasecmp(uri, scheme, l))
2782                         uri += l;
2783                 else {
2784                         ast_log(LOG_NOTICE, "Missing scheme '%s' in '%s'\n", scheme, uri);
2785                         error = -1;
2786                 }
2787         }
2788         if (!domain) {
2789                 /* if we don't want to split around domain, keep everything as a name,
2790                  * so we need to do nothing here, except remember why.
2791                  */
2792         } else {
2793                 /* store the result in a temp. variable to avoid it being
2794                  * overwritten if arguments point to the same place.
2795                  */
2796                 char *c, *dom = "";
2797
2798                 if ((c = strchr(uri, '@')) == NULL) {
2799                         /* domain-only URI, according to the SIP RFC. */
2800                         dom = uri;
2801                         name = "";
2802                 } else {
2803                         *c++ = '\0';
2804                         dom = c;
2805                         name = uri;
2806                 }
2807
2808                 /* Remove options in domain and name */
2809                 dom = strsep(&dom, ";");
2810                 name = strsep(&name, ";");
2811
2812                 if (port && (c = strchr(dom, ':'))) { /* Remove :port */
2813                         *c++ = '\0';
2814                         *port = c;
2815                 }
2816                 if (pass && (c = strchr(name, ':'))) {  /* user:password */
2817                         *c++ = '\0';
2818                         *pass = c;
2819                 }
2820                 *domain = dom;
2821         }
2822         if (ret_name)   /* same as for domain, store the result only at the end */
2823                 *ret_name = name;
2824         if (options)
2825                 *options = uri ? uri : "";
2826
2827         return error;
2828 }
2829
2830 /*! \brief Send message with Access-URL header, if this is an HTML URL only! */
2831 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen)
2832 {
2833         struct sip_pvt *p = chan->tech_pvt;
2834
2835         if (subclass != AST_HTML_URL)
2836                 return -1;
2837
2838         ast_string_field_build(p, url, "<%s>;mode=active", data);
2839
2840         if (sip_debug_test_pvt(p))
2841                 ast_debug(1, "Send URL %s, state = %d!\n", data, chan->_state);
2842
2843         switch (chan->_state) {
2844         case AST_STATE_RING:
2845                 transmit_response(p, "100 Trying", &p->initreq);
2846                 break;
2847         case AST_STATE_RINGING:
2848                 transmit_response(p, "180 Ringing", &p->initreq);
2849                 break;
2850         case AST_STATE_UP:
2851                 if (!p->pendinginvite) {                /* We are up, and have no outstanding invite */
2852                         transmit_reinvite_with_sdp(p, FALSE);
2853                 } else if (!ast_test_flag(&p->flags[0], SIP_PENDINGBYE)) {
2854                         ast_set_flag(&p->flags[0], SIP_NEEDREINVITE);   
2855                 }       
2856                 break;
2857         default:
2858                 ast_log(LOG_WARNING, "Don't know how to send URI when state is %d!\n", chan->_state);
2859         }
2860
2861         return 0;
2862 }
2863
2864 /*! \brief Send SIP MESSAGE text within a call
2865         Called from PBX core sendtext() application */
2866 static int sip_sendtext(struct ast_channel *ast, const char *text)
2867 {
2868         struct sip_pvt *p = ast->tech_pvt;
2869         int debug = sip_debug_test_pvt(p);
2870
2871         if (debug)
2872                 ast_verbose("Sending text %s on %s\n", text, ast->name);
2873         if (!p)
2874                 return -1;
2875         if (ast_strlen_zero(text))
2876                 return 0;
2877         if (debug)
2878                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
2879         transmit_message_with_text(p, text);
2880         return 0;       
2881 }
2882
2883 /*! \brief Update peer object in realtime storage 
2884         If the Asterisk system name is set in asterisk.conf, we will use
2885         that name and store that in the "regserver" field in the sippeers
2886         table to facilitate multi-server setups.
2887 */
2888 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
2889 {
2890         char port[10];
2891         char ipaddr[INET_ADDRSTRLEN];
2892         char regseconds[20];
2893         char *tablename = NULL;
2894
2895         char *sysname = ast_config_AST_SYSTEM_NAME;
2896         char *syslabel = NULL;
2897
2898         time_t nowtime = time(NULL) + expirey;
2899         const char *fc = fullcontact ? "fullcontact" : NULL;
2900
2901         int realtimeregs = ast_check_realtime("sipregs");
2902
2903         tablename = realtimeregs ? "sipregs" : "sippeers";
2904         
2905         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
2906         ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2907         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
2908         
2909         if (ast_strlen_zero(sysname))   /* No system name, disable this */
2910                 sysname = NULL;
2911         else if (sip_cfg.rtsave_sysname)
2912                 syslabel = "regserver";
2913
2914         if (fc)
2915                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
2916                         "port", port, "regseconds", regseconds,
2917                         "username", username, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
2918         else
2919                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
2920                         "port", port, "regseconds", regseconds,
2921                         "username", username, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
2922 }
2923
2924 /*! \brief Automatically add peer extension to dial plan */
2925 static void register_peer_exten(struct sip_peer *peer, int onoff)
2926 {
2927         char multi[256];
2928         char *stringp, *ext, *context;
2929
2930         /* XXX note that global_regcontext is both a global 'enable' flag and
2931          * the name of the global regexten context, if not specified
2932          * individually.
2933          */
2934         if (ast_strlen_zero(global_regcontext))
2935                 return;
2936
2937         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
2938         stringp = multi;
2939         while ((ext = strsep(&stringp, "&"))) {
2940                 if ((context = strchr(ext, '@'))) {
2941                         *context++ = '\0';      /* split ext@context */
2942                         if (!ast_context_find(context)) {
2943                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
2944                                 continue;
2945                         }
2946                 } else {
2947                         context = global_regcontext;
2948                 }
2949                 if (onoff)
2950                         ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
2951                                  ast_strdup(peer->name), ast_free_ptr, "SIP");
2952                 else
2953                         ast_context_remove_extension(context, ext, 1, NULL);
2954         }
2955 }
2956
2957 static void destroy_mailbox(struct sip_mailbox *mailbox)
2958 {
2959         if (mailbox->mailbox)
2960                 ast_free(mailbox->mailbox);
2961         if (mailbox->context)
2962                 ast_free(mailbox->context);
2963         if (mailbox->event_sub)
2964                 ast_event_unsubscribe(mailbox->event_sub);
2965         ast_free(mailbox);
2966 }
2967
2968 static void clear_peer_mailboxes(struct sip_peer *peer)
2969 {
2970         struct sip_mailbox *mailbox;
2971
2972         while ((mailbox = AST_LIST_REMOVE_HEAD(&peer->mailboxes, entry)))
2973                 destroy_mailbox(mailbox);
2974 }
2975
2976 /*! \brief Destroy peer object from memory */
2977 static void sip_destroy_peer(struct sip_peer *peer)
2978 {
2979         ast_debug(3, "Destroying SIP peer %s\n", peer->name);
2980
2981         if (peer->outboundproxy)
2982                 ast_free(peer->outboundproxy);
2983         peer->outboundproxy = NULL;
2984
2985         /* Delete it, it needs to disappear */
2986         if (peer->call)
2987                 peer->call = sip_destroy(peer->call);
2988
2989         if (peer->mwipvt)       /* We have an active subscription, delete it */
2990                 peer->mwipvt = sip_destroy(peer->mwipvt);
2991
2992         if (peer->chanvars) {
2993                 ast_variables_destroy(peer->chanvars);
2994                 peer->chanvars = NULL;
2995         }
2996         if (peer->expire > -1)
2997                 ast_sched_del(sched, peer->expire);
2998
2999         if (peer->pokeexpire > -1)
3000                 ast_sched_del(sched, peer->pokeexpire);
3001         register_peer_exten(peer, FALSE);
3002         ast_free_ha(peer->ha);
3003         if (peer->selfdestruct)
3004                 apeerobjs--;
3005         else if (peer->is_realtime) {
3006                 rpeerobjs--;
3007                 ast_debug(3,"-REALTIME- peer Destroyed. Name: %s. Realtime Peer objects: %d\n", peer->name, rpeerobjs);
3008         } else
3009                 speerobjs--;
3010         clear_realm_authentication(peer->auth);
3011         peer->auth = NULL;
3012         if (peer->dnsmgr)
3013                 ast_dnsmgr_release(peer->dnsmgr);
3014         clear_peer_mailboxes(peer);
3015         ast_free(peer);
3016 }
3017
3018 /*! \brief Update peer data in database (if used) */
3019 static void update_peer(struct sip_peer *p, int expiry)
3020 {
3021         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
3022         if (sip_cfg.peer_rtupdate &&
3023             (p->is_realtime || rtcachefriends)) {
3024                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
3025         }
3026 }
3027
3028 static struct ast_variable *get_insecure_variable_from_config(struct ast_config *config)
3029 {
3030         struct ast_variable *var = NULL;
3031         struct ast_flags flags = {0};
3032         char *cat = NULL;
3033         const char *insecure;
3034         while ((cat = ast_category_browse(config, cat))) {
3035                 insecure = ast_variable_retrieve(config, cat, "insecure");
3036                 set_insecure_flags(&flags, insecure, -1);
3037                 if (ast_test_flag(&flags, SIP_INSECURE_PORT)) {
3038                         var = ast_category_root(config, cat);
3039                         break;