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