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