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