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