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