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