add a bit of comments on internal functions.
[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  * Packets are linked in a list, whose head is in the struct sip_pvt they belong to.
1099  * Each packet holds a reference to the parent struct sip_pvt.
1100  * This structure is allocated in __sip_reliable_xmit() and only for packets that
1101  * require retransmissions.
1102  */
1103 struct sip_pkt {
1104         struct sip_pkt *next;                   /*!< Next packet in linked list */
1105         int retrans;                            /*!< Retransmission number */
1106         int method;                             /*!< SIP method for this packet */
1107         int seqno;                              /*!< Sequence number */
1108         char is_resp;                           /*!< 1 if this is a response packet (e.g. 200 OK), 0 if it is a request */
1109         char is_fatal;                          /*!< non-zero if there is a fatal error */
1110         struct sip_pvt *owner;                  /*!< Owner AST call */
1111         int retransid;                          /*!< Retransmission ID */
1112         int timer_a;                            /*!< SIP timer A, retransmission timer */
1113         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1114         int packetlen;                          /*!< Length of packet */
1115         char data[0];
1116 };      
1117
1118 /*! \brief Structure for SIP user data. User's place calls to us */
1119 struct sip_user {
1120         /* Users who can access various contexts */
1121         ASTOBJ_COMPONENTS(struct sip_user);
1122         char secret[80];                /*!< Password */
1123         char md5secret[80];             /*!< Password in md5 */
1124         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1125         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
1126         char cid_num[80];               /*!< Caller ID num */
1127         char cid_name[80];              /*!< Caller ID name */
1128         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
1129         char language[MAX_LANGUAGE];    /*!< Default language for this user */
1130         char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1131         char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1132         char useragent[256];            /*!< User agent in SIP request */
1133         struct ast_codec_pref prefs;    /*!< codec prefs */
1134         ast_group_t callgroup;          /*!< Call group */
1135         ast_group_t pickupgroup;        /*!< Pickup Group */
1136         unsigned int sipoptions;        /*!< Supported SIP options */
1137         struct ast_flags flags[2];      /*!< SIP_ flags */
1138
1139         /* things that don't belong in flags */
1140         char is_realtime;               /*!< this is a 'realtime' user */
1141
1142         int amaflags;                   /*!< AMA flags for billing */
1143         int callingpres;                /*!< Calling id presentation */
1144         int capability;                 /*!< Codec capability */
1145         int inUse;                      /*!< Number of calls in use */
1146         int call_limit;                 /*!< Limit of concurrent calls */
1147         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1148         struct ast_ha *ha;              /*!< ACL setting */
1149         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
1150         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1151         int autoframing;
1152 };
1153
1154 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
1155 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1156 struct sip_peer {
1157         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
1158                                         /*!< peer->name is the unique name of this object */
1159         char secret[80];                /*!< Password */
1160         char md5secret[80];             /*!< Password in MD5 */
1161         struct sip_auth *auth;          /*!< Realm authentication list */
1162         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1163         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1164         char username[80];              /*!< Temporary username until registration */ 
1165         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1166         int amaflags;                   /*!< AMA Flags (for billing) */
1167         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
1168         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1169         char fromuser[80];              /*!< From: user when calling this peer */
1170         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
1171         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
1172         char cid_num[80];               /*!< Caller ID num */
1173         char cid_name[80];              /*!< Caller ID name */
1174         int callingpres;                /*!< Calling id presentation */
1175         int inUse;                      /*!< Number of calls in use */
1176         int inRinging;                  /*!< Number of calls ringing */
1177         int onHold;                     /*!< Peer has someone on hold */
1178         int call_limit;                 /*!< Limit of concurrent calls */
1179         int busy_level;                 /*!< Level of active channels where we signal busy */
1180         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1181         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1182         char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox setting for MWI checks */
1183         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
1184         char mohinterpret[MAX_MUSICCLASS];/*!<  Music on Hold class */
1185         char mohsuggest[MAX_MUSICCLASS];/*!<  Music on Hold class */
1186         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
1187         struct ast_codec_pref prefs;    /*!<  codec prefs */
1188         int lastmsgssent;
1189         unsigned int sipoptions;        /*!<  Supported SIP options */
1190         struct ast_flags flags[2];      /*!<  SIP_ flags */
1191
1192         /* things that don't belong in flags */
1193         char is_realtime;               /*!< this is a 'realtime' peer */
1194
1195         int expire;                     /*!<  When to expire this peer registration */
1196         int capability;                 /*!<  Codec capability */
1197         int rtptimeout;                 /*!<  RTP timeout */
1198         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1199         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1200         ast_group_t callgroup;          /*!<  Call group */
1201         ast_group_t pickupgroup;        /*!<  Pickup group */
1202         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this peer */
1203         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1204         struct sockaddr_in addr;        /*!<  IP address of peer */
1205         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1206         
1207         /* Qualification */
1208         struct sip_pvt *call;           /*!<  Call pointer */
1209         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
1210         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
1211         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
1212         struct timeval ps;              /*!<  Time for sending SIP OPTION in sip_pke_peer() */
1213         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
1214         struct ast_ha *ha;              /*!<  Access control list */
1215         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1216         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1217         int autoframing;
1218         struct ast_event_sub *mwi_event_sub; /*!< The MWI event subscription */
1219 };
1220
1221
1222
1223 /*! \brief Registrations with other SIP proxies */
1224 struct sip_registry {
1225         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1226         AST_DECLARE_STRING_FIELDS(
1227                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
1228                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1229                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1230                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1231                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1232                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1233                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
1234                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1235                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
1236                 AST_STRING_FIELD(secret);       /*!< Password in clear text */  
1237                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
1238                 AST_STRING_FIELD(callback);     /*!< Contact extension */
1239                 AST_STRING_FIELD(random);
1240         );
1241         int portno;                     /*!<  Optional port override */
1242         int expire;                     /*!< Sched ID of expiration */
1243         int expiry;                     /*!< Value to use for the Expires header */
1244         int regattempts;                /*!< Number of attempts (since the last success) */
1245         int timeout;                    /*!< sched id of sip_reg_timeout */
1246         int refresh;                    /*!< How often to refresh */
1247         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1248         enum sipregistrystate regstate; /*!< Registration state (see above) */
1249         struct timeval regtime;         /*!< Last successful registration time */
1250         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
1251         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
1252         struct sockaddr_in us;          /*!< Who the server thinks we are */
1253         int noncecount;                 /*!< Nonce-count */
1254         char lastmsg[256];              /*!< Last Message sent/received */
1255 };
1256
1257 /* --- Linked lists of various objects --------*/
1258
1259 /*! \brief  The user list: Users and friends */
1260 static struct ast_user_list {
1261         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1262 } userl;
1263
1264 /*! \brief  The peer list: Peers and Friends */
1265 static struct ast_peer_list {
1266         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1267 } peerl;
1268
1269 /*! \brief  The register list: Other SIP proxies we register with and place calls to */
1270 static struct ast_register_list {
1271         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1272         int recheck;
1273 } regl;
1274
1275 static int temp_pvt_init(void *);
1276 static void temp_pvt_cleanup(void *);
1277
1278 /*! \brief A per-thread temporary pvt structure */
1279 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1280
1281 /*! \brief Authentication list for realm authentication 
1282  * \todo Move the sip_auth list to AST_LIST */
1283 static struct sip_auth *authl = NULL;
1284
1285
1286 /* --- Sockets and networking --------------*/
1287
1288 /*! \brief Main socket for SIP communication.
1289  * sipsock is shared between the manager thread (which handles reload
1290  * requests), the io handler (sipsock_read()) and the user routines that
1291  * issue writes (using __sip_xmit()).
1292  * The socket is -1 only when opening fails (this is a permanent condition),
1293  * or when we are handling a reload() that changes its address (this is
1294  * a transient situation during which we might have a harmless race, see
1295  * below). Because the conditions for the race to be possible are extremely
1296  * rare, we don't want to pay the cost of locking on every I/O.
1297  * Rather, we remember that when the race may occur, communication is
1298  * bound to fail anyways, so we just live with this event and let
1299  * the protocol handle this above us.
1300  */
1301 static int sipsock  = -1;
1302
1303 static struct sockaddr_in bindaddr;     /*!< The address we bind to */
1304
1305 /*! \brief our (internal) default address/port to put in SIP/SDP messages
1306  *  internip is initialized picking a suitable address from one of the
1307  * interfaces, and the same port number we bind to. It is used as the
1308  * default address/port in SIP messages, and as the default address
1309  * (but not port) in SDP messages.
1310  */
1311 static struct sockaddr_in internip;
1312
1313 /*! \brief our external IP address/port for SIP sessions.
1314  * externip.sin_addr is only set when we know we might be behind
1315  * a NAT, and this is done using a variety of (mutually exclusive)
1316  * ways from the config file:
1317  *
1318  * + with "externip = host[:port]" we specify the address/port explicitly.
1319  *   The address is looked up only once when (re)loading the config file;
1320  * 
1321  * + with "externhost = host[:port]" we do a similar thing, but the
1322  *   hostname is stored in externhost, and the hostname->IP mapping
1323  *   is refreshed every 'externrefresh' seconds;
1324  * 
1325  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
1326  *   to the specified server, and store the result in externip.
1327  *
1328  * Other variables (externhost, externexpire, externrefresh) are used
1329  * to support the above functions.
1330  */
1331 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
1332
1333 static char externhost[MAXHOSTNAMELEN];         /*!< External host name */
1334 static time_t externexpire;                     /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1335 static int externrefresh = 10;
1336 static struct sockaddr_in stunaddr;             /*!< stun server address */
1337
1338 /*! \brief  List of local networks
1339  * We store "localnet" addresses from the config file into an access list,
1340  * marked as 'DENY', so the call to ast_apply_ha() will return
1341  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
1342  * (i.e. presumably public) addresses.
1343  */
1344 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
1345
1346 static struct sockaddr_in debugaddr;
1347
1348 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
1349
1350 /*---------------------------- Forward declarations of functions in chan_sip.c */
1351 /*! \note This is added to help splitting up chan_sip.c into several files
1352         in coming releases */
1353
1354 /*--- PBX interface functions */
1355 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1356 static int sip_devicestate(void *data);
1357 static int sip_sendtext(struct ast_channel *ast, const char *text);
1358 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1359 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
1360 static int sip_hangup(struct ast_channel *ast);
1361 static int sip_answer(struct ast_channel *ast);
1362 static struct ast_frame *sip_read(struct ast_channel *ast);
1363 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1364 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1365 static int sip_transfer(struct ast_channel *ast, const char *dest);
1366 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1367 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1368 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
1369
1370 /*--- Transmitting responses and requests */
1371 static int sipsock_read(int *id, int fd, short events, void *ignore);
1372 static int __sip_xmit(struct sip_pvt *p, char *data, int len);
1373 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod);
1374 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1375 static int retrans_pkt(void *data);
1376 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1377 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);
1378 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1379 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1380 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1381 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1382 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1383 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);
1384 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1385 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1386 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1387 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1388 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1389 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version);
1390 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1391 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1392 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1393 static int transmit_refer(struct sip_pvt *p, const char *dest);
1394 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1395 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1396 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1397 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1398 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1399 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1400 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1401 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1402 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
1403
1404 /*--- Dialog management */
1405 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1406                                  int useglobal_nat, const int intended_method);
1407 static int __sip_autodestruct(void *data);
1408 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1409 static void sip_cancel_destroy(struct sip_pvt *p);
1410 static struct sip_pvt *sip_destroy(struct sip_pvt *p);
1411 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
1412 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1413 static void __sip_pretend_ack(struct sip_pvt *p);
1414 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1415 static int auto_congest(void *nothing);
1416 static int update_call_counter(struct sip_pvt *fup, int event);
1417 static int hangup_sip2cause(int cause);
1418 static const char *hangup_cause2sip(int cause);
1419 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1420 static void free_old_route(struct sip_route *route);
1421 static void list_route(struct sip_route *route);
1422 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1423 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1424                                               struct sip_request *req, char *uri);
1425 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1426 static void check_pendings(struct sip_pvt *p);
1427 static void *sip_park_thread(void *stuff);
1428 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1429 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1430
1431 /*--- Codec handling / SDP */
1432 static void try_suggested_sip_codec(struct sip_pvt *p);
1433 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1434 static const char *get_sdp(struct sip_request *req, const char *name);
1435 static int find_sdp(struct sip_request *req);
1436 static int process_sdp(struct sip_pvt *p, struct sip_request *req);
1437 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1438                              struct ast_str **m_buf, struct ast_str **a_buf,
1439                              int debug, int *min_packet_size);
1440 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1441                                 struct ast_str **m_buf, struct ast_str **a_buf,
1442                                 int debug);
1443 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p);
1444 static void do_setnat(struct sip_pvt *p, int natflags);
1445 static void stop_media_flows(struct sip_pvt *p);
1446
1447 /*--- Authentication stuff */
1448 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1449 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1450 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1451                                          const char *secret, const char *md5secret, int sipmethod,
1452                                          char *uri, enum xmittype reliable, int ignore);
1453 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1454                                               int sipmethod, char *uri, enum xmittype reliable,
1455                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1456 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1457
1458 /*--- Domain handling */
1459 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1460 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1461 static void clear_sip_domains(void);
1462
1463 /*--- SIP realm authentication */
1464 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);
1465 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1466 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1467
1468 /*--- Misc functions */
1469 static int sip_do_reload(enum channelreloadreason reason);
1470 static int reload_config(enum channelreloadreason reason);
1471 static int expire_register(void *data);
1472 static void *do_monitor(void *data);
1473 static int restart_monitor(void);
1474 static int sip_addrcmp(char *name, struct sockaddr_in *sin);    /* Support for peer matching */
1475 static int sip_refer_allocate(struct sip_pvt *p);
1476 static void ast_quiet_chan(struct ast_channel *chan);
1477 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1478
1479 /*--- Device monitoring and Device/extension state/event handling */
1480 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1481 static int sip_devicestate(void *data);
1482 static int sip_poke_noanswer(void *data);
1483 static int sip_poke_peer(struct sip_peer *peer);
1484 static void sip_poke_all_peers(void);
1485 static void sip_peer_hold(struct sip_pvt *p, int hold);
1486 static void mwi_event_cb(const struct ast_event *, void *);
1487
1488 /*--- Applications, functions, CLI and manager command helpers */
1489 static const char *sip_nat_mode(const struct sip_pvt *p);
1490 static int sip_show_inuse(int fd, int argc, char *argv[]);
1491 static char *transfermode2str(enum transfermodes mode) attribute_const;
1492 static char *nat2str(int nat) attribute_const;
1493 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1494 static int sip_show_users(int fd, int argc, char *argv[]);
1495 static int _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1496 static int sip_show_peers(int fd, int argc, char *argv[]);
1497 static int sip_show_objects(int fd, int argc, char *argv[]);
1498 static void  print_group(int fd, ast_group_t group, int crlf);
1499 static const char *dtmfmode2str(int mode) attribute_const;
1500 static const char *insecure2str(int port, int invite) attribute_const;
1501 static void cleanup_stale_contexts(char *new, char *old);
1502 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1503 static const char *domain_mode_to_text(const enum domain_mode mode);
1504 static int sip_show_domains(int fd, int argc, char *argv[]);
1505 static int _sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1506 static int sip_show_peer(int fd, int argc, char *argv[]);
1507 static int sip_show_user(int fd, int argc, char *argv[]);
1508 static int sip_show_registry(int fd, int argc, char *argv[]);
1509 static int sip_unregister(int fd, int argc, char *argv[]);
1510 static int sip_show_settings(int fd, int argc, char *argv[]);
1511 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1512 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1513 static char *complete_sip_peer(const char *word, int state, int flags2);
1514 static char *complete_sip_registered_peer(const char *word, int state, int flags2);
1515 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1516 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1517 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1518 static char *complete_sip_debug_peer(const char *line, const char *word, int pos, int state);
1519 static char *complete_sip_user(const char *word, int state, int flags2);
1520 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1521 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1522 static char *complete_sip_prune_realtime_peer(const char *line, const char *word, int pos, int state);
1523 static char *complete_sip_prune_realtime_user(const char *line, const char *word, int pos, int state);
1524 static int sip_show_channel(int fd, int argc, char *argv[]);
1525 static int sip_show_history(int fd, int argc, char *argv[]);
1526 static int sip_do_debug_ip(int fd, int argc, char *argv[]);
1527 static int sip_do_debug_peer(int fd, int argc, char *argv[]);
1528 static int sip_do_debug(int fd, int argc, char *argv[]);
1529 static int sip_no_debug(int fd, int argc, char *argv[]);
1530 static int sip_notify(int fd, int argc, char *argv[]);
1531 static int sip_do_history(int fd, int argc, char *argv[]);
1532 static int sip_no_history(int fd, int argc, char *argv[]);
1533 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1534 static int sip_addheader(struct ast_channel *chan, void *data);
1535 static int sip_do_reload(enum channelreloadreason reason);
1536 static int sip_reload(int fd, int argc, char *argv[]);
1537 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
1538
1539 /*--- Debugging 
1540         Functions for enabling debug per IP or fully, or enabling history logging for
1541         a SIP dialog
1542 */
1543 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to LOG_DEBUG at end of dialog, before destroying data */
1544 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1545 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1546 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1547 static void sip_dump_history(struct sip_pvt *dialog);
1548
1549 /*--- Device object handling */
1550 static struct sip_peer *temp_peer(const char *name);
1551 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1552 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
1553 static int update_call_counter(struct sip_pvt *fup, int event);
1554 static void sip_destroy_peer(struct sip_peer *peer);
1555 static void sip_destroy_user(struct sip_user *user);
1556 static int sip_poke_peer(struct sip_peer *peer);
1557 static void set_peer_defaults(struct sip_peer *peer);
1558 static struct sip_peer *temp_peer(const char *name);
1559 static void register_peer_exten(struct sip_peer *peer, int onoff);
1560 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1561 static struct sip_user *find_user(const char *name, int realtime);
1562 static int sip_poke_peer_s(void *data);
1563 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1564 static void reg_source_db(struct sip_peer *peer);
1565 static void destroy_association(struct sip_peer *peer);
1566 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1567
1568 /* Realtime device support */
1569 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey);
1570 static struct sip_user *realtime_user(const char *username);
1571 static void update_peer(struct sip_peer *p, int expiry);
1572 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1573 static int sip_prune_realtime(int fd, int argc, char *argv[]);
1574
1575 /*--- Internal UA client handling (outbound registrations) */
1576 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us);
1577 static void sip_registry_destroy(struct sip_registry *reg);
1578 static int sip_register(char *value, int lineno);
1579 static char *regstate2str(enum sipregistrystate regstate) attribute_const;
1580 static int sip_reregister(void *data);
1581 static int __sip_do_register(struct sip_registry *r);
1582 static int sip_reg_timeout(void *data);
1583 static void sip_send_all_registers(void);
1584
1585 /*--- Parsing SIP requests and responses */
1586 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1587 static int determine_firstline_parts(struct sip_request *req);
1588 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1589 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1590 static int find_sip_method(const char *msg);
1591 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1592 static void parse_request(struct sip_request *req);
1593 static const char *get_header(const struct sip_request *req, const char *name);
1594 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1595 static int method_match(enum sipmethod id, const char *name);
1596 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1597 static char *get_in_brackets(char *tmp);
1598 static const char *find_alias(const char *name, const char *_default);
1599 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1600 static int lws2sws(char *msgbuf, int len);
1601 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1602 static char *remove_uri_parameters(char *uri);
1603 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1604 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1605 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1606 static int set_address_from_contact(struct sip_pvt *pvt);
1607 static void check_via(struct sip_pvt *p, struct sip_request *req);
1608 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1609 static int get_rpid_num(const char *input, char *output, int maxlen);
1610 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1611 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1612 static int get_msg_text(char *buf, int len, struct sip_request *req);
1613 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1614
1615 /*--- Constructing requests and responses */
1616 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1617 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1618 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1619 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1620 static int init_resp(struct sip_request *resp, const char *msg);
1621 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1622 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1623 static void build_via(struct sip_pvt *p);
1624 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1625 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1626 static char *generate_random_string(char *buf, size_t size);
1627 static void build_callid_pvt(struct sip_pvt *pvt);
1628 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1629 static void make_our_tag(char *tagbuf, size_t len);
1630 static int add_header(struct sip_request *req, const char *var, const char *value);
1631 static int add_header_contentLength(struct sip_request *req, int len);
1632 static int add_line(struct sip_request *req, const char *line);
1633 static int add_text(struct sip_request *req, const char *text);
1634 static int add_digit(struct sip_request *req, char digit, unsigned int duration);
1635 static int add_vidupdate(struct sip_request *req);
1636 static void add_route(struct sip_request *req, struct sip_route *route);
1637 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1638 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1639 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1640 static void set_destination(struct sip_pvt *p, char *uri);
1641 static void append_date(struct sip_request *req);
1642 static void build_contact(struct sip_pvt *p);
1643 static void build_rpid(struct sip_pvt *p);
1644
1645 /*------Request handling functions */
1646 static int handle_request(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1647 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);
1648 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1649 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1650 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1651 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1652 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1653 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1654 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1655 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1656 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, struct sockaddr_in *sin);
1657 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1658 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1659
1660 /*------Response handling functions */
1661 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1662 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1663 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1664 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1665
1666 /*----- RTP interface functions */
1667 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);
1668 static enum ast_rtp_get_result sip_get_rtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1669 static enum ast_rtp_get_result sip_get_vrtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1670 static enum ast_rtp_get_result sip_get_trtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1671 static int sip_get_codec(struct ast_channel *chan);
1672 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
1673
1674 /*------ T38 Support --------- */
1675 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); 
1676 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1677 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1678 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1679
1680 /*! \brief Definition of this channel for PBX channel registration */
1681 static const struct ast_channel_tech sip_tech = {
1682         .type = "SIP",
1683         .description = "Session Initiation Protocol (SIP)",
1684         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1685         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1686         .requester = sip_request_call,                  /* called with chan unlocked */
1687         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1688         .call = sip_call,                       /* called with chan locked */
1689         .send_html = sip_sendhtml,
1690         .hangup = sip_hangup,                   /* called with chan locked */
1691         .answer = sip_answer,                   /* called with chan locked */
1692         .read = sip_read,                       /* called with chan locked */
1693         .write = sip_write,                     /* called with chan locked */
1694         .write_video = sip_write,               /* called with chan locked */
1695         .write_text = sip_write,
1696         .indicate = sip_indicate,               /* called with chan locked */
1697         .transfer = sip_transfer,               /* called with chan locked */
1698         .fixup = sip_fixup,                     /* called with chan locked */
1699         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1700         .send_digit_end = sip_senddigit_end,
1701         .bridge = ast_rtp_bridge,                       /* XXX chan unlocked ? */
1702         .early_bridge = ast_rtp_early_bridge,
1703         .send_text = sip_sendtext,              /* called with chan locked */
1704         .func_channel_read = acf_channel_read,
1705 };
1706
1707 /*! \brief This version of the sip channel tech has no send_digit_begin
1708  *  callback.  This is for use with channels using SIP INFO DTMF so that
1709  *  the core knows that the channel doesn't want DTMF BEGIN frames. */
1710 static const struct ast_channel_tech sip_tech_info = {
1711         .type = "SIP",
1712         .description = "Session Initiation Protocol (SIP)",
1713         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1714         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1715         .requester = sip_request_call,
1716         .devicestate = sip_devicestate,
1717         .call = sip_call,
1718         .hangup = sip_hangup,
1719         .answer = sip_answer,
1720         .read = sip_read,
1721         .write = sip_write,
1722         .write_video = sip_write,
1723         .indicate = sip_indicate,
1724         .transfer = sip_transfer,
1725         .fixup = sip_fixup,
1726         .send_digit_end = sip_senddigit_end,
1727         .bridge = ast_rtp_bridge,
1728         .send_text = sip_sendtext,
1729         .func_channel_read = acf_channel_read,
1730 };
1731
1732 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
1733 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
1734
1735 /**--- some list management macros. **/
1736  
1737 #define UNLINK(element, head, prev) do {        \
1738         if (prev)                               \
1739                 (prev)->next = (element)->next; \
1740         else                                    \
1741                 (head) = (element)->next;       \
1742         } while (0)
1743
1744 /*! \brief Interface structure with callbacks used to connect to RTP module */
1745 static struct ast_rtp_protocol sip_rtp = {
1746         type: "SIP",
1747         get_rtp_info: sip_get_rtp_peer,
1748         get_vrtp_info: sip_get_vrtp_peer,
1749         get_trtp_info: sip_get_trtp_peer,
1750         set_rtp_peer: sip_set_rtp_peer,
1751         get_codec: sip_get_codec,
1752 };
1753
1754 /*! \brief Helper function to lock, hiding the underlying locking mechanism.  */
1755 static void sip_pvt_lock(struct sip_pvt *pvt)
1756 {
1757         ast_mutex_lock(&pvt->pvt_lock);
1758 }
1759
1760 /*! \brief Helper function to unlock pvt, hiding the underlying locking mechanism. */
1761 static void sip_pvt_unlock(struct sip_pvt *pvt)
1762 {
1763         ast_mutex_unlock(&pvt->pvt_lock);
1764 }
1765
1766 /*!
1767  * helper functions to unreference various types of objects.
1768  * By handling them this way, we don't have to declare the
1769  * destructor on each call, which removes the chance of errors.
1770  */
1771 static void unref_peer(struct sip_peer *peer)
1772 {
1773         ASTOBJ_UNREF(peer, sip_destroy_peer);
1774 }
1775
1776 static void unref_user(struct sip_user *user)
1777 {
1778         ASTOBJ_UNREF(user, sip_destroy_user);
1779 }
1780
1781 static void registry_unref(struct sip_registry *reg)
1782 {
1783         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
1784         ASTOBJ_UNREF(reg, sip_registry_destroy);
1785 }
1786
1787 /*! \brief Add object reference to SIP registry */
1788 static struct sip_registry *registry_addref(struct sip_registry *reg)
1789 {
1790         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
1791         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
1792 }
1793
1794 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
1795 static struct ast_udptl_protocol sip_udptl = {
1796         type: "SIP",
1797         get_udptl_info: sip_get_udptl_peer,
1798         set_udptl_peer: sip_set_udptl_peer,
1799 };
1800
1801 /*! \brief Append to SIP dialog history 
1802         \return Always returns 0 */
1803 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1804
1805 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1806         __attribute__ ((format (printf, 2, 3)));
1807
1808
1809 /*! \brief Convert transfer status to string */
1810 static const char *referstatus2str(enum referstatus rstatus)
1811 {
1812         int i = (sizeof(referstatusstrings) / sizeof(referstatusstrings[0]));
1813         int x;
1814
1815         for (x = 0; x < i; x++) {
1816                 if (referstatusstrings[x].status ==  rstatus)
1817                         return referstatusstrings[x].text;
1818         }
1819         return "";
1820 }
1821
1822 /*! \brief Initialize the initital request packet in the pvt structure.
1823         This packet is used for creating replies and future requests in
1824         a dialog */
1825 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1826 {
1827         if (p->initreq.headers)
1828                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
1829         else
1830                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
1831         /* Use this as the basis */
1832         copy_request(&p->initreq, req);
1833         parse_request(&p->initreq);
1834         if (req->debug)
1835                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1836 }
1837
1838 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
1839 static void sip_alreadygone(struct sip_pvt *dialog)
1840 {
1841         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
1842         dialog->alreadygone = 1;
1843 }
1844
1845 /*! Resolve DNS srv name or host name in a sip_proxy structure */
1846 static int proxy_update(struct sip_proxy *proxy)
1847 {
1848         /* if it's actually an IP address and not a name,
1849            there's no need for a managed lookup */
1850         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
1851                 /* Ok, not an IP address, then let's check if it's a domain or host */
1852                 /* XXX Todo - if we have proxy port, don't do SRV */
1853                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, global_srvlookup ? "_sip._udp" : NULL) < 0) {
1854                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
1855                         return FALSE;
1856                 }
1857         }
1858         proxy->last_dnsupdate = time(NULL);
1859         return TRUE;
1860 }
1861
1862 /*! \brief Allocate and initialize sip proxy */
1863 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
1864 {
1865         struct sip_proxy *proxy;
1866         proxy = ast_calloc(1, sizeof(*proxy));
1867         if (!proxy)
1868                 return NULL;
1869         proxy->force = force;
1870         ast_copy_string(proxy->name, name, sizeof(proxy->name));
1871         proxy->ip.sin_port = htons((!ast_strlen_zero(port) ? atoi(port) : STANDARD_SIP_PORT));
1872         proxy_update(proxy);
1873         return proxy;
1874 }
1875
1876 /*! \brief Get default outbound proxy or global proxy */
1877 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
1878 {
1879         if (peer && peer->outboundproxy) {
1880                 if (sipdebug)
1881                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
1882                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
1883                 return peer->outboundproxy;
1884         }
1885         if (global_outboundproxy.name[0]) {
1886                 if (sipdebug)
1887                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
1888                 append_history(dialog, "OBproxy", "Using global obproxy %s", global_outboundproxy.name);
1889                 return &global_outboundproxy;
1890         }
1891         if (sipdebug)
1892                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
1893         return NULL;
1894 }
1895
1896 /*! \brief returns true if 'name' (with optional trailing whitespace)
1897  * matches the sip method 'id'.
1898  * Strictly speaking, SIP methods are case SENSITIVE, but we do
1899  * a case-insensitive comparison to be more tolerant.
1900  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
1901  */
1902 static int method_match(enum sipmethod id, const char *name)
1903 {
1904         int len = strlen(sip_methods[id].text);
1905         int l_name = name ? strlen(name) : 0;
1906         /* true if the string is long enough, and ends with whitespace, and matches */
1907         return (l_name >= len && name[len] < 33 &&
1908                 !strncasecmp(sip_methods[id].text, name, len));
1909 }
1910
1911 /*! \brief  find_sip_method: Find SIP method from header */
1912 static int find_sip_method(const char *msg)
1913 {
1914         int i, res = 0;
1915         
1916         if (ast_strlen_zero(msg))
1917                 return 0;
1918         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1919                 if (method_match(i, msg))
1920                         res = sip_methods[i].id;
1921         }
1922         return res;
1923 }
1924
1925 /*! \brief Parse supported header in incoming packet */
1926 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
1927 {
1928         char *next, *sep;
1929         char *temp;
1930         unsigned int profile = 0;
1931         int i, found;
1932
1933         if (ast_strlen_zero(supported) )
1934                 return 0;
1935         temp = ast_strdupa(supported);
1936
1937         if (sipdebug)
1938                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1939
1940         for (next = temp; next; next = sep) {
1941                 found = FALSE;
1942                 if ( (sep = strchr(next, ',')) != NULL)
1943                         *sep++ = '\0';
1944                 next = ast_skip_blanks(next);
1945                 if (sipdebug)
1946                         ast_debug(3, "Found SIP option: -%s-\n", next);
1947                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1948                         if (!strcasecmp(next, sip_options[i].text)) {
1949                                 profile |= sip_options[i].id;
1950                                 found = TRUE;
1951                                 if (sipdebug)
1952                                         ast_debug(3, "Matched SIP option: %s\n", next);
1953                                 break;
1954                         }
1955                 }
1956                 if (!found && sipdebug) {
1957                         if (!strncasecmp(next, "x-", 2))
1958                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
1959                         else
1960                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1961                 }
1962         }
1963
1964         if (pvt)
1965                 pvt->sipoptions = profile;
1966         return profile;
1967 }
1968
1969 /*! \brief See if we pass debug IP filter */
1970 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
1971 {
1972         if (!sipdebug)
1973                 return 0;
1974         if (debugaddr.sin_addr.s_addr) {
1975                 if (((ntohs(debugaddr.sin_port) != 0)
1976                         && (debugaddr.sin_port != addr->sin_port))
1977                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1978                         return 0;
1979         }
1980         return 1;
1981 }
1982
1983 /*! \brief The real destination address for a write */
1984 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
1985 {
1986         if (p->outboundproxy)
1987                 return &p->outboundproxy->ip;
1988
1989         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
1990 }
1991
1992 /*! \brief Display SIP nat mode */
1993 static const char *sip_nat_mode(const struct sip_pvt *p)
1994 {
1995         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
1996 }
1997
1998 /*! \brief Test PVT for debugging output */
1999 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
2000 {
2001         if (!sipdebug)
2002                 return 0;
2003         return sip_debug_test_addr(sip_real_dst(p));
2004 }
2005
2006 /*! \brief Transmit SIP message */
2007 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
2008 {
2009         int res;
2010         const struct sockaddr_in *dst = sip_real_dst(p);
2011         res = sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
2012
2013         if (res == -1) {
2014                 switch (errno) {
2015                         case EBADF:             /* Bad file descriptor - seems like this is generated when the host exist, but doesn't accept the UDP packet */
2016                         case EHOSTUNREACH:      /* Host can't be reached */
2017                         case ENETDOWN:          /* Inteface down */
2018                         case ENETUNREACH:       /* Network failure */
2019                                 res = XMIT_ERROR;       /* Don't bother with trying to transmit again */
2020                 }
2021         }
2022         if (res != len)
2023                 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));
2024         return res;
2025 }
2026
2027
2028 /*! \brief Build a Via header for a request */
2029 static void build_via(struct sip_pvt *p)
2030 {
2031         /* Work around buggy UNIDEN UIP200 firmware */
2032         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
2033
2034         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
2035         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
2036                         ast_inet_ntoa(p->ourip.sin_addr),
2037                         ntohs(p->ourip.sin_port), p->branch, rport);
2038 }
2039
2040 /*! \brief NAT fix - decide which IP address to use for Asterisk server?
2041  *
2042  * Using the localaddr structure built up with localnet statements in sip.conf
2043  * apply it to their address to see if we need to substitute our
2044  * externip or can get away with our internal bindaddr
2045  * 'us' is always overwritten.
2046  */
2047 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us)
2048 {
2049         struct sockaddr_in theirs;
2050         /* Set want_remap to non-zero if we want to remap 'us' to an externally
2051          * reachable IP address and port. This is done if:
2052          * 1. we have a localaddr list (containing 'internal' addresses marked
2053          *    as 'deny', so ast_apply_ha() will return AST_SENSE_DENY on them,
2054          *    and AST_SENSE_ALLOW on 'external' ones);
2055          * 2. either stunaddr or externip is set, so we know what to use as the
2056          *    externally visible address;
2057          * 3. the remote address, 'them', is external;
2058          * 4. the address returned by ast_ouraddrfor() is 'internal' (AST_SENSE_DENY
2059          *    when passed to ast_apply_ha() so it does need to be remapped.
2060          *    This fourth condition is checked later.
2061          */
2062         int want_remap = localaddr &&
2063                 (externip.sin_addr.s_addr || stunaddr.sin_addr.s_addr) &&
2064                 ast_apply_ha(localaddr, &theirs) == AST_SENSE_ALLOW ;
2065
2066         *us = internip;         /* starting guess for the internal address */
2067         /* now ask the system what would it use to talk to 'them' */
2068         ast_ouraddrfor(them, &us->sin_addr);
2069         theirs.sin_addr = *them;
2070
2071         if (want_remap &&
2072             (!global_matchexterniplocally || !ast_apply_ha(localaddr, us)) ) {
2073                 /* if we used externhost or stun, see if it is time to refresh the info */
2074                 if (externexpire && time(NULL) >= externexpire) {
2075                         if (stunaddr.sin_addr.s_addr) {
2076                                 ast_stun_request(sipsock, &stunaddr, NULL, &externip);
2077                         } else {
2078                                 if (ast_parse_arg(externhost, PARSE_INADDR, &externip))
2079                                         ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
2080                         }
2081                         externexpire = time(NULL) + externrefresh;
2082                 }
2083                 if (externip.sin_addr.s_addr)
2084                         *us = externip;
2085                 else
2086                         ast_log(LOG_WARNING, "stun failed\n");
2087                 ast_debug(1, "Target address %s is not local, substituting externip\n", 
2088                         ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
2089         } else if (bindaddr.sin_addr.s_addr) {
2090                 /* no remapping, but we bind to a specific address, so use it. */
2091                 *us = bindaddr;
2092         }
2093 }
2094
2095 /*! \brief Append to SIP dialog history with arg list  */
2096 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
2097 {
2098         char buf[80], *c = buf; /* max history length */
2099         struct sip_history *hist;
2100         int l;
2101
2102         vsnprintf(buf, sizeof(buf), fmt, ap);
2103         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
2104         l = strlen(buf) + 1;
2105         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
2106                 return;
2107         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
2108                 ast_free(hist);
2109                 return;
2110         }
2111         memcpy(hist->event, buf, l);
2112         AST_LIST_INSERT_TAIL(p->history, hist, list);
2113 }
2114
2115 /*! \brief Append to SIP dialog history with arg list  */
2116 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2117 {
2118         va_list ap;
2119
2120         if (!p)
2121                 return;
2122         va_start(ap, fmt);
2123         append_history_va(p, fmt, ap);
2124         va_end(ap);
2125
2126         return;
2127 }
2128
2129 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
2130 static int retrans_pkt(void *data)
2131 {
2132         struct sip_pkt *pkt = data, *prev, *cur = NULL;
2133         int reschedule = DEFAULT_RETRANS;
2134         int xmitres = 0;
2135
2136         /* Lock channel PVT */
2137         sip_pvt_lock(pkt->owner);
2138
2139         if (pkt->retrans < MAX_RETRANS) {
2140                 pkt->retrans++;
2141                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
2142                         if (sipdebug)
2143                                 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);
2144                 } else {
2145                         int siptimer_a;
2146
2147                         if (sipdebug)
2148                                 ast_debug(4, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
2149                         if (!pkt->timer_a)
2150                                 pkt->timer_a = 2 ;
2151                         else
2152                                 pkt->timer_a = 2 * pkt->timer_a;
2153  
2154                         /* For non-invites, a maximum of 4 secs */
2155                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
2156                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
2157                                 siptimer_a = 4000;
2158                 
2159                         /* Reschedule re-transmit */
2160                         reschedule = siptimer_a;
2161                         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);
2162                 } 
2163
2164                 if (sip_debug_test_pvt(pkt->owner)) {
2165                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
2166                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
2167                                 pkt->retrans, sip_nat_mode(pkt->owner),
2168                                 ast_inet_ntoa(dst->sin_addr),
2169                                 ntohs(dst->sin_port), pkt->data);
2170                 }
2171
2172                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
2173                 xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
2174                 sip_pvt_unlock(pkt->owner);
2175                 if (xmitres == XMIT_ERROR)
2176                         ast_log(LOG_WARNING, "Network error on retransmit in dialog %s\n", pkt->owner->callid);
2177                 else 
2178                         return  reschedule;
2179         } 
2180         /* Too many retries */
2181         if (pkt->owner && pkt->method != SIP_OPTIONS && xmitres == 0) {
2182                 if (pkt->is_fatal || sipdebug)  /* Tell us if it's critical or if we're debugging */
2183                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s)\n",
2184                                 pkt->owner->callid, pkt->seqno,
2185                                 pkt->is_fatal ? "Critical" : "Non-critical", pkt->is_resp ? "Response" : "Request");
2186         } else if (pkt->method == SIP_OPTIONS && sipdebug) {
2187                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
2188
2189         } 
2190         if (xmitres == XMIT_ERROR) {
2191                 ast_log(LOG_WARNING, "Transmit error :: Cancelling transmission on Call ID %s\n", pkt->owner->callid);
2192                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2193         } else 
2194                 append_history(pkt->owner, "MaxRetries", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2195                 
2196         pkt->retransid = -1;
2197
2198         if (pkt->is_fatal) {
2199                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
2200                         sip_pvt_unlock(pkt->owner);     /* SIP_PVT, not channel */
2201                         usleep(1);
2202                         sip_pvt_lock(pkt->owner);
2203                 }
2204
2205                 if (pkt->owner->owner && !pkt->owner->owner->hangupcause) 
2206                         pkt->owner->owner->hangupcause = AST_CAUSE_NO_USER_RESPONSE;
2207                 
2208                 if (pkt->owner->owner) {
2209                         sip_alreadygone(pkt->owner);
2210                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
2211                         ast_queue_hangup(pkt->owner->owner);
2212                         ast_channel_unlock(pkt->owner->owner);
2213                 } else {
2214                         /* If no channel owner, destroy now */
2215
2216                         /* Let the peerpoke system expire packets when the timer expires for poke_noanswer */
2217                         if (pkt->method != SIP_OPTIONS && pkt->method != SIP_REGISTER) {
2218                                 pkt->owner->needdestroy = 1;
2219                                 sip_alreadygone(pkt->owner);
2220                                 append_history(pkt->owner, "DialogKill", "Killing this failed dialog immediately");
2221                         }
2222                 }
2223         }
2224
2225         if (pkt->method == SIP_BYE) {
2226                 /* We're not getting answers on SIP BYE's.  Tear down the call anyway. */
2227                 if (pkt->owner->owner) 
2228                         ast_channel_unlock(pkt->owner->owner);
2229                 append_history(pkt->owner, "ByeFailure", "Remote peer doesn't respond to bye. Destroying call anyway.");
2230                 pkt->owner->needdestroy = 1;
2231         }
2232
2233         /* Remove the packet */
2234         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
2235                 if (cur == pkt) {
2236                         UNLINK(cur, pkt->owner->packets, prev);
2237                         sip_pvt_unlock(pkt->owner);
2238                         ast_free(pkt);
2239                         return 0;
2240                 }
2241         }
2242         /* error case */
2243         ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
2244         sip_pvt_unlock(pkt->owner);
2245         return 0;
2246 }
2247
2248 /*! \brief Transmit packet with retransmits 
2249         \return 0 on success, -1 on failure to allocate packet 
2250 */
2251 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
2252 {
2253         struct sip_pkt *pkt;
2254         int siptimer_a = DEFAULT_RETRANS;
2255         int xmitres = 0;
2256
2257         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
2258                 return AST_FAILURE;
2259         memcpy(pkt->data, data, len);
2260         pkt->method = sipmethod;
2261         pkt->packetlen = len;
2262         pkt->next = p->packets;
2263         pkt->owner = p;
2264         pkt->seqno = seqno;
2265         if (resp)
2266                 pkt->is_resp = 1;
2267         pkt->data[len] = '\0';
2268         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
2269         if (fatal)
2270                 pkt->is_fatal = 1;
2271         if (pkt->timer_t1)
2272                 siptimer_a = pkt->timer_t1 * 2;
2273
2274         /* Schedule retransmission */
2275         pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
2276         if (sipdebug)
2277                 ast_debug(4, "*** SIP TIMER: Initalizing retransmit timer on packet: Id  #%d\n", pkt->retransid);
2278         pkt->next = p->packets;
2279         p->packets = pkt;
2280         if (sipmethod == SIP_INVITE) {
2281                 /* Note this is a pending invite */
2282                 p->pendinginvite = seqno;
2283         }
2284
2285         xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);    /* Send packet */
2286
2287         if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2288                 append_history(pkt->owner, "XmitErr", "%s", pkt->is_fatal ? "(Critical)" : "(Non-critical)");
2289                 ast_sched_del(sched, pkt->retransid);   /* No more retransmission */
2290                 pkt->retransid = -1;
2291                 return AST_FAILURE;
2292         } else
2293                 return AST_SUCCESS;
2294 }
2295
2296 /*! \brief Kill a SIP dialog (called by scheduler) */
2297 static int __sip_autodestruct(void *data)
2298 {
2299         struct sip_pvt *p = data;
2300
2301         /* If this is a subscription, tell the phone that we got a timeout */
2302         if (p->subscribed) {
2303                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1, TRUE);   /* Send last notification */
2304                 p->subscribed = NONE;
2305                 append_history(p, "Subscribestatus", "timeout");
2306                 ast_debug(3, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
2307                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
2308         }
2309
2310         if (p->subscribed == MWI_NOTIFICATION)
2311                 if (p->relatedpeer)
2312                         unref_peer(p->relatedpeer);     /* Remove link to peer. If it's realtime, make sure it's gone from memory) */
2313
2314         /* Reset schedule ID */
2315         p->autokillid = -1;
2316
2317         if (p->owner) {
2318                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
2319                 ast_queue_hangup(p->owner);
2320         } else if (p->refer) {
2321                 ast_debug(3, "Finally hanging up channel after transfer: %s\n", p->callid);
2322                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2323                 append_history(p, "ReferBYE", "Sending BYE on transferer call leg %s", p->callid);
2324                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
2325         } else {
2326                 append_history(p, "AutoDestroy", "%s", p->callid);
2327                 ast_debug(3, "Auto destroying SIP dialog '%s'\n", p->callid);
2328                 sip_destroy(p);         /* Go ahead and destroy dialog. All attempts to recover is done */
2329         }
2330         return 0;
2331 }
2332
2333 /*! \brief Schedule destruction of SIP dialog */
2334 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2335 {
2336         if (ms < 0) {
2337                 if (p->timer_t1 == 0)
2338                         p->timer_t1 = SIP_TIMER_T1;     /* Set timer T1 if not set (RFC 3261) */
2339                 ms = p->timer_t1 * 64;
2340         }
2341         if (sip_debug_test_pvt(p))
2342                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2343         if (p->do_history)
2344                 append_history(p, "SchedDestroy", "%d ms", ms);
2345
2346         if (p->autokillid > -1)
2347                 ast_sched_del(sched, p->autokillid);
2348         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
2349 }
2350
2351 /*! \brief Cancel destruction of SIP dialog */
2352 static void sip_cancel_destroy(struct sip_pvt *p)
2353 {
2354         if (p->autokillid > -1) {
2355                 ast_sched_del(sched, p->autokillid);
2356                 append_history(p, "CancelDestroy", "");
2357                 p->autokillid = -1;
2358         }
2359 }
2360
2361 /*! \brief Acknowledges receipt of a packet and stops retransmission */
2362 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2363 {
2364         struct sip_pkt *cur, *prev = NULL;
2365         const char *msg = "Not Found";  /* used only for debugging */
2366
2367         sip_pvt_lock(p);
2368
2369         /* If we have an outbound proxy for this dialog, then delete it now since
2370           the rest of the requests in this dialog needs to follow the routing.
2371           If obforcing is set, we will keep the outbound proxy during the whole
2372           dialog, regardless of what the SIP rfc says
2373         */
2374         if (p->outboundproxy && !p->outboundproxy->force)
2375                 p->outboundproxy = NULL;
2376
2377         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2378                 if (cur->seqno != seqno || cur->is_resp != resp)
2379                         continue;
2380                 if (cur->is_resp || cur->method == sipmethod) {
2381                         msg = "Found";
2382                         if (!resp && (seqno == p->pendinginvite)) {
2383                                 ast_debug(1, "Acked pending invite %d\n", p->pendinginvite);
2384                                 p->pendinginvite = 0;
2385                         }
2386                         if (cur->retransid > -1) {
2387                                 if (sipdebug)
2388                                         ast_debug(4, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2389                                 ast_sched_del(sched, cur->retransid);
2390                                 cur->retransid = -1;
2391                         }
2392                         UNLINK(cur, p->packets, prev);
2393                         ast_free(cur);
2394                         break;
2395                 }
2396         }
2397         sip_pvt_unlock(p);
2398         ast_debug(1, "Stopping retransmission on '%s' of %s %d: Match %s\n",
2399                 p->callid, resp ? "Response" : "Request", seqno, msg);
2400 }
2401
2402 /*! \brief Pretend to ack all packets
2403  * maybe the lock on p is not strictly necessary but there might be a race */
2404 static void __sip_pretend_ack(struct sip_pvt *p)
2405 {
2406         struct sip_pkt *cur = NULL;
2407
2408         while (p->packets) {
2409                 int method;
2410                 if (cur == p->packets) {
2411                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2412                         return;
2413                 }
2414                 cur = p->packets;
2415                 method = (cur->method) ? cur->method : find_sip_method(cur->data);
2416                 __sip_ack(p, cur->seqno, cur->is_resp, method);
2417         }
2418 }
2419
2420 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2421 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2422 {
2423         struct sip_pkt *cur;
2424         int res = -1;
2425
2426         for (cur = p->packets; cur; cur = cur->next) {
2427                 if (cur->seqno == seqno && cur->is_resp == resp &&
2428                         (cur->is_resp || method_match(sipmethod, cur->data))) {
2429                         /* this is our baby */
2430                         if (cur->retransid > -1) {
2431                                 if (sipdebug)
2432                                         ast_debug(4, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2433                                 ast_sched_del(sched, cur->retransid);
2434                                 cur->retransid = -1;
2435                         }
2436                         res = 0;
2437                         break;
2438                 }
2439         }
2440         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");
2441         return res;
2442 }
2443
2444
2445 /*! \brief Copy SIP request, parse it */
2446 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2447 {
2448         memset(dst, 0, sizeof(*dst));
2449         memcpy(dst->data, src->data, sizeof(dst->data));
2450         dst->len = src->len;
2451         parse_request(dst);
2452 }
2453
2454 /*! \brief add a blank line if no body */
2455 static void add_blank(struct sip_request *req)
2456 {
2457         if (!req->lines) {
2458                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2459                 snprintf(req->data + req->len, sizeof(req->data) - req->len, "\r\n");
2460                 req->len += strlen(req->data + req->len);
2461         }
2462 }
2463
2464 /*! \brief Transmit response on SIP request*/
2465 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2466 {
2467         int res;
2468
2469         add_blank(req);
2470         if (sip_debug_test_pvt(p)) {
2471                 const struct sockaddr_in *dst = sip_real_dst(p);
2472
2473                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
2474                         reliable ? "Reliably " : "", sip_nat_mode(p),
2475                         ast_inet_ntoa(dst->sin_addr),
2476                         ntohs(dst->sin_port), req->data);
2477         }
2478         if (p->do_history) {
2479                 struct sip_request tmp;
2480                 parse_copy(&tmp, req);
2481                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), 
2482                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
2483         }
2484         res = (reliable) ?
2485                  __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2486                 __sip_xmit(p, req->data, req->len);
2487         if (res > 0)
2488                 return 0;
2489         return res;
2490 }
2491
2492 /*! \brief Send SIP Request to the other part of the dialogue */
2493 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2494 {
2495         int res;
2496
2497         /* If we have an outbound proxy, reset peer address 
2498                 Only do this once.
2499         */
2500         if (p->outboundproxy) {
2501                 p->sa = p->outboundproxy->ip;
2502         }
2503
2504         add_blank(req);
2505         if (sip_debug_test_pvt(p)) {
2506                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
2507                         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);
2508                 else
2509                         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);
2510         }
2511         if (p->do_history) {
2512                 struct sip_request tmp;
2513                 parse_copy(&tmp, req);
2514                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
2515         }
2516         res = (reliable) ?
2517                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2518                 __sip_xmit(p, req->data, req->len);
2519         return res;
2520 }
2521
2522 /*! \brief Locate closing quote in a string, skipping escaped quotes.
2523  * optionally with a limit on the search.
2524  * start must be past the first quote.
2525  */
2526 static const char *find_closing_quote(const char *start, const char *lim)
2527 {
2528         char last_char = '\0';
2529         const char *s;
2530         for (s = start; *s && s != lim; last_char = *s++) {
2531                 if (*s == '"' && last_char != '\\')
2532                         break;
2533         }
2534         return s;
2535 }
2536
2537 /*! \brief Pick out text in brackets from character string
2538         \return pointer to terminated stripped string
2539         \param tmp input string that will be modified
2540         Examples:
2541 \verbatim
2542         "foo" <bar>     valid input, returns bar
2543         foo             returns the whole string
2544         < "foo ... >    returns the string between brackets
2545         < "foo...       bogus (missing closing bracket), returns the whole string
2546                         XXX maybe should still skip the opening bracket
2547 \endverbatim
2548  */
2549 static char *get_in_brackets(char *tmp)
2550 {
2551         const char *parse = tmp;
2552         char *first_bracket;
2553
2554         /*
2555          * Skip any quoted text until we find the part in brackets.
2556         * On any error give up and return the full string.
2557         */
2558         while ( (first_bracket = strchr(parse, '<')) ) {
2559                 char *first_quote = strchr(parse, '"');
2560
2561                 if (!first_quote || first_quote > first_bracket)
2562                         break; /* no need to look at quoted part */
2563                 /* the bracket is within quotes, so ignore it */
2564                 parse = find_closing_quote(first_quote + 1, NULL);
2565                 if (!*parse) { /* not found, return full string ? */
2566                         /* XXX or be robust and return in-bracket part ? */
2567                         ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
2568                         break;
2569                 }
2570                 parse++;
2571         }
2572         if (first_bracket) {
2573                 char *second_bracket = strchr(first_bracket + 1, '>');
2574                 if (second_bracket) {
2575                         *second_bracket = '\0';
2576                         tmp = first_bracket + 1;
2577                 } else {
2578                         ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
2579                 }
2580         }
2581         return tmp;
2582 }
2583
2584 /*! \brief * parses a URI in its components.
2585  *
2586  * \note 
2587  *- If scheme is specified, drop it from the top.
2588  * - If a component is not requested, do not split around it.
2589  * This means that if we don't have domain, we cannot split
2590  * name:pass and domain:port.
2591  * It is safe to call with ret_name, pass, domain, port
2592  * pointing all to the same place.
2593  * Init pointers to empty string so we never get NULL dereferencing.
2594  * Overwrites the string.
2595  * return 0 on success, other values on error.
2596  * \verbatim 
2597  * general form we are expecting is sip[s]:username[:password][;parameter]@host[:port][;...] 
2598  * \endverbatim
2599  */
2600 static int parse_uri(char *uri, char *scheme,
2601         char **ret_name, char **pass, char **domain, char **port, char **options)
2602 {
2603         char *name = NULL;
2604         int error = 0;
2605
2606         /* init field as required */
2607         if (pass)
2608                 *pass = "";
2609         if (port)
2610                 *port = "";
2611         if (scheme) {
2612                 int l = strlen(scheme);
2613                 if (!strncasecmp(uri, scheme, l))
2614                         uri += l;
2615                 else {
2616                         ast_log(LOG_NOTICE, "Missing scheme '%s' in '%s'\n", scheme, uri);
2617                         error = -1;
2618                 }
2619         }
2620         if (!domain) {
2621                 /* if we don't want to split around domain, keep everything as a name,
2622                  * so we need to do nothing here, except remember why.
2623                  */
2624         } else {
2625                 /* store the result in a temp. variable to avoid it being
2626                  * overwritten if arguments point to the same place.
2627                  */
2628                 char *c, *dom = "";
2629
2630                 if ((c = strchr(uri, '@')) == NULL) {
2631                         /* domain-only URI, according to the SIP RFC. */
2632                         dom = uri;
2633                         name = "";
2634                 } else {
2635                         *c++ = '\0';
2636                         dom = c;
2637                         name = uri;
2638                 }
2639
2640                 /* Remove options in domain and name */
2641                 dom = strsep(&dom, ";");
2642                 name = strsep(&name, ";");
2643
2644                 if (port && (c = strchr(dom, ':'))) { /* Remove :port */
2645                         *c++ = '\0';
2646                         *port = c;
2647                 }
2648                 if (pass && (c = strchr(name, ':'))) {  /* user:password */
2649                         *c++ = '\0';
2650                         *pass = c;
2651                 }
2652                 *domain = dom;
2653         }
2654         if (ret_name)   /* same as for domain, store the result only at the end */
2655                 *ret_name = name;
2656         if (options)
2657                 *options = uri ? uri : "";
2658
2659         return error;
2660 }
2661
2662 /*! \brief Send message with Access-URL header, if this is an HTML URL only! */
2663 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen)
2664 {
2665         struct sip_pvt *p = chan->tech_pvt;
2666
2667         if (subclass != AST_HTML_URL)
2668                 return -1;
2669
2670         ast_string_field_build(p, url, "<%s>;mode=active", data);
2671
2672         if (sip_debug_test_pvt(p))
2673                 ast_debug(1, "Send URL %s, state = %d!\n", data, chan->_state);
2674
2675         switch (chan->_state) {
2676         case AST_STATE_RING:
2677                 transmit_response(p, "100 Trying", &p->initreq);
2678                 break;
2679         case AST_STATE_RINGING:
2680                 transmit_response(p, "180 Ringing", &p->initreq);
2681                 break;
2682         case AST_STATE_UP:
2683                 if (!p->pendinginvite) {                /* We are up, and have no outstanding invite */
2684                         transmit_reinvite_with_sdp(p, FALSE);
2685                 } else if (!ast_test_flag(&p->flags[0], SIP_PENDINGBYE)) {
2686                         ast_set_flag(&p->flags[0], SIP_NEEDREINVITE);   
2687                 }       
2688                 break;
2689         default:
2690                 ast_log(LOG_WARNING, "Don't know how to send URI when state is %d!\n", chan->_state);
2691         }
2692
2693         return 0;
2694 }
2695
2696 /*! \brief Send SIP MESSAGE text within a call
2697         Called from PBX core sendtext() application */
2698 static int sip_sendtext(struct ast_channel *ast, const char *text)
2699 {
2700         struct sip_pvt *p = ast->tech_pvt;
2701         int debug = sip_debug_test_pvt(p);
2702
2703         if (debug)
2704                 ast_verbose("Sending text %s on %s\n", text, ast->name);
2705         if (!p)
2706                 return -1;
2707         if (ast_strlen_zero(text))
2708                 return 0;
2709         if (debug)
2710                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
2711         transmit_message_with_text(p, text);
2712         return 0;       
2713 }
2714
2715 /*! \brief Update peer object in realtime storage 
2716         If the Asterisk system name is set in asterisk.conf, we will use
2717         that name and store that in the "regserver" field in the sippeers
2718         table to facilitate multi-server setups.
2719 */
2720 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
2721 {
2722         char port[10];
2723         char ipaddr[INET_ADDRSTRLEN];
2724         char regseconds[20];
2725         char *tablename = NULL;
2726
2727         char *sysname = ast_config_AST_SYSTEM_NAME;
2728         char *syslabel = NULL;
2729
2730         time_t nowtime = time(NULL) + expirey;
2731         const char *fc = fullcontact ? "fullcontact" : NULL;
2732
2733         int realtimeregs = ast_check_realtime("sipregs");
2734
2735         tablename = realtimeregs ? "sipregs" : "sippeers";
2736         
2737         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
2738         ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2739         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
2740         
2741         if (ast_strlen_zero(sysname))   /* No system name, disable this */
2742                 sysname = NULL;
2743         else if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTSAVE_SYSNAME))
2744                 syslabel = "regserver";
2745
2746         if (fc)
2747                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
2748                         "port", port, "regseconds", regseconds,
2749                         "username", username, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
2750         else
2751                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
2752                         "port", port, "regseconds", regseconds,
2753                         "username", username, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
2754 }
2755
2756 /*! \brief Automatically add peer extension to dial plan */
2757 static void register_peer_exten(struct sip_peer *peer, int onoff)
2758 {
2759         char multi[256];
2760         char *stringp, *ext, *context;
2761
2762         /* XXX note that global_regcontext is both a global 'enable' flag and
2763          * the name of the global regexten context, if not specified
2764          * individually.
2765          */
2766         if (ast_strlen_zero(global_regcontext))
2767                 return;
2768
2769         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
2770         stringp = multi;
2771         while ((ext = strsep(&stringp, "&"))) {
2772                 if ((context = strchr(ext, '@'))) {
2773                         *context++ = '\0';      /* split ext@context */
2774                         if (!ast_context_find(context)) {
2775                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
2776                                 continue;
2777                         }
2778                 } else {
2779                         context = global_regcontext;
2780                 }
2781                 if (onoff)
2782                         ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
2783                                  ast_strdup(peer->name), ast_free, "SIP");
2784                 else
2785                         ast_context_remove_extension(context, ext, 1, NULL);
2786         }
2787 }
2788
2789 /*! \brief Destroy peer object from memory */
2790 static void sip_destroy_peer(struct sip_peer *peer)
2791 {
2792         ast_debug(3, "Destroying SIP peer %s\n", peer->name);
2793
2794         if (peer->outboundproxy)
2795                 ast_free(peer->outboundproxy);
2796
2797         /* Delete it, it needs to disappear */
2798         if (peer->call)
2799                 peer->call = sip_destroy(peer->call);
2800
2801         if (peer->mwipvt)       /* We have an active subscription, delete it */
2802                 peer->mwipvt = sip_destroy(peer->mwipvt);
2803
2804         if (peer->mwi_event_sub) {
2805                 ast_event_unsubscribe(peer->mwi_event_sub);
2806                 peer->mwi_event_sub = NULL;
2807         }
2808
2809         if (peer->chanvars) {
2810                 ast_variables_destroy(peer->chanvars);
2811                 peer->chanvars = NULL;
2812         }
2813         if (peer->expire > -1)
2814                 ast_sched_del(sched, peer->expire);
2815
2816         if (peer->pokeexpire > -1)
2817                 ast_sched_del(sched, peer->pokeexpire);
2818         register_peer_exten(peer, FALSE);
2819         ast_free_ha(peer->ha);
2820         if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
2821                 apeerobjs--;
2822         else if (peer->is_realtime) {
2823                 rpeerobjs--;
2824                 ast_debug(3,"-REALTIME- peer Destroyed. Name: %s. Realtime Peer objects: %d\n", peer->name, rpeerobjs);
2825         } else
2826                 speerobjs--;
2827         clear_realm_authentication(peer->auth);
2828         peer->auth = NULL;
2829         if (peer->dnsmgr)
2830                 ast_dnsmgr_release(peer->dnsmgr);
2831         ast_free(peer);
2832 }
2833
2834 /*! \brief Update peer data in database (if used) */
2835 static void update_peer(struct sip_peer *p, int expiry)
2836 {
2837         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2838         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
2839             (p->is_realtime || rtcachefriends)) {
2840                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
2841         }
2842 }
2843
2844
2845 /*! \brief  realtime_peer: Get peer from realtime storage
2846  * Checks the "sippeers" realtime family from extconfig.conf 
2847  * Checks the "sipregs" realtime family from extconfig.conf if it's configured.
2848  * \todo Consider adding check of port address when matching here to follow the same
2849  *      algorithm as for static peers. Will we break anything by adding that?
2850 */
2851 static struct sip_peer *realtime_peer(const char *newpeername, struct sockaddr_in *sin)
2852 {
2853         struct sip_peer *peer;
2854         struct ast_variable *var = NULL;
2855         struct ast_variable *varregs = NULL;
2856         struct ast_variable *tmp;
2857         char ipaddr[INET_ADDRSTRLEN];
2858         int realtimeregs = ast_check_realtime("sipregs");
2859
2860         /* First check on peer name */
2861         if (newpeername) {
2862                 var = ast_load_realtime("sippeers", "name", newpeername, NULL);
2863                 if (realtimeregs)
2864                         varregs = ast_load_realtime("sipregs", "name", newpeername, NULL);
2865         } else if (sin) {       /* Then check on IP address for dynamic peers */
2866                 ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2867                 var = ast_load_realtime("sippeers", "host", ipaddr, NULL);      /* First check for fixed IP hosts */
2868                 if (var) {
2869                         if (realtimeregs) {
2870                                 tmp = var;
2871                                 while (tmp) {
2872                                         if (!newpeername && !strcasecmp(tmp->name, "name"))
2873                                                 newpeername = tmp->value;
2874                                         tmp = tmp->next;
2875                                 }
2876                                 varregs = ast_load_realtime("sipregs", "name", newpeername, NULL);
2877                         }
2878                 } else {
2879                         if (realtimeregs)
2880                                 varregs = ast_load_realtime("sipregs", "ipaddr", ipaddr, NULL); /* Then check for registered hosts */
2881                         else
2882                                 var = ast_load_realtime("sippeers", "ipaddr", ipaddr, NULL); /* Then check for registered hosts */
2883                         if (varregs) {
2884                                 tmp = varregs;
2885                                 while (tmp) {
2886                                         if (!newpeername && !strcasecmp(tmp->name, "name"))
2887                                                 newpeername = tmp->value;
2888                                         tmp = tmp->next;
2889                                 }
2890                                 var = ast_load_realtime("sippeers", "name", newpeername, NULL);
2891                         }
2892                 }
2893         }
2894
2895         if (!var)
2896                 return NULL;
2897
2898         for (tmp = var; tmp; tmp = tmp->next) {
2899                 /* If this is type=user, then skip this object. */
2900                 if (!strcasecmp(tmp->name, "type") &&
2901                     !strcasecmp(tmp->value, "user")) {
2902                         ast_variables_destroy(var);
2903                         ast_variables_destroy(varregs);
2904                         return NULL;
2905                 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
2906                         newpeername = tmp->value;
2907                 }
2908         }
2909         
2910         if (!newpeername) {     /* Did not find peer in realtime */
2911                 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", ipaddr);
2912                 ast_variables_destroy(var);
2913                 return NULL;
2914         }
2915
2916
2917         /* Peer found in realtime, now build it in memory */
2918         peer = build_peer(newpeername, var, varregs, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2919         if (!peer) {
2920                 ast_variables_destroy(var);
2921                 ast_variables_destroy(varregs);
2922                 return NULL;
2923         }
2924
2925         ast_debug(3,"-REALTIME- loading peer from database to memory. Name: %s. Peer objects: %d\n", peer->name, rpeerobjs);
2926
2927         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2928                 /* Cache peer */
2929                 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
2930                 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
2931                         if (peer->expire > -1) {
2932                                 ast_sched_del(sched, peer->expire);
2933                         }
2934                         peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
2935                 }
2936                 ASTOBJ_CONTAINER_LINK(&peerl,peer);
2937         } else {
2938                 peer->is_realtime = 1;
2939         }
2940         ast_variables_destroy(var);
2941         ast_variables_destroy(varregs);
2942
2943         return peer;
2944 }
2945
2946 /*! \brief Support routine for find_peer */
2947 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
2948 {
2949         /* We know name is the first field, so we can cast */
2950         struct sip_peer *p = (struct sip_peer *) name;
2951         return  !(!inaddrcmp(&p->addr, sin) || 
2952                                         (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
2953                                         (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
2954 }
2955
2956 /*! \brief Locate peer by name or ip address 
2957  *      This is used on incoming SIP message to find matching peer on ip
2958         or outgoing message to find matching peer on name */
2959 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
2960 {
2961         struct sip_peer *p = NULL;
2962
2963         if (peer)
2964                 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
2965         else
2966                 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
2967
2968         if (!p && realtime)
2969                 p = realtime_peer(peer, sin);
2970
2971         return p;
2972 }
2973
2974 /*! \brief Remove user object from in-memory storage */
2975 static void sip_destroy_user(struct sip_user *user)
2976 {
2977         ast_debug(3, "Destroying user object from memory: %s\n", user->name);
2978         ast_free_ha(user->ha);
2979         if (user->chanvars) {
2980                 ast_variables_destroy(user->chanvars);
2981                 user->chanvars = NULL;
2982         }
2983         if (user->is_realtime)
2984                 ruserobjs--;
2985         else
2986                 suserobjs--;
2987         ast_free(user);
2988 }
2989
2990 /*! \brief Load user from realtime storage
2991  * Loads user from "sipusers" category in realtime (extconfig.conf)
2992  * Users are matched on From: user name (the domain in skipped) */
2993 static struct sip_user *realtime_user(const char *username)
2994 {
2995         struct ast_variable *var;
2996         struct ast_variable *tmp;
2997         struct sip_user *user = NULL;
2998
2999         var = ast_load_realtime("sipusers", "name", username, NULL);
3000
3001         if (!var)
3002                 return NULL;
3003
3004         for (tmp = var; tmp; tmp = tmp->next) {
3005                 if (!strcasecmp(tmp->name, "type") &&
3006                         !strcasecmp(tmp->value, "peer")) {
3007                         ast_variables_destroy(var);
3008                         return NULL;
3009                 }
3010         }
3011
3012         user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
3013         
3014         if (!user) {    /* No user found */
3015                 ast_variables_destroy(var);
3016                 return NULL;
3017         }
3018
3019         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
3020                 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
3021                 suserobjs++;
3022                 ASTOBJ_CONTAINER_LINK(&userl,user);
3023         } else {
3024                 /* Move counter from s to r... */
3025                 suserobjs--;
3026                 ruserobjs++;
3027                 user->is_realtime = 1;
3028         }
3029         ast_variables_destroy(var);
3030         return user;
3031 }
3032