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