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