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