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