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