document the way sipdebug works, and implement it through
[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 struct sip_request {
636         char *rlPart1;          /*!< SIP Method Name or "SIP/2.0" protocol version */
637         char *rlPart2;          /*!< The Request URI or Response Status */
638         int len;                /*!< Length */
639         int headers;            /*!< # of SIP Headers */
640         int method;             /*!< Method of this request */
641         int lines;              /*!< Body Content */
642         unsigned int flags;     /*!< SIP_PKT Flags for this packet */
643         char *header[SIP_MAX_HEADERS];
644         char *line[SIP_MAX_LINES];
645         char data[SIP_MAX_PACKET];
646         unsigned int sdp_start; /*!< the line number where the SDP begins */
647         unsigned int sdp_end;   /*!< the line number where the SDP ends */
648 };
649
650 /*
651  * A sip packet is stored into the data[] buffer, with the header followed
652  * by an empty line and the body of the message.
653  * On outgoing packets, data is accumulated in data[] with len reflecting
654  * the next available byte, headers and lines count the number of lines
655  * in both parts. There are no '\0' in data[0..len-1].
656  *
657  * On received packet, the input read from the socket is copied into data[],
658  * len is set and the string is NUL-terminated. Then a parser fills up
659  * the other fields -header[] and line[] to point to the lines of the
660  * message, rlPart1 and rlPart2 parse the first lnie as below:
661  *
662  * Requests have in the first line      METHOD URI SIP/2.0
663  *      rlPart1 = method; rlPart2 = uri;
664  * Responses have in the first line     SIP/2.0 code description
665  *      rlPart1 = SIP/2.0; rlPart2 = code + description;
666  *
667  */
668
669 /*! \brief structure used in transfers */
670 struct sip_dual {
671         struct ast_channel *chan1;      /*!< First channel involved */
672         struct ast_channel *chan2;      /*!< Second channel involved */
673         struct sip_request req;         /*!< Request that caused the transfer (REFER) */
674         int seqno;                      /*!< Sequence number */
675 };
676
677 struct sip_pkt;
678
679 /*! \brief Parameters to the transmit_invite function */
680 struct sip_invite_param {
681         int addsipheaders;              /*!< Add extra SIP headers */
682         const char *uri_options;        /*!< URI options to add to the URI */
683         const char *vxml_url;           /*!< VXML url for Cisco phones */
684         char *auth;                     /*!< Authentication */
685         char *authheader;               /*!< Auth header */
686         enum sip_auth_type auth_type;   /*!< Authentication type */
687         const char *replaces;           /*!< Replaces header for call transfers */
688         int transfer;                   /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
689 };
690
691 /*! \brief Structure to save routing information for a SIP session */
692 struct sip_route {
693         struct sip_route *next;
694         char hop[0];
695 };
696
697 /*! \brief Modes for SIP domain handling in the PBX */
698 enum domain_mode {
699         SIP_DOMAIN_AUTO,                /*!< This domain is auto-configured */
700         SIP_DOMAIN_CONFIG,              /*!< This domain is from configuration */
701 };
702
703 /*! \brief Domain data structure. 
704         \note In the future, we will connect this to a configuration tree specific
705         for this domain
706 */
707 struct domain {
708         char domain[MAXHOSTNAMELEN];            /*!< SIP domain we are responsible for */
709         char context[AST_MAX_EXTENSION];        /*!< Incoming context for this domain */
710         enum domain_mode mode;                  /*!< How did we find this domain? */
711         AST_LIST_ENTRY(domain) list;            /*!< List mechanics */
712 };
713
714 static AST_LIST_HEAD_STATIC(domain_list, domain);       /*!< The SIP domain list */
715
716
717 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
718 struct sip_history {
719         AST_LIST_ENTRY(sip_history) list;
720         char event[0];  /* actually more, depending on needs */
721 };
722
723 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
724
725 /*! \brief sip_auth: Credentials for authentication to other SIP services */
726 struct sip_auth {
727         char realm[AST_MAX_EXTENSION];  /*!< Realm in which these credentials are valid */
728         char username[256];             /*!< Username */
729         char secret[256];               /*!< Secret */
730         char md5secret[256];            /*!< MD5Secret */
731         struct sip_auth *next;          /*!< Next auth structure in list */
732 };
733
734 /*--- Various flags for the flags field in the pvt structure 
735         Trying to sort these up:
736         D: Dialog only
737         DP: Dialog and peer/user
738         P: Peer/user only, not dialog
739         G: Global flag only
740 */
741 #define __SIP_ALREADYGONE               (1 << 0)        /*!< D: Whether or not we've already been destroyed by our peer */
742 #define __SIP_NEEDDESTROY               (1 << 1)        /*!< D: if we need to be destroyed by the monitor thread */
743 #define SIP_NOVIDEO             (1 << 2)        /*!< D: Didn't get video in invite, don't offer */
744 #define SIP_RINGING             (1 << 3)        /*!< D: Have sent 180 ringing */
745 #define SIP_PROGRESS_SENT       (1 << 4)        /*!< D: Have sent 183 message progress */
746 #define SIP_NEEDREINVITE        (1 << 5)        /*!< D: Do we need to send another reinvite? */
747 #define SIP_PENDINGBYE          (1 << 6)        /*!< D: Need to send bye after we ack? */
748 #define SIP_GOTREFER            (1 << 7)        /*!< D: Got a refer? */
749 #define SIP_PROMISCREDIR        (1 << 8)        /*!< DP: Promiscuous redirection */
750 #define SIP_TRUSTRPID           (1 << 9)        /*!< DP: Trust RPID headers? */
751 #define SIP_USEREQPHONE         (1 << 10)       /*!< DP: Add user=phone to numeric URI. Default off */
752 #define __SIP_REALTIME                  (1 << 11)       /*!< P: Flag for realtime users */
753 #define SIP_USECLIENTCODE       (1 << 12)       /*!< DP: Trust X-ClientCode info message */
754 #define SIP_OUTGOING            (1 << 13)       /*!< D: Direction of the last transaction in this dialog */
755 #define SIP_DIALOG_ANSWEREDELSEWHERE    (1 << 14)       /*!< D: This call is cancelled due to answer on another channel */
756 #define SIP_DEFER_BYE_ON_TRANSFER       (1 << 15)       /*!< D: Do not hangup at first ast_hangup */
757 #define SIP_DTMF                (3 << 16)       /*!< DP: DTMF Support: four settings, uses two bits */
758 #define SIP_DTMF_RFC2833        (0 << 16)       /*!< DP: DTMF Support: RTP DTMF - "rfc2833" */
759 #define SIP_DTMF_INBAND         (1 << 16)       /*!< DP: DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
760 #define SIP_DTMF_INFO           (2 << 16)       /*!< DP: DTMF Support: SIP Info messages - "info" */
761 #define SIP_DTMF_AUTO           (3 << 16)       /*!< DP: DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
762 /* NAT settings */
763 #define SIP_NAT                 (3 << 18)       /*!< DP: four settings, uses two bits */
764 #define SIP_NAT_NEVER           (0 << 18)       /*!< DP: No nat support */
765 #define SIP_NAT_RFC3581         (1 << 18)       /*!< DP: NAT RFC3581 */
766 #define SIP_NAT_ROUTE           (2 << 18)       /*!< DP: NAT Only ROUTE */
767 #define SIP_NAT_ALWAYS          (3 << 18)       /*!< DP: NAT Both ROUTE and RFC3581 */
768 /* re-INVITE related settings */
769 #define SIP_REINVITE            (7 << 20)       /*!< DP: three bits used */
770 #define SIP_CAN_REINVITE        (1 << 20)       /*!< DP: allow peers to be reinvited to send media directly p2p */
771 #define SIP_CAN_REINVITE_NAT    (2 << 20)       /*!< DP: allow media reinvite when new peer is behind NAT */
772 #define SIP_REINVITE_UPDATE     (4 << 20)       /*!< DP: use UPDATE (RFC3311) when reinviting this peer */
773 /* "insecure" settings */
774 #define SIP_INSECURE_PORT       (1 << 23)       /*!< DP: don't require matching port for incoming requests */
775 #define SIP_INSECURE_INVITE     (1 << 24)       /*!< DP: don't require authentication for incoming INVITEs */
776 /* Sending PROGRESS in-band settings */
777 #define SIP_PROG_INBAND         (3 << 25)       /*!< DP: three settings, uses two bits */
778 #define SIP_PROG_INBAND_NEVER   (0 << 25)
779 #define SIP_PROG_INBAND_NO      (1 << 25)
780 #define SIP_PROG_INBAND_YES     (2 << 25)
781 #define __SIP_NO_HISTORY                (1 << 27)       /*!< D: Suppress recording request/response history */
782 #define SIP_CALL_LIMIT          (1 << 28)       /*!< D: Call limit enforced for this call */
783 #define SIP_SENDRPID            (1 << 29)       /*!< DP: Remote Party-ID Support */
784 #define SIP_INC_COUNT           (1 << 30)       /*!< D: Did this dialog increment the counter of in-use calls? */
785 #define SIP_G726_NONSTANDARD    (1 << 31)       /*!< DP: Use non-standard packing for G726-32 data */
786
787 /*! \brief Flags to copy from peer/user to dialog */
788 #define SIP_FLAGS_TO_COPY \
789         (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
790          SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT | SIP_G726_NONSTANDARD | \
791          SIP_USEREQPHONE | SIP_INSECURE_PORT | SIP_INSECURE_INVITE)
792
793 /*--- a new page of flags (for flags[1] */
794 /* realtime flags */
795 #define SIP_PAGE2_RTCACHEFRIENDS        (1 << 0)        /*!< G: Should we keep RT objects in memory for extended time? */
796 #define SIP_PAGE2_RTUPDATE              (1 << 1)        /*!< G: Update database with registration data for peer? */
797 #define SIP_PAGE2_RTAUTOCLEAR           (1 << 2)        /*!< G: Should we clean memory from peers after expiry? */
798 #define SIP_PAGE2_RT_FROMCONTACT        (1 << 4)        
799 #define SIP_PAGE2_RTSAVE_SYSNAME        (1 << 5)        /*!< G: Save system name at registration? */
800 /* Space for addition of other realtime flags in the future */
801 #define SIP_PAGE2_IGNOREREGEXPIRE       (1 << 10)       /*!< G: Ignore expiration of peer  */
802 #define __SIP_PAGE2_DEBUG                       (3 << 11)       /*!< G: Debug flags */
803 #define __SIP_PAGE2_DEBUG_CONFIG                (1 << 11)       /*!< G: Debug flags */
804 #define __SIP_PAGE2_DEBUG_CONSOLE               (1 << 12)       /*!< G: Debug flags */
805 #define SIP_PAGE2_DYNAMIC               (1 << 13)       /*!< P: Dynamic Peers register with Asterisk */
806 #define SIP_PAGE2_SELFDESTRUCT          (1 << 14)       /*!< P: Automatic peers need to destruct themselves */
807 #define SIP_PAGE2_VIDEOSUPPORT          (1 << 15)       /*!< DP: Video supported if offered? */
808 #define SIP_PAGE2_ALLOWSUBSCRIBE        (1 << 16)       /*!< GP: Allow subscriptions from this peer? */
809 #define SIP_PAGE2_ALLOWOVERLAP          (1 << 17)       /*!< DP: Allow overlap dialing ? */
810 #define SIP_PAGE2_SUBSCRIBEMWIONLY      (1 << 18)       /*!< GP: Only issue MWI notification if subscribed to */
811 #define SIP_PAGE2_INC_RINGING           (1 << 19)       /*!< D: Did this connection increment the counter of in-use calls? */
812 #define SIP_PAGE2_T38SUPPORT            (7 << 20)       /*!< GDP: T38 Fax Passthrough Support */
813 #define SIP_PAGE2_T38SUPPORT_UDPTL      (1 << 20)       /*!< GDP: 20: T38 Fax Passthrough Support */
814 #define SIP_PAGE2_T38SUPPORT_RTP        (2 << 20)       /*!< GDP: 21: T38 Fax Passthrough Support (not implemented) */
815 #define SIP_PAGE2_T38SUPPORT_TCP        (4 << 20)       /*!< GDP: 22: T38 Fax Passthrough Support (not implemented) */
816 #define SIP_PAGE2_CALL_ONHOLD           (3 << 23)       /*!< D: Call hold states */
817 #define SIP_PAGE2_CALL_ONHOLD_ACTIVE    (1 << 23)       /*!< D: 23: Active hold */
818 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR    (2 << 23)       /*!< D: 23: One directional hold */
819 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE  (3 << 23)       /*!< D: 23: Inactive hold */
820 #define SIP_PAGE2_RFC2833_COMPENSATE    (1 << 25)       /*!< DP: 25: Compensate for buggy RFC2833 implementations */
821 #define SIP_PAGE2_BUGGY_MWI             (1 << 26)       /*!< DP: 26: Buggy CISCO MWI fix */
822 #define SIP_PAGE2_NOTEXT                (1 << 27)       /*!< GPD: 27: Text not supported  */
823 #define SIP_PAGE2_TEXTSUPPORT           (1 << 28)       /*!< GPD: 28: Global text enable */
824 #define __SIP_PAGE2_DEBUG_TEXT          (1 << 29)       /*!< GPD: 29: Global text debug */
825 #define SIP_PAGE2_OUTGOING_CALL         (1 << 30)       /*!< D: 30: Is this an outgoing call? */
826
827 #define SIP_PAGE2_FLAGS_TO_COPY \
828         (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_VIDEOSUPPORT | \
829         SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE | SIP_PAGE2_BUGGY_MWI | \
830         SIP_PAGE2_TEXTSUPPORT )
831
832 /* SIP packet flags */
833 #define SIP_PKT_DEBUG           (1 << 0)        /*!< Debug this packet */
834 #define SIP_PKT_WITH_TOTAG      (1 << 1)        /*!< This packet has a to-tag */
835 #define SIP_PKT_IGNORE          (1 << 2)        /*!< This is a re-transmit, ignore it */
836
837 /* T.38 set of flags */
838 #define T38FAX_FILL_BIT_REMOVAL         (1 << 0)        /*!< Default: 0 (unset)*/
839 #define T38FAX_TRANSCODING_MMR                  (1 << 1)        /*!< Default: 0 (unset)*/
840 #define T38FAX_TRANSCODING_JBIG         (1 << 2)        /*!< Default: 0 (unset)*/
841 /* Rate management */
842 #define T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF   (0 << 3)
843 #define T38FAX_RATE_MANAGEMENT_LOCAL_TCF        (1 << 3)        /*!< Unset for transferredTCF (UDPTL), set for localTCF (TPKT) */
844 /* UDP Error correction */
845 #define T38FAX_UDP_EC_NONE                      (0 << 4)        /*!< two bits, if unset NO t38UDPEC field in T38 SDP*/
846 #define T38FAX_UDP_EC_FEC                       (1 << 4)        /*!< Set for t38UDPFEC */
847 #define T38FAX_UDP_EC_REDUNDANCY                (2 << 4)        /*!< Set for t38UDPRedundancy */
848 /* T38 Spec version */
849 #define T38FAX_VERSION                          (3 << 6)        /*!< two bits, 2 values so far, up to 4 values max */
850 #define T38FAX_VERSION_0                        (0 << 6)        /*!< Version 0 */
851 #define T38FAX_VERSION_1                        (1 << 6)        /*!< Version 1 */
852 /* Maximum Fax Rate */
853 #define T38FAX_RATE_2400                        (1 << 8)        /*!< 2400 bps t38FaxRate */
854 #define T38FAX_RATE_4800                        (1 << 9)        /*!< 4800 bps t38FaxRate */
855 #define T38FAX_RATE_7200                        (1 << 10)       /*!< 7200 bps t38FaxRate */
856 #define T38FAX_RATE_9600                        (1 << 11)       /*!< 9600 bps t38FaxRate */
857 #define T38FAX_RATE_12000                       (1 << 12)       /*!< 12000 bps t38FaxRate */
858 #define T38FAX_RATE_14400                       (1 << 13)       /*!< 14400 bps t38FaxRate */
859
860 /*!< This is default: NO MMR and JBIG transcoding, NO fill bit removal, transferredTCF TCF, UDP FEC, Version 0 and 9600 max fax rate */
861 static int global_t38_capability = T38FAX_VERSION_0 | T38FAX_RATE_2400 | T38FAX_RATE_4800 | T38FAX_RATE_7200 | T38FAX_RATE_9600;
862
863 /*! \brief debugging state
864  * We store separately the debugging requests from the config file
865  * and requests from the CLI. Debugging is enabled if either is set
866  * (which means that if sipdebug is set in the config file, we can
867  * only turn it off by reloading the config).
868  */
869 enum sip_debug_e {
870         sip_debug_none = 0,
871         sip_debug_config = 1,
872         sip_debug_console = 2,
873 };
874
875 static enum sip_debug_e sipdebug;
876
877 /*! \brief extra debugging for 'text' related events.
878  * At thie moment this is set together with sip_debug_console.
879  * It should either go away or be implemented properly.
880  */
881 static int sipdebug_text;
882
883 /*! \brief T38 States for a call */
884 enum t38state {
885         T38_DISABLED = 0,                /*!< Not enabled */
886         T38_LOCAL_DIRECT,                /*!< Offered from local */
887         T38_LOCAL_REINVITE,              /*!< Offered from local - REINVITE */
888         T38_PEER_DIRECT,                 /*!< Offered from peer */
889         T38_PEER_REINVITE,               /*!< Offered from peer - REINVITE */
890         T38_ENABLED                      /*!< Negotiated (enabled) */
891 };
892
893 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
894 struct t38properties {
895         struct ast_flags t38support;    /*!< Flag for udptl, rtp or tcp support for this session */
896         int capability;                 /*!< Our T38 capability */
897         int peercapability;             /*!< Peers T38 capability */
898         int jointcapability;            /*!< Supported T38 capability at both ends */
899         enum t38state state;            /*!< T.38 state */
900 };
901
902 /*! \brief Parameters to know status of transfer */
903 enum referstatus {
904         REFER_IDLE,                    /*!< No REFER is in progress */
905         REFER_SENT,                    /*!< Sent REFER to transferee */
906         REFER_RECEIVED,                /*!< Received REFER from transferrer */
907         REFER_CONFIRMED,               /*!< Refer confirmed with a 100 TRYING */
908         REFER_ACCEPTED,                /*!< Accepted by transferee */
909         REFER_RINGING,                 /*!< Target Ringing */
910         REFER_200OK,                   /*!< Answered by transfer target */
911         REFER_FAILED,                  /*!< REFER declined - go on */
912         REFER_NOAUTH                   /*!< We had no auth for REFER */
913 };
914
915 static const struct c_referstatusstring {
916         enum referstatus status;
917         char *text;
918 } referstatusstrings[] = {
919         { REFER_IDLE,           "<none>" },
920         { REFER_SENT,           "Request sent" },
921         { REFER_RECEIVED,       "Request received" },
922         { REFER_ACCEPTED,       "Accepted" },
923         { REFER_RINGING,        "Target ringing" },
924         { REFER_200OK,          "Done" },
925         { REFER_FAILED,         "Failed" },
926         { REFER_NOAUTH,         "Failed - auth failure" }
927 } ;
928
929 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed
930         \note OEJ: Should be moved to string fields */
931 struct sip_refer {
932         char refer_to[AST_MAX_EXTENSION];               /*!< Place to store REFER-TO extension */
933         char refer_to_domain[AST_MAX_EXTENSION];        /*!< Place to store REFER-TO domain */
934         char refer_to_urioption[AST_MAX_EXTENSION];     /*!< Place to store REFER-TO uri options */
935         char refer_to_context[AST_MAX_EXTENSION];       /*!< Place to store REFER-TO context */
936         char referred_by[AST_MAX_EXTENSION];            /*!< Place to store REFERRED-BY extension */
937         char referred_by_name[AST_MAX_EXTENSION];       /*!< Place to store REFERRED-BY extension */
938         char refer_contact[AST_MAX_EXTENSION];          /*!< Place to store Contact info from a REFER extension */
939         char replaces_callid[BUFSIZ];                   /*!< Replace info: callid */
940         char replaces_callid_totag[BUFSIZ/2];           /*!< Replace info: to-tag */
941         char replaces_callid_fromtag[BUFSIZ/2];         /*!< Replace info: from-tag */
942         struct sip_pvt *refer_call;                     /*!< Call we are referring */
943         int attendedtransfer;                           /*!< Attended or blind transfer? */
944         int localtransfer;                              /*!< Transfer to local domain? */
945         enum referstatus status;                        /*!< REFER status */
946 };
947
948 /*! \brief sip_pvt: PVT structures are used for each SIP dialog, ie. a call, a registration, a subscribe  */
949 struct sip_pvt {
950         ast_mutex_t pvt_lock;                   /*!< Dialog private lock */
951         enum invitestates invitestate;          /*!< Track state of SIP_INVITEs */
952         int method;                             /*!< SIP method that opened this dialog */
953         AST_DECLARE_STRING_FIELDS(
954                 AST_STRING_FIELD(callid);       /*!< Global CallID */
955                 AST_STRING_FIELD(randdata);     /*!< Random data */
956                 AST_STRING_FIELD(accountcode);  /*!< Account code */
957                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
958                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
959                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
960                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
961                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
962                 AST_STRING_FIELD(from);         /*!< The From: header */
963                 AST_STRING_FIELD(useragent);    /*!< User agent in SIP request */
964                 AST_STRING_FIELD(exten);        /*!< Extension where to start */
965                 AST_STRING_FIELD(context);      /*!< Context for this call */
966                 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
967                 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
968                 AST_STRING_FIELD(fromdomain);   /*!< Domain to show in the from field */
969                 AST_STRING_FIELD(fromuser);     /*!< User to show in the user field */
970                 AST_STRING_FIELD(fromname);     /*!< Name to show in the user field */
971                 AST_STRING_FIELD(tohost);       /*!< Host we should put in the "to" field */
972                 AST_STRING_FIELD(language);     /*!< Default language for this call */
973                 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
974                 AST_STRING_FIELD(mohsuggest);   /*!< MOH class to suggest when putting a peer on hold */
975                 AST_STRING_FIELD(rdnis);        /*!< Referring DNIS */
976                 AST_STRING_FIELD(redircause);   /*!< Referring cause */
977                 AST_STRING_FIELD(theirtag);     /*!< Their tag */
978                 AST_STRING_FIELD(username);     /*!< [user] name */
979                 AST_STRING_FIELD(peername);     /*!< [peer] name, not set if [user] */
980                 AST_STRING_FIELD(authname);     /*!< Who we use for authentication */
981                 AST_STRING_FIELD(uri);          /*!< Original requested URI */
982                 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
983                 AST_STRING_FIELD(peersecret);   /*!< Password */
984                 AST_STRING_FIELD(peermd5secret);
985                 AST_STRING_FIELD(cid_num);      /*!< Caller*ID number */
986                 AST_STRING_FIELD(cid_name);     /*!< Caller*ID name */
987                 AST_STRING_FIELD(via);          /*!< Via: header */
988                 AST_STRING_FIELD(fullcontact);  /*!< The Contact: that the UA registers with us */
989                         /* we only store the part in <brackets> in this field. */
990                 AST_STRING_FIELD(our_contact);  /*!< Our contact header */
991                 AST_STRING_FIELD(rpid);         /*!< Our RPID header */
992                 AST_STRING_FIELD(rpid_from);    /*!< Our RPID From header */
993                 AST_STRING_FIELD(url);          /*!< URL to be sent with next message to peer */
994         );
995         unsigned int ocseq;                     /*!< Current outgoing seqno */
996         unsigned int icseq;                     /*!< Current incoming seqno */
997         ast_group_t callgroup;                  /*!< Call group */
998         ast_group_t pickupgroup;                /*!< Pickup group */
999         int lastinvite;                         /*!< Last Cseq of invite */
1000         struct ast_flags flags[2];              /*!< SIP_ flags */
1001
1002         /* boolean or small integers that don't belong in flags */
1003         char do_history;                        /*!< Set if we want to record history */
1004         char alreadygone;                       /*!< already destroyed by our peer */
1005         char needdestroy;                       /*!< need to be destroyed by the monitor thread */
1006
1007         int timer_t1;                           /*!< SIP timer T1, ms rtt */
1008         unsigned int sipoptions;                /*!< Supported SIP options on the other end */
1009         struct ast_codec_pref prefs;            /*!< codec prefs */
1010         int capability;                         /*!< Special capability (codec) */
1011         int jointcapability;                    /*!< Supported capability at both ends (codecs) */
1012         int peercapability;                     /*!< Supported peer capability */
1013         int prefcodec;                          /*!< Preferred codec (outbound only) */
1014         int noncodeccapability;                 /*!< DTMF RFC2833 telephony-event */
1015         int jointnoncodeccapability;            /*!< Joint Non codec capability */
1016         int redircodecs;                        /*!< Redirect codecs */
1017         int maxcallbitrate;                     /*!< Maximum Call Bitrate for Video Calls */    
1018         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this dialog */
1019         struct t38properties t38;               /*!< T38 settings */
1020         struct sockaddr_in udptlredirip;        /*!< Where our T.38 UDPTL should be going if not to us */
1021         struct ast_udptl *udptl;                /*!< T.38 UDPTL session */
1022         int callingpres;                        /*!< Calling presentation */
1023         int authtries;                          /*!< Times we've tried to authenticate */
1024         int expiry;                             /*!< How long we take to expire */
1025         long branch;                            /*!< The branch identifier of this session */
1026         char tag[11];                           /*!< Our tag for this session */
1027         int sessionid;                          /*!< SDP Session ID */
1028         int sessionversion;                     /*!< SDP Session Version */
1029         struct sockaddr_in sa;                  /*!< Our peer */
1030         struct sockaddr_in redirip;             /*!< Where our RTP should be going if not to us */
1031         struct sockaddr_in vredirip;            /*!< Where our Video RTP should be going if not to us */
1032         struct sockaddr_in tredirip;            /*!< Where our Text RTP should be going if not to us */
1033         time_t lastrtprx;                       /*!< Last RTP received */
1034         time_t lastrtptx;                       /*!< Last RTP sent */
1035         int rtptimeout;                         /*!< RTP timeout time */
1036         struct sockaddr_in recv;                /*!< Received as */
1037         struct sockaddr_in ourip;               /*!< Our IP (as seen from the outside) */
1038         struct ast_channel *owner;              /*!< Who owns us (if we have an owner) */
1039         struct sip_route *route;                /*!< Head of linked list of routing steps (fm Record-Route) */
1040         int route_persistant;                   /*!< Is this the "real" route? */
1041         struct sip_auth *peerauth;              /*!< Realm authentication */
1042         int noncecount;                         /*!< Nonce-count */
1043         char lastmsg[256];                      /*!< Last Message sent/received */
1044         int amaflags;                           /*!< AMA Flags */
1045         int pendinginvite;                      /*!< Any pending invite ? (seqno of this) */
1046         struct sip_request initreq;             /*!< Latest request that opened a new transaction
1047                                                         within this dialog.
1048                                                         NOT the request that opened the dialog
1049                                                 */
1050         
1051         int initid;                             /*!< Auto-congest ID if appropriate (scheduler) */
1052         int autokillid;                         /*!< Auto-kill ID (scheduler) */
1053         enum transfermodes allowtransfer;       /*!< REFER: restriction scheme */
1054         struct sip_refer *refer;                /*!< REFER: SIP transfer data structure */
1055         enum subscriptiontype subscribed;       /*!< SUBSCRIBE: Is this dialog a subscription?  */
1056         int stateid;                            /*!< SUBSCRIBE: ID for devicestate subscriptions */
1057         int laststate;                          /*!< SUBSCRIBE: Last known extension state */
1058         int dialogver;                          /*!< SUBSCRIBE: Version for subscription dialog-info */
1059         
1060         struct ast_dsp *vad;                    /*!< Inband DTMF Detection dsp */
1061         
1062         struct sip_peer *relatedpeer;           /*!< If this dialog is related to a peer, which one 
1063                                                         Used in peerpoke, mwi subscriptions */
1064         struct sip_registry *registry;          /*!< If this is a REGISTER dialog, to which registry */
1065         struct ast_rtp *rtp;                    /*!< RTP Session */
1066         struct ast_rtp *vrtp;                   /*!< Video RTP session */
1067         struct ast_rtp *trtp;                   /*!< Text RTP session */
1068         struct sip_pkt *packets;                /*!< Packets scheduled for re-transmission */
1069         struct sip_history_head *history;       /*!< History of this SIP dialog */
1070         struct ast_variable *chanvars;          /*!< Channel variables to set for inbound call */
1071         struct sip_pvt *next;                   /*!< Next dialog in chain */
1072         struct sip_invite_param *options;       /*!< Options for INVITE */
1073         int autoframing;                        /*!< The number of Asters we group in a Pyroflax
1074                                                         before strolling to the Grokyzp√•
1075                                                         (A bit unsure of this, please correct if
1076                                                         you know more) */
1077 };
1078
1079 static struct sip_pvt *dialoglist = NULL;
1080
1081 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
1082 AST_MUTEX_DEFINE_STATIC(dialoglock);
1083
1084 /*! \brief hide the way the list is locked/unlocked */
1085 static void dialoglist_lock(void)
1086 {
1087         ast_mutex_lock(&dialoglock);
1088 }
1089
1090 static void dialoglist_unlock(void)
1091 {
1092         ast_mutex_unlock(&dialoglock);
1093 }
1094
1095 #define FLAG_RESPONSE (1 << 0)
1096 #define FLAG_FATAL (1 << 1)
1097
1098 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission */
1099 struct sip_pkt {
1100         struct sip_pkt *next;                   /*!< Next packet in linked list */
1101         int retrans;                            /*!< Retransmission number */
1102         int method;                             /*!< SIP method for this packet */
1103         int seqno;                              /*!< Sequence number */
1104         unsigned int flags;                     /*!< non-zero if this is a response packet (e.g. 200 OK) */
1105         struct sip_pvt *owner;                  /*!< Owner AST call */
1106         int retransid;                          /*!< Retransmission ID */
1107         int timer_a;                            /*!< SIP timer A, retransmission timer */
1108         int timer_t1;                           /*!< SIP Timer T1, estimated RTT or 500 ms */
1109         int packetlen;                          /*!< Length of packet */
1110         char data[0];
1111 };      
1112
1113 /*! \brief Structure for SIP user data. User's place calls to us */
1114 struct sip_user {
1115         /* Users who can access various contexts */
1116         ASTOBJ_COMPONENTS(struct sip_user);
1117         char secret[80];                /*!< Password */
1118         char md5secret[80];             /*!< Password in md5 */
1119         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1120         char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
1121         char cid_num[80];               /*!< Caller ID num */
1122         char cid_name[80];              /*!< Caller ID name */
1123         char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
1124         char language[MAX_LANGUAGE];    /*!< Default language for this user */
1125         char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1126         char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1127         char useragent[256];            /*!< User agent in SIP request */
1128         struct ast_codec_pref prefs;    /*!< codec prefs */
1129         ast_group_t callgroup;          /*!< Call group */
1130         ast_group_t pickupgroup;        /*!< Pickup Group */
1131         unsigned int sipoptions;        /*!< Supported SIP options */
1132         struct ast_flags flags[2];      /*!< SIP_ flags */
1133
1134         /* things that don't belong in flags */
1135         char is_realtime;               /*!< this is a 'realtime' user */
1136
1137         int amaflags;                   /*!< AMA flags for billing */
1138         int callingpres;                /*!< Calling id presentation */
1139         int capability;                 /*!< Codec capability */
1140         int inUse;                      /*!< Number of calls in use */
1141         int call_limit;                 /*!< Limit of concurrent calls */
1142         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1143         struct ast_ha *ha;              /*!< ACL setting */
1144         struct ast_variable *chanvars;  /*!< Variables to set for channel created by user */
1145         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1146         int autoframing;
1147 };
1148
1149 /*! \brief Structure for SIP peer data, we place calls to peers if registered  or fixed IP address (host) */
1150 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1151 struct sip_peer {
1152         ASTOBJ_COMPONENTS(struct sip_peer);     /*!< name, refcount, objflags,  object pointers */
1153                                         /*!< peer->name is the unique name of this object */
1154         char secret[80];                /*!< Password */
1155         char md5secret[80];             /*!< Password in MD5 */
1156         struct sip_auth *auth;          /*!< Realm authentication list */
1157         char context[AST_MAX_CONTEXT];  /*!< Default context for incoming calls */
1158         char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1159         char username[80];              /*!< Temporary username until registration */ 
1160         char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1161         int amaflags;                   /*!< AMA Flags (for billing) */
1162         char tohost[MAXHOSTNAMELEN];    /*!< If not dynamic, IP address */
1163         char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1164         char fromuser[80];              /*!< From: user when calling this peer */
1165         char fromdomain[MAXHOSTNAMELEN];        /*!< From: domain when calling this peer */
1166         char fullcontact[256];          /*!< Contact registered with us (not in sip.conf) */
1167         char cid_num[80];               /*!< Caller ID num */
1168         char cid_name[80];              /*!< Caller ID name */
1169         int callingpres;                /*!< Calling id presentation */
1170         int inUse;                      /*!< Number of calls in use */
1171         int inRinging;                  /*!< Number of calls ringing */
1172         int onHold;                     /*!< Peer has someone on hold */
1173         int call_limit;                 /*!< Limit of concurrent calls */
1174         int busy_level;                 /*!< Level of active channels where we signal busy */
1175         enum transfermodes allowtransfer;       /*! SIP Refer restriction scheme */
1176         char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1177         char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox setting for MWI checks */
1178         char language[MAX_LANGUAGE];    /*!<  Default language for prompts */
1179         char mohinterpret[MAX_MUSICCLASS];/*!<  Music on Hold class */
1180         char mohsuggest[MAX_MUSICCLASS];/*!<  Music on Hold class */
1181         char useragent[256];            /*!<  User agent in SIP request (saved from registration) */
1182         struct ast_codec_pref prefs;    /*!<  codec prefs */
1183         int lastmsgssent;
1184         unsigned int sipoptions;        /*!<  Supported SIP options */
1185         struct ast_flags flags[2];      /*!<  SIP_ flags */
1186
1187         /* things that don't belong in flags */
1188         char is_realtime;               /*!< this is a 'realtime' peer */
1189
1190         int expire;                     /*!<  When to expire this peer registration */
1191         int capability;                 /*!<  Codec capability */
1192         int rtptimeout;                 /*!<  RTP timeout */
1193         int rtpholdtimeout;             /*!<  RTP Hold Timeout */
1194         int rtpkeepalive;               /*!<  Send RTP packets for keepalive */
1195         ast_group_t callgroup;          /*!<  Call group */
1196         ast_group_t pickupgroup;        /*!<  Pickup group */
1197         struct sip_proxy *outboundproxy;        /*!< Outbound proxy for this peer */
1198         struct ast_dnsmgr_entry *dnsmgr;/*!<  DNS refresh manager for peer */
1199         struct sockaddr_in addr;        /*!<  IP address of peer */
1200         int maxcallbitrate;             /*!< Maximum Bitrate for a video call */
1201         
1202         /* Qualification */
1203         struct sip_pvt *call;           /*!<  Call pointer */
1204         int pokeexpire;                 /*!<  When to expire poke (qualify= checking) */
1205         int lastms;                     /*!<  How long last response took (in ms), or -1 for no response */
1206         int maxms;                      /*!<  Max ms we will accept for the host to be up, 0 to not monitor */
1207         struct timeval ps;              /*!<  Time for sending SIP OPTION in sip_pke_peer() */
1208         struct sockaddr_in defaddr;     /*!<  Default IP address, used until registration */
1209         struct ast_ha *ha;              /*!<  Access control list */
1210         struct ast_variable *chanvars;  /*!<  Variables to set for channel created by user */
1211         struct sip_pvt *mwipvt;         /*!<  Subscription for MWI */
1212         int autoframing;
1213         struct ast_event_sub *mwi_event_sub; /*!< The MWI event subscription */
1214 };
1215
1216
1217
1218 /*! \brief Registrations with other SIP proxies */
1219 struct sip_registry {
1220         ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1221         AST_DECLARE_STRING_FIELDS(
1222                 AST_STRING_FIELD(callid);       /*!< Global Call-ID */
1223                 AST_STRING_FIELD(realm);        /*!< Authorization realm */
1224                 AST_STRING_FIELD(nonce);        /*!< Authorization nonce */
1225                 AST_STRING_FIELD(opaque);       /*!< Opaque nonsense */
1226                 AST_STRING_FIELD(qop);          /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1227                 AST_STRING_FIELD(domain);       /*!< Authorization domain */
1228                 AST_STRING_FIELD(username);     /*!< Who we are registering as */
1229                 AST_STRING_FIELD(authuser);     /*!< Who we *authenticate* as */
1230                 AST_STRING_FIELD(hostname);     /*!< Domain or host we register to */
1231                 AST_STRING_FIELD(secret);       /*!< Password in clear text */  
1232                 AST_STRING_FIELD(md5secret);    /*!< Password in md5 */
1233                 AST_STRING_FIELD(callback);     /*!< Contact extension */
1234                 AST_STRING_FIELD(random);
1235         );
1236         int portno;                     /*!<  Optional port override */
1237         int expire;                     /*!< Sched ID of expiration */
1238         int expiry;                     /*!< Value to use for the Expires header */
1239         int regattempts;                /*!< Number of attempts (since the last success) */
1240         int timeout;                    /*!< sched id of sip_reg_timeout */
1241         int refresh;                    /*!< How often to refresh */
1242         struct sip_pvt *call;           /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1243         enum sipregistrystate regstate; /*!< Registration state (see above) */
1244         struct timeval regtime;         /*!< Last successful registration time */
1245         int callid_valid;               /*!< 0 means we haven't chosen callid for this registry yet. */
1246         unsigned int ocseq;             /*!< Sequence number we got to for REGISTERs for this registry */
1247         struct sockaddr_in us;          /*!< Who the server thinks we are */
1248         int noncecount;                 /*!< Nonce-count */
1249         char lastmsg[256];              /*!< Last Message sent/received */
1250 };
1251
1252 /* --- Linked lists of various objects --------*/
1253
1254 /*! \brief  The user list: Users and friends */
1255 static struct ast_user_list {
1256         ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1257 } userl;
1258
1259 /*! \brief  The peer list: Peers and Friends */
1260 static struct ast_peer_list {
1261         ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1262 } peerl;
1263
1264 /*! \brief  The register list: Other SIP proxies we register with and place calls to */
1265 static struct ast_register_list {
1266         ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1267         int recheck;
1268 } regl;
1269
1270 static int temp_pvt_init(void *);
1271 static void temp_pvt_cleanup(void *);
1272
1273 /*! \brief A per-thread temporary pvt structure */
1274 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1275
1276 /*! \brief Authentication list for realm authentication 
1277  * \todo Move the sip_auth list to AST_LIST */
1278 static struct sip_auth *authl = NULL;
1279
1280
1281 /* --- Sockets and networking --------------*/
1282
1283 /*! \brief Main socket for SIP communication.
1284  * sipsock is shared between the manager thread (which handles reload
1285  * requests), the io handler (sipsock_read()) and the user routines that
1286  * issue writes (using __sip_xmit()).
1287  * The socket is -1 only when opening fails (this is a permanent condition),
1288  * or when we are handling a reload() that changes its address (this is
1289  * a transient situation during which we might have a harmless race, see
1290  * below). Because the conditions for the race to be possible are extremely
1291  * rare, we don't want to pay the cost of locking on every I/O.
1292  * Rather, we remember that when the race may occur, communication is
1293  * bound to fail anyways, so we just live with this event and let
1294  * the protocol handle this above us.
1295  */
1296 static int sipsock  = -1;
1297
1298 static struct sockaddr_in bindaddr;     /*!< The address we bind to */
1299
1300 /*! \brief our (internal) default address/port to put in SIP/SDP messages
1301  *  internip is initialized picking a suitable address from one of the
1302  * interfaces, and the same port number we bind to. It is used as the
1303  * default address/port in SIP messages, and as the default address
1304  * (but not port) in SDP messages.
1305  */
1306 static struct sockaddr_in internip;
1307
1308 /*! \brief our external IP address/port for SIP sessions.
1309  * externip.sin_addr is only set when we know we might be behind
1310  * a NAT, and this is done using a variety of (mutually exclusive)
1311  * ways from the config file:
1312  *
1313  * + with "externip = host[:port]" we specify the address/port explicitly.
1314  *   The address is looked up only once when (re)loading the config file;
1315  * 
1316  * + with "externhost = host[:port]" we do a similar thing, but the
1317  *   hostname is stored in externhost, and the hostname->IP mapping
1318  *   is refreshed every 'externrefresh' seconds;
1319  * 
1320  * + with "stunaddr = host[:port]" we run queries every externrefresh seconds
1321  *   to the specified server, and store the result in externip.
1322  *
1323  * Other variables (externhost, externexpire, externrefresh) are used
1324  * to support the above functions.
1325  */
1326 static struct sockaddr_in externip;             /*!< External IP address if we are behind NAT */
1327
1328 static char externhost[MAXHOSTNAMELEN];         /*!< External host name */
1329 static time_t externexpire;                     /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1330 static int externrefresh = 10;
1331 static struct sockaddr_in stunaddr;             /*!< stun server address */
1332
1333 /*! \brief  List of local networks
1334  * We store "localnet" addresses from the config file into an access list,
1335  * marked as 'DENY', so the call to ast_apply_ha() will return
1336  * AST_SENSE_DENY for 'local' addresses, and AST_SENSE_ALLOW for 'non local'
1337  * (i.e. presumably public) addresses.
1338  */
1339 static struct ast_ha *localaddr;                /*!< List of local networks, on the same side of NAT as this Asterisk */
1340
1341 static struct sockaddr_in debugaddr;
1342
1343 static struct ast_config *notify_types;         /*!< The list of manual NOTIFY types we know how to send */
1344
1345 /*---------------------------- Forward declarations of functions in chan_sip.c */
1346 /*! \note This is added to help splitting up chan_sip.c into several files
1347         in coming releases */
1348
1349 /*--- PBX interface functions */
1350 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1351 static int sip_devicestate(void *data);
1352 static int sip_sendtext(struct ast_channel *ast, const char *text);
1353 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1354 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen);
1355 static int sip_hangup(struct ast_channel *ast);
1356 static int sip_answer(struct ast_channel *ast);
1357 static struct ast_frame *sip_read(struct ast_channel *ast);
1358 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1359 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1360 static int sip_transfer(struct ast_channel *ast, const char *dest);
1361 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1362 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1363 static int sip_senddigit_end(struct ast_channel *ast, char digit, unsigned int duration);
1364
1365 /*--- Transmitting responses and requests */
1366 static int sipsock_read(int *id, int fd, short events, void *ignore);
1367 static int __sip_xmit(struct sip_pvt *p, char *data, int len);
1368 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod);
1369 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1370 static int retrans_pkt(void *data);
1371 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1372 static int transmit_response_using_temp(ast_string_field callid, struct sockaddr_in *sin, int useglobal_nat, const int intended_method, const struct sip_request *req, const char *msg);
1373 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1374 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1375 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1376 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1377 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1378 static int transmit_response_with_auth(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *rand, enum xmittype reliable, const char *header, int stale);
1379 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1380 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1381 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1382 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1383 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1384 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version);
1385 static int transmit_info_with_digit(struct sip_pvt *p, const char digit, unsigned int duration);
1386 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1387 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1388 static int transmit_refer(struct sip_pvt *p, const char *dest);
1389 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1390 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1391 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1392 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1393 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1394 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1395 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1396 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1397 static int sip_send_mwi_to_peer(struct sip_peer *peer, const struct ast_event *event, int cache_only);
1398
1399 /*--- Dialog management */
1400 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1401                                  int useglobal_nat, const int intended_method);
1402 static int __sip_autodestruct(void *data);
1403 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1404 static void sip_cancel_destroy(struct sip_pvt *p);
1405 static void sip_destroy(struct sip_pvt *p);
1406 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
1407 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1408 static void __sip_pretend_ack(struct sip_pvt *p);
1409 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1410 static int auto_congest(void *nothing);
1411 static int update_call_counter(struct sip_pvt *fup, int event);
1412 static int hangup_sip2cause(int cause);
1413 static const char *hangup_cause2sip(int cause);
1414 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1415 static void free_old_route(struct sip_route *route);
1416 static void list_route(struct sip_route *route);
1417 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1418 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1419                                               struct sip_request *req, char *uri);
1420 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1421 static void check_pendings(struct sip_pvt *p);
1422 static void *sip_park_thread(void *stuff);
1423 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1424 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1425
1426 /*--- Codec handling / SDP */
1427 static void try_suggested_sip_codec(struct sip_pvt *p);
1428 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1429 static const char *get_sdp(struct sip_request *req, const char *name);
1430 static int find_sdp(struct sip_request *req);
1431 static int process_sdp(struct sip_pvt *p, struct sip_request *req);
1432 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1433                              struct ast_str **m_buf, struct ast_str **a_buf,
1434                              int debug, int *min_packet_size);
1435 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1436                                 struct ast_str **m_buf, struct ast_str **a_buf,
1437                                 int debug);
1438 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p);
1439 static void do_setnat(struct sip_pvt *p, int natflags);
1440 static void stop_media_flows(struct sip_pvt *p);
1441
1442 /*--- Authentication stuff */
1443 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1444 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1445 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1446                                          const char *secret, const char *md5secret, int sipmethod,
1447                                          char *uri, enum xmittype reliable, int ignore);
1448 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1449                                               int sipmethod, char *uri, enum xmittype reliable,
1450                                               struct sockaddr_in *sin, struct sip_peer **authpeer);
1451 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1452
1453 /*--- Domain handling */
1454 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1455 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1456 static void clear_sip_domains(void);
1457
1458 /*--- SIP realm authentication */
1459 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);
1460 static int clear_realm_authentication(struct sip_auth *authlist);       /* Clear realm authentication list (at reload) */
1461 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1462
1463 /*--- Misc functions */
1464 static int sip_do_reload(enum channelreloadreason reason);
1465 static int reload_config(enum channelreloadreason reason);
1466 static int expire_register(void *data);
1467 static void *do_monitor(void *data);
1468 static int restart_monitor(void);
1469 static void sip_destroy(struct sip_pvt *p);
1470 static int sip_addrcmp(char *name, struct sockaddr_in *sin);    /* Support for peer matching */
1471 static int sip_refer_allocate(struct sip_pvt *p);
1472 static void ast_quiet_chan(struct ast_channel *chan);
1473 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1474
1475 /*--- Device monitoring and Device/extension state/event handling */
1476 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1477 static int sip_devicestate(void *data);
1478 static int sip_poke_noanswer(void *data);
1479 static int sip_poke_peer(struct sip_peer *peer);
1480 static void sip_poke_all_peers(void);
1481 static void sip_peer_hold(struct sip_pvt *p, int hold);
1482 static void mwi_event_cb(const struct ast_event *, void *);
1483
1484 /*--- Applications, functions, CLI and manager command helpers */
1485 static const char *sip_nat_mode(const struct sip_pvt *p);
1486 static int sip_show_inuse(int fd, int argc, char *argv[]);
1487 static char *transfermode2str(enum transfermodes mode) attribute_const;
1488 static char *nat2str(int nat) attribute_const;
1489 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1490 static int sip_show_users(int fd, int argc, char *argv[]);
1491 static int _sip_show_peers(int fd, int *total, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1492 static int sip_show_peers(int fd, int argc, char *argv[]);
1493 static int sip_show_objects(int fd, int argc, char *argv[]);
1494 static void  print_group(int fd, ast_group_t group, int crlf);
1495 static const char *dtmfmode2str(int mode) attribute_const;
1496 static const char *insecure2str(int port, int invite) attribute_const;
1497 static void cleanup_stale_contexts(char *new, char *old);
1498 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1499 static const char *domain_mode_to_text(const enum domain_mode mode);
1500 static int sip_show_domains(int fd, int argc, char *argv[]);
1501 static int _sip_show_peer(int type, int fd, struct mansession *s, const struct message *m, int argc, const char *argv[]);
1502 static int sip_show_peer(int fd, int argc, char *argv[]);
1503 static int sip_show_user(int fd, int argc, char *argv[]);
1504 static int sip_show_registry(int fd, int argc, char *argv[]);
1505 static int sip_unregister(int fd, int argc, char *argv[]);
1506 static int sip_show_settings(int fd, int argc, char *argv[]);
1507 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1508 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1509 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1510 static int sip_show_channels(int fd, int argc, char *argv[]);
1511 static int sip_show_subscriptions(int fd, int argc, char *argv[]);
1512 static char *complete_sip_channel(const char *word, int state);
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_channel(const char *line, const char *word, int pos, int state);
1516 static char *complete_sip_show_history(const char *line, const char *word, int pos, int state);
1517 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1518 static char *complete_sip_unregister(const char *line, const char *word, int pos, int state);
1519 static char *complete_sip_debug_peer(const char *line, const char *word, int pos, int state);
1520 static char *complete_sip_user(const char *word, int state, int flags2);
1521 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1522 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1523 static char *complete_sip_prune_realtime_peer(const char *line, const char *word, int pos, int state);
1524 static char *complete_sip_prune_realtime_user(const char *line, const char *word, int pos, int state);
1525 static int sip_show_channel(int fd, int argc, char *argv[]);
1526 static int sip_show_history(int fd, int argc, char *argv[]);
1527 static int sip_do_debug_ip(int fd, int argc, char *argv[]);
1528 static int sip_do_debug_peer(int fd, int argc, char *argv[]);
1529 static int sip_do_debug(int fd, int argc, char *argv[]);
1530 static int sip_no_debug(int fd, int argc, char *argv[]);
1531 static int sip_notify(int fd, int argc, char *argv[]);
1532 static int sip_do_history(int fd, int argc, char *argv[]);
1533 static int sip_no_history(int fd, int argc, char *argv[]);
1534 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1535 static int sip_addheader(struct ast_channel *chan, void *data);
1536 static int sip_do_reload(enum channelreloadreason reason);
1537 static int sip_reload(int fd, int argc, char *argv[]);
1538 static int acf_channel_read(struct ast_channel *chan, const char *funcname, char *preparse, char *buf, size_t buflen);
1539
1540 /*--- Debugging 
1541         Functions for enabling debug per IP or fully, or enabling history logging for
1542         a SIP dialog
1543 */
1544 static void sip_dump_history(struct sip_pvt *dialog);   /* Dump history to LOG_DEBUG at end of dialog, before destroying data */
1545 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1546 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1547 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1548 static void sip_dump_history(struct sip_pvt *dialog);
1549
1550 /*--- Device object handling */
1551 static struct sip_peer *temp_peer(const char *name);
1552 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1553 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
1554 static int update_call_counter(struct sip_pvt *fup, int event);
1555 static void sip_destroy_peer(struct sip_peer *peer);
1556 static void sip_destroy_user(struct sip_user *user);
1557 static int sip_poke_peer(struct sip_peer *peer);
1558 static void set_peer_defaults(struct sip_peer *peer);
1559 static struct sip_peer *temp_peer(const char *name);
1560 static void register_peer_exten(struct sip_peer *peer, int onoff);
1561 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1562 static struct sip_user *find_user(const char *name, int realtime);
1563 static int sip_poke_peer_s(void *data);
1564 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1565 static void reg_source_db(struct sip_peer *peer);
1566 static void destroy_association(struct sip_peer *peer);
1567 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1568
1569 /* Realtime device support */
1570 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey);
1571 static struct sip_user *realtime_user(const char *username);
1572 static void update_peer(struct sip_peer *p, int expiry);
1573 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1574 static int sip_prune_realtime(int fd, int argc, char *argv[]);
1575
1576 /*--- Internal UA client handling (outbound registrations) */
1577 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us);
1578 static void sip_registry_destroy(struct sip_registry *reg);
1579 static int sip_register(char *value, int lineno);
1580 static char *regstate2str(enum sipregistrystate regstate) attribute_const;
1581 static int sip_reregister(void *data);
1582 static int __sip_do_register(struct sip_registry *r);
1583 static int sip_reg_timeout(void *data);
1584 static void sip_send_all_registers(void);
1585
1586 /*--- Parsing SIP requests and responses */
1587 static void append_date(struct sip_request *req);       /* Append date to SIP packet */
1588 static int determine_firstline_parts(struct sip_request *req);
1589 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1590 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1591 static int find_sip_method(const char *msg);
1592 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1593 static void parse_request(struct sip_request *req);
1594 static const char *get_header(const struct sip_request *req, const char *name);
1595 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1596 static int method_match(enum sipmethod id, const char *name);
1597 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1598 static char *get_in_brackets(char *tmp);
1599 static const char *find_alias(const char *name, const char *_default);
1600 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1601 static int lws2sws(char *msgbuf, int len);
1602 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1603 static char *remove_uri_parameters(char *uri);
1604 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1605 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1606 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1607 static int set_address_from_contact(struct sip_pvt *pvt);
1608 static void check_via(struct sip_pvt *p, struct sip_request *req);
1609 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1610 static int get_rpid_num(const char *input, char *output, int maxlen);
1611 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1612 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1613 static int get_msg_text(char *buf, int len, struct sip_request *req);
1614 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1615
1616 /*--- Constructing requests and responses */
1617 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1618 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1619 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1620 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1621 static int init_resp(struct sip_request *resp, const char *msg);
1622 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1623 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1624 static void build_via(struct sip_pvt *p);
1625 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1626 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1627 static char *generate_random_string(char *buf, size_t size);
1628 static void build_callid_pvt(struct sip_pvt *pvt);
1629 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1630 static void make_our_tag(char *tagbuf, size_t len);
1631 static int add_header(struct sip_request *req, const char *var, const char *value);
1632 static int add_header_contentLength(struct sip_request *req, int len);
1633 static int add_line(struct sip_request *req, const char *line);
1634 static int add_text(struct sip_request *req, const char *text);
1635 static int add_digit(struct sip_request *req, char digit, unsigned int duration);
1636 static int add_vidupdate(struct sip_request *req);
1637 static void add_route(struct sip_request *req, struct sip_route *route);
1638 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1639 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1640 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1641 static void set_destination(struct sip_pvt *p, char *uri);
1642 static void append_date(struct sip_request *req);
1643 static void build_contact(struct sip_pvt *p);
1644 static void build_rpid(struct sip_pvt *p);
1645
1646 /*------Request handling functions */
1647 static int handle_request(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1648 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);
1649 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1650 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1651 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1652 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1653 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1654 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1655 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1656 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1657 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1658 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1659 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1660
1661 /*------Response handling functions */
1662 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1663 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1664 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1665 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1666
1667 /*----- RTP interface functions */
1668 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);
1669 static enum ast_rtp_get_result sip_get_rtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1670 static enum ast_rtp_get_result sip_get_vrtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1671 static enum ast_rtp_get_result sip_get_trtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1672 static int sip_get_codec(struct ast_channel *chan);
1673 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
1674
1675 /*------ T38 Support --------- */
1676 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); 
1677 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1678 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1679 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1680
1681 /*! \brief Definition of this channel for PBX channel registration */
1682 static const struct ast_channel_tech sip_tech = {
1683         .type = "SIP",
1684         .description = "Session Initiation Protocol (SIP)",
1685         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1686         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1687         .requester = sip_request_call,                  /* called with chan unlocked */
1688         .devicestate = sip_devicestate,                 /* called with chan unlocked (not chan-specific) */
1689         .call = sip_call,                       /* called with chan locked */
1690         .send_html = sip_sendhtml,
1691         .hangup = sip_hangup,                   /* called with chan locked */
1692         .answer = sip_answer,                   /* called with chan locked */
1693         .read = sip_read,                       /* called with chan locked */
1694         .write = sip_write,                     /* called with chan locked */
1695         .write_video = sip_write,               /* called with chan locked */
1696         .write_text = sip_write,
1697         .indicate = sip_indicate,               /* called with chan locked */
1698         .transfer = sip_transfer,               /* called with chan locked */
1699         .fixup = sip_fixup,                     /* called with chan locked */
1700         .send_digit_begin = sip_senddigit_begin,        /* called with chan unlocked */
1701         .send_digit_end = sip_senddigit_end,
1702         .bridge = ast_rtp_bridge,                       /* XXX chan unlocked ? */
1703         .early_bridge = ast_rtp_early_bridge,
1704         .send_text = sip_sendtext,              /* called with chan locked */
1705         .func_channel_read = acf_channel_read,
1706 };
1707
1708 /*! \brief This version of the sip channel tech has no send_digit_begin
1709  *  callback.  This is for use with channels using SIP INFO DTMF so that
1710  *  the core knows that the channel doesn't want DTMF BEGIN frames. */
1711 static const struct ast_channel_tech sip_tech_info = {
1712         .type = "SIP",
1713         .description = "Session Initiation Protocol (SIP)",
1714         .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1715         .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1716         .requester = sip_request_call,
1717         .devicestate = sip_devicestate,
1718         .call = sip_call,
1719         .hangup = sip_hangup,
1720         .answer = sip_answer,
1721         .read = sip_read,
1722         .write = sip_write,
1723         .write_video = sip_write,
1724         .indicate = sip_indicate,
1725         .transfer = sip_transfer,
1726         .fixup = sip_fixup,
1727         .send_digit_end = sip_senddigit_end,
1728         .bridge = ast_rtp_bridge,
1729         .send_text = sip_sendtext,
1730         .func_channel_read = acf_channel_read,
1731 };
1732
1733 /* wrapper macro to tell whether t points to one of the sip_tech descriptors */
1734 #define IS_SIP_TECH(t)  ((t) == &sip_tech || (t) == &sip_tech_info)
1735
1736 /**--- some list management macros. **/
1737  
1738 #define UNLINK(element, head, prev) do {        \
1739         if (prev)                               \
1740                 (prev)->next = (element)->next; \
1741         else                                    \
1742                 (head) = (element)->next;       \
1743         } while (0)
1744
1745 /*! \brief Interface structure with callbacks used to connect to RTP module */
1746 static struct ast_rtp_protocol sip_rtp = {
1747         type: "SIP",
1748         get_rtp_info: sip_get_rtp_peer,
1749         get_vrtp_info: sip_get_vrtp_peer,
1750         get_trtp_info: sip_get_trtp_peer,
1751         set_rtp_peer: sip_set_rtp_peer,
1752         get_codec: sip_get_codec,
1753 };
1754
1755 /*! \brief Helper function to lock, hiding the underlying locking mechanism.  */
1756 static void sip_pvt_lock(struct sip_pvt *pvt)
1757 {
1758         ast_mutex_lock(&pvt->pvt_lock);
1759 }
1760
1761 /*! \brief Helper function to unlock pvt, hiding the underlying locking mechanism. */
1762 static void sip_pvt_unlock(struct sip_pvt *pvt)
1763 {
1764         ast_mutex_unlock(&pvt->pvt_lock);
1765 }
1766
1767 /*!
1768  * helper functions to unreference various types of objects.
1769  * By handling them this way, we don't have to declare the
1770  * destructor on each call, which removes the chance of errors.
1771  */
1772 static void unref_peer(struct sip_peer *peer)
1773 {
1774         ASTOBJ_UNREF(peer, sip_destroy_peer);
1775 }
1776
1777 static void unref_user(struct sip_user *user)
1778 {
1779         ASTOBJ_UNREF(user, sip_destroy_user);
1780 }
1781
1782 static void registry_unref(struct sip_registry *reg)
1783 {
1784         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount - 1);
1785         ASTOBJ_UNREF(reg, sip_registry_destroy);
1786 }
1787
1788 /*! \brief Add object reference to SIP registry */
1789 static struct sip_registry *registry_addref(struct sip_registry *reg)
1790 {
1791         ast_debug(3, "SIP Registry %s: refcount now %d\n", reg->hostname, reg->refcount + 1);
1792         return ASTOBJ_REF(reg); /* Add pointer to registry in packet */
1793 }
1794
1795 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
1796 static struct ast_udptl_protocol sip_udptl = {
1797         type: "SIP",
1798         get_udptl_info: sip_get_udptl_peer,
1799         set_udptl_peer: sip_set_udptl_peer,
1800 };
1801
1802 /*! \brief Append to SIP dialog history 
1803         \return Always returns 0 */
1804 #define append_history(p, event, fmt , args... )        append_history_full(p, "%-15s " fmt, event, ## args)
1805
1806 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1807         __attribute__ ((format (printf, 2, 3)));
1808
1809
1810 /*! \brief Convert transfer status to string */
1811 static const char *referstatus2str(enum referstatus rstatus)
1812 {
1813         int i = (sizeof(referstatusstrings) / sizeof(referstatusstrings[0]));
1814         int x;
1815
1816         for (x = 0; x < i; x++) {
1817                 if (referstatusstrings[x].status ==  rstatus)
1818                         return referstatusstrings[x].text;
1819         }
1820         return "";
1821 }
1822
1823 /*! \brief Initialize the initital request packet in the pvt structure.
1824         This packet is used for creating replies and future requests in
1825         a dialog */
1826 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1827 {
1828         if (p->initreq.headers)
1829                 ast_debug(1, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
1830         else
1831                 ast_debug(1, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
1832         /* Use this as the basis */
1833         copy_request(&p->initreq, req);
1834         parse_request(&p->initreq);
1835         if (ast_test_flag(req, SIP_PKT_DEBUG))
1836                 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1837 }
1838
1839 /*! \brief Encapsulate setting of SIP_ALREADYGONE to be able to trace it with debugging */
1840 static void sip_alreadygone(struct sip_pvt *dialog)
1841 {
1842         ast_debug(3, "Setting SIP_ALREADYGONE on dialog %s\n", dialog->callid);
1843         dialog->alreadygone = 1;
1844 }
1845
1846 /*! Resolve DNS srv name or host name in a sip_proxy structure */
1847 static int proxy_update(struct sip_proxy *proxy)
1848 {
1849         /* if it's actually an IP address and not a name,
1850            there's no need for a managed lookup */
1851         if (!inet_aton(proxy->name, &proxy->ip.sin_addr)) {
1852                 /* Ok, not an IP address, then let's check if it's a domain or host */
1853                 /* XXX Todo - if we have proxy port, don't do SRV */
1854                 if (ast_get_ip_or_srv(&proxy->ip, proxy->name, global_srvlookup ? "_sip._udp" : NULL) < 0) {
1855                         ast_log(LOG_WARNING, "Unable to locate host '%s'\n", proxy->name);
1856                         return FALSE;
1857                 }
1858         }
1859         proxy->last_dnsupdate = time(NULL);
1860         return TRUE;
1861 }
1862
1863 /*! \brief Allocate and initialize sip proxy */
1864 static struct sip_proxy *proxy_allocate(char *name, char *port, int force)
1865 {
1866         struct sip_proxy *proxy;
1867         proxy = ast_calloc(1, sizeof(*proxy));
1868         if (!proxy)
1869                 return NULL;
1870         proxy->force = force;
1871         ast_copy_string(proxy->name, name, sizeof(proxy->name));
1872         proxy->ip.sin_port = htons((!ast_strlen_zero(port) ? atoi(port) : STANDARD_SIP_PORT));
1873         proxy_update(proxy);
1874         return proxy;
1875 }
1876
1877 /*! \brief Get default outbound proxy or global proxy */
1878 static struct sip_proxy *obproxy_get(struct sip_pvt *dialog, struct sip_peer *peer)
1879 {
1880         if (peer && peer->outboundproxy) {
1881                 if (sipdebug)
1882                         ast_debug(1, "OBPROXY: Applying peer OBproxy to this call\n");
1883                 append_history(dialog, "OBproxy", "Using peer obproxy %s", peer->outboundproxy->name);
1884                 return peer->outboundproxy;
1885         }
1886         if (global_outboundproxy.name[0]) {
1887                 if (sipdebug)
1888                         ast_debug(1, "OBPROXY: Applying global OBproxy to this call\n");
1889                 append_history(dialog, "OBproxy", "Using global obproxy %s", global_outboundproxy.name);
1890                 return &global_outboundproxy;
1891         }
1892         if (sipdebug)
1893                 ast_debug(1, "OBPROXY: Not applying OBproxy to this call\n");
1894         return NULL;
1895 }
1896
1897 /*! \brief returns true if 'name' (with optional trailing whitespace)
1898  * matches the sip method 'id'.
1899  * Strictly speaking, SIP methods are case SENSITIVE, but we do
1900  * a case-insensitive comparison to be more tolerant.
1901  * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
1902  */
1903 static int method_match(enum sipmethod id, const char *name)
1904 {
1905         int len = strlen(sip_methods[id].text);
1906         int l_name = name ? strlen(name) : 0;
1907         /* true if the string is long enough, and ends with whitespace, and matches */
1908         return (l_name >= len && name[len] < 33 &&
1909                 !strncasecmp(sip_methods[id].text, name, len));
1910 }
1911
1912 /*! \brief  find_sip_method: Find SIP method from header */
1913 static int find_sip_method(const char *msg)
1914 {
1915         int i, res = 0;
1916         
1917         if (ast_strlen_zero(msg))
1918                 return 0;
1919         for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1920                 if (method_match(i, msg))
1921                         res = sip_methods[i].id;
1922         }
1923         return res;
1924 }
1925
1926 /*! \brief Parse supported header in incoming packet */
1927 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
1928 {
1929         char *next, *sep;
1930         char *temp;
1931         unsigned int profile = 0;
1932         int i, found;
1933
1934         if (ast_strlen_zero(supported) )
1935                 return 0;
1936         temp = ast_strdupa(supported);
1937
1938         if (sipdebug)
1939                 ast_debug(3, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1940
1941         for (next = temp; next; next = sep) {
1942                 found = FALSE;
1943                 if ( (sep = strchr(next, ',')) != NULL)
1944                         *sep++ = '\0';
1945                 next = ast_skip_blanks(next);
1946                 if (sipdebug)
1947                         ast_debug(3, "Found SIP option: -%s-\n", next);
1948                 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1949                         if (!strcasecmp(next, sip_options[i].text)) {
1950                                 profile |= sip_options[i].id;
1951                                 found = TRUE;
1952                                 if (sipdebug)
1953                                         ast_debug(3, "Matched SIP option: %s\n", next);
1954                                 break;
1955                         }
1956                 }
1957                 if (!found && sipdebug) {
1958                         if (!strncasecmp(next, "x-", 2))
1959                                 ast_debug(3, "Found private SIP option, not supported: %s\n", next);
1960                         else
1961                                 ast_debug(3, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1962                 }
1963         }
1964
1965         if (pvt)
1966                 pvt->sipoptions = profile;
1967         return profile;
1968 }
1969
1970 /*! \brief See if we pass debug IP filter */
1971 static inline int sip_debug_test_addr(const struct sockaddr_in *addr) 
1972 {
1973         if (!sipdebug)
1974                 return 0;
1975         if (debugaddr.sin_addr.s_addr) {
1976                 if (((ntohs(debugaddr.sin_port) != 0)
1977                         && (debugaddr.sin_port != addr->sin_port))
1978                         || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1979                         return 0;
1980         }
1981         return 1;
1982 }
1983
1984 /*! \brief The real destination address for a write */
1985 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
1986 {
1987         if (p->outboundproxy)
1988                 return &p->outboundproxy->ip;
1989
1990         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
1991 }
1992
1993 /*! \brief Display SIP nat mode */
1994 static const char *sip_nat_mode(const struct sip_pvt *p)
1995 {
1996         return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
1997 }
1998
1999 /*! \brief Test PVT for debugging output */
2000 static inline int sip_debug_test_pvt(struct sip_pvt *p) 
2001 {
2002         if (!sipdebug)
2003                 return 0;
2004         return sip_debug_test_addr(sip_real_dst(p));
2005 }
2006
2007 /*! \brief Transmit SIP message */
2008 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
2009 {
2010         int res;
2011         const struct sockaddr_in *dst = sip_real_dst(p);
2012         res = sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
2013
2014         if (res == -1) {
2015                 switch (errno) {
2016                         case EBADF:             /* Bad file descriptor - seems like this is generated when the host exist, but doesn't accept the UDP packet */
2017                         case EHOSTUNREACH:      /* Host can't be reached */
2018                         case ENETDOWN:          /* Inteface down */
2019                         case ENETUNREACH:       /* Network failure */
2020                                 res = XMIT_ERROR;       /* Don't bother with trying to transmit again */
2021                 }
2022         }
2023         if (res != len)
2024                 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));
2025         return res;
2026 }
2027
2028
2029 /*! \brief Build a Via header for a request */
2030 static void build_via(struct sip_pvt *p)
2031 {
2032         /* Work around buggy UNIDEN UIP200 firmware */
2033         const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
2034
2035         /* z9hG4bK is a magic cookie.  See RFC 3261 section 8.1.1.7 */
2036         ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
2037                         ast_inet_ntoa(p->ourip.sin_addr),
2038                         ntohs(p->ourip.sin_port), p->branch, rport);
2039 }
2040
2041 /*! \brief NAT fix - decide which IP address to use for Asterisk server?
2042  *
2043  * Using the localaddr structure built up with localnet statements in sip.conf
2044  * apply it to their address to see if we need to substitute our
2045  * externip or can get away with our internal bindaddr
2046  * 'us' is always overwritten.
2047  */
2048 static void ast_sip_ouraddrfor(struct in_addr *them, struct sockaddr_in *us)
2049 {
2050         struct sockaddr_in theirs;
2051         /* Set want_remap to non-zero if we want to remap 'us' to an externally
2052          * reachable IP address and port. This is done if:
2053          * 1. we have a localaddr list (containing 'internal' addresses marked
2054          *    as 'deny', so ast_apply_ha() will return AST_SENSE_DENY on them,
2055          *    and AST_SENSE_ALLOW on 'external' ones);
2056          * 2. either stunaddr or externip is set, so we know what to use as the
2057          *    externally visible address;
2058          * 3. the remote address, 'them', is external;
2059          * 4. the address returned by ast_ouraddrfor() is 'internal' (AST_SENSE_DENY
2060          *    when passed to ast_apply_ha() so it does need to be remapped.
2061          *    This fourth condition is checked later.
2062          */
2063         int want_remap = localaddr &&
2064                 (externip.sin_addr.s_addr || stunaddr.sin_addr.s_addr) &&
2065                 ast_apply_ha(localaddr, &theirs) == AST_SENSE_ALLOW ;
2066
2067         *us = internip;         /* starting guess for the internal address */
2068         /* now ask the system what would it use to talk to 'them' */
2069         ast_ouraddrfor(them, &us->sin_addr);
2070         theirs.sin_addr = *them;
2071
2072         if (want_remap &&
2073             (!global_matchexterniplocally || !ast_apply_ha(localaddr, us)) ) {
2074                 /* if we used externhost or stun, see if it is time to refresh the info */
2075                 if (externexpire && time(NULL) >= externexpire) {
2076                         if (stunaddr.sin_addr.s_addr) {
2077                                 ast_stun_request(sipsock, &stunaddr, NULL, &externip);
2078                         } else {
2079                                 if (ast_parse_arg(externhost, PARSE_INADDR, &externip))
2080                                         ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
2081                         }
2082                         externexpire = time(NULL) + externrefresh;
2083                 }
2084                 if (externip.sin_addr.s_addr)
2085                         *us = externip;
2086                 else
2087                         ast_log(LOG_WARNING, "stun failed\n");
2088                 ast_debug(1, "Target address %s is not local, substituting externip\n", 
2089                         ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
2090         } else if (bindaddr.sin_addr.s_addr) {
2091                 /* no remapping, but we bind to a specific address, so use it. */
2092                 *us = bindaddr;
2093         }
2094 }
2095
2096 /*! \brief Append to SIP dialog history with arg list  */
2097 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
2098 {
2099         char buf[80], *c = buf; /* max history length */
2100         struct sip_history *hist;
2101         int l;
2102
2103         vsnprintf(buf, sizeof(buf), fmt, ap);
2104         strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
2105         l = strlen(buf) + 1;
2106         if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
2107                 return;
2108         if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
2109                 ast_free(hist);
2110                 return;
2111         }
2112         memcpy(hist->event, buf, l);
2113         AST_LIST_INSERT_TAIL(p->history, hist, list);
2114 }
2115
2116 /*! \brief Append to SIP dialog history with arg list  */
2117 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
2118 {
2119         va_list ap;
2120
2121         if (!p)
2122                 return;
2123         va_start(ap, fmt);
2124         append_history_va(p, fmt, ap);
2125         va_end(ap);
2126
2127         return;
2128 }
2129
2130 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
2131 static int retrans_pkt(void *data)
2132 {
2133         struct sip_pkt *pkt = data, *prev, *cur = NULL;
2134         int reschedule = DEFAULT_RETRANS;
2135         int xmitres = 0;
2136
2137         /* Lock channel PVT */
2138         sip_pvt_lock(pkt->owner);
2139
2140         if (pkt->retrans < MAX_RETRANS) {
2141                 pkt->retrans++;
2142                 if (!pkt->timer_t1) {   /* Re-schedule using timer_a and timer_t1 */
2143                         if (sipdebug)
2144                                 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);
2145                 } else {
2146                         int siptimer_a;
2147
2148                         if (sipdebug)
2149                                 ast_debug(4, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
2150                         if (!pkt->timer_a)
2151                                 pkt->timer_a = 2 ;
2152                         else
2153                                 pkt->timer_a = 2 * pkt->timer_a;
2154  
2155                         /* For non-invites, a maximum of 4 secs */
2156                         siptimer_a = pkt->timer_t1 * pkt->timer_a;      /* Double each time */
2157                         if (pkt->method != SIP_INVITE && siptimer_a > 4000)
2158                                 siptimer_a = 4000;
2159                 
2160                         /* Reschedule re-transmit */
2161                         reschedule = siptimer_a;
2162                         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);
2163                 } 
2164
2165                 if (sip_debug_test_pvt(pkt->owner)) {
2166                         const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
2167                         ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
2168                                 pkt->retrans, sip_nat_mode(pkt->owner),
2169                                 ast_inet_ntoa(dst->sin_addr),
2170                                 ntohs(dst->sin_port), pkt->data);
2171                 }
2172
2173                 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
2174                 xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
2175                 sip_pvt_unlock(pkt->owner);
2176                 if (xmitres == XMIT_ERROR)
2177                         ast_log(LOG_WARNING, "Network error on retransmit in dialog %s\n", pkt->owner->callid);
2178                 else 
2179                         return  reschedule;
2180         } 
2181         /* Too many retries */
2182         if (pkt->owner && pkt->method != SIP_OPTIONS && xmitres == 0) {
2183                 if (ast_test_flag(pkt, FLAG_FATAL) || sipdebug) /* Tell us if it's critical or if we're debugging */
2184                         ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s)\n", pkt->owner->callid, pkt->seqno, (ast_test_flag(pkt, FLAG_FATAL)) ? "Critical" : "Non-critical", (ast_test_flag(pkt, FLAG_RESPONSE)) ? "Response" : "Request");
2185         } else if (pkt->method == SIP_OPTIONS && sipdebug) {
2186                         ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
2187
2188         } 
2189         if (xmitres == XMIT_ERROR) {
2190                 ast_log(LOG_WARNING, "Transmit error :: Cancelling transmission on Call ID %s\n", pkt->owner->callid);
2191                 append_history(pkt->owner, "XmitErr", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
2192         } else 
2193                 append_history(pkt->owner, "MaxRetries", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
2194                 
2195         pkt->retransid = -1;
2196
2197         if (ast_test_flag(pkt, FLAG_FATAL)) {
2198                 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
2199                         sip_pvt_unlock(pkt->owner);     /* SIP_PVT, not channel */
2200                         usleep(1);
2201                         sip_pvt_lock(pkt->owner);
2202                 }
2203
2204                 if (pkt->owner->owner && !pkt->owner->owner->hangupcause) 
2205                         pkt->owner->owner->hangupcause = AST_CAUSE_NO_USER_RESPONSE;
2206                 
2207                 if (pkt->owner->owner) {
2208                         sip_alreadygone(pkt->owner);
2209                         ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
2210                         ast_queue_hangup(pkt->owner->owner);
2211                         ast_channel_unlock(pkt->owner->owner);
2212                 } else {
2213                         /* If no channel owner, destroy now */
2214
2215                         /* Let the peerpoke system expire packets when the timer expires for poke_noanswer */
2216                         if (pkt->method != SIP_OPTIONS && pkt->method != SIP_REGISTER) {
2217                                 pkt->owner->needdestroy = 1;
2218                                 sip_alreadygone(pkt->owner);
2219                                 append_history(pkt->owner, "DialogKill", "Killing this failed dialog immediately");
2220                         }
2221                 }
2222         }
2223
2224         if (pkt->method == SIP_BYE) {
2225                 /* We're not getting answers on SIP BYE's.  Tear down the call anyway. */
2226                 if (pkt->owner->owner) 
2227                         ast_channel_unlock(pkt->owner->owner);
2228                 append_history(pkt->owner, "ByeFailure", "Remote peer doesn't respond to bye. Destroying call anyway.");
2229                 pkt->owner->needdestroy = 1;
2230         }
2231
2232         /* Remove the packet */
2233         for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
2234                 if (cur == pkt) {
2235                         UNLINK(cur, pkt->owner->packets, prev);
2236                         sip_pvt_unlock(pkt->owner);
2237                         ast_free(pkt);
2238                         return 0;
2239                 }
2240         }
2241         /* error case */
2242         ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
2243         sip_pvt_unlock(pkt->owner);
2244         return 0;
2245 }
2246
2247 /*! \brief Transmit packet with retransmits 
2248         \return 0 on success, -1 on failure to allocate packet 
2249 */
2250 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
2251 {
2252         struct sip_pkt *pkt;
2253         int siptimer_a = DEFAULT_RETRANS;
2254         int xmitres = 0;
2255
2256         if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
2257                 return AST_FAILURE;
2258         memcpy(pkt->data, data, len);
2259         pkt->method = sipmethod;
2260         pkt->packetlen = len;
2261         pkt->next = p->packets;
2262         pkt->owner = p;
2263         pkt->seqno = seqno;
2264         if (resp)
2265                 ast_set_flag(pkt, FLAG_RESPONSE);
2266         pkt->data[len] = '\0';
2267         pkt->timer_t1 = p->timer_t1;    /* Set SIP timer T1 */
2268         if (fatal)
2269                 ast_set_flag(pkt, FLAG_FATAL);
2270         if (pkt->timer_t1)
2271                 siptimer_a = pkt->timer_t1 * 2;
2272
2273         /* Schedule retransmission */
2274         pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
2275         if (sipdebug)
2276                 ast_debug(4, "*** SIP TIMER: Initalizing retransmit timer on packet: Id  #%d\n", pkt->retransid);
2277         pkt->next = p->packets;
2278         p->packets = pkt;
2279         if (sipmethod == SIP_INVITE) {
2280                 /* Note this is a pending invite */
2281                 p->pendinginvite = seqno;
2282         }
2283
2284         xmitres = __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);    /* Send packet */
2285
2286         if (xmitres == XMIT_ERROR) {    /* Serious network trouble, no need to try again */
2287                 append_history(pkt->owner, "XmitErr", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
2288                 ast_sched_del(sched, pkt->retransid);   /* No more retransmission */
2289                 pkt->retransid = -1;
2290                 return AST_FAILURE;
2291         } else
2292                 return AST_SUCCESS;
2293 }
2294
2295 /*! \brief Kill a SIP dialog (called by scheduler) */
2296 static int __sip_autodestruct(void *data)
2297 {
2298         struct sip_pvt *p = data;
2299
2300         /* If this is a subscription, tell the phone that we got a timeout */
2301         if (p->subscribed) {
2302                 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1, TRUE);   /* Send last notification */
2303                 p->subscribed = NONE;
2304                 append_history(p, "Subscribestatus", "timeout");
2305                 ast_debug(3, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
2306                 return 10000;   /* Reschedule this destruction so that we know that it's gone */
2307         }
2308
2309         if (p->subscribed == MWI_NOTIFICATION)
2310                 if (p->relatedpeer)
2311                         unref_peer(p->relatedpeer);     /* Remove link to peer. If it's realtime, make sure it's gone from memory) */
2312
2313         /* Reset schedule ID */
2314         p->autokillid = -1;
2315
2316         if (p->owner) {
2317                 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
2318                 ast_queue_hangup(p->owner);
2319         } else if (p->refer) {
2320                 ast_debug(3, "Finally hanging up channel after transfer: %s\n", p->callid);
2321                 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2322                 append_history(p, "ReferBYE", "Sending BYE on transferer call leg %s", p->callid);
2323                 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
2324         } else {
2325                 append_history(p, "AutoDestroy", "%s", p->callid);
2326                 ast_debug(3, "Auto destroying SIP dialog '%s'\n", p->callid);
2327                 sip_destroy(p);         /* Go ahead and destroy dialog. All attempts to recover is done */
2328         }
2329         return 0;
2330 }
2331
2332 /*! \brief Schedule destruction of SIP dialog */
2333 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2334 {
2335         if (ms < 0) {
2336                 if (p->timer_t1 == 0)
2337                         p->timer_t1 = SIP_TIMER_T1;     /* Set timer T1 if not set (RFC 3261) */
2338                 ms = p->timer_t1 * 64;
2339         }
2340         if (sip_debug_test_pvt(p))
2341                 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2342         if (p->do_history)
2343                 append_history(p, "SchedDestroy", "%d ms", ms);
2344
2345         if (p->autokillid > -1)
2346                 ast_sched_del(sched, p->autokillid);
2347         p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
2348 }
2349
2350 /*! \brief Cancel destruction of SIP dialog */
2351 static void sip_cancel_destroy(struct sip_pvt *p)
2352 {
2353         if (p->autokillid > -1) {
2354                 ast_sched_del(sched, p->autokillid);
2355                 append_history(p, "CancelDestroy", "");
2356                 p->autokillid = -1;
2357         }
2358 }
2359
2360 /*! \brief Acknowledges receipt of a packet and stops retransmission */
2361 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2362 {
2363         struct sip_pkt *cur, *prev = NULL;
2364         const char *msg = "Not Found";  /* used only for debugging */
2365
2366         sip_pvt_lock(p);
2367
2368         /* If we have an outbound proxy for this dialog, then delete it now since
2369           the rest of the requests in this dialog needs to follow the routing.
2370           If obforcing is set, we will keep the outbound proxy during the whole
2371           dialog, regardless of what the SIP rfc says
2372         */
2373         if (p->outboundproxy && !p->outboundproxy->force)
2374                 p->outboundproxy = NULL;
2375
2376         for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2377                 if (cur->seqno != seqno || ast_test_flag(cur, FLAG_RESPONSE) != resp)
2378                         continue;
2379                 if (ast_test_flag(cur, FLAG_RESPONSE) || cur->method == sipmethod) {
2380                         msg = "Found";
2381                         if (!resp && (seqno == p->pendinginvite)) {
2382                                 ast_debug(1, "Acked pending invite %d\n", p->pendinginvite);
2383                                 p->pendinginvite = 0;
2384                         }
2385                         if (cur->retransid > -1) {
2386                                 if (sipdebug)
2387                                         ast_debug(4, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2388                                 ast_sched_del(sched, cur->retransid);
2389                                 cur->retransid = -1;
2390                         }
2391                         UNLINK(cur, p->packets, prev);
2392                         ast_free(cur);
2393                         break;
2394                 }
2395         }
2396         sip_pvt_unlock(p);
2397         ast_debug(1, "Stopping retransmission on '%s' of %s %d: Match %s\n",
2398                 p->callid, resp ? "Response" : "Request", seqno, msg);
2399 }
2400
2401 /*! \brief Pretend to ack all packets
2402  * maybe the lock on p is not strictly necessary but there might be a race */
2403 static void __sip_pretend_ack(struct sip_pvt *p)
2404 {
2405         struct sip_pkt *cur = NULL;
2406
2407         while (p->packets) {
2408                 int method;
2409                 if (cur == p->packets) {
2410                         ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2411                         return;
2412                 }
2413                 cur = p->packets;
2414                 method = (cur->method) ? cur->method : find_sip_method(cur->data);
2415                 __sip_ack(p, cur->seqno, ast_test_flag(cur, FLAG_RESPONSE), method);
2416         }
2417 }
2418
2419 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2420 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2421 {
2422         struct sip_pkt *cur;
2423         int res = -1;
2424
2425         for (cur = p->packets; cur; cur = cur->next) {
2426                 if (cur->seqno == seqno && ast_test_flag(cur, FLAG_RESPONSE) == resp &&
2427                         (ast_test_flag(cur, FLAG_RESPONSE) || method_match(sipmethod, cur->data))) {
2428                         /* this is our baby */
2429                         if (cur->retransid > -1) {
2430                                 if (sipdebug)
2431                                         ast_debug(4, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2432                                 ast_sched_del(sched, cur->retransid);
2433                                 cur->retransid = -1;
2434                         }
2435                         res = 0;
2436                         break;
2437                 }
2438         }
2439         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");
2440         return res;
2441 }
2442
2443
2444 /*! \brief Copy SIP request, parse it */
2445 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2446 {
2447         memset(dst, 0, sizeof(*dst));
2448         memcpy(dst->data, src->data, sizeof(dst->data));
2449         dst->len = src->len;
2450         parse_request(dst);
2451 }
2452
2453 /*! \brief add a blank line if no body */
2454 static void add_blank(struct sip_request *req)
2455 {
2456         if (!req->lines) {
2457                 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2458                 snprintf(req->data + req->len, sizeof(req->data) - req->len, "\r\n");
2459                 req->len += strlen(req->data + req->len);
2460         }
2461 }
2462
2463 /*! \brief Transmit response on SIP request*/
2464 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2465 {
2466         int res;
2467
2468         add_blank(req);
2469         if (sip_debug_test_pvt(p)) {
2470                 const struct sockaddr_in *dst = sip_real_dst(p);
2471
2472                 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
2473                         reliable ? "Reliably " : "", sip_nat_mode(p),
2474                         ast_inet_ntoa(dst->sin_addr),
2475                         ntohs(dst->sin_port), req->data);
2476         }
2477         if (p->do_history) {
2478                 struct sip_request tmp;
2479                 parse_copy(&tmp, req);
2480                 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), 
2481                         (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
2482         }
2483         res = (reliable) ?
2484                  __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2485                 __sip_xmit(p, req->data, req->len);
2486         if (res > 0)
2487                 return 0;
2488         return res;
2489 }
2490
2491 /*! \brief Send SIP Request to the other part of the dialogue */
2492 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2493 {
2494         int res;
2495
2496         /* If we have an outbound proxy, reset peer address 
2497                 Only do this once.
2498         */
2499         if (p->outboundproxy) {
2500                 p->sa = p->outboundproxy->ip;
2501         }
2502
2503         add_blank(req);
2504         if (sip_debug_test_pvt(p)) {
2505                 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
2506                         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);
2507                 else
2508                         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);
2509         }
2510         if (p->do_history) {
2511                 struct sip_request tmp;
2512                 parse_copy(&tmp, req);
2513                 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
2514         }
2515         res = (reliable) ?
2516                 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2517                 __sip_xmit(p, req->data, req->len);
2518         return res;
2519 }
2520
2521 /*! \brief Locate closing quote in a string, skipping escaped quotes.
2522  * optionally with a limit on the search.
2523  * start must be past the first quote.
2524  */
2525 static const char *find_closing_quote(const char *start, const char *lim)
2526 {
2527         char last_char = '\0';
2528         const char *s;
2529         for (s = start; *s && s != lim; last_char = *s++) {
2530                 if (*s == '"' && last_char != '\\')
2531                         break;
2532         }
2533         return s;
2534 }
2535
2536 /*! \brief Pick out text in brackets from character string
2537         \return pointer to terminated stripped string
2538         \param tmp input string that will be modified
2539         Examples:
2540 \verbatim
2541         "foo" <bar>     valid input, returns bar
2542         foo             returns the whole string
2543         < "foo ... >    returns the string between brackets
2544         < "foo...       bogus (missing closing bracket), returns the whole string
2545                         XXX maybe should still skip the opening bracket
2546 \endverbatim
2547  */
2548 static char *get_in_brackets(char *tmp)
2549 {
2550         const char *parse = tmp;
2551         char *first_bracket;
2552
2553         /*
2554          * Skip any quoted text until we find the part in brackets.
2555         * On any error give up and return the full string.
2556         */
2557         while ( (first_bracket = strchr(parse, '<')) ) {
2558                 char *first_quote = strchr(parse, '"');
2559
2560                 if (!first_quote || first_quote > first_bracket)
2561                         break; /* no need to look at quoted part */
2562                 /* the bracket is within quotes, so ignore it */
2563                 parse = find_closing_quote(first_quote + 1, NULL);
2564                 if (!*parse) { /* not found, return full string ? */
2565                         /* XXX or be robust and return in-bracket part ? */
2566                         ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
2567                         break;
2568                 }
2569                 parse++;
2570         }
2571         if (first_bracket) {
2572                 char *second_bracket = strchr(first_bracket + 1, '>');
2573                 if (second_bracket) {
2574                         *second_bracket = '\0';
2575                         tmp = first_bracket + 1;
2576                 } else {
2577                         ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
2578                 }
2579         }
2580         return tmp;
2581 }
2582
2583 /*! \brief * parses a URI in its components.
2584  *
2585  * \note 
2586  *- If scheme is specified, drop it from the top.
2587  * - If a component is not requested, do not split around it.
2588  * This means that if we don't have domain, we cannot split
2589  * name:pass and domain:port.
2590  * It is safe to call with ret_name, pass, domain, port
2591  * pointing all to the same place.
2592  * Init pointers to empty string so we never get NULL dereferencing.
2593  * Overwrites the string.
2594  * return 0 on success, other values on error.
2595  * \verbatim 
2596  * general form we are expecting is sip[s]:username[:password][;parameter]@host[:port][;...] 
2597  * \endverbatim
2598  */
2599 static int parse_uri(char *uri, char *scheme,
2600         char **ret_name, char **pass, char **domain, char **port, char **options)
2601 {
2602         char *name = NULL;
2603         int error = 0;
2604
2605         /* init field as required */
2606         if (pass)
2607                 *pass = "";
2608         if (port)
2609                 *port = "";
2610         if (scheme) {
2611                 int l = strlen(scheme);
2612                 if (!strncasecmp(uri, scheme, l))
2613                         uri += l;
2614                 else {
2615                         ast_log(LOG_NOTICE, "Missing scheme '%s' in '%s'\n", scheme, uri);
2616                         error = -1;
2617                 }
2618         }
2619         if (!domain) {
2620                 /* if we don't want to split around domain, keep everything as a name,
2621                  * so we need to do nothing here, except remember why.
2622                  */
2623         } else {
2624                 /* store the result in a temp. variable to avoid it being
2625                  * overwritten if arguments point to the same place.
2626                  */
2627                 char *c, *dom = "";
2628
2629                 if ((c = strchr(uri, '@')) == NULL) {
2630                         /* domain-only URI, according to the SIP RFC. */
2631                         dom = uri;
2632                         name = "";
2633                 } else {
2634                         *c++ = '\0';
2635                         dom = c;
2636                         name = uri;
2637                 }
2638
2639                 /* Remove options in domain and name */
2640                 dom = strsep(&dom, ";");
2641                 name = strsep(&name, ";");
2642
2643                 if (port && (c = strchr(dom, ':'))) { /* Remove :port */
2644                         *c++ = '\0';
2645                         *port = c;
2646                 }
2647                 if (pass && (c = strchr(name, ':'))) {  /* user:password */
2648                         *c++ = '\0';
2649                         *pass = c;
2650                 }
2651                 *domain = dom;
2652         }
2653         if (ret_name)   /* same as for domain, store the result only at the end */
2654                 *ret_name = name;
2655         if (options)
2656                 *options = uri ? uri : "";
2657
2658         return error;
2659 }
2660
2661 /*! \brief Send message with Access-URL header, if this is an HTML URL only! */
2662 static int sip_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen)
2663 {
2664         struct sip_pvt *p = chan->tech_pvt;
2665
2666         if (subclass != AST_HTML_URL)
2667                 return -1;
2668
2669         ast_string_field_build(p, url, "<%s>;mode=active", data);
2670
2671         if (sip_debug_test_pvt(p))
2672                 ast_debug(1, "Send URL %s, state = %d!\n", data, chan->_state);
2673
2674         switch (chan->_state) {
2675         case AST_STATE_RING:
2676                 transmit_response(p, "100 Trying", &p->initreq);
2677                 break;
2678         case AST_STATE_RINGING:
2679                 transmit_response(p, "180 Ringing", &p->initreq);
2680                 break;
2681         case AST_STATE_UP:
2682                 if (!p->pendinginvite) {                /* We are up, and have no outstanding invite */
2683                         transmit_reinvite_with_sdp(p, FALSE);
2684                 } else if (!ast_test_flag(&p->flags[0], SIP_PENDINGBYE)) {
2685                         ast_set_flag(&p->flags[0], SIP_NEEDREINVITE);   
2686                 }       
2687                 break;
2688         default:
2689                 ast_log(LOG_WARNING, "Don't know how to send URI when state is %d!\n", chan->_state);
2690         }
2691
2692         return 0;
2693 }
2694
2695 /*! \brief Send SIP MESSAGE text within a call
2696         Called from PBX core sendtext() application */
2697 static int sip_sendtext(struct ast_channel *ast, const char *text)
2698 {
2699         struct sip_pvt *p = ast->tech_pvt;
2700         int debug = sip_debug_test_pvt(p);
2701
2702         if (debug)
2703                 ast_verbose("Sending text %s on %s\n", text, ast->name);
2704         if (!p)
2705                 return -1;
2706         if (ast_strlen_zero(text))
2707                 return 0;
2708         if (debug)
2709                 ast_verbose("Really sending text %s on %s\n", text, ast->name);
2710         transmit_message_with_text(p, text);
2711         return 0;       
2712 }
2713
2714 /*! \brief Update peer object in realtime storage 
2715         If the Asterisk system name is set in asterisk.conf, we will use
2716         that name and store that in the "regserver" field in the sippeers
2717         table to facilitate multi-server setups.
2718 */
2719 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
2720 {
2721         char port[10];
2722         char ipaddr[INET_ADDRSTRLEN];
2723         char regseconds[20];
2724         char *tablename = NULL;
2725
2726         char *sysname = ast_config_AST_SYSTEM_NAME;
2727         char *syslabel = NULL;
2728
2729         time_t nowtime = time(NULL) + expirey;
2730         const char *fc = fullcontact ? "fullcontact" : NULL;
2731
2732         int realtimeregs = ast_check_realtime("sipregs");
2733
2734         tablename = realtimeregs ? "sipregs" : "sippeers";
2735         
2736         snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime);   /* Expiration time */
2737         ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2738         snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
2739         
2740         if (ast_strlen_zero(sysname))   /* No system name, disable this */
2741                 sysname = NULL;
2742         else if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTSAVE_SYSNAME))
2743                 syslabel = "regserver";
2744
2745         if (fc)
2746                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
2747                         "port", port, "regseconds", regseconds,
2748                         "username", username, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
2749         else
2750                 ast_update_realtime(tablename, "name", peername, "ipaddr", ipaddr,
2751                         "port", port, "regseconds", regseconds,
2752                         "username", username, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
2753 }
2754
2755 /*! \brief Automatically add peer extension to dial plan */
2756 static void register_peer_exten(struct sip_peer *peer, int onoff)
2757 {
2758         char multi[256];
2759         char *stringp, *ext, *context;
2760
2761         /* XXX note that global_regcontext is both a global 'enable' flag and
2762          * the name of the global regexten context, if not specified
2763          * individually.
2764          */
2765         if (ast_strlen_zero(global_regcontext))
2766                 return;
2767
2768         ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
2769         stringp = multi;
2770         while ((ext = strsep(&stringp, "&"))) {
2771                 if ((context = strchr(ext, '@'))) {
2772                         *context++ = '\0';      /* split ext@context */
2773                         if (!ast_context_find(context)) {
2774                                 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
2775                                 continue;
2776                         }
2777                 } else {
2778                         context = global_regcontext;
2779                 }
2780                 if (onoff)
2781                         ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
2782                                  ast_strdup(peer->name), ast_free, "SIP");
2783                 else
2784                         ast_context_remove_extension(context, ext, 1, NULL);
2785         }
2786 }
2787
2788 /*! \brief Destroy peer object from memory */
2789 static void sip_destroy_peer(struct sip_peer *peer)
2790 {
2791         ast_debug(3, "Destroying SIP peer %s\n", peer->name);
2792
2793         if (peer->outboundproxy)
2794                 ast_free(peer->outboundproxy);
2795
2796         /* Delete it, it needs to disappear */
2797         if (peer->call)
2798                 sip_destroy(peer->call);
2799
2800         if (peer->mwipvt)       /* We have an active subscription, delete it */
2801                 sip_destroy(peer->mwipvt);
2802
2803         if (peer->mwi_event_sub) {
2804                 ast_event_unsubscribe(peer->mwi_event_sub);
2805                 peer->mwi_event_sub = NULL;
2806         }
2807
2808         if (peer->chanvars) {
2809                 ast_variables_destroy(peer->chanvars);
2810                 peer->chanvars = NULL;
2811         }
2812         if (peer->expire > -1)
2813                 ast_sched_del(sched, peer->expire);
2814
2815         if (peer->pokeexpire > -1)
2816                 ast_sched_del(sched, peer->pokeexpire);
2817         register_peer_exten(peer, FALSE);
2818         ast_free_ha(peer->ha);
2819         if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
2820                 apeerobjs--;
2821         else if (peer->is_realtime) {
2822                 rpeerobjs--;
2823                 ast_debug(3,"-REALTIME- peer Destroyed. Name: %s. Realtime Peer objects: %d\n", peer->name, rpeerobjs);
2824         } else
2825                 speerobjs--;
2826         clear_realm_authentication(peer->auth);
2827         peer->auth = NULL;
2828         if (peer->dnsmgr)
2829                 ast_dnsmgr_release(peer->dnsmgr);
2830         ast_free(peer);
2831 }
2832
2833 /*! \brief Update peer data in database (if used) */
2834 static void update_peer(struct sip_peer *p, int expiry)
2835 {
2836         int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2837         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
2838             (p->is_realtime || rtcachefriends)) {
2839                 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
2840         }
2841 }
2842
2843
2844 /*! \brief  realtime_peer: Get peer from realtime storage
2845  * Checks the "sippeers" realtime family from extconfig.conf 
2846  * Checks the "sipregs" realtime family from extconfig.conf if it's configured.
2847  * \todo Consider adding check of port address when matching here to follow the same
2848  *      algorithm as for static peers. Will we break anything by adding that?
2849 */
2850 static struct sip_peer *realtime_peer(const char *newpeername, struct sockaddr_in *sin)
2851 {
2852         struct sip_peer *peer;
2853         struct ast_variable *var = NULL;
2854         struct ast_variable *varregs = NULL;
2855         struct ast_variable *tmp;
2856         char ipaddr[INET_ADDRSTRLEN];
2857         int realtimeregs = ast_check_realtime("sipregs");
2858
2859         /* First check on peer name */
2860         if (newpeername) {
2861                 var = ast_load_realtime("sippeers", "name", newpeername, NULL);
2862                 if (realtimeregs)
2863                         varregs = ast_load_realtime("sipregs", "name", newpeername, NULL);
2864         } else if (sin) {       /* Then check on IP address for dynamic peers */
2865                 ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2866                 var = ast_load_realtime("sippeers", "host", ipaddr, NULL);      /* First check for fixed IP hosts */
2867                 if (var) {
2868                         if (realtimeregs) {
2869                                 tmp = var;
2870                                 while (tmp) {
2871                                         if (!newpeername && !strcasecmp(tmp->name, "name"))
2872                                                 newpeername = tmp->value;
2873                                         tmp = tmp->next;
2874                                 }
2875                                 varregs = ast_load_realtime("sipregs", "name", newpeername, NULL);
2876                         }
2877                 } else {
2878                         if (realtimeregs)
2879                                 varregs = ast_load_realtime("sipregs", "ipaddr", ipaddr, NULL); /* Then check for registered hosts */
2880                         else
2881                                 var = ast_load_realtime("sippeers", "ipaddr", ipaddr, NULL); /* Then check for registered hosts */
2882                         if (varregs) {
2883                                 tmp = varregs;
2884                                 while (tmp) {
2885                                         if (!newpeername && !strcasecmp(tmp->name, "name"))
2886                                                 newpeername = tmp->value;
2887                                         tmp = tmp->next;
2888                                 }
2889                                 var = ast_load_realtime("sippeers", "name", newpeername, NULL);
2890                         }
2891                 }
2892         }
2893
2894         if (!var)
2895                 return NULL;
2896
2897         for (tmp = var; tmp; tmp = tmp->next) {
2898                 /* If this is type=user, then skip this object. */
2899                 if (!strcasecmp(tmp->name, "type") &&
2900                     !strcasecmp(tmp->value, "user")) {
2901                         ast_variables_destroy(var);
2902                         ast_variables_destroy(varregs);
2903                         return NULL;
2904                 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
2905                         newpeername = tmp->value;
2906                 }
2907         }
2908         
2909         if (!newpeername) {     /* Did not find peer in realtime */
2910                 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", ipaddr);
2911                 ast_variables_destroy(var);
2912                 return NULL;
2913         }
2914
2915
2916         /* Peer found in realtime, now build it in memory */
2917         peer = build_peer(newpeername, var, varregs, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2918         if (!peer) {
2919                 ast_variables_destroy(var);
2920                 ast_variables_destroy(varregs);
2921                 return NULL;
2922         }
2923
2924         ast_debug(3,"-REALTIME- loading peer from database to memory. Name: %s. Peer objects: %d\n", peer->name, rpeerobjs);
2925
2926         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2927                 /* Cache peer */
2928                 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
2929                 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
2930                         if (peer->expire > -1) {
2931                                 ast_sched_del(sched, peer->expire);
2932                         }
2933                         peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
2934                 }
2935                 ASTOBJ_CONTAINER_LINK(&peerl,peer);
2936         } else {
2937                 peer->is_realtime = 1;
2938         }
2939         ast_variables_destroy(var);
2940         ast_variables_destroy(varregs);
2941
2942         return peer;
2943 }
2944
2945 /*! \brief Support routine for find_peer */
2946 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
2947 {
2948         /* We know name is the first field, so we can cast */
2949         struct sip_peer *p = (struct sip_peer *) name;
2950         return  !(!inaddrcmp(&p->addr, sin) || 
2951                                         (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
2952                                         (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
2953 }
2954
2955 /*! \brief Locate peer by name or ip address 
2956  *      This is used on incoming SIP message to find matching peer on ip
2957         or outgoing message to find matching peer on name */
2958 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
2959 {
2960         struct sip_peer *p = NULL;
2961
2962         if (peer)
2963                 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
2964         else
2965                 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
2966
2967         if (!p && realtime)
2968                 p = realtime_peer(peer, sin);
2969
2970         return p;
2971 }
2972
2973 /*! \brief Remove user object from in-memory storage */
2974 static void sip_destroy_user(struct sip_user *user)
2975 {
2976         ast_debug(3, "Destroying user object from memory: %s\n", user->name);
2977         ast_free_ha(user->ha);
2978         if (user->chanvars) {
2979                 ast_variables_destroy(user->chanvars);
2980                 user->chanvars = NULL;
2981         }
2982         if (user->is_realtime)
2983                 ruserobjs--;
2984         else
2985                 suserobjs--;
2986         ast_free(user);
2987 }
2988
2989 /*! \brief Load user from realtime storage
2990  * Loads user from "sipusers" category in realtime (extconfig.conf)
2991  * Users are matched on From: user name (the domain in skipped) */
2992 static struct sip_user *realtime_user(const char *username)
2993 {
2994         struct ast_variable *var;
2995         struct ast_variable *tmp;
2996         struct sip_user *user = NULL;
2997
2998         var = ast_load_realtime("sipusers", "name", username, NULL);
2999
3000         if (!var)
3001                 return NULL;
3002
3003         for (tmp = var; tmp; tmp = tmp->next) {
3004                 if (!strcasecmp(tmp->name, "type") &&
3005                         !strcasecmp(tmp->value, "peer")) {
3006                         ast_variables_destroy(var);
3007                         return NULL;
3008                 }
3009         }
3010
3011         user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
3012         
3013         if (!user) {    /* No user found */
3014                 ast_variables_destroy(var);
3015                 return NULL;
3016         }
3017
3018         if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
3019                 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
3020                 suserobjs++;
3021                 ASTOBJ_CONTAINER_LINK(&userl,user);
3022         } else {
3023                 /* Move counter from s to r... */
3024                 suserobjs--;
3025                 ruserobjs++;
3026                 user->is_realtime = 1;
3027         }
3028         ast_variables_destroy(var);
3029         return user;
3030 }
3031
3032 /*! \brief Locate user by name 
3033  * Locates user by name (From: sip uri user name part) first