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