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