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