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