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