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