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