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