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