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