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