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