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