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