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