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