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