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