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