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