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