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