2 * Asterisk -- An open source telephony toolkit.
4 * Copyright (C) 1999 - 2006, Digium, Inc.
6 * Mark Spencer <markster@digium.com>
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.
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.
21 * \brief Implementation of Session Initiation Protocol
23 * \author Mark Spencer <markster@digium.com>
26 * \arg \ref AstCREDITS
28 * Implementation of RFC 3261 - without S/MIME, TCP and TLS support
29 * Configuration file \link Config_sip sip.conf \endlink
34 * \todo Better support of forking
35 * \todo VIA branch tag transaction checking
36 * \todo Transaction support
38 * \ingroup channel_drivers
40 * \par Overview of the handling of SIP sessions
41 * The SIP channel handles several types of SIP sessions, or dialogs,
42 * not all of them being "telephone calls".
43 * - Incoming calls that will be sent to the PBX core
44 * - Outgoing calls, generated by the PBX
45 * - SIP subscriptions and notifications of states and voicemail messages
46 * - SIP registrations, both inbound and outbound
47 * - SIP peer management (peerpoke, OPTIONS)
50 * In the SIP channel, there's a list of active SIP dialogs, which includes
51 * all of these when they are active. "sip show channels" in the CLI will
52 * show most of these, excluding subscriptions which are shown by
53 * "sip show subscriptions"
55 * \par incoming packets
56 * Incoming packets are received in the monitoring thread, then handled by
57 * sipsock_read(). This function parses the packet and matches an existing
58 * dialog or starts a new SIP dialog.
60 * sipsock_read sends the packet to handle_request(), that parses a bit more.
61 * if it's a response to an outbound request, it's sent to handle_response().
62 * If it is a request, handle_request sends it to one of a list of functions
63 * depending on the request type - INVITE, OPTIONS, REFER, BYE, CANCEL etc
64 * sipsock_read locks the ast_channel if it exists (an active call) and
65 * unlocks it after we have processed the SIP message.
67 * A new INVITE is sent to handle_request_invite(), that will end up
68 * starting a new channel in the PBX, the new channel after that executing
69 * in a separate channel thread. This is an incoming "call".
70 * When the call is answered, either by a bridged channel or the PBX itself
71 * the sip_answer() function is called.
73 * The actual media - Video or Audio - is mostly handled by the RTP subsystem
77 * Outbound calls are set up by the PBX through the sip_request_call()
78 * function. After that, they are activated by sip_call().
81 * The PBX issues a hangup on both incoming and outgoing calls through
82 * the sip_hangup() function
88 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
94 #include <sys/socket.h>
95 #include <sys/ioctl.h>
102 #include <sys/signal.h>
103 #include <netinet/in.h>
104 #include <netinet/in_systm.h>
105 #include <arpa/inet.h>
106 #include <netinet/ip.h>
109 #include "asterisk/lock.h"
110 #include "asterisk/channel.h"
111 #include "asterisk/config.h"
112 #include "asterisk/logger.h"
113 #include "asterisk/module.h"
114 #include "asterisk/pbx.h"
115 #include "asterisk/options.h"
116 #include "asterisk/lock.h"
117 #include "asterisk/sched.h"
118 #include "asterisk/io.h"
119 #include "asterisk/rtp.h"
120 #include "asterisk/udptl.h"
121 #include "asterisk/acl.h"
122 #include "asterisk/manager.h"
123 #include "asterisk/callerid.h"
124 #include "asterisk/cli.h"
125 #include "asterisk/app.h"
126 #include "asterisk/musiconhold.h"
127 #include "asterisk/dsp.h"
128 #include "asterisk/features.h"
129 #include "asterisk/acl.h"
130 #include "asterisk/srv.h"
131 #include "asterisk/astdb.h"
132 #include "asterisk/causes.h"
133 #include "asterisk/utils.h"
134 #include "asterisk/file.h"
135 #include "asterisk/astobj.h"
136 #include "asterisk/dnsmgr.h"
137 #include "asterisk/devicestate.h"
138 #include "asterisk/linkedlists.h"
139 #include "asterisk/stringfields.h"
140 #include "asterisk/monitor.h"
141 #include "asterisk/localtime.h"
142 #include "asterisk/abstract_jb.h"
143 #include "asterisk/compiler.h"
144 #include "asterisk/threadstorage.h"
145 #include "asterisk/translate.h"
155 #define VIDEO_CODEC_MASK 0x1fc0000 /*!< Video codecs from H.261 thru AST_FORMAT_MAX_VIDEO */
156 #ifndef IPTOS_MINCOST
157 #define IPTOS_MINCOST 0x02
160 /* #define VOCAL_DATA_HACK */
162 #define DEFAULT_DEFAULT_EXPIRY 120
163 #define DEFAULT_MIN_EXPIRY 60
164 #define DEFAULT_MAX_EXPIRY 3600
165 #define DEFAULT_REGISTRATION_TIMEOUT 20
166 #define DEFAULT_MAX_FORWARDS "70"
168 /* guard limit must be larger than guard secs */
169 /* guard min must be < 1000, and should be >= 250 */
170 #define EXPIRY_GUARD_SECS 15 /*!< How long before expiry do we reregister */
171 #define EXPIRY_GUARD_LIMIT 30 /*!< Below here, we use EXPIRY_GUARD_PCT instead of
173 #define EXPIRY_GUARD_MIN 500 /*!< This is the minimum guard time applied. If
174 GUARD_PCT turns out to be lower than this, it
175 will use this time instead.
176 This is in milliseconds. */
177 #define EXPIRY_GUARD_PCT 0.20 /*!< Percentage of expires timeout to use when
178 below EXPIRY_GUARD_LIMIT */
179 #define DEFAULT_EXPIRY 900 /*!< Expire slowly */
181 static int min_expiry = DEFAULT_MIN_EXPIRY; /*!< Minimum accepted registration time */
182 static int max_expiry = DEFAULT_MAX_EXPIRY; /*!< Maximum accepted registration time */
183 static int default_expiry = DEFAULT_DEFAULT_EXPIRY;
184 static int expiry = DEFAULT_EXPIRY;
187 #define MAX(a,b) ((a) > (b) ? (a) : (b))
190 #define CALLERID_UNKNOWN "Unknown"
192 #define DEFAULT_MAXMS 2000 /*!< Qualification: Must be faster than 2 seconds by default */
193 #define DEFAULT_FREQ_OK 60 * 1000 /*!< Qualification: How often to check for the host to be up */
194 #define DEFAULT_FREQ_NOTOK 10 * 1000 /*!< Qualification: How often to check, if the host is down... */
196 #define DEFAULT_RETRANS 1000 /*!< How frequently to retransmit Default: 2 * 500 ms in RFC 3261 */
197 #define MAX_RETRANS 6 /*!< Try only 6 times for retransmissions, a total of 7 transmissions */
198 #define SIP_TIMER_T1 500 /* SIP timer T1 (according to RFC 3261) */
199 #define SIP_TRANS_TIMEOUT 32000 /*!< SIP request timeout (rfc 3261) 64*T1
200 \todo Use known T1 for timeout (peerpoke)
202 #define DEFAULT_TRANS_TIMEOUT -1 /* Use default SIP transaction timeout */
203 #define MAX_AUTHTRIES 3 /*!< Try authentication three times, then fail */
205 #define SIP_MAX_HEADERS 64 /*!< Max amount of SIP headers to read */
206 #define SIP_MAX_LINES 64 /*!< Max amount of lines in SIP attachment (like SDP) */
207 #define SIP_MAX_PACKET 4096 /*!< Also from RFC 3261 (2543), should sub headers tho */
209 #define INITIAL_CSEQ 101 /*!< our initial sip sequence number */
211 /*! \brief Global jitterbuffer configuration - by default, jb is disabled */
212 static struct ast_jb_conf default_jbconf =
216 .resync_threshold = -1,
219 static struct ast_jb_conf global_jbconf;
221 static const char config[] = "sip.conf";
222 static const char notify_config[] = "sip_notify.conf";
227 /*! \brief Authorization scheme for call transfers
228 \note Not a bitfield flag, since there are plans for other modes,
229 like "only allow transfers for authenticated devices" */
231 TRANSFER_OPENFORALL, /*!< Allow all SIP transfers */
232 TRANSFER_CLOSED, /*!< Allow no SIP transfers */
241 /*! \brief States for the INVITE transaction, not the dialog
242 \note this is for the INVITE that sets up the dialog
245 INV_NONE = 0, /*!< No state at all, maybe not an INVITE dialog */
246 INV_CALLING, /*!< Invite sent, no answer */
247 INV_PROCEEDING, /*!< We got 1xx message */
248 INV_EARLY_MEDIA, /*!< We got 18x message with to-tag back */
249 INV_COMPLETED, /*!< Got final response with error. Wait for ACK, then CONFIRMED */
250 INV_CONFIRMED, /*!< Confirmed response - we've got an ack (Incoming calls only) */
251 INV_TERMINATED, /*!< Transaction done - either successful (AST_STATE_UP) or failed, but done
252 The only way out of this is a BYE from one side */
253 INV_CANCELLED /*!< Transaction cancelled by client or server in non-terminated state */
256 /* Do _NOT_ make any changes to this enum, or the array following it;
257 if you think you are doing the right thing, you are probably
258 not doing the right thing. If you think there are changes
259 needed, get someone else to review them first _before_
260 submitting a patch. If these two lists do not match properly
261 bad things will happen.
265 XMIT_CRITICAL = 2, /*!< Transmit critical SIP message reliably, with re-transmits.
266 If it fails, it's critical and will cause a teardown of the session */
267 XMIT_RELIABLE = 1, /*!< Transmit SIP message reliably, with re-transmits */
268 XMIT_UNRELIABLE = 0, /*!< Transmit SIP message without bothering with re-transmits */
271 enum parse_register_result {
272 PARSE_REGISTER_FAILED,
273 PARSE_REGISTER_UPDATE,
274 PARSE_REGISTER_QUERY,
277 enum subscriptiontype {
286 static const struct cfsubscription_types {
287 enum subscriptiontype type;
288 const char * const event;
289 const char * const mediatype;
290 const char * const text;
291 } subscription_types[] = {
292 { NONE, "-", "unknown", "unknown" },
293 /* RFC 4235: SIP Dialog event package */
294 { DIALOG_INFO_XML, "dialog", "application/dialog-info+xml", "dialog-info+xml" },
295 { CPIM_PIDF_XML, "presence", "application/cpim-pidf+xml", "cpim-pidf+xml" }, /* RFC 3863 */
296 { PIDF_XML, "presence", "application/pidf+xml", "pidf+xml" }, /* RFC 3863 */
297 { XPIDF_XML, "presence", "application/xpidf+xml", "xpidf+xml" }, /* Pre-RFC 3863 with MS additions */
298 { MWI_NOTIFICATION, "message-summary", "application/simple-message-summary", "mwi" } /* RFC 3842: Mailbox notification */
301 /*! \brief SIP Request methods known by Asterisk */
303 SIP_UNKNOWN, /* Unknown response */
304 SIP_RESPONSE, /* Not request, response to outbound request */
310 SIP_PRACK, /* Not supported at all */
315 SIP_UPDATE, /* We can send UPDATE; but not accept it */
318 SIP_PUBLISH, /* Not supported at all */
319 SIP_PING, /* Not supported at all, no standard but still implemented out there */
322 /*! \brief Authentication types - proxy or www authentication
323 \note Endpoints, like Asterisk, should always use WWW authentication to
324 allow multiple authentications in the same call - to the proxy and
332 /*! \brief Authentication result from check_auth* functions */
333 enum check_auth_result {
334 AUTH_DONT_KNOW = -100, /*!< no result, need to check further */
335 /* XXX maybe this is the same as AUTH_NOT_FOUND */
338 AUTH_CHALLENGE_SENT = 1,
339 AUTH_SECRET_FAILED = -1,
340 AUTH_USERNAME_MISMATCH = -2,
341 AUTH_NOT_FOUND = -3, /* returned by register_verify */
343 AUTH_UNKNOWN_DOMAIN = -5,
346 /*! \brief States for outbound registrations (with register= lines in sip.conf */
347 enum sipregistrystate {
348 REG_STATE_UNREGISTERED = 0, /*!< We are not registred */
349 REG_STATE_REGSENT, /*!< Registration request sent */
350 REG_STATE_AUTHSENT, /*!< We have tried to authenticate */
351 REG_STATE_REGISTERED, /*!< Registred and done */
352 REG_STATE_REJECTED, /*!< Registration rejected */
353 REG_STATE_TIMEOUT, /*!< Registration timed out */
354 REG_STATE_NOAUTH, /*!< We have no accepted credentials */
355 REG_STATE_FAILED, /*!< Registration failed after several tries */
358 enum can_create_dialog {
359 CAN_NOT_CREATE_DIALOG,
361 CAN_CREATE_DIALOG_UNSUPPORTED_METHOD,
364 /*! XXX Note that sip_methods[i].id == i must hold or the code breaks */
365 static const struct cfsip_methods {
367 int need_rtp; /*!< when this is the 'primary' use for a pvt structure, does it need RTP? */
369 enum can_create_dialog can_create;
371 { SIP_UNKNOWN, RTP, "-UNKNOWN-", CAN_CREATE_DIALOG },
372 { SIP_RESPONSE, NO_RTP, "SIP/2.0", CAN_NOT_CREATE_DIALOG },
373 { SIP_REGISTER, NO_RTP, "REGISTER", CAN_CREATE_DIALOG },
374 { SIP_OPTIONS, NO_RTP, "OPTIONS", CAN_CREATE_DIALOG },
375 { SIP_NOTIFY, NO_RTP, "NOTIFY", CAN_CREATE_DIALOG },
376 { SIP_INVITE, RTP, "INVITE", CAN_CREATE_DIALOG },
377 { SIP_ACK, NO_RTP, "ACK", CAN_NOT_CREATE_DIALOG },
378 { SIP_PRACK, NO_RTP, "PRACK", CAN_NOT_CREATE_DIALOG },
379 { SIP_BYE, NO_RTP, "BYE", CAN_NOT_CREATE_DIALOG },
380 { SIP_REFER, NO_RTP, "REFER", CAN_CREATE_DIALOG },
381 { SIP_SUBSCRIBE, NO_RTP, "SUBSCRIBE", CAN_CREATE_DIALOG },
382 { SIP_MESSAGE, NO_RTP, "MESSAGE", CAN_CREATE_DIALOG },
383 { SIP_UPDATE, NO_RTP, "UPDATE", CAN_NOT_CREATE_DIALOG },
384 { SIP_INFO, NO_RTP, "INFO", CAN_NOT_CREATE_DIALOG },
385 { SIP_CANCEL, NO_RTP, "CANCEL", CAN_NOT_CREATE_DIALOG },
386 { SIP_PUBLISH, NO_RTP, "PUBLISH", CAN_CREATE_DIALOG_UNSUPPORTED_METHOD },
387 { SIP_PING, NO_RTP, "PING", CAN_CREATE_DIALOG_UNSUPPORTED_METHOD }
390 /*! Define SIP option tags, used in Require: and Supported: headers
391 We need to be aware of these properties in the phones to use
392 the replace: header. We should not do that without knowing
393 that the other end supports it...
394 This is nothing we can configure, we learn by the dialog
395 Supported: header on the REGISTER (peer) or the INVITE
397 We are not using many of these today, but will in the future.
398 This is documented in RFC 3261
401 #define NOT_SUPPORTED 0
403 #define SIP_OPT_REPLACES (1 << 0)
404 #define SIP_OPT_100REL (1 << 1)
405 #define SIP_OPT_TIMER (1 << 2)
406 #define SIP_OPT_EARLY_SESSION (1 << 3)
407 #define SIP_OPT_JOIN (1 << 4)
408 #define SIP_OPT_PATH (1 << 5)
409 #define SIP_OPT_PREF (1 << 6)
410 #define SIP_OPT_PRECONDITION (1 << 7)
411 #define SIP_OPT_PRIVACY (1 << 8)
412 #define SIP_OPT_SDP_ANAT (1 << 9)
413 #define SIP_OPT_SEC_AGREE (1 << 10)
414 #define SIP_OPT_EVENTLIST (1 << 11)
415 #define SIP_OPT_GRUU (1 << 12)
416 #define SIP_OPT_TARGET_DIALOG (1 << 13)
417 #define SIP_OPT_NOREFERSUB (1 << 14)
418 #define SIP_OPT_HISTINFO (1 << 15)
419 #define SIP_OPT_RESPRIORITY (1 << 16)
421 /*! \brief List of well-known SIP options. If we get this in a require,
422 we should check the list and answer accordingly. */
423 static const struct cfsip_options {
424 int id; /*!< Bitmap ID */
425 int supported; /*!< Supported by Asterisk ? */
426 char * const text; /*!< Text id, as in standard */
427 } sip_options[] = { /* XXX used in 3 places */
428 /* RFC3891: Replaces: header for transfer */
429 { SIP_OPT_REPLACES, SUPPORTED, "replaces" },
430 /* One version of Polycom firmware has the wrong label */
431 { SIP_OPT_REPLACES, SUPPORTED, "replace" },
432 /* RFC3262: PRACK 100% reliability */
433 { SIP_OPT_100REL, NOT_SUPPORTED, "100rel" },
434 /* RFC4028: SIP Session Timers */
435 { SIP_OPT_TIMER, NOT_SUPPORTED, "timer" },
436 /* RFC3959: SIP Early session support */
437 { SIP_OPT_EARLY_SESSION, NOT_SUPPORTED, "early-session" },
438 /* RFC3911: SIP Join header support */
439 { SIP_OPT_JOIN, NOT_SUPPORTED, "join" },
440 /* RFC3327: Path support */
441 { SIP_OPT_PATH, NOT_SUPPORTED, "path" },
442 /* RFC3840: Callee preferences */
443 { SIP_OPT_PREF, NOT_SUPPORTED, "pref" },
444 /* RFC3312: Precondition support */
445 { SIP_OPT_PRECONDITION, NOT_SUPPORTED, "precondition" },
446 /* RFC3323: Privacy with proxies*/
447 { SIP_OPT_PRIVACY, NOT_SUPPORTED, "privacy" },
448 /* RFC4092: Usage of the SDP ANAT Semantics in the SIP */
449 { SIP_OPT_SDP_ANAT, NOT_SUPPORTED, "sdp-anat" },
450 /* RFC3329: Security agreement mechanism */
451 { SIP_OPT_SEC_AGREE, NOT_SUPPORTED, "sec_agree" },
452 /* SIMPLE events: draft-ietf-simple-event-list-07.txt */
453 { SIP_OPT_EVENTLIST, NOT_SUPPORTED, "eventlist" },
454 /* GRUU: Globally Routable User Agent URI's */
455 { SIP_OPT_GRUU, NOT_SUPPORTED, "gruu" },
456 /* Target-dialog: draft-ietf-sip-target-dialog-03.txt */
457 { SIP_OPT_TARGET_DIALOG,NOT_SUPPORTED, "tdialog" },
458 /* Disable the REFER subscription, RFC 4488 */
459 { SIP_OPT_NOREFERSUB, NOT_SUPPORTED, "norefersub" },
460 /* ietf-sip-history-info-06.txt */
461 { SIP_OPT_HISTINFO, NOT_SUPPORTED, "histinfo" },
462 /* ietf-sip-resource-priority-10.txt */
463 { SIP_OPT_RESPRIORITY, NOT_SUPPORTED, "resource-priority" },
467 /*! \brief SIP Methods we support */
468 #define ALLOWED_METHODS "INVITE, ACK, CANCEL, OPTIONS, BYE, REFER, SUBSCRIBE, NOTIFY"
470 /*! \brief SIP Extensions we support */
471 #define SUPPORTED_EXTENSIONS "replaces"
473 /*! \brief Standard SIP port from RFC 3261. DO NOT CHANGE THIS */
474 #define STANDARD_SIP_PORT 5060
475 /* Note: in many SIP headers, absence of a port number implies port 5060,
476 * and this is why we cannot change the above constant.
477 * There is a limited number of places in asterisk where we could,
478 * in principle, use a different "default" port number, but
479 * we do not support this feature at the moment.
482 /* Default values, set and reset in reload_config before reading configuration */
483 /* These are default values in the source. There are other recommended values in the
484 sip.conf.sample for new installations. These may differ to keep backwards compatibility,
485 yet encouraging new behaviour on new installations
487 #define DEFAULT_CONTEXT "default"
488 #define DEFAULT_MOHINTERPRET "default"
489 #define DEFAULT_MOHSUGGEST ""
490 #define DEFAULT_VMEXTEN "asterisk"
491 #define DEFAULT_CALLERID "asterisk"
492 #define DEFAULT_NOTIFYMIME "application/simple-message-summary"
493 #define DEFAULT_MWITIME 10
494 #define DEFAULT_ALLOWGUEST TRUE
495 #define DEFAULT_SRVLOOKUP FALSE /*!< Recommended setting is ON */
496 #define DEFAULT_COMPACTHEADERS FALSE
497 #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. */
498 #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. */
499 #define DEFAULT_TOS_VIDEO 0 /*!< Video packets should be marked as DSCP AF41, but the default is 0 to be compatible with previous versions. */
500 #define DEFAULT_ALLOW_EXT_DOM TRUE
501 #define DEFAULT_REALM "asterisk"
502 #define DEFAULT_NOTIFYRINGING TRUE
503 #define DEFAULT_PEDANTIC FALSE
504 #define DEFAULT_AUTOCREATEPEER FALSE
505 #define DEFAULT_QUALIFY FALSE
506 #define DEFAULT_T1MIN 100 /*!< 100 MS for minimal roundtrip time */
507 #define DEFAULT_MAX_CALL_BITRATE (384) /*!< Max bitrate for video */
508 #ifndef DEFAULT_USERAGENT
509 #define DEFAULT_USERAGENT "Asterisk PBX" /*!< Default Useragent: header unless re-defined in sip.conf */
513 /* Default setttings are used as a channel setting and as a default when
514 configuring devices */
515 static char default_context[AST_MAX_CONTEXT];
516 static char default_subscribecontext[AST_MAX_CONTEXT];
517 static char default_language[MAX_LANGUAGE];
518 static char default_callerid[AST_MAX_EXTENSION];
519 static char default_fromdomain[AST_MAX_EXTENSION];
520 static char default_notifymime[AST_MAX_EXTENSION];
521 static int default_qualify; /*!< Default Qualify= setting */
522 static char default_vmexten[AST_MAX_EXTENSION];
523 static char default_mohinterpret[MAX_MUSICCLASS]; /*!< Global setting for moh class to use when put on hold */
524 static char default_mohsuggest[MAX_MUSICCLASS]; /*!< Global setting for moh class to suggest when putting
525 * a bridged channel on hold */
526 static int default_maxcallbitrate; /*!< Maximum bitrate for call */
527 static struct ast_codec_pref default_prefs; /*!< Default codec prefs */
529 /* Global settings only apply to the channel */
530 static int global_limitonpeers; /*!< Match call limit on peers only */
531 static int global_rtautoclear;
532 static int global_notifyringing; /*!< Send notifications on ringing */
533 static int global_notifyhold; /*!< Send notifications on hold */
534 static int global_alwaysauthreject; /*!< Send 401 Unauthorized for all failing requests */
535 static int global_srvlookup; /*!< SRV Lookup on or off. Default is off, RFC behavior is on */
536 static int pedanticsipchecking; /*!< Extra checking ? Default off */
537 static int autocreatepeer; /*!< Auto creation of peers at registration? Default off. */
538 static int global_match_auth_username; /*!< Match auth username if available instead of From: Default off. */
539 static int global_relaxdtmf; /*!< Relax DTMF */
540 static int global_rtptimeout; /*!< Time out call if no RTP */
541 static int global_rtpholdtimeout;
542 static int global_rtpkeepalive; /*!< Send RTP keepalives */
543 static int global_reg_timeout;
544 static int global_regattempts_max; /*!< Registration attempts before giving up */
545 static int global_allowguest; /*!< allow unauthenticated users/peers to connect? */
546 static int global_allowsubscribe; /*!< Flag for disabling ALL subscriptions, this is FALSE only if all peers are FALSE
547 the global setting is in globals_flags[1] */
548 static int global_mwitime; /*!< Time between MWI checks for peers */
549 static unsigned int global_tos_sip; /*!< IP type of service for SIP packets */
550 static unsigned int global_tos_audio; /*!< IP type of service for audio RTP packets */
551 static unsigned int global_tos_video; /*!< IP type of service for video RTP packets */
552 static int compactheaders; /*!< send compact sip headers */
553 static int recordhistory; /*!< Record SIP history. Off by default */
554 static int dumphistory; /*!< Dump history to verbose before destroying SIP dialog */
555 static char global_realm[MAXHOSTNAMELEN]; /*!< Default realm */
556 static char global_regcontext[AST_MAX_CONTEXT]; /*!< Context for auto-extensions */
557 static char global_useragent[AST_MAX_EXTENSION]; /*!< Useragent for the SIP channel */
558 static int allow_external_domains; /*!< Accept calls to external SIP domains? */
559 static int global_callevents; /*!< Whether we send manager events or not */
560 static int global_t1min; /*!< T1 roundtrip time minimum */
561 static int global_autoframing; /*!< Turn autoframing on or off. */
562 static enum transfermodes global_allowtransfer; /*!< SIP Refer restriction scheme */
564 /*! \brief Codecs that we support by default: */
565 static int global_capability = AST_FORMAT_ULAW | AST_FORMAT_ALAW | AST_FORMAT_GSM | AST_FORMAT_H263;
566 static int noncodeccapability = AST_RTP_DTMF;
568 /* Object counters */
569 static int suserobjs = 0; /*!< Static users */
570 static int ruserobjs = 0; /*!< Realtime users */
571 static int speerobjs = 0; /*!< Statis peers */
572 static int rpeerobjs = 0; /*!< Realtime peers */
573 static int apeerobjs = 0; /*!< Autocreated peer objects */
574 static int regobjs = 0; /*!< Registry objects */
576 static struct ast_flags global_flags[2] = {{0}}; /*!< global SIP_ flags */
578 AST_MUTEX_DEFINE_STATIC(netlock);
580 /*! \brief Protect the monitoring thread, so only one process can kill or start it, and not
581 when it's doing something critical. */
583 AST_MUTEX_DEFINE_STATIC(monlock);
585 AST_MUTEX_DEFINE_STATIC(sip_reload_lock);
587 /*! \brief This is the thread for the monitor which checks for input on the channels
588 which are not currently in use. */
589 static pthread_t monitor_thread = AST_PTHREADT_NULL;
591 static int sip_reloading = FALSE; /*!< Flag for avoiding multiple reloads at the same time */
592 static enum channelreloadreason sip_reloadreason; /*!< Reason for last reload/load of configuration */
594 static struct sched_context *sched; /*!< The scheduling context */
595 static struct io_context *io; /*!< The IO context */
596 static int *sipsock_read_id; /*!< ID of IO entry for sipsock FD */
598 #define DEC_CALL_LIMIT 0
599 #define INC_CALL_LIMIT 1
600 #define DEC_CALL_RINGING 2
601 #define INC_CALL_RINGING 3
603 /*! \brief sip_request: The data grabbed from the UDP socket */
605 char *rlPart1; /*!< SIP Method Name or "SIP/2.0" protocol version */
606 char *rlPart2; /*!< The Request URI or Response Status */
607 int len; /*!< Length */
608 int headers; /*!< # of SIP Headers */
609 int method; /*!< Method of this request */
610 int lines; /*!< Body Content */
611 unsigned int flags; /*!< SIP_PKT Flags for this packet */
612 char *header[SIP_MAX_HEADERS];
613 char *line[SIP_MAX_LINES];
614 char data[SIP_MAX_PACKET];
615 unsigned int sdp_start; /*!< the line number where the SDP begins */
616 unsigned int sdp_end; /*!< the line number where the SDP ends */
620 * A sip packet is stored into the data[] buffer, with the header followed
621 * by an empty line and the body of the message.
622 * On outgoing packets, data is accumulated in data[] with len reflecting
623 * the next available byte, headers and lines count the number of lines
624 * in both parts. There are no '\0' in data[0..len-1].
626 * On received packet, the input read from the socket is copied into data[],
627 * len is set and the string is NUL-terminated. Then a parser fills up
628 * the other fields -header[] and line[] to point to the lines of the
629 * message, rlPart1 and rlPart2 parse the first lnie as below:
631 * Requests have in the first line METHOD URI SIP/2.0
632 * rlPart1 = method; rlPart2 = uri;
633 * Responses have in the first line SIP/2.0 code description
634 * rlPart1 = SIP/2.0; rlPart2 = code + description;
638 /*! \brief structure used in transfers */
640 struct ast_channel *chan1; /*!< First channel involved */
641 struct ast_channel *chan2; /*!< Second channel involved */
642 struct sip_request req; /*!< Request that caused the transfer (REFER) */
643 int seqno; /*!< Sequence number */
648 /*! \brief Parameters to the transmit_invite function */
649 struct sip_invite_param {
650 int addsipheaders; /*!< Add extra SIP headers */
651 const char *uri_options; /*!< URI options to add to the URI */
652 const char *vxml_url; /*!< VXML url for Cisco phones */
653 char *auth; /*!< Authentication */
654 char *authheader; /*!< Auth header */
655 enum sip_auth_type auth_type; /*!< Authentication type */
656 const char *replaces; /*!< Replaces header for call transfers */
657 int transfer; /*!< Flag - is this Invite part of a SIP transfer? (invite/replaces) */
660 /*! \brief Structure to save routing information for a SIP session */
662 struct sip_route *next;
666 /*! \brief Modes for SIP domain handling in the PBX */
668 SIP_DOMAIN_AUTO, /*!< This domain is auto-configured */
669 SIP_DOMAIN_CONFIG, /*!< This domain is from configuration */
672 /*! \brief Domain data structure.
673 \note In the future, we will connect this to a configuration tree specific
677 char domain[MAXHOSTNAMELEN]; /*!< SIP domain we are responsible for */
678 char context[AST_MAX_EXTENSION]; /*!< Incoming context for this domain */
679 enum domain_mode mode; /*!< How did we find this domain? */
680 AST_LIST_ENTRY(domain) list; /*!< List mechanics */
683 static AST_LIST_HEAD_STATIC(domain_list, domain); /*!< The SIP domain list */
686 /*! \brief sip_history: Structure for saving transactions within a SIP dialog */
688 AST_LIST_ENTRY(sip_history) list;
689 char event[0]; /* actually more, depending on needs */
692 AST_LIST_HEAD_NOLOCK(sip_history_head, sip_history); /*!< history list, entry in sip_pvt */
694 /*! \brief sip_auth: Credentials for authentication to other SIP services */
696 char realm[AST_MAX_EXTENSION]; /*!< Realm in which these credentials are valid */
697 char username[256]; /*!< Username */
698 char secret[256]; /*!< Secret */
699 char md5secret[256]; /*!< MD5Secret */
700 struct sip_auth *next; /*!< Next auth structure in list */
703 /*--- Various flags for the flags field in the pvt structure */
704 #define SIP_ALREADYGONE (1 << 0) /*!< Whether or not we've already been destroyed by our peer */
705 #define SIP_NEEDDESTROY (1 << 1) /*!< if we need to be destroyed by the monitor thread */
706 #define SIP_NOVIDEO (1 << 2) /*!< Didn't get video in invite, don't offer */
707 #define SIP_RINGING (1 << 3) /*!< Have sent 180 ringing */
708 #define SIP_PROGRESS_SENT (1 << 4) /*!< Have sent 183 message progress */
709 #define SIP_NEEDREINVITE (1 << 5) /*!< Do we need to send another reinvite? */
710 #define SIP_PENDINGBYE (1 << 6) /*!< Need to send bye after we ack? */
711 #define SIP_GOTREFER (1 << 7) /*!< Got a refer? */
712 #define SIP_PROMISCREDIR (1 << 8) /*!< Promiscuous redirection */
713 #define SIP_TRUSTRPID (1 << 9) /*!< Trust RPID headers? */
714 #define SIP_USEREQPHONE (1 << 10) /*!< Add user=phone to numeric URI. Default off */
715 #define SIP_REALTIME (1 << 11) /*!< Flag for realtime users */
716 #define SIP_USECLIENTCODE (1 << 12) /*!< Trust X-ClientCode info message */
717 #define SIP_OUTGOING (1 << 13) /*!< Direction of the last transaction in this dialog */
718 #define SIP_FREE_BIT (1 << 14) /*!< ---- */
719 #define SIP_DEFER_BYE_ON_TRANSFER (1 << 15) /*!< Do not hangup at first ast_hangup */
720 #define SIP_DTMF (3 << 16) /*!< DTMF Support: four settings, uses two bits */
721 #define SIP_DTMF_RFC2833 (0 << 16) /*!< DTMF Support: RTP DTMF - "rfc2833" */
722 #define SIP_DTMF_INBAND (1 << 16) /*!< DTMF Support: Inband audio, only for ULAW/ALAW - "inband" */
723 #define SIP_DTMF_INFO (2 << 16) /*!< DTMF Support: SIP Info messages - "info" */
724 #define SIP_DTMF_AUTO (3 << 16) /*!< DTMF Support: AUTO switch between rfc2833 and in-band DTMF */
726 #define SIP_NAT (3 << 18) /*!< four settings, uses two bits */
727 #define SIP_NAT_NEVER (0 << 18) /*!< No nat support */
728 #define SIP_NAT_RFC3581 (1 << 18) /*!< NAT RFC3581 */
729 #define SIP_NAT_ROUTE (2 << 18) /*!< NAT Only ROUTE */
730 #define SIP_NAT_ALWAYS (3 << 18) /*!< NAT Both ROUTE and RFC3581 */
731 /* re-INVITE related settings */
732 #define SIP_REINVITE (7 << 20) /*!< three bits used */
733 #define SIP_CAN_REINVITE (1 << 20) /*!< allow peers to be reinvited to send media directly p2p */
734 #define SIP_CAN_REINVITE_NAT (2 << 20) /*!< allow media reinvite when new peer is behind NAT */
735 #define SIP_REINVITE_UPDATE (4 << 20) /*!< use UPDATE (RFC3311) when reinviting this peer */
736 /* "insecure" settings */
737 #define SIP_INSECURE_PORT (1 << 23) /*!< don't require matching port for incoming requests */
738 #define SIP_INSECURE_INVITE (1 << 24) /*!< don't require authentication for incoming INVITEs */
739 /* Sending PROGRESS in-band settings */
740 #define SIP_PROG_INBAND (3 << 25) /*!< three settings, uses two bits */
741 #define SIP_PROG_INBAND_NEVER (0 << 25)
742 #define SIP_PROG_INBAND_NO (1 << 25)
743 #define SIP_PROG_INBAND_YES (2 << 25)
744 #define SIP_NO_HISTORY (1 << 27) /*!< Suppress recording request/response history */
745 #define SIP_CALL_LIMIT (1 << 28) /*!< Call limit enforced for this call */
746 #define SIP_SENDRPID (1 << 29) /*!< Remote Party-ID Support */
747 #define SIP_INC_COUNT (1 << 30) /*!< Did this connection increment the counter of in-use calls? */
748 #define SIP_G726_NONSTANDARD (1 << 31) /*!< Use non-standard packing for G726-32 data */
750 #define SIP_FLAGS_TO_COPY \
751 (SIP_PROMISCREDIR | SIP_TRUSTRPID | SIP_SENDRPID | SIP_DTMF | SIP_REINVITE | \
752 SIP_PROG_INBAND | SIP_USECLIENTCODE | SIP_NAT | SIP_G726_NONSTANDARD | \
753 SIP_USEREQPHONE | SIP_INSECURE_PORT | SIP_INSECURE_INVITE)
755 /*--- a new page of flags (for flags[1] */
757 #define SIP_PAGE2_RTCACHEFRIENDS (1 << 0)
758 #define SIP_PAGE2_RTUPDATE (1 << 1)
759 #define SIP_PAGE2_RTAUTOCLEAR (1 << 2)
760 #define SIP_PAGE2_RT_FROMCONTACT (1 << 4)
761 #define SIP_PAGE2_RTSAVE_SYSNAME (1 << 5)
762 /* Space for addition of other realtime flags in the future */
763 #define SIP_PAGE2_IGNOREREGEXPIRE (1 << 10)
764 #define SIP_PAGE2_DEBUG (3 << 11)
765 #define SIP_PAGE2_DEBUG_CONFIG (1 << 11)
766 #define SIP_PAGE2_DEBUG_CONSOLE (1 << 12)
767 #define SIP_PAGE2_DYNAMIC (1 << 13) /*!< Dynamic Peers register with Asterisk */
768 #define SIP_PAGE2_SELFDESTRUCT (1 << 14) /*!< Automatic peers need to destruct themselves */
769 #define SIP_PAGE2_VIDEOSUPPORT (1 << 15)
770 #define SIP_PAGE2_ALLOWSUBSCRIBE (1 << 16) /*!< Allow subscriptions from this peer? */
771 #define SIP_PAGE2_ALLOWOVERLAP (1 << 17) /*!< Allow overlap dialing ? */
772 #define SIP_PAGE2_SUBSCRIBEMWIONLY (1 << 18) /*!< Only issue MWI notification if subscribed to */
773 #define SIP_PAGE2_INC_RINGING (1 << 19) /*!< Did this connection increment the counter of in-use calls? */
774 #define SIP_PAGE2_T38SUPPORT (7 << 20) /*!< T38 Fax Passthrough Support */
775 #define SIP_PAGE2_T38SUPPORT_UDPTL (1 << 20) /*!< 20: T38 Fax Passthrough Support */
776 #define SIP_PAGE2_T38SUPPORT_RTP (2 << 20) /*!< 21: T38 Fax Passthrough Support (not implemented) */
777 #define SIP_PAGE2_T38SUPPORT_TCP (4 << 20) /*!< 22: T38 Fax Passthrough Support (not implemented) */
778 #define SIP_PAGE2_CALL_ONHOLD (3 << 23) /*!< Call states */
779 #define SIP_PAGE2_CALL_ONHOLD_ONEDIR (1 << 23) /*!< 23: One directional hold */
780 #define SIP_PAGE2_CALL_ONHOLD_INACTIVE (1 << 24) /*!< 24: Inactive */
781 #define SIP_PAGE2_RFC2833_COMPENSATE (1 << 25)
783 #define SIP_PAGE2_FLAGS_TO_COPY \
784 (SIP_PAGE2_ALLOWSUBSCRIBE | SIP_PAGE2_ALLOWOVERLAP | SIP_PAGE2_VIDEOSUPPORT | SIP_PAGE2_T38SUPPORT | SIP_PAGE2_RFC2833_COMPENSATE)
786 /* SIP packet flags */
787 #define SIP_PKT_DEBUG (1 << 0) /*!< Debug this packet */
788 #define SIP_PKT_WITH_TOTAG (1 << 1) /*!< This packet has a to-tag */
789 #define SIP_PKT_IGNORE (1 << 2) /*!< This is a re-transmit, ignore it */
791 /* T.38 set of flags */
792 #define T38FAX_FILL_BIT_REMOVAL (1 << 0) /*!< Default: 0 (unset)*/
793 #define T38FAX_TRANSCODING_MMR (1 << 1) /*!< Default: 0 (unset)*/
794 #define T38FAX_TRANSCODING_JBIG (1 << 2) /*!< Default: 0 (unset)*/
795 /* Rate management */
796 #define T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF (0 << 3)
797 #define T38FAX_RATE_MANAGEMENT_LOCAL_TCF (1 << 3) /*!< Unset for transferredTCF (UDPTL), set for localTCF (TPKT) */
798 /* UDP Error correction */
799 #define T38FAX_UDP_EC_NONE (0 << 4) /*!< two bits, if unset NO t38UDPEC field in T38 SDP*/
800 #define T38FAX_UDP_EC_FEC (1 << 4) /*!< Set for t38UDPFEC */
801 #define T38FAX_UDP_EC_REDUNDANCY (2 << 4) /*!< Set for t38UDPRedundancy */
802 /* T38 Spec version */
803 #define T38FAX_VERSION (3 << 6) /*!< two bits, 2 values so far, up to 4 values max */
804 #define T38FAX_VERSION_0 (0 << 6) /*!< Version 0 */
805 #define T38FAX_VERSION_1 (1 << 6) /*!< Version 1 */
806 /* Maximum Fax Rate */
807 #define T38FAX_RATE_2400 (1 << 8) /*!< 2400 bps t38FaxRate */
808 #define T38FAX_RATE_4800 (1 << 9) /*!< 4800 bps t38FaxRate */
809 #define T38FAX_RATE_7200 (1 << 10) /*!< 7200 bps t38FaxRate */
810 #define T38FAX_RATE_9600 (1 << 11) /*!< 9600 bps t38FaxRate */
811 #define T38FAX_RATE_12000 (1 << 12) /*!< 12000 bps t38FaxRate */
812 #define T38FAX_RATE_14400 (1 << 13) /*!< 14400 bps t38FaxRate */
814 /*!< This is default: NO MMR and JBIG trancoding, NO fill bit removal, transferredTCF TCF, UDP FEC, Version 0 and 9600 max fax rate */
815 static int global_t38_capability = T38FAX_VERSION_0 | T38FAX_RATE_2400 | T38FAX_RATE_4800 | T38FAX_RATE_7200 | T38FAX_RATE_9600;
817 #define sipdebug ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG)
818 #define sipdebug_config ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONFIG)
819 #define sipdebug_console ast_test_flag(&global_flags[1], SIP_PAGE2_DEBUG_CONSOLE)
821 /*! \brief T38 States for a call */
823 T38_DISABLED = 0, /*!< Not enabled */
824 T38_LOCAL_DIRECT, /*!< Offered from local */
825 T38_LOCAL_REINVITE, /*!< Offered from local - REINVITE */
826 T38_PEER_DIRECT, /*!< Offered from peer */
827 T38_PEER_REINVITE, /*!< Offered from peer - REINVITE */
828 T38_ENABLED /*!< Negotiated (enabled) */
831 /*! \brief T.38 channel settings (at some point we need to make this alloc'ed */
832 struct t38properties {
833 struct ast_flags t38support; /*!< Flag for udptl, rtp or tcp support for this session */
834 int capability; /*!< Our T38 capability */
835 int peercapability; /*!< Peers T38 capability */
836 int jointcapability; /*!< Supported T38 capability at both ends */
837 enum t38state state; /*!< T.38 state */
840 /*! \brief Parameters to know status of transfer */
842 REFER_IDLE, /*!< No REFER is in progress */
843 REFER_SENT, /*!< Sent REFER to transferee */
844 REFER_RECEIVED, /*!< Received REFER from transferer */
845 REFER_CONFIRMED, /*!< Refer confirmed with a 100 TRYING */
846 REFER_ACCEPTED, /*!< Accepted by transferee */
847 REFER_RINGING, /*!< Target Ringing */
848 REFER_200OK, /*!< Answered by transfer target */
849 REFER_FAILED, /*!< REFER declined - go on */
850 REFER_NOAUTH /*!< We had no auth for REFER */
853 static const struct c_referstatusstring {
854 enum referstatus status;
856 } referstatusstrings[] = {
857 { REFER_IDLE, "<none>" },
858 { REFER_SENT, "Request sent" },
859 { REFER_RECEIVED, "Request received" },
860 { REFER_ACCEPTED, "Accepted" },
861 { REFER_RINGING, "Target ringing" },
862 { REFER_200OK, "Done" },
863 { REFER_FAILED, "Failed" },
864 { REFER_NOAUTH, "Failed - auth failure" }
867 /*! \brief Structure to handle SIP transfers. Dynamically allocated when needed */
868 /* OEJ: Should be moved to string fields */
870 char refer_to[AST_MAX_EXTENSION]; /*!< Place to store REFER-TO extension */
871 char refer_to_domain[AST_MAX_EXTENSION]; /*!< Place to store REFER-TO domain */
872 char refer_to_urioption[AST_MAX_EXTENSION]; /*!< Place to store REFER-TO uri options */
873 char refer_to_context[AST_MAX_EXTENSION]; /*!< Place to store REFER-TO context */
874 char referred_by[AST_MAX_EXTENSION]; /*!< Place to store REFERRED-BY extension */
875 char referred_by_name[AST_MAX_EXTENSION]; /*!< Place to store REFERRED-BY extension */
876 char refer_contact[AST_MAX_EXTENSION]; /*!< Place to store Contact info from a REFER extension */
877 char replaces_callid[BUFSIZ]; /*!< Replace info: callid */
878 char replaces_callid_totag[BUFSIZ/2]; /*!< Replace info: to-tag */
879 char replaces_callid_fromtag[BUFSIZ/2]; /*!< Replace info: from-tag */
880 struct sip_pvt *refer_call; /*!< Call we are referring */
881 int attendedtransfer; /*!< Attended or blind transfer? */
882 int localtransfer; /*!< Transfer to local domain? */
883 enum referstatus status; /*!< REFER status */
886 /*! \brief sip_pvt: PVT structures are used for each SIP dialog, ie. a call, a registration, a subscribe */
888 ast_mutex_t pvt_lock; /*!< Dialog private lock */
889 enum invitestates invitestate; /*!< Track state of SIP_INVITEs */
890 int method; /*!< SIP method that opened this dialog */
891 AST_DECLARE_STRING_FIELDS(
892 AST_STRING_FIELD(callid); /*!< Global CallID */
893 AST_STRING_FIELD(randdata); /*!< Random data */
894 AST_STRING_FIELD(accountcode); /*!< Account code */
895 AST_STRING_FIELD(realm); /*!< Authorization realm */
896 AST_STRING_FIELD(nonce); /*!< Authorization nonce */
897 AST_STRING_FIELD(opaque); /*!< Opaque nonsense */
898 AST_STRING_FIELD(qop); /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
899 AST_STRING_FIELD(domain); /*!< Authorization domain */
900 AST_STRING_FIELD(from); /*!< The From: header */
901 AST_STRING_FIELD(useragent); /*!< User agent in SIP request */
902 AST_STRING_FIELD(exten); /*!< Extension where to start */
903 AST_STRING_FIELD(context); /*!< Context for this call */
904 AST_STRING_FIELD(subscribecontext); /*!< Subscribecontext */
905 AST_STRING_FIELD(subscribeuri); /*!< Subscribecontext */
906 AST_STRING_FIELD(fromdomain); /*!< Domain to show in the from field */
907 AST_STRING_FIELD(fromuser); /*!< User to show in the user field */
908 AST_STRING_FIELD(fromname); /*!< Name to show in the user field */
909 AST_STRING_FIELD(tohost); /*!< Host we should put in the "to" field */
910 AST_STRING_FIELD(language); /*!< Default language for this call */
911 AST_STRING_FIELD(mohinterpret); /*!< MOH class to use when put on hold */
912 AST_STRING_FIELD(mohsuggest); /*!< MOH class to suggest when putting a peer on hold */
913 AST_STRING_FIELD(rdnis); /*!< Referring DNIS */
914 AST_STRING_FIELD(redircause); /*!< Referring cause */
915 AST_STRING_FIELD(theirtag); /*!< Their tag */
916 AST_STRING_FIELD(username); /*!< [user] name */
917 AST_STRING_FIELD(peername); /*!< [peer] name, not set if [user] */
918 AST_STRING_FIELD(authname); /*!< Who we use for authentication */
919 AST_STRING_FIELD(uri); /*!< Original requested URI */
920 AST_STRING_FIELD(okcontacturi); /*!< URI from the 200 OK on INVITE */
921 AST_STRING_FIELD(peersecret); /*!< Password */
922 AST_STRING_FIELD(peermd5secret);
923 AST_STRING_FIELD(cid_num); /*!< Caller*ID number */
924 AST_STRING_FIELD(cid_name); /*!< Caller*ID name */
925 AST_STRING_FIELD(via); /*!< Via: header */
926 AST_STRING_FIELD(fullcontact); /*!< The Contact: that the UA registers with us */
927 /* we only store the part in <brackets> in this field. */
928 AST_STRING_FIELD(our_contact); /*!< Our contact header */
929 AST_STRING_FIELD(rpid); /*!< Our RPID header */
930 AST_STRING_FIELD(rpid_from); /*!< Our RPID From header */
932 unsigned int ocseq; /*!< Current outgoing seqno */
933 unsigned int icseq; /*!< Current incoming seqno */
934 ast_group_t callgroup; /*!< Call group */
935 ast_group_t pickupgroup; /*!< Pickup group */
936 int lastinvite; /*!< Last Cseq of invite */
937 struct ast_flags flags[2]; /*!< SIP_ flags */
938 int timer_t1; /*!< SIP timer T1, ms rtt */
939 unsigned int sipoptions; /*!< Supported SIP options on the other end */
940 struct ast_codec_pref prefs; /*!< codec prefs */
941 int capability; /*!< Special capability (codec) */
942 int jointcapability; /*!< Supported capability at both ends (codecs) */
943 int peercapability; /*!< Supported peer capability */
944 int prefcodec; /*!< Preferred codec (outbound only) */
945 int noncodeccapability; /*!< DTMF RFC2833 telephony-event */
946 int redircodecs; /*!< Redirect codecs */
947 int maxcallbitrate; /*!< Maximum Call Bitrate for Video Calls */
948 struct t38properties t38; /*!< T38 settings */
949 struct sockaddr_in udptlredirip; /*!< Where our T.38 UDPTL should be going if not to us */
950 struct ast_udptl *udptl; /*!< T.38 UDPTL session */
951 int callingpres; /*!< Calling presentation */
952 int authtries; /*!< Times we've tried to authenticate */
953 int expiry; /*!< How long we take to expire */
954 long branch; /*!< The branch identifier of this session */
955 char tag[11]; /*!< Our tag for this session */
956 int sessionid; /*!< SDP Session ID */
957 int sessionversion; /*!< SDP Session Version */
958 struct sockaddr_in sa; /*!< Our peer */
959 struct sockaddr_in redirip; /*!< Where our RTP should be going if not to us */
960 struct sockaddr_in vredirip; /*!< Where our Video RTP should be going if not to us */
961 time_t lastrtprx; /*!< Last RTP received */
962 time_t lastrtptx; /*!< Last RTP sent */
963 int rtptimeout; /*!< RTP timeout time */
964 int rtpholdtimeout; /*!< RTP timeout when on hold */
965 int rtpkeepalive; /*!< Send RTP packets for keepalive */
966 struct sockaddr_in recv; /*!< Received as */
967 struct in_addr ourip; /*!< Our IP */
968 struct ast_channel *owner; /*!< Who owns us (if we have an owner) */
969 struct sip_route *route; /*!< Head of linked list of routing steps (fm Record-Route) */
970 int route_persistant; /*!< Is this the "real" route? */
971 struct sip_auth *peerauth; /*!< Realm authentication */
972 int noncecount; /*!< Nonce-count */
973 char lastmsg[256]; /*!< Last Message sent/received */
974 int amaflags; /*!< AMA Flags */
975 int pendinginvite; /*!< Any pending invite ? (seqno of this) */
976 struct sip_request initreq; /*!< Latest request that opened a new transaction
978 NOT the request that opened the dialog
981 int initid; /*!< Auto-congest ID if appropriate (scheduler) */
982 int autokillid; /*!< Auto-kill ID (scheduler) */
983 enum transfermodes allowtransfer; /*!< REFER: restriction scheme */
984 struct sip_refer *refer; /*!< REFER: SIP transfer data structure */
985 enum subscriptiontype subscribed; /*!< SUBSCRIBE: Is this dialog a subscription? */
986 int stateid; /*!< SUBSCRIBE: ID for devicestate subscriptions */
987 int laststate; /*!< SUBSCRIBE: Last known extension state */
988 int dialogver; /*!< SUBSCRIBE: Version for subscription dialog-info */
990 struct ast_dsp *vad; /*!< Inband DTMF Detection dsp */
992 struct sip_peer *relatedpeer; /*!< If this dialog is related to a peer, which one
993 Used in peerpoke, mwi subscriptions */
994 struct sip_registry *registry; /*!< If this is a REGISTER dialog, to which registry */
995 struct ast_rtp *rtp; /*!< RTP Session */
996 struct ast_rtp *vrtp; /*!< Video RTP session */
997 struct sip_pkt *packets; /*!< Packets scheduled for re-transmission */
998 struct sip_history_head *history; /*!< History of this SIP dialog */
999 struct ast_variable *chanvars; /*!< Channel variables to set for inbound call */
1000 struct sip_pvt *next; /*!< Next dialog in chain */
1001 struct sip_invite_param *options; /*!< Options for INVITE */
1002 int autoframing; /*!< The number of Asters we group in a Pyroflax
1003 before strolling to the Grokyzpå
1004 (A bit unsure of this, please correct if
1008 static struct sip_pvt *dialoglist = NULL;
1010 /*! \brief Protect the SIP dialog list (of sip_pvt's) */
1011 AST_MUTEX_DEFINE_STATIC(dialoglock);
1013 /*! \brief hide the way the list is locked/unlocked */
1014 static void dialoglist_lock(void)
1016 ast_mutex_lock(&dialoglock);
1019 static void dialoglist_unlock(void)
1021 ast_mutex_unlock(&dialoglock);
1024 #define FLAG_RESPONSE (1 << 0)
1025 #define FLAG_FATAL (1 << 1)
1027 /*! \brief sip packet - raw format for outbound packets that are sent or scheduled for transmission */
1029 struct sip_pkt *next; /*!< Next packet in linked list */
1030 int retrans; /*!< Retransmission number */
1031 int method; /*!< SIP method for this packet */
1032 int seqno; /*!< Sequence number */
1033 unsigned int flags; /*!< non-zero if this is a response packet (e.g. 200 OK) */
1034 struct sip_pvt *owner; /*!< Owner AST call */
1035 int retransid; /*!< Retransmission ID */
1036 int timer_a; /*!< SIP timer A, retransmission timer */
1037 int timer_t1; /*!< SIP Timer T1, estimated RTT or 500 ms */
1038 int packetlen; /*!< Length of packet */
1042 /*! \brief Structure for SIP user data. User's place calls to us */
1044 /* Users who can access various contexts */
1045 ASTOBJ_COMPONENTS(struct sip_user);
1046 char secret[80]; /*!< Password */
1047 char md5secret[80]; /*!< Password in md5 */
1048 char context[AST_MAX_CONTEXT]; /*!< Default context for incoming calls */
1049 char subscribecontext[AST_MAX_CONTEXT]; /* Default context for subscriptions */
1050 char cid_num[80]; /*!< Caller ID num */
1051 char cid_name[80]; /*!< Caller ID name */
1052 char accountcode[AST_MAX_ACCOUNT_CODE]; /* Account code */
1053 char language[MAX_LANGUAGE]; /*!< Default language for this user */
1054 char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1055 char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1056 char useragent[256]; /*!< User agent in SIP request */
1057 struct ast_codec_pref prefs; /*!< codec prefs */
1058 ast_group_t callgroup; /*!< Call group */
1059 ast_group_t pickupgroup; /*!< Pickup Group */
1060 unsigned int sipoptions; /*!< Supported SIP options */
1061 struct ast_flags flags[2]; /*!< SIP_ flags */
1062 int amaflags; /*!< AMA flags for billing */
1063 int callingpres; /*!< Calling id presentation */
1064 int capability; /*!< Codec capability */
1065 int inUse; /*!< Number of calls in use */
1066 int call_limit; /*!< Limit of concurrent calls */
1067 enum transfermodes allowtransfer; /*! SIP Refer restriction scheme */
1068 struct ast_ha *ha; /*!< ACL setting */
1069 struct ast_variable *chanvars; /*!< Variables to set for channel created by user */
1070 int maxcallbitrate; /*!< Maximum Bitrate for a video call */
1074 /*! \brief Structure for SIP peer data, we place calls to peers if registered or fixed IP address (host) */
1075 /* XXX field 'name' must be first otherwise sip_addrcmp() will fail */
1077 ASTOBJ_COMPONENTS(struct sip_peer); /*!< name, refcount, objflags, object pointers */
1078 /*!< peer->name is the unique name of this object */
1079 char secret[80]; /*!< Password */
1080 char md5secret[80]; /*!< Password in MD5 */
1081 struct sip_auth *auth; /*!< Realm authentication list */
1082 char context[AST_MAX_CONTEXT]; /*!< Default context for incoming calls */
1083 char subscribecontext[AST_MAX_CONTEXT]; /*!< Default context for subscriptions */
1084 char username[80]; /*!< Temporary username until registration */
1085 char accountcode[AST_MAX_ACCOUNT_CODE]; /*!< Account code */
1086 int amaflags; /*!< AMA Flags (for billing) */
1087 char tohost[MAXHOSTNAMELEN]; /*!< If not dynamic, IP address */
1088 char regexten[AST_MAX_EXTENSION]; /*!< Extension to register (if regcontext is used) */
1089 char fromuser[80]; /*!< From: user when calling this peer */
1090 char fromdomain[MAXHOSTNAMELEN]; /*!< From: domain when calling this peer */
1091 char fullcontact[256]; /*!< Contact registered with us (not in sip.conf) */
1092 char cid_num[80]; /*!< Caller ID num */
1093 char cid_name[80]; /*!< Caller ID name */
1094 int callingpres; /*!< Calling id presentation */
1095 int inUse; /*!< Number of calls in use */
1096 int inRinging; /*!< Number of calls ringing */
1097 int onHold; /*!< Peer has someone on hold */
1098 int call_limit; /*!< Limit of concurrent calls */
1099 enum transfermodes allowtransfer; /*! SIP Refer restriction scheme */
1100 char vmexten[AST_MAX_EXTENSION]; /*!< Dialplan extension for MWI notify message*/
1101 char mailbox[AST_MAX_EXTENSION]; /*!< Mailbox setting for MWI checks */
1102 char language[MAX_LANGUAGE]; /*!< Default language for prompts */
1103 char mohinterpret[MAX_MUSICCLASS];/*!< Music on Hold class */
1104 char mohsuggest[MAX_MUSICCLASS];/*!< Music on Hold class */
1105 char useragent[256]; /*!< User agent in SIP request (saved from registration) */
1106 struct ast_codec_pref prefs; /*!< codec prefs */
1108 time_t lastmsgcheck; /*!< Last time we checked for MWI */
1109 unsigned int sipoptions; /*!< Supported SIP options */
1110 struct ast_flags flags[2]; /*!< SIP_ flags */
1111 int expire; /*!< When to expire this peer registration */
1112 int capability; /*!< Codec capability */
1113 int rtptimeout; /*!< RTP timeout */
1114 int rtpholdtimeout; /*!< RTP Hold Timeout */
1115 int rtpkeepalive; /*!< Send RTP packets for keepalive */
1116 ast_group_t callgroup; /*!< Call group */
1117 ast_group_t pickupgroup; /*!< Pickup group */
1118 struct ast_dnsmgr_entry *dnsmgr;/*!< DNS refresh manager for peer */
1119 struct sockaddr_in addr; /*!< IP address of peer */
1120 int maxcallbitrate; /*!< Maximum Bitrate for a video call */
1123 struct sip_pvt *call; /*!< Call pointer */
1124 int pokeexpire; /*!< When to expire poke (qualify= checking) */
1125 int lastms; /*!< How long last response took (in ms), or -1 for no response */
1126 int maxms; /*!< Max ms we will accept for the host to be up, 0 to not monitor */
1127 struct timeval ps; /*!< Time for sending SIP OPTION in sip_pke_peer() */
1128 struct sockaddr_in defaddr; /*!< Default IP address, used until registration */
1129 struct ast_ha *ha; /*!< Access control list */
1130 struct ast_variable *chanvars; /*!< Variables to set for channel created by user */
1131 struct sip_pvt *mwipvt; /*!< Subscription for MWI */
1138 /*! \brief Registrations with other SIP proxies */
1139 struct sip_registry {
1140 ASTOBJ_COMPONENTS_FULL(struct sip_registry,1,1);
1141 AST_DECLARE_STRING_FIELDS(
1142 AST_STRING_FIELD(callid); /*!< Global Call-ID */
1143 AST_STRING_FIELD(realm); /*!< Authorization realm */
1144 AST_STRING_FIELD(nonce); /*!< Authorization nonce */
1145 AST_STRING_FIELD(opaque); /*!< Opaque nonsense */
1146 AST_STRING_FIELD(qop); /*!< Quality of Protection, since SIP wasn't complicated enough yet. */
1147 AST_STRING_FIELD(domain); /*!< Authorization domain */
1148 AST_STRING_FIELD(username); /*!< Who we are registering as */
1149 AST_STRING_FIELD(authuser); /*!< Who we *authenticate* as */
1150 AST_STRING_FIELD(hostname); /*!< Domain or host we register to */
1151 AST_STRING_FIELD(secret); /*!< Password in clear text */
1152 AST_STRING_FIELD(md5secret); /*!< Password in md5 */
1153 AST_STRING_FIELD(callback); /*!< Contact extension */
1154 AST_STRING_FIELD(random);
1156 int portno; /*!< Optional port override */
1157 int expire; /*!< Sched ID of expiration */
1158 int expiry; /*!< Value to use for the Expires header */
1159 int regattempts; /*!< Number of attempts (since the last success) */
1160 int timeout; /*!< sched id of sip_reg_timeout */
1161 int refresh; /*!< How often to refresh */
1162 struct sip_pvt *call; /*!< create a sip_pvt structure for each outbound "registration dialog" in progress */
1163 enum sipregistrystate regstate; /*!< Registration state (see above) */
1164 time_t regtime; /*!< Last succesful registration time */
1165 int callid_valid; /*!< 0 means we haven't chosen callid for this registry yet. */
1166 unsigned int ocseq; /*!< Sequence number we got to for REGISTERs for this registry */
1167 struct sockaddr_in us; /*!< Who the server thinks we are */
1168 int noncecount; /*!< Nonce-count */
1169 char lastmsg[256]; /*!< Last Message sent/received */
1172 /* --- Linked lists of various objects --------*/
1174 /*! \brief The user list: Users and friends */
1175 static struct ast_user_list {
1176 ASTOBJ_CONTAINER_COMPONENTS(struct sip_user);
1179 /*! \brief The peer list: Peers and Friends */
1180 static struct ast_peer_list {
1181 ASTOBJ_CONTAINER_COMPONENTS(struct sip_peer);
1184 /*! \brief The register list: Other SIP proxys we register with and place calls to */
1185 static struct ast_register_list {
1186 ASTOBJ_CONTAINER_COMPONENTS(struct sip_registry);
1190 static int temp_pvt_init(void *);
1191 static void temp_pvt_cleanup(void *);
1193 /*! \brief A per-thread temporary pvt structure */
1194 AST_THREADSTORAGE_CUSTOM(ts_temp_pvt, temp_pvt_init, temp_pvt_cleanup);
1196 /*! \todo Move the sip_auth list to AST_LIST */
1197 static struct sip_auth *authl = NULL; /*!< Authentication list for realm authentication */
1200 /* --- Sockets and networking --------------*/
1201 static int sipsock = -1; /*!< Main socket for SIP network communication */
1202 static struct sockaddr_in bindaddr = { 0, }; /*!< The address we bind to */
1203 static struct sockaddr_in externip; /*!< External IP address if we are behind NAT */
1204 static char externhost[MAXHOSTNAMELEN]; /*!< External host name (possibly with dynamic DNS and DHCP */
1205 static time_t externexpire = 0; /*!< Expiration counter for re-resolving external host name in dynamic DNS */
1206 static int externrefresh = 10;
1207 static struct ast_ha *localaddr; /*!< List of local networks, on the same side of NAT as this Asterisk */
1208 static struct in_addr __ourip;
1209 static struct sockaddr_in outboundproxyip;
1211 static struct sockaddr_in debugaddr;
1213 static struct ast_config *notify_types; /*!< The list of manual NOTIFY types we know how to send */
1215 /*---------------------------- Forward declarations of functions in chan_sip.c */
1216 /*! \note This is added to help splitting up chan_sip.c into several files
1217 in coming releases */
1219 /*--- PBX interface functions */
1220 static struct ast_channel *sip_request_call(const char *type, int format, void *data, int *cause);
1221 static int sip_devicestate(void *data);
1222 static int sip_sendtext(struct ast_channel *ast, const char *text);
1223 static int sip_call(struct ast_channel *ast, char *dest, int timeout);
1224 static int sip_hangup(struct ast_channel *ast);
1225 static int sip_answer(struct ast_channel *ast);
1226 static struct ast_frame *sip_read(struct ast_channel *ast);
1227 static int sip_write(struct ast_channel *ast, struct ast_frame *frame);
1228 static int sip_indicate(struct ast_channel *ast, int condition, const void *data, size_t datalen);
1229 static int sip_transfer(struct ast_channel *ast, const char *dest);
1230 static int sip_fixup(struct ast_channel *oldchan, struct ast_channel *newchan);
1231 static int sip_senddigit_begin(struct ast_channel *ast, char digit);
1232 static int sip_senddigit_end(struct ast_channel *ast, char digit);
1234 /*--- Transmitting responses and requests */
1235 static int sipsock_read(int *id, int fd, short events, void *ignore);
1236 static int __sip_xmit(struct sip_pvt *p, char *data, int len);
1237 static int __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod);
1238 static int __transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1239 static int retrans_pkt(void *data);
1240 static int transmit_sip_request(struct sip_pvt *p, struct sip_request *req);
1241 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);
1242 static int transmit_response(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1243 static int transmit_response_reliable(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1244 static int transmit_response_with_date(struct sip_pvt *p, const char *msg, const struct sip_request *req);
1245 static int transmit_response_with_sdp(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1246 static int transmit_response_with_unsupported(struct sip_pvt *p, const char *msg, const struct sip_request *req, const char *unsupported);
1247 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);
1248 static int transmit_response_with_allow(struct sip_pvt *p, const char *msg, const struct sip_request *req, enum xmittype reliable);
1249 static void transmit_fake_auth_response(struct sip_pvt *p, struct sip_request *req, int reliable);
1250 static int transmit_request(struct sip_pvt *p, int sipmethod, int inc, enum xmittype reliable, int newbranch);
1251 static int transmit_request_with_auth(struct sip_pvt *p, int sipmethod, int seqno, enum xmittype reliable, int newbranch);
1252 static int transmit_invite(struct sip_pvt *p, int sipmethod, int sdp, int init);
1253 static int transmit_reinvite_with_sdp(struct sip_pvt *p, int t38version);
1254 static int transmit_info_with_digit(struct sip_pvt *p, const char digit);
1255 static int transmit_info_with_vidupdate(struct sip_pvt *p);
1256 static int transmit_message_with_text(struct sip_pvt *p, const char *text);
1257 static int transmit_refer(struct sip_pvt *p, const char *dest);
1258 static int transmit_notify_with_mwi(struct sip_pvt *p, int newmsgs, int oldmsgs, char *vmexten);
1259 static int transmit_notify_with_sipfrag(struct sip_pvt *p, int cseq, char *message, int terminate);
1260 static int transmit_register(struct sip_registry *r, int sipmethod, const char *auth, const char *authheader);
1261 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1262 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno);
1263 static void copy_request(struct sip_request *dst, const struct sip_request *src);
1264 static void receive_message(struct sip_pvt *p, struct sip_request *req);
1265 static void parse_moved_contact(struct sip_pvt *p, struct sip_request *req);
1266 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1267 static int does_peer_need_mwi(struct sip_peer *peer);
1269 /*--- Dialog management */
1270 static struct sip_pvt *sip_alloc(ast_string_field callid, struct sockaddr_in *sin,
1271 int useglobal_nat, const int intended_method);
1272 static int __sip_autodestruct(void *data);
1273 static void sip_scheddestroy(struct sip_pvt *p, int ms);
1274 static void sip_cancel_destroy(struct sip_pvt *p);
1275 static void sip_destroy(struct sip_pvt *p);
1276 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist);
1277 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1278 static void __sip_pretend_ack(struct sip_pvt *p);
1279 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod);
1280 static int auto_congest(void *nothing);
1281 static int update_call_counter(struct sip_pvt *fup, int event);
1282 static int hangup_sip2cause(int cause);
1283 static const char *hangup_cause2sip(int cause);
1284 static struct sip_pvt *find_call(struct sip_request *req, struct sockaddr_in *sin, const int intended_method);
1285 static void free_old_route(struct sip_route *route);
1286 static void list_route(struct sip_route *route);
1287 static void build_route(struct sip_pvt *p, struct sip_request *req, int backwards);
1288 static enum check_auth_result register_verify(struct sip_pvt *p, struct sockaddr_in *sin,
1289 struct sip_request *req, char *uri);
1290 static struct sip_pvt *get_sip_pvt_byid_locked(const char *callid, const char *totag, const char *fromtag);
1291 static void check_pendings(struct sip_pvt *p);
1292 static void *sip_park_thread(void *stuff);
1293 static int sip_park(struct ast_channel *chan1, struct ast_channel *chan2, struct sip_request *req, int seqno);
1294 static int sip_sipredirect(struct sip_pvt *p, const char *dest);
1296 /*--- Codec handling / SDP */
1297 static void try_suggested_sip_codec(struct sip_pvt *p);
1298 static const char* get_sdp_iterate(int* start, struct sip_request *req, const char *name);
1299 static const char *get_sdp(struct sip_request *req, const char *name);
1300 static int find_sdp(struct sip_request *req);
1301 static int process_sdp(struct sip_pvt *p, struct sip_request *req);
1302 static void add_codec_to_sdp(const struct sip_pvt *p, int codec, int sample_rate,
1303 char **m_buf, size_t *m_size, char **a_buf, size_t *a_size,
1304 int debug, int *min_packet_size);
1305 static void add_noncodec_to_sdp(const struct sip_pvt *p, int format, int sample_rate,
1306 char **m_buf, size_t *m_size, char **a_buf, size_t *a_size,
1308 static enum sip_result add_sdp(struct sip_request *resp, struct sip_pvt *p);
1309 static void do_setnat(struct sip_pvt *p, int natflags);
1311 /*--- Authentication stuff */
1312 static int reply_digest(struct sip_pvt *p, struct sip_request *req, char *header, int sipmethod, char *digest, int digest_len);
1313 static int build_reply_digest(struct sip_pvt *p, int method, char *digest, int digest_len);
1314 static enum check_auth_result check_auth(struct sip_pvt *p, struct sip_request *req, const char *username,
1315 const char *secret, const char *md5secret, int sipmethod,
1316 char *uri, enum xmittype reliable, int ignore);
1317 static enum check_auth_result check_user_full(struct sip_pvt *p, struct sip_request *req,
1318 int sipmethod, char *uri, enum xmittype reliable,
1319 struct sockaddr_in *sin, struct sip_peer **authpeer);
1320 static int check_user(struct sip_pvt *p, struct sip_request *req, int sipmethod, char *uri, enum xmittype reliable, struct sockaddr_in *sin);
1322 /*--- Domain handling */
1323 static int check_sip_domain(const char *domain, char *context, size_t len); /* Check if domain is one of our local domains */
1324 static int add_sip_domain(const char *domain, const enum domain_mode mode, const char *context);
1325 static void clear_sip_domains(void);
1327 /*--- SIP realm authentication */
1328 static struct sip_auth *add_realm_authentication(struct sip_auth *authlist, char *configuration, int lineno);
1329 static int clear_realm_authentication(struct sip_auth *authlist); /* Clear realm authentication list (at reload) */
1330 static struct sip_auth *find_realm_authentication(struct sip_auth *authlist, const char *realm);
1332 /*--- Misc functions */
1333 static int sip_do_reload(enum channelreloadreason reason);
1334 static int reload_config(enum channelreloadreason reason);
1335 static int expire_register(void *data);
1336 static void *do_monitor(void *data);
1337 static int restart_monitor(void);
1338 static int sip_send_mwi_to_peer(struct sip_peer *peer);
1339 static void sip_destroy(struct sip_pvt *p);
1340 static int sip_addrcmp(char *name, struct sockaddr_in *sin); /* Support for peer matching */
1341 static int sip_refer_allocate(struct sip_pvt *p);
1342 static void ast_quiet_chan(struct ast_channel *chan);
1343 static int attempt_transfer(struct sip_dual *transferer, struct sip_dual *target);
1345 /*--- Device monitoring and Device/extension state handling */
1346 static int cb_extensionstate(char *context, char* exten, int state, void *data);
1347 static int sip_devicestate(void *data);
1348 static int sip_poke_noanswer(void *data);
1349 static int sip_poke_peer(struct sip_peer *peer);
1350 static void sip_poke_all_peers(void);
1351 static void sip_peer_hold(struct sip_pvt *p, int hold);
1353 /*--- Applications, functions, CLI and manager command helpers */
1354 static const char *sip_nat_mode(const struct sip_pvt *p);
1355 static int sip_show_inuse(int fd, int argc, char *argv[]);
1356 static char *transfermode2str(enum transfermodes mode) attribute_const;
1357 static char *nat2str(int nat) attribute_const;
1358 static int peer_status(struct sip_peer *peer, char *status, int statuslen);
1359 static int sip_show_users(int fd, int argc, char *argv[]);
1360 static int _sip_show_peers(int fd, int *total, struct mansession *s, struct message *m, int argc, char *argv[]);
1361 static int manager_sip_show_peers( struct mansession *s, struct message *m );
1362 static int sip_show_peers(int fd, int argc, char *argv[]);
1363 static int sip_show_objects(int fd, int argc, char *argv[]);
1364 static void print_group(int fd, ast_group_t group, int crlf);
1365 static const char *dtmfmode2str(int mode) attribute_const;
1366 static const char *insecure2str(int port, int invite) attribute_const;
1367 static void cleanup_stale_contexts(char *new, char *old);
1368 static void print_codec_to_cli(int fd, struct ast_codec_pref *pref);
1369 static const char *domain_mode_to_text(const enum domain_mode mode);
1370 static int sip_show_domains(int fd, int argc, char *argv[]);
1371 static int _sip_show_peer(int type, int fd, struct mansession *s, struct message *m, int argc, char *argv[]);
1372 static int manager_sip_show_peer( struct mansession *s, struct message *m);
1373 static int sip_show_peer(int fd, int argc, char *argv[]);
1374 static int _sip_show_peer(int type, int fd, struct mansession *s, struct message *m, int argc, char *argv[]);
1375 static int sip_show_user(int fd, int argc, char *argv[]);
1376 static int sip_show_registry(int fd, int argc, char *argv[]);
1377 static int sip_show_settings(int fd, int argc, char *argv[]);
1378 static const char *subscription_type2str(enum subscriptiontype subtype) attribute_pure;
1379 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1380 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1381 static int sip_show_channels(int fd, int argc, char *argv[]);
1382 static int sip_show_subscriptions(int fd, int argc, char *argv[]);
1383 static int __sip_show_channels(int fd, int argc, char *argv[], int subscriptions);
1384 static char *complete_sipch(const char *line, const char *word, int pos, int state);
1385 static char *complete_sip_peer(const char *word, int state, int flags2);
1386 static char *complete_sip_show_peer(const char *line, const char *word, int pos, int state);
1387 static char *complete_sip_debug_peer(const char *line, const char *word, int pos, int state);
1388 static char *complete_sip_user(const char *word, int state, int flags2);
1389 static char *complete_sip_show_user(const char *line, const char *word, int pos, int state);
1390 static char *complete_sipnotify(const char *line, const char *word, int pos, int state);
1391 static char *complete_sip_prune_realtime_peer(const char *line, const char *word, int pos, int state);
1392 static char *complete_sip_prune_realtime_user(const char *line, const char *word, int pos, int state);
1393 static int sip_show_channel(int fd, int argc, char *argv[]);
1394 static int sip_show_history(int fd, int argc, char *argv[]);
1395 static int sip_do_debug_ip(int fd, int argc, char *argv[]);
1396 static int sip_do_debug_peer(int fd, int argc, char *argv[]);
1397 static int sip_do_debug(int fd, int argc, char *argv[]);
1398 static int sip_no_debug(int fd, int argc, char *argv[]);
1399 static int sip_notify(int fd, int argc, char *argv[]);
1400 static int sip_do_history(int fd, int argc, char *argv[]);
1401 static int sip_no_history(int fd, int argc, char *argv[]);
1402 static int func_header_read(struct ast_channel *chan, char *function, char *data, char *buf, size_t len);
1403 static int func_check_sipdomain(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1404 static int function_sippeer(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1405 static int function_sipchaninfo_read(struct ast_channel *chan, char *cmd, char *data, char *buf, size_t len);
1406 static int sip_dtmfmode(struct ast_channel *chan, void *data);
1407 static int sip_addheader(struct ast_channel *chan, void *data);
1408 static int sip_do_reload(enum channelreloadreason reason);
1409 static int sip_reload(int fd, int argc, char *argv[]);
1412 Functions for enabling debug per IP or fully, or enabling history logging for
1415 static void sip_dump_history(struct sip_pvt *dialog); /* Dump history to LOG_DEBUG at end of dialog, before destroying data */
1416 static inline int sip_debug_test_addr(const struct sockaddr_in *addr);
1417 static inline int sip_debug_test_pvt(struct sip_pvt *p);
1418 static void append_history_full(struct sip_pvt *p, const char *fmt, ...);
1419 static void sip_dump_history(struct sip_pvt *dialog);
1421 /*--- Device object handling */
1422 static struct sip_peer *temp_peer(const char *name);
1423 static struct sip_peer *build_peer(const char *name, struct ast_variable *v, struct ast_variable *alt, int realtime);
1424 static struct sip_user *build_user(const char *name, struct ast_variable *v, int realtime);
1425 static int update_call_counter(struct sip_pvt *fup, int event);
1426 static void sip_destroy_peer(struct sip_peer *peer);
1427 static void sip_destroy_user(struct sip_user *user);
1428 static int sip_poke_peer(struct sip_peer *peer);
1429 static void set_peer_defaults(struct sip_peer *peer);
1430 static struct sip_peer *temp_peer(const char *name);
1431 static void register_peer_exten(struct sip_peer *peer, int onoff);
1432 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime);
1433 static struct sip_user *find_user(const char *name, int realtime);
1434 static int sip_poke_peer_s(void *data);
1435 static enum parse_register_result parse_register_contact(struct sip_pvt *pvt, struct sip_peer *p, struct sip_request *req);
1436 static void reg_source_db(struct sip_peer *peer);
1437 static void destroy_association(struct sip_peer *peer);
1438 static int handle_common_options(struct ast_flags *flags, struct ast_flags *mask, struct ast_variable *v);
1440 /* Realtime device support */
1441 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey);
1442 static struct sip_user *realtime_user(const char *username);
1443 static void update_peer(struct sip_peer *p, int expiry);
1444 static struct sip_peer *realtime_peer(const char *peername, struct sockaddr_in *sin);
1445 static int sip_prune_realtime(int fd, int argc, char *argv[]);
1447 /*--- Internal UA client handling (outbound registrations) */
1448 static int ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us);
1449 static void sip_registry_destroy(struct sip_registry *reg);
1450 static int sip_register(char *value, int lineno);
1451 static char *regstate2str(enum sipregistrystate regstate) attribute_const;
1452 static int sip_reregister(void *data);
1453 static int __sip_do_register(struct sip_registry *r);
1454 static int sip_reg_timeout(void *data);
1455 static void sip_send_all_registers(void);
1457 /*--- Parsing SIP requests and responses */
1458 static void append_date(struct sip_request *req); /* Append date to SIP packet */
1459 static int determine_firstline_parts(struct sip_request *req);
1460 static const struct cfsubscription_types *find_subscription_type(enum subscriptiontype subtype);
1461 static const char *gettag(const struct sip_request *req, const char *header, char *tagbuf, int tagbufsize);
1462 static int find_sip_method(const char *msg);
1463 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported);
1464 static void parse_request(struct sip_request *req);
1465 static const char *get_header(const struct sip_request *req, const char *name);
1466 static const char *referstatus2str(enum referstatus rstatus) attribute_pure;
1467 static int method_match(enum sipmethod id, const char *name);
1468 static void parse_copy(struct sip_request *dst, const struct sip_request *src);
1469 static char *get_in_brackets(char *tmp);
1470 static const char *find_alias(const char *name, const char *_default);
1471 static const char *__get_header(const struct sip_request *req, const char *name, int *start);
1472 static int lws2sws(char *msgbuf, int len);
1473 static void extract_uri(struct sip_pvt *p, struct sip_request *req);
1474 static int get_refer_info(struct sip_pvt *transferer, struct sip_request *outgoing_req);
1475 static int get_also_info(struct sip_pvt *p, struct sip_request *oreq);
1476 static int parse_ok_contact(struct sip_pvt *pvt, struct sip_request *req);
1477 static int set_address_from_contact(struct sip_pvt *pvt);
1478 static void check_via(struct sip_pvt *p, struct sip_request *req);
1479 static char *get_calleridname(const char *input, char *output, size_t outputsize);
1480 static int get_rpid_num(const char *input, char *output, int maxlen);
1481 static int get_rdnis(struct sip_pvt *p, struct sip_request *oreq);
1482 static int get_destination(struct sip_pvt *p, struct sip_request *oreq);
1483 static int get_msg_text(char *buf, int len, struct sip_request *req);
1484 static void free_old_route(struct sip_route *route);
1485 static int transmit_state_notify(struct sip_pvt *p, int state, int full, int timeout);
1487 /*--- Constructing requests and responses */
1488 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req);
1489 static int init_req(struct sip_request *req, int sipmethod, const char *recip);
1490 static int reqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod, int seqno, int newbranch);
1491 static void initreqprep(struct sip_request *req, struct sip_pvt *p, int sipmethod);
1492 static int init_resp(struct sip_request *resp, const char *msg);
1493 static int respprep(struct sip_request *resp, struct sip_pvt *p, const char *msg, const struct sip_request *req);
1494 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p);
1495 static void build_via(struct sip_pvt *p);
1496 static int create_addr_from_peer(struct sip_pvt *r, struct sip_peer *peer);
1497 static int create_addr(struct sip_pvt *dialog, const char *opeer);
1498 static char *generate_random_string(char *buf, size_t size);
1499 static void build_callid_pvt(struct sip_pvt *pvt);
1500 static void build_callid_registry(struct sip_registry *reg, struct in_addr ourip, const char *fromdomain);
1501 static void make_our_tag(char *tagbuf, size_t len);
1502 static int add_header(struct sip_request *req, const char *var, const char *value);
1503 static int add_header_contentLength(struct sip_request *req, int len);
1504 static int add_line(struct sip_request *req, const char *line);
1505 static int add_text(struct sip_request *req, const char *text);
1506 static int add_digit(struct sip_request *req, char digit);
1507 static int add_vidupdate(struct sip_request *req);
1508 static void add_route(struct sip_request *req, struct sip_route *route);
1509 static int copy_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1510 static int copy_all_header(struct sip_request *req, const struct sip_request *orig, const char *field);
1511 static int copy_via_headers(struct sip_pvt *p, struct sip_request *req, const struct sip_request *orig, const char *field);
1512 static void set_destination(struct sip_pvt *p, char *uri);
1513 static void append_date(struct sip_request *req);
1514 static void build_contact(struct sip_pvt *p);
1515 static void build_rpid(struct sip_pvt *p);
1517 /*------Request handling functions */
1518 static int handle_request(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int *recount, int *nounlock);
1519 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);
1520 static int handle_request_refer(struct sip_pvt *p, struct sip_request *req, int debug, int seqno, int *nounlock);
1521 static int handle_request_bye(struct sip_pvt *p, struct sip_request *req);
1522 static int handle_request_register(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, char *e);
1523 static int handle_request_cancel(struct sip_pvt *p, struct sip_request *req);
1524 static int handle_request_message(struct sip_pvt *p, struct sip_request *req);
1525 static int handle_request_subscribe(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1526 static void handle_request_info(struct sip_pvt *p, struct sip_request *req);
1527 static int handle_request_options(struct sip_pvt *p, struct sip_request *req);
1528 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1529 static int handle_request_notify(struct sip_pvt *p, struct sip_request *req, struct sockaddr_in *sin, int seqno, char *e);
1530 static int handle_invite_replaces(struct sip_pvt *p, struct sip_request *req, int debug, int ignore, int seqno, struct sockaddr_in *sin);
1531 static int local_attended_transfer(struct sip_pvt *transferer, struct sip_dual *current, struct sip_request *req, int seqno);
1533 /*------Response handling functions */
1534 static void handle_response_invite(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1535 static void handle_response_refer(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1536 static int handle_response_register(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1537 static void handle_response(struct sip_pvt *p, int resp, char *rest, struct sip_request *req, int seqno);
1539 /*----- RTP interface functions */
1540 static int sip_set_rtp_peer(struct ast_channel *chan, struct ast_rtp *rtp, struct ast_rtp *vrtp, int codecs, int nat_active);
1541 static enum ast_rtp_get_result sip_get_rtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1542 static enum ast_rtp_get_result sip_get_vrtp_peer(struct ast_channel *chan, struct ast_rtp **rtp);
1543 static int sip_get_codec(struct ast_channel *chan);
1544 static struct ast_frame *sip_rtp_read(struct ast_channel *ast, struct sip_pvt *p, int *faxdetect);
1546 /*------ T38 Support --------- */
1547 static int sip_handle_t38_reinvite(struct ast_channel *chan, struct sip_pvt *pvt, int reinvite); /*!< T38 negotiation helper function */
1548 static int transmit_response_with_t38_sdp(struct sip_pvt *p, char *msg, struct sip_request *req, int retrans);
1549 static struct ast_udptl *sip_get_udptl_peer(struct ast_channel *chan);
1550 static int sip_set_udptl_peer(struct ast_channel *chan, struct ast_udptl *udptl);
1552 /*! \brief Definition of this channel for PBX channel registration */
1553 static const struct ast_channel_tech sip_tech = {
1555 .description = "Session Initiation Protocol (SIP)",
1556 .capabilities = ((AST_FORMAT_MAX_AUDIO << 1) - 1),
1557 .properties = AST_CHAN_TP_WANTSJITTER | AST_CHAN_TP_CREATESJITTER,
1558 .requester = sip_request_call,
1559 .devicestate = sip_devicestate,
1561 .hangup = sip_hangup,
1562 .answer = sip_answer,
1565 .write_video = sip_write,
1566 .indicate = sip_indicate,
1567 .transfer = sip_transfer,
1569 .send_digit_begin = sip_senddigit_begin,
1570 .send_digit_end = sip_senddigit_end,
1571 .bridge = ast_rtp_bridge,
1572 .early_bridge = ast_rtp_early_bridge,
1573 .send_text = sip_sendtext,
1576 /**--- some list management macros. **/
1578 #define UNLINK(element, head, prev) do { \
1580 (prev)->next = (element)->next; \
1582 (head) = (element)->next; \
1585 /*! \brief Interface structure with callbacks used to connect to RTP module */
1586 static struct ast_rtp_protocol sip_rtp = {
1588 get_rtp_info: sip_get_rtp_peer,
1589 get_vrtp_info: sip_get_vrtp_peer,
1590 set_rtp_peer: sip_set_rtp_peer,
1591 get_codec: sip_get_codec,
1594 /*! \brief Helper function to lock, hiding the underlying locking mechanism. */
1595 static void sip_pvt_lock(struct sip_pvt *pvt)
1597 ast_mutex_lock(&pvt->pvt_lock);
1600 /*! \brief Helper function to unlock pvt, hiding the underlying locking mechanism. */
1601 static void sip_pvt_unlock(struct sip_pvt *pvt)
1603 ast_mutex_unlock(&pvt->pvt_lock);
1607 * helper functions to unreference various types of objects.
1608 * By handling them this way, we don't have to declare the
1609 * destructor on each call, which removes the chance of errors.
1611 static void unref_peer(struct sip_peer *peer)
1613 ASTOBJ_UNREF(peer, sip_destroy_peer);
1616 static void unref_user(struct sip_user *user)
1618 ASTOBJ_UNREF(user, sip_destroy_user);
1621 static void unref_registry(struct sip_registry *reg)
1623 ASTOBJ_UNREF(reg, sip_registry_destroy);
1626 /*! \brief Interface structure with callbacks used to connect to UDPTL module*/
1627 static struct ast_udptl_protocol sip_udptl = {
1629 get_udptl_info: sip_get_udptl_peer,
1630 set_udptl_peer: sip_set_udptl_peer,
1633 /*! \brief Convert transfer status to string */
1634 static const char *referstatus2str(enum referstatus rstatus)
1636 int i = (sizeof(referstatusstrings) / sizeof(referstatusstrings[0]));
1639 for (x = 0; x < i; x++) {
1640 if (referstatusstrings[x].status == rstatus)
1641 return referstatusstrings[x].text;
1646 /*! \brief Initialize the initital request packet in the pvt structure.
1647 This packet is used for creating replies and future requests in
1649 static void initialize_initreq(struct sip_pvt *p, struct sip_request *req)
1652 if (p->initreq.headers)
1653 ast_log(LOG_DEBUG, "Initializing already initialized SIP dialog %s (presumably reinvite)\n", p->callid);
1655 ast_log(LOG_DEBUG, "Initializing initreq for method %s - callid %s\n", sip_methods[req->method].text, p->callid);
1657 /* Use this as the basis */
1658 copy_request(&p->initreq, req);
1659 parse_request(&p->initreq);
1660 if (ast_test_flag(req, SIP_PKT_DEBUG))
1661 ast_verbose("Initreq: %d headers, %d lines\n", p->initreq.headers, p->initreq.lines);
1665 /*! \brief returns true if 'name' (with optional trailing whitespace)
1666 * matches the sip method 'id'.
1667 * Strictly speaking, SIP methods are case SENSITIVE, but we do
1668 * a case-insensitive comparison to be more tolerant.
1669 * following Jon Postel's rule: Be gentle in what you accept, strict with what you send
1671 static int method_match(enum sipmethod id, const char *name)
1673 int len = strlen(sip_methods[id].text);
1674 int l_name = name ? strlen(name) : 0;
1675 /* true if the string is long enough, and ends with whitespace, and matches */
1676 return (l_name >= len && name[len] < 33 &&
1677 !strncasecmp(sip_methods[id].text, name, len));
1680 /*! \brief find_sip_method: Find SIP method from header */
1681 static int find_sip_method(const char *msg)
1685 if (ast_strlen_zero(msg))
1687 for (i = 1; i < (sizeof(sip_methods) / sizeof(sip_methods[0])) && !res; i++) {
1688 if (method_match(i, msg))
1689 res = sip_methods[i].id;
1694 /*! \brief Parse supported header in incoming packet */
1695 static unsigned int parse_sip_options(struct sip_pvt *pvt, const char *supported)
1699 unsigned int profile = 0;
1702 if (ast_strlen_zero(supported) )
1704 temp = ast_strdupa(supported);
1706 if (option_debug > 2 && sipdebug)
1707 ast_log(LOG_DEBUG, "Begin: parsing SIP \"Supported: %s\"\n", supported);
1709 for (next = temp; next; next = sep) {
1711 if ( (sep = strchr(next, ',')) != NULL)
1713 next = ast_skip_blanks(next);
1714 if (option_debug > 2 && sipdebug)
1715 ast_log(LOG_DEBUG, "Found SIP option: -%s-\n", next);
1716 for (i=0; i < (sizeof(sip_options) / sizeof(sip_options[0])); i++) {
1717 if (!strcasecmp(next, sip_options[i].text)) {
1718 profile |= sip_options[i].id;
1720 if (option_debug > 2 && sipdebug)
1721 ast_log(LOG_DEBUG, "Matched SIP option: %s\n", next);
1725 if (!found && option_debug > 2 && sipdebug) {
1726 if (!strncasecmp(next, "x-", 2))
1727 ast_log(LOG_DEBUG, "Found private SIP option, not supported: %s\n", next);
1729 ast_log(LOG_DEBUG, "Found no match for SIP option: %s (Please file bug report!)\n", next);
1734 pvt->sipoptions = profile;
1738 /*! \brief See if we pass debug IP filter */
1739 static inline int sip_debug_test_addr(const struct sockaddr_in *addr)
1743 if (debugaddr.sin_addr.s_addr) {
1744 if (((ntohs(debugaddr.sin_port) != 0)
1745 && (debugaddr.sin_port != addr->sin_port))
1746 || (debugaddr.sin_addr.s_addr != addr->sin_addr.s_addr))
1752 /*! \brief The real destination address for a write */
1753 static const struct sockaddr_in *sip_real_dst(const struct sip_pvt *p)
1755 return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? &p->recv : &p->sa;
1758 /*! \brief Display SIP nat mode */
1759 static const char *sip_nat_mode(const struct sip_pvt *p)
1761 return ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_ROUTE ? "NAT" : "no NAT";
1764 /*! \brief Test PVT for debugging output */
1765 static inline int sip_debug_test_pvt(struct sip_pvt *p)
1769 return sip_debug_test_addr(sip_real_dst(p));
1772 /*! \brief Transmit SIP message */
1773 static int __sip_xmit(struct sip_pvt *p, char *data, int len)
1776 const struct sockaddr_in *dst = sip_real_dst(p);
1777 res = sendto(sipsock, data, len, 0, (const struct sockaddr *)dst, sizeof(struct sockaddr_in));
1780 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));
1785 /*! \brief Build a Via header for a request */
1786 static void build_via(struct sip_pvt *p)
1788 /* Work around buggy UNIDEN UIP200 firmware */
1789 const char *rport = ast_test_flag(&p->flags[0], SIP_NAT) & SIP_NAT_RFC3581 ? ";rport" : "";
1791 /* z9hG4bK is a magic cookie. See RFC 3261 section 8.1.1.7 */
1792 ast_string_field_build(p, via, "SIP/2.0/UDP %s:%d;branch=z9hG4bK%08x%s",
1793 ast_inet_ntoa(p->ourip), ourport, p->branch, rport);
1796 /*! \brief NAT fix - decide which IP address to use for ASterisk server?
1798 * Using the localaddr structure built up with localnet statements in sip.conf
1799 * apply it to their address to see if we need to substitute our
1800 * externip or can get away with our internal bindaddr
1802 static enum sip_result ast_sip_ouraddrfor(struct in_addr *them, struct in_addr *us)
1804 struct sockaddr_in theirs, ours;
1806 /* Get our local information */
1807 ast_ouraddrfor(them, us);
1808 theirs.sin_addr = *them;
1809 ours.sin_addr = *us;
1811 if (localaddr && externip.sin_addr.s_addr &&
1812 ast_apply_ha(localaddr, &theirs) &&
1813 !ast_apply_ha(localaddr, &ours)) {
1814 if (externexpire && time(NULL) >= externexpire) {
1815 struct ast_hostent ahp;
1818 externexpire = time(NULL) + externrefresh;
1819 if ((hp = ast_gethostbyname(externhost, &ahp))) {
1820 memcpy(&externip.sin_addr, hp->h_addr, sizeof(externip.sin_addr));
1822 ast_log(LOG_NOTICE, "Warning: Re-lookup of '%s' failed!\n", externhost);
1824 *us = externip.sin_addr;
1826 ast_log(LOG_DEBUG, "Target address %s is not local, substituting externip\n",
1827 ast_inet_ntoa(*(struct in_addr *)&them->s_addr));
1829 } else if (bindaddr.sin_addr.s_addr)
1830 *us = bindaddr.sin_addr;
1834 /*! \brief Append to SIP dialog history
1835 \return Always returns 0 */
1836 #define append_history(p, event, fmt , args... ) append_history_full(p, "%-15s " fmt, event, ## args)
1838 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1839 __attribute__ ((format (printf, 2, 3)));
1841 /*! \brief Append to SIP dialog history with arg list */
1842 static void append_history_va(struct sip_pvt *p, const char *fmt, va_list ap)
1844 char buf[80], *c = buf; /* max history length */
1845 struct sip_history *hist;
1848 vsnprintf(buf, sizeof(buf), fmt, ap);
1849 strsep(&c, "\r\n"); /* Trim up everything after \r or \n */
1850 l = strlen(buf) + 1;
1851 if (!(hist = ast_calloc(1, sizeof(*hist) + l)))
1853 if (!p->history && !(p->history = ast_calloc(1, sizeof(*p->history)))) {
1857 memcpy(hist->event, buf, l);
1858 AST_LIST_INSERT_TAIL(p->history, hist, list);
1861 /*! \brief Append to SIP dialog history with arg list */
1862 static void append_history_full(struct sip_pvt *p, const char *fmt, ...)
1869 append_history_va(p, fmt, ap);
1875 /*! \brief Retransmit SIP message if no answer (Called from scheduler) */
1876 static int retrans_pkt(void *data)
1878 struct sip_pkt *pkt = data, *prev, *cur = NULL;
1879 int reschedule = DEFAULT_RETRANS;
1881 /* Lock channel PVT */
1882 sip_pvt_lock(pkt->owner);
1884 if (pkt->retrans < MAX_RETRANS) {
1886 if (!pkt->timer_t1) { /* Re-schedule using timer_a and timer_t1 */
1887 if (sipdebug && option_debug > 3)
1888 ast_log(LOG_DEBUG, "SIP TIMER: Not rescheduling id #%d:%s (Method %d) (No timer T1)\n", pkt->retransid, sip_methods[pkt->method].text, pkt->method);
1892 if (sipdebug && option_debug > 3)
1893 ast_log(LOG_DEBUG, "SIP TIMER: Rescheduling retransmission #%d (%d) %s - %d\n", pkt->retransid, pkt->retrans, sip_methods[pkt->method].text, pkt->method);
1897 pkt->timer_a = 2 * pkt->timer_a;
1899 /* For non-invites, a maximum of 4 secs */
1900 siptimer_a = pkt->timer_t1 * pkt->timer_a; /* Double each time */
1901 if (pkt->method != SIP_INVITE && siptimer_a > 4000)
1904 /* Reschedule re-transmit */
1905 reschedule = siptimer_a;
1906 if (option_debug > 3)
1907 ast_log(LOG_DEBUG, "** SIP timers: Rescheduling retransmission %d to %d ms (t1 %d ms (Retrans id #%d)) \n", pkt->retrans +1, siptimer_a, pkt->timer_t1, pkt->retransid);
1910 if (sip_debug_test_pvt(pkt->owner)) {
1911 const struct sockaddr_in *dst = sip_real_dst(pkt->owner);
1912 ast_verbose("Retransmitting #%d (%s) to %s:%d:\n%s\n---\n",
1913 pkt->retrans, sip_nat_mode(pkt->owner),
1914 ast_inet_ntoa(dst->sin_addr),
1915 ntohs(dst->sin_port), pkt->data);
1918 append_history(pkt->owner, "ReTx", "%d %s", reschedule, pkt->data);
1919 __sip_xmit(pkt->owner, pkt->data, pkt->packetlen);
1920 sip_pvt_unlock(pkt->owner);
1923 /* Too many retries */
1924 if (pkt->owner && pkt->method != SIP_OPTIONS) {
1925 if (ast_test_flag(pkt, FLAG_FATAL) || sipdebug) /* Tell us if it's critical or if we're debugging */
1926 ast_log(LOG_WARNING, "Maximum retries exceeded on transmission %s for seqno %d (%s %s)\n", pkt->owner->callid, pkt->seqno, (ast_test_flag(pkt, FLAG_FATAL)) ? "Critical" : "Non-critical", (ast_test_flag(pkt, FLAG_RESPONSE)) ? "Response" : "Request");
1928 if ((pkt->method == SIP_OPTIONS) && sipdebug)
1929 ast_log(LOG_WARNING, "Cancelling retransmit of OPTIONs (call id %s) \n", pkt->owner->callid);
1931 append_history(pkt->owner, "MaxRetries", "%s", (ast_test_flag(pkt, FLAG_FATAL)) ? "(Critical)" : "(Non-critical)");
1933 pkt->retransid = -1;
1935 if (ast_test_flag(pkt, FLAG_FATAL)) {
1936 while(pkt->owner->owner && ast_channel_trylock(pkt->owner->owner)) {
1937 sip_pvt_unlock(pkt->owner); /* SIP_PVT, not channel */
1939 sip_pvt_lock(pkt->owner);
1941 if (pkt->owner->owner) {
1942 ast_set_flag(&pkt->owner->flags[0], SIP_ALREADYGONE);
1943 ast_log(LOG_WARNING, "Hanging up call %s - no reply to our critical packet.\n", pkt->owner->callid);
1944 ast_queue_hangup(pkt->owner->owner);
1945 ast_channel_unlock(pkt->owner->owner);
1947 /* If no channel owner, destroy now */
1949 /* Let the peerpoke system expire packets when the timer expires for poke_noanswer */
1950 if (pkt->method != SIP_OPTIONS)
1951 ast_set_flag(&pkt->owner->flags[0], SIP_NEEDDESTROY);
1954 /* Remove the packet */
1955 for (prev = NULL, cur = pkt->owner->packets; cur; prev = cur, cur = cur->next) {
1957 UNLINK(cur, pkt->owner->packets, prev);
1958 sip_pvt_unlock(pkt->owner);
1964 ast_log(LOG_WARNING, "Weird, couldn't find packet owner!\n");
1965 sip_pvt_unlock(pkt->owner);
1969 /*! \brief Transmit packet with retransmits
1970 \return 0 on success, -1 on failure to allocate packet
1972 static enum sip_result __sip_reliable_xmit(struct sip_pvt *p, int seqno, int resp, char *data, int len, int fatal, int sipmethod)
1974 struct sip_pkt *pkt;
1975 int siptimer_a = DEFAULT_RETRANS;
1977 if (!(pkt = ast_calloc(1, sizeof(*pkt) + len + 1)))
1979 memcpy(pkt->data, data, len);
1980 pkt->method = sipmethod;
1981 pkt->packetlen = len;
1982 pkt->next = p->packets;
1986 ast_set_flag(pkt, FLAG_RESPONSE);
1987 pkt->data[len] = '\0';
1988 pkt->timer_t1 = p->timer_t1; /* Set SIP timer T1 */
1990 ast_set_flag(pkt, FLAG_FATAL);
1992 siptimer_a = pkt->timer_t1 * 2;
1994 /* Schedule retransmission */
1995 pkt->retransid = ast_sched_add_variable(sched, siptimer_a, retrans_pkt, pkt, 1);
1996 if (option_debug > 3 && sipdebug)
1997 ast_log(LOG_DEBUG, "*** SIP TIMER: Initalizing retransmit timer on packet: Id #%d\n", pkt->retransid);
1998 pkt->next = p->packets;
2001 __sip_xmit(pkt->owner, pkt->data, pkt->packetlen); /* Send packet */
2002 if (sipmethod == SIP_INVITE) {
2003 /* Note this is a pending invite */
2004 p->pendinginvite = seqno;
2009 /*! \brief Kill a SIP dialog (called by scheduler) */
2010 static int __sip_autodestruct(void *data)
2012 struct sip_pvt *p = data;
2014 /* If this is a subscription, tell the phone that we got a timeout */
2015 if (p->subscribed) {
2016 transmit_state_notify(p, AST_EXTENSION_DEACTIVATED, 1, TRUE); /* Send last notification */
2017 p->subscribed = NONE;
2018 append_history(p, "Subscribestatus", "timeout");
2019 if (option_debug > 2)
2020 ast_log(LOG_DEBUG, "Re-scheduled destruction of SIP subsription %s\n", p->callid ? p->callid : "<unknown>");
2021 return 10000; /* Reschedule this destruction so that we know that it's gone */
2024 if (p->subscribed == MWI_NOTIFICATION)
2026 unref_peer(p->relatedpeer); /* Remove link to peer. If it's realtime, make sure it's gone from memory) */
2028 /* Reset schedule ID */
2032 ast_log(LOG_WARNING, "Autodestruct on dialog '%s' with owner in place (Method: %s)\n", p->callid, sip_methods[p->method].text);
2033 ast_queue_hangup(p->owner);
2034 } else if (p->refer) {
2035 if (option_debug > 2)
2036 ast_log(LOG_DEBUG, "Finally hanging up channel after transfer: %s\n", p->callid);
2037 transmit_request_with_auth(p, SIP_BYE, 0, XMIT_RELIABLE, 1);
2038 append_history(p, "ReferBYE", "Sending BYE on transferer call leg %s", p->callid);
2039 sip_scheddestroy(p, DEFAULT_TRANS_TIMEOUT);
2041 append_history(p, "AutoDestroy", "%s", p->callid);
2043 ast_log(LOG_DEBUG, "Auto destroying SIP dialog '%s'\n", p->callid);
2044 sip_destroy(p); /* Go ahead and destroy dialog. All attempts to recover is done */
2049 /*! \brief Schedule destruction of SIP dialog */
2050 static void sip_scheddestroy(struct sip_pvt *p, int ms)
2053 if (p->timer_t1 == 0)
2054 p->timer_t1 = SIP_TIMER_T1; /* Set timer T1 if not set (RFC 3261) */
2055 ms = p->timer_t1 * 64;
2057 if (sip_debug_test_pvt(p))
2058 ast_verbose("Scheduling destruction of SIP dialog '%s' in %d ms (Method: %s)\n", p->callid, ms, sip_methods[p->method].text);
2059 if (!ast_test_flag(&p->flags[0], SIP_NO_HISTORY))
2060 append_history(p, "SchedDestroy", "%d ms", ms);
2062 if (p->autokillid > -1)
2063 ast_sched_del(sched, p->autokillid);
2064 p->autokillid = ast_sched_add(sched, ms, __sip_autodestruct, p);
2067 /*! \brief Cancel destruction of SIP dialog */
2068 static void sip_cancel_destroy(struct sip_pvt *p)
2070 if (p->autokillid > -1) {
2071 ast_sched_del(sched, p->autokillid);
2072 append_history(p, "CancelDestroy", "");
2077 /*! \brief Acknowledges receipt of a packet and stops retransmission */
2078 static void __sip_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2080 struct sip_pkt *cur, *prev = NULL;
2081 const char *msg = "Not Found"; /* used only for debugging */
2084 for (cur = p->packets; cur; prev = cur, cur = cur->next) {
2085 if (cur->seqno != seqno || ast_test_flag(cur, FLAG_RESPONSE) != resp)
2087 if (ast_test_flag(cur, FLAG_RESPONSE) || cur->method == sipmethod) {
2089 if (!resp && (seqno == p->pendinginvite)) {
2091 ast_log(LOG_DEBUG, "Acked pending invite %d\n", p->pendinginvite);
2092 p->pendinginvite = 0;
2094 if (cur->retransid > -1) {
2095 if (sipdebug && option_debug > 3)
2096 ast_log(LOG_DEBUG, "** SIP TIMER: Cancelling retransmit of packet (reply received) Retransid #%d\n", cur->retransid);
2097 ast_sched_del(sched, cur->retransid);
2098 cur->retransid = -1;
2100 UNLINK(cur, p->packets, prev);
2107 ast_log(LOG_DEBUG, "Stopping retransmission on '%s' of %s %d: Match %s\n",
2108 p->callid, resp ? "Response" : "Request", seqno, msg);
2111 /*! \brief Pretend to ack all packets
2112 * maybe the lock on p is not strictly necessary but there might be a race */
2113 static void __sip_pretend_ack(struct sip_pvt *p)
2115 struct sip_pkt *cur = NULL;
2117 while (p->packets) {
2119 if (cur == p->packets) {
2120 ast_log(LOG_WARNING, "Have a packet that doesn't want to give up! %s\n", sip_methods[cur->method].text);
2124 method = (cur->method) ? cur->method : find_sip_method(cur->data);
2125 __sip_ack(p, cur->seqno, ast_test_flag(cur, FLAG_RESPONSE), method);
2129 /*! \brief Acks receipt of packet, keep it around (used for provisional responses) */
2130 static int __sip_semi_ack(struct sip_pvt *p, int seqno, int resp, int sipmethod)
2132 struct sip_pkt *cur;
2135 for (cur = p->packets; cur; cur = cur->next) {
2136 if (cur->seqno == seqno && ast_test_flag(cur, FLAG_RESPONSE) == resp &&
2137 (ast_test_flag(cur, FLAG_RESPONSE) || method_match(sipmethod, cur->data))) {
2138 /* this is our baby */
2139 if (cur->retransid > -1) {
2140 if (option_debug > 3 && sipdebug)
2141 ast_log(LOG_DEBUG, "*** SIP TIMER: Cancelling retransmission #%d - %s (got response)\n", cur->retransid, sip_methods[sipmethod].text);
2142 ast_sched_del(sched, cur->retransid);
2143 cur->retransid = -1;
2150 ast_log(LOG_DEBUG, "(Provisional) Stopping retransmission (but retaining packet) on '%s' %s %d: %s\n", p->callid, resp ? "Response" : "Request", seqno, res ? "Not Found" : "Found");
2155 /*! \brief Copy SIP request, parse it */
2156 static void parse_copy(struct sip_request *dst, const struct sip_request *src)
2158 memset(dst, 0, sizeof(*dst));
2159 memcpy(dst->data, src->data, sizeof(dst->data));
2160 dst->len = src->len;
2164 /*! \brief add a blank line if no body */
2165 static void add_blank(struct sip_request *req)
2168 /* Add extra empty return. add_header() reserves 4 bytes so cannot be truncated */
2169 snprintf(req->data + req->len, sizeof(req->data) - req->len, "\r\n");
2170 req->len += strlen(req->data + req->len);
2174 /*! \brief Transmit response on SIP request*/
2175 static int send_response(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2180 if (sip_debug_test_pvt(p)) {
2181 const struct sockaddr_in *dst = sip_real_dst(p);
2183 ast_verbose("\n<--- %sTransmitting (%s) to %s:%d --->\n%s\n<------------>\n",
2184 reliable ? "Reliably " : "", sip_nat_mode(p),
2185 ast_inet_ntoa(dst->sin_addr),
2186 ntohs(dst->sin_port), req->data);
2188 if (!ast_test_flag(&p->flags[0], SIP_NO_HISTORY)) {
2189 struct sip_request tmp;
2190 parse_copy(&tmp, req);
2191 append_history(p, reliable ? "TxRespRel" : "TxResp", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"),
2192 (tmp.method == SIP_RESPONSE || tmp.method == SIP_UNKNOWN) ? tmp.rlPart2 : sip_methods[tmp.method].text);
2195 __sip_reliable_xmit(p, seqno, 1, req->data, req->len, (reliable == XMIT_CRITICAL), req->method) :
2196 __sip_xmit(p, req->data, req->len);
2202 /*! \brief Send SIP Request to the other part of the dialogue */
2203 static int send_request(struct sip_pvt *p, struct sip_request *req, enum xmittype reliable, int seqno)
2208 if (sip_debug_test_pvt(p)) {
2209 if (ast_test_flag(&p->flags[0], SIP_NAT_ROUTE))
2210 ast_verbose("%sTransmitting (NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->recv.sin_addr), ntohs(p->recv.sin_port), req->data);
2212 ast_verbose("%sTransmitting (no NAT) to %s:%d:\n%s\n---\n", reliable ? "Reliably " : "", ast_inet_ntoa(p->sa.sin_addr), ntohs(p->sa.sin_port), req->data);
2214 if (!ast_test_flag(&p->flags[0], SIP_NO_HISTORY)) {
2215 struct sip_request tmp;
2216 parse_copy(&tmp, req);
2217 append_history(p, reliable ? "TxReqRel" : "TxReq", "%s / %s - %s", tmp.data, get_header(&tmp, "CSeq"), sip_methods[tmp.method].text);
2220 __sip_reliable_xmit(p, seqno, 0, req->data, req->len, (reliable > 1), req->method) :
2221 __sip_xmit(p, req->data, req->len);
2225 /*! \brief Locate closing quote in a string, skipping escaped quotes.
2226 * optionally with a limit on the search.
2227 * start must be past the first quote.
2229 static const char *find_closing_quote(const char *start, const char *lim)
2231 char last_char = '\0';
2233 for (s = start; *s && s != lim; last_char = *s++) {
2234 if (*s == '"' && last_char != '\\')
2240 /*! \brief Pick out text in brackets from character string
2241 \return pointer to terminated stripped string
2242 \param tmp input string that will be modified
2245 "foo" <bar> valid input, returns bar
2246 foo returns the whole string
2247 < "foo ... > returns the string between brackets
2248 < "foo... bogus (missing closing bracket), returns the whole string
2249 XXX maybe should still skip the opening bracket
2251 static char *get_in_brackets(char *tmp)
2253 const char *parse = tmp;
2254 char *first_bracket;
2257 * Skip any quoted text until we find the part in brackets.
2258 * On any error give up and return the full string.
2260 while ( (first_bracket = strchr(parse, '<')) ) {
2261 char *first_quote = strchr(parse, '"');
2263 if (!first_quote || first_quote > first_bracket)
2264 break; /* no need to look at quoted part */
2265 /* the bracket is within quotes, so ignore it */
2266 parse = find_closing_quote(first_quote + 1, NULL);
2267 if (!*parse) { /* not found, return full string ? */
2268 /* XXX or be robust and return in-bracket part ? */
2269 ast_log(LOG_WARNING, "No closing quote found in '%s'\n", tmp);
2274 if (first_bracket) {
2275 char *second_bracket = strchr(first_bracket + 1, '>');
2276 if (second_bracket) {
2277 *second_bracket = '\0';
2278 tmp = first_bracket + 1;
2280 ast_log(LOG_WARNING, "No closing bracket found in '%s'\n", tmp);
2287 * parses a URI in its components.
2288 * If scheme is specified, drop it from the top.
2289 * If a component is not requested, do not split around it.
2290 * This means that if we don't have domain, we cannot split
2291 * name:pass and domain:port.
2292 * It is safe to call with ret_name, pass, domain, port
2293 * pointing all to the same place.
2294 * Init pointers to empty string so we never get NULL dereferencing.
2295 * Overwrites the string.
2296 * return 0 on success, other values on error.
2298 static int parse_uri(char *uri, char *scheme,
2299 char **ret_name, char **pass, char **domain, char **port, char **options)
2304 /* init field as required */
2309 name = strsep(&uri, ";"); /* remove options */
2311 int l = strlen(scheme);
2312 if (!strncmp(name, scheme, l))
2315 ast_log(LOG_NOTICE, "Missing scheme '%s' in '%s'\n", scheme, name);
2320 /* if we don't want to split around domain, keep everything as a name,
2321 * so we need to do nothing here, except remember why.
2324 /* store the result in a temp. variable to avoid it being
2325 * overwritten if arguments point to the same place.
2329 if ((c = strchr(name, '@')) == NULL) {
2330 /* domain-only URI, according to the SIP RFC. */
2337 if (port && (c = strchr(dom, ':'))) { /* Remove :port */
2341 if (pass && (c = strchr(name, ':'))) { /* user:password */
2347 if (ret_name) /* same as for domain, store the result only at the end */
2350 *options = uri ? uri : "";
2355 /*! \brief Send SIP MESSAGE text within a call
2356 Called from PBX core sendtext() application */
2357 static int sip_sendtext(struct ast_channel *ast, const char *text)
2359 struct sip_pvt *p = ast->tech_pvt;
2360 int debug = sip_debug_test_pvt(p);
2363 ast_verbose("Sending text %s on %s\n", text, ast->name);
2366 if (ast_strlen_zero(text))
2369 ast_verbose("Really sending text %s on %s\n", text, ast->name);
2370 transmit_message_with_text(p, text);
2374 /*! \brief Update peer object in realtime storage
2375 If the Asterisk system name is set in asterisk.conf, we will use
2376 that name and store that in the "regserver" field in the sippeers
2377 table to facilitate multi-server setups.
2379 static void realtime_update_peer(const char *peername, struct sockaddr_in *sin, const char *username, const char *fullcontact, int expirey)
2382 char ipaddr[INET_ADDRSTRLEN];
2383 char regseconds[20];
2385 char *sysname = ast_config_AST_SYSTEM_NAME;
2386 char *syslabel = NULL;
2388 time_t nowtime = time(NULL) + expirey;
2389 const char *fc = fullcontact ? "fullcontact" : NULL;
2391 snprintf(regseconds, sizeof(regseconds), "%d", (int)nowtime); /* Expiration time */
2392 ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2393 snprintf(port, sizeof(port), "%d", ntohs(sin->sin_port));
2395 if (ast_strlen_zero(sysname)) /* No system name, disable this */
2397 else if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTSAVE_SYSNAME))
2398 syslabel = "regserver";
2401 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
2402 "port", port, "regseconds", regseconds,
2403 "username", username, fc, fullcontact, syslabel, sysname, NULL); /* note fc and syslabel _can_ be NULL */
2405 ast_update_realtime("sippeers", "name", peername, "ipaddr", ipaddr,
2406 "port", port, "regseconds", regseconds,
2407 "username", username, syslabel, sysname, NULL); /* note syslabel _can_ be NULL */
2410 /*! \brief Automatically add peer extension to dial plan */
2411 static void register_peer_exten(struct sip_peer *peer, int onoff)
2414 char *stringp, *ext, *context;
2416 /* XXX note that global_regcontext is both a global 'enable' flag and
2417 * the name of the global regexten context, if not specified
2420 if (ast_strlen_zero(global_regcontext))
2423 ast_copy_string(multi, S_OR(peer->regexten, peer->name), sizeof(multi));
2425 while ((ext = strsep(&stringp, "&"))) {
2426 if ((context = strchr(ext, '@'))) {
2427 *context++ = '\0'; /* split ext@context */
2428 if (!ast_context_find(context)) {
2429 ast_log(LOG_WARNING, "Context %s must exist in regcontext= in sip.conf!\n", context);
2433 context = global_regcontext;
2436 ast_add_extension(context, 1, ext, 1, NULL, NULL, "Noop",
2437 ast_strdup(peer->name), ast_free, "SIP");
2439 ast_context_remove_extension(context, ext, 1, NULL);
2443 /*! \brief Destroy peer object from memory */
2444 static void sip_destroy_peer(struct sip_peer *peer)
2446 if (option_debug > 2)
2447 ast_log(LOG_DEBUG, "Destroying SIP peer %s\n", peer->name);
2449 /* Delete it, it needs to disappear */
2451 sip_destroy(peer->call);
2453 if (peer->mwipvt) /* We have an active subscription, delete it */
2454 sip_destroy(peer->mwipvt);
2456 if (peer->chanvars) {
2457 ast_variables_destroy(peer->chanvars);
2458 peer->chanvars = NULL;
2460 if (peer->expire > -1)
2461 ast_sched_del(sched, peer->expire);
2463 if (peer->pokeexpire > -1)
2464 ast_sched_del(sched, peer->pokeexpire);
2465 register_peer_exten(peer, FALSE);
2466 ast_free_ha(peer->ha);
2467 if (ast_test_flag(&peer->flags[1], SIP_PAGE2_SELFDESTRUCT))
2469 else if (ast_test_flag(&peer->flags[0], SIP_REALTIME)) {
2471 if (option_debug > 2)
2472 ast_log(LOG_DEBUG,"-REALTIME- peer Destroyed. Name: %s. Realtime Peer objects: %d\n", peer->name, rpeerobjs);
2475 clear_realm_authentication(peer->auth);
2478 ast_dnsmgr_release(peer->dnsmgr);
2482 /*! \brief Update peer data in database (if used) */
2483 static void update_peer(struct sip_peer *p, int expiry)
2485 int rtcachefriends = ast_test_flag(&p->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2486 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTUPDATE) &&
2487 (ast_test_flag(&p->flags[0], SIP_REALTIME) || rtcachefriends)) {
2488 realtime_update_peer(p->name, &p->addr, p->username, rtcachefriends ? p->fullcontact : NULL, expiry);
2493 /*! \brief realtime_peer: Get peer from realtime storage
2494 * Checks the "sippeers" realtime family from extconfig.conf
2495 * \todo Consider adding check of port address when matching here to follow the same
2496 * algorithm as for static peers. Will we break anything by adding that?
2498 static struct sip_peer *realtime_peer(const char *newpeername, struct sockaddr_in *sin)
2500 struct sip_peer *peer;
2501 struct ast_variable *var = NULL;
2502 struct ast_variable *tmp;
2503 char ipaddr[INET_ADDRSTRLEN];
2505 /* First check on peer name */
2507 var = ast_load_realtime("sippeers", "name", newpeername, NULL);
2508 else if (sin) { /* Then check on IP address for dynamic peers */
2509 ast_copy_string(ipaddr, ast_inet_ntoa(sin->sin_addr), sizeof(ipaddr));
2510 var = ast_load_realtime("sippeers", "host", ipaddr, NULL); /* First check for fixed IP hosts */
2512 var = ast_load_realtime("sippeers", "ipaddr", ipaddr, NULL); /* Then check for registred hosts */
2518 for (tmp = var; tmp; tmp = tmp->next) {
2519 /* If this is type=user, then skip this object. */
2520 if (!strcasecmp(tmp->name, "type") &&
2521 !strcasecmp(tmp->value, "user")) {
2522 ast_variables_destroy(var);
2524 } else if (!newpeername && !strcasecmp(tmp->name, "name")) {
2525 newpeername = tmp->value;
2529 if (!newpeername) { /* Did not find peer in realtime */
2530 ast_log(LOG_WARNING, "Cannot Determine peer name ip=%s\n", ipaddr);
2531 ast_variables_destroy(var);
2536 /* Peer found in realtime, now build it in memory */
2537 peer = build_peer(newpeername, var, NULL, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2539 ast_variables_destroy(var);
2543 if (option_debug > 2)
2544 ast_log(LOG_DEBUG,"-REALTIME- loading peer from database to memory. Name: %s. Peer objects: %d\n", peer->name, rpeerobjs);
2546 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2548 ast_copy_flags(&peer->flags[1],&global_flags[1], SIP_PAGE2_RTAUTOCLEAR|SIP_PAGE2_RTCACHEFRIENDS);
2549 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTAUTOCLEAR)) {
2550 if (peer->expire > -1) {
2551 ast_sched_del(sched, peer->expire);
2553 peer->expire = ast_sched_add(sched, (global_rtautoclear) * 1000, expire_register, (void *)peer);
2555 ASTOBJ_CONTAINER_LINK(&peerl,peer);
2557 ast_set_flag(&peer->flags[0], SIP_REALTIME);
2559 ast_variables_destroy(var);
2564 /*! \brief Support routine for find_peer */
2565 static int sip_addrcmp(char *name, struct sockaddr_in *sin)
2567 /* We know name is the first field, so we can cast */
2568 struct sip_peer *p = (struct sip_peer *) name;
2569 return !(!inaddrcmp(&p->addr, sin) ||
2570 (ast_test_flag(&p->flags[0], SIP_INSECURE_PORT) &&
2571 (p->addr.sin_addr.s_addr == sin->sin_addr.s_addr)));
2574 /*! \brief Locate peer by name or ip address
2575 * This is used on incoming SIP message to find matching peer on ip
2576 or outgoing message to find matching peer on name */
2577 static struct sip_peer *find_peer(const char *peer, struct sockaddr_in *sin, int realtime)
2579 struct sip_peer *p = NULL;
2582 p = ASTOBJ_CONTAINER_FIND(&peerl, peer);
2584 p = ASTOBJ_CONTAINER_FIND_FULL(&peerl, sin, name, sip_addr_hashfunc, 1, sip_addrcmp);
2587 p = realtime_peer(peer, sin);
2592 /*! \brief Remove user object from in-memory storage */
2593 static void sip_destroy_user(struct sip_user *user)
2595 if (option_debug > 2)
2596 ast_log(LOG_DEBUG, "Destroying user object from memory: %s\n", user->name);
2597 ast_free_ha(user->ha);
2598 if (user->chanvars) {
2599 ast_variables_destroy(user->chanvars);
2600 user->chanvars = NULL;
2602 if (ast_test_flag(&user->flags[0], SIP_REALTIME))
2609 /*! \brief Load user from realtime storage
2610 * Loads user from "sipusers" category in realtime (extconfig.conf)
2611 * Users are matched on From: user name (the domain in skipped) */
2612 static struct sip_user *realtime_user(const char *username)
2614 struct ast_variable *var;
2615 struct ast_variable *tmp;
2616 struct sip_user *user = NULL;
2618 var = ast_load_realtime("sipusers", "name", username, NULL);
2623 for (tmp = var; tmp; tmp = tmp->next) {
2624 if (!strcasecmp(tmp->name, "type") &&
2625 !strcasecmp(tmp->value, "peer")) {
2626 ast_variables_destroy(var);
2631 user = build_user(username, var, !ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS));
2633 if (!user) { /* No user found */
2634 ast_variables_destroy(var);
2638 if (ast_test_flag(&global_flags[1], SIP_PAGE2_RTCACHEFRIENDS)) {
2639 ast_set_flag(&user->flags[1], SIP_PAGE2_RTCACHEFRIENDS);
2641 ASTOBJ_CONTAINER_LINK(&userl,user);
2643 /* Move counter from s to r... */
2646 ast_set_flag(&user->flags[0], SIP_REALTIME);
2648 ast_variables_destroy(var);
2652 /*! \brief Locate user by name
2653 * Locates user by name (From: sip uri user name part) first
2654 * from in-memory list (static configuration) then from
2655 * realtime storage (defined in extconfig.conf) */
2656 static struct sip_user *find_user(const char *name, int realtime)
2658 struct sip_user *u = ASTOBJ_CONTAINER_FIND(&userl, name);
2660 u = realtime_user(name);
2664 /*! \brief Set nat mode on the various data sockets */
2665 static void do_setnat(struct sip_pvt *p, int natflags)
2667 const char *mode = natflags ? "On" : "Off";
2671 ast_log(LOG_DEBUG, "Setting NAT on RTP to %s\n", mode);
2672 ast_rtp_setnat(p->rtp, natflags);
2676 ast_log(LOG_DEBUG, "Setting NAT on VRTP to %s\n", mode);
2677 ast_rtp_setnat(p->vrtp, natflags);
2681 ast_log(LOG_DEBUG, "Setting NAT on UDPTL to %s\n", mode);
2682 ast_udptl_setnat(p->udptl, natflags);
2686 /*! \brief Create address structure from peer reference.
2687 * return -1 on error, 0 on success.
2689 static int create_addr_from_peer(struct sip_pvt *dialog, struct sip_peer *peer)
2691 if ((peer->addr.sin_addr.s_addr || peer->defaddr.sin_addr.s_addr) &&
2692 (!peer->maxms || ((peer->lastms >= 0) && (peer->lastms <= peer->maxms)))) {
2693 dialog->sa = (peer->addr.sin_addr.s_addr) ? peer->addr : peer->defaddr;
2694 dialog->recv = dialog->sa;
2698 ast_copy_flags(&dialog->flags[0], &peer->flags[0], SIP_FLAGS_TO_COPY);
2699 ast_copy_flags(&dialog->flags[1], &peer->flags[1], SIP_PAGE2_FLAGS_TO_COPY);
2700 dialog->capability = peer->capability;
2701 if ((!ast_test_flag(&dialog->flags[1], SIP_PAGE2_VIDEOSUPPORT) || !(dialog->capability & AST_FORMAT_VIDEO_MASK)) && dialog->vrtp) {
2702 ast_rtp_destroy(dialog->vrtp);
2703 dialog->vrtp = NULL;
2705 dialog->prefs = peer->prefs;
2706 if (ast_test_flag(&dialog->flags[1], SIP_PAGE2_T38SUPPORT)) {
2707 dialog->t38.capability = global_t38_capability;
2708 if (dialog->udptl) {
2709 if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_FEC )
2710 dialog->t38.capability |= T38FAX_UDP_EC_FEC;
2711 else if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_REDUNDANCY )
2712 dialog->t38.capability |= T38FAX_UDP_EC_REDUNDANCY;
2713 else if (ast_udptl_get_error_correction_scheme(dialog->udptl) == UDPTL_ERROR_CORRECTION_NONE )
2714 dialog->t38.capability |= T38FAX_UDP_EC_NONE;
2715 dialog->t38.capability |= T38FAX_RATE_MANAGEMENT_TRANSFERED_TCF;
2716 if (option_debug > 1)
2717 ast_log(LOG_DEBUG,"Our T38 capability (%d)\n", dialog->t38.capability);
2719 dialog->t38.jointcapability = dialog->t38.capability;
2720 } else if (dialog->udptl) {
2721 ast_udptl_destroy(dialog->udptl);
2722 dialog->udptl = NULL;
2724 do_setnat(dialog, ast_test_flag(&dialog->flags[0], SIP_NAT) & SIP_NAT_ROUTE );
2727 ast_rtp_setdtmf(dialog->rtp, ast_test_flag(&dialog->flags[0], SIP_DTMF) != SIP_DTMF_INFO);
2728 ast_rtp_setdtmfcompensate(dialog->rtp, ast_test_flag(&dialog->flags[1], SIP_PAGE2_RFC2833_COMPENSATE));
2731 ast_rtp_setdtmf(dialog->vrtp, 0);
2732 ast_rtp_setdtmfcompensate(dialog->vrtp, 0);
2735 /* Set Frame packetization */
2737 ast_rtp_codec_setpref(dialog->rtp, &dialog->prefs);
2738 dialog->autoframing = peer->autoframing;
2740 ast_string_field_set(dialog, peername, peer->username);
2741 ast_string_field_set(dialog, authname, peer->username);
2742 ast_string_field_set(dialog, username, peer->username);
2743 ast_string_field_set(dialog, peersecret, peer->secret);
2744 ast_string_field_set(dialog, peermd5secret, peer->md5secret);
2745 ast_string_field_set(dialog, tohost, peer->tohost);
2746 ast_string_field_set(dialog, fullcontact, peer->fullcontact);
2747 if (!dialog->initreq.headers && !ast_strlen_zero(peer->fromdomain)) {
2750 tmpcall = ast_strdupa(dialog->callid);
2751 c = strchr(tmpcall, '@');
2754 ast_string_field_build(dialog, callid, "%s@%s", tmpcall, peer->fromdomain);
2757 if (ast_strlen_zero(dialog->tohost))
2758 ast_string_field_set(dialog, tohost, ast_inet_ntoa(dialog->sa.sin_addr));
2759 if (!ast_strlen_zero(peer->fromdomain))
2760 ast_string_field_set(dialog, fromdomain, peer->fromdomain);
2761 if (!ast_strlen_zero(peer->fromuser))
2762 ast_string_field_set(dialog, fromuser, peer->fromuser);
2763 dialog->callgroup = peer->callgroup;
2764 dialog->pickupgroup = peer->pickupgroup;
2765 dialog->allowtransfer = peer->allowtransfer;
2766 /* Set timer T1 to RTT for this peer (if known by qualify=) */
2767 /* Minimum is settable or default to 100 ms */
2768 if (peer->maxms && peer->lastms)
2769 dialog->timer_t1 = peer->lastms < global_t1min ? global_t1min : peer->lastms;
2770 if ((ast_test_flag(&dialog->flags[0], SIP_DTMF) == SIP_DTMF_RFC2833) ||
2771 (ast_test_flag(&dialog->flags[0], SIP_DTMF) == SIP_DTMF_AUTO))
2772 dialog->noncodeccapability |= AST_RTP_DTMF;
2774 dialog->noncodeccapability &= ~AST_RTP_DTMF;
2775 ast_string_field_set(dialog, context, peer->context);
2776 dialog->rtptimeout = peer->rtptimeout;
2777 dialog->rtpholdtimeout = peer->rtpholdtimeout;
2778 dialog->rtpkeepalive = peer->rtpkeepalive;
2779 if (peer->call_limit)
2780 ast_set_flag(&dialog->flags[0], SIP_CALL_LIMIT);
2781 dialog->maxcallbitrate = peer->maxcallbitrate;
2786 /*! \brief create address structure from peer name
2787 * Or, if peer not found, find it in the global DNS
2788 * returns TRUE (-1) on failure, FALSE on success */
2789 static int create_addr(struct sip_pvt *dialog, const char *opeer)
2792 struct ast_hostent ahp;
2793 struct sip_peer *peer;
2796 char host[MAXHOSTNAMELEN], *hostn;
2799 ast_copy_string(peername, opeer, sizeof(peername));
2800 port = strchr(peername, ':');
2803 dialog->sa.sin_family = AF_INET;
2804 dialog->timer_t1 = SIP_TIMER_T1; /* Default SIP retransmission timer T1 (RFC 3261) */
2805 peer = find_peer(peername, NULL, 1);
2808 int res = create_addr_from_peer(dialog, peer);
2813 portno = port ? atoi(port) : STANDARD_SIP_PORT;
2814 if (global_srvlookup) {
2815 char service[MAXHOSTNAMELEN];
2819 snprintf(service, sizeof(service), "_sip._udp.%s", peername);
2820 ret = ast_get_srv(NULL, host, sizeof(host), &tportno, service);
2826 hp = ast_gethostbyname(hostn, &ahp);
2828 ast_log(LOG_WARNING, "No such host: %s\n", peername);
2831 ast_string_field_set(dialog, tohost, peername);
2832 memcpy(&dialog->sa.sin_addr, hp->h_addr, sizeof(dialog->sa.sin_addr));
2833 dialog->sa.sin_port = htons(portno);
2834 dialog->recv = dialog->sa;
2838 /*! \brief Scheduled congestion on a call */
2839 static int auto_congest(void *nothing)
2841 struct sip_pvt *p = nothing;
2846 /* XXX fails on possible deadlock */
2847 if (!ast_channel_trylock(p->owner)) {
2848 ast_log(LOG_NOTICE, "Auto-congesting %s\n", p->owner->name);
2849 append_history(p, "Cong", "Auto-congesting (timer)");
2850 ast_queue_control(p->owner, AST_CONTROL_CONGESTION);
2851 ast_channel_unlock(p->owner);
2859 /*! \brief Initiate SIP call from PBX
2860 * used from the dial() application */
2861 static int sip_call(struct ast_channel *ast, char *dest, int timeout)
2865 struct varshead *headp;
2866 struct ast_var_t *current;
2867 const char *referer = NULL; /* SIP refererer */
2870 if ((ast->_state != AST_STATE_DOWN) && (ast->_state != AST_STATE_RESERVED)) {
2871 ast_log(LOG_WARNING, "sip_call called on %s, neither down nor reserved\n", ast->name);
2875 /* Check whether there is vxml_url, distinctive ring variables */
2876 headp=&ast->varshead;
2877 AST_LIST_TRAVERSE(headp,current,entries) {
2878 /* Check whether there is a VXML_URL variable */
2879 if (!p->options->vxml_url && !strcasecmp(ast_var_name(current), "VXML_URL")) {
2880 p->options->vxml_url = ast_var_value(current);
2881 } else if (!p->options->uri_options && !strcasecmp(ast_var_name(current), "SIP_URI_OPTIONS")) {
2882 p->options->uri_options = ast_var_value(current);
2883 } else if (!p->options->addsipheaders && !strncasecmp(ast_var_name(current), "SIPADDHEADER", strlen("SIPADDHEADER"))) {
2884 /* Check whether there is a variable with a name starting with SIPADDHEADER */
2885 p->options->addsipheaders = 1;
2886 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER")) {
2887 /* This is a transfered call */
2888 p->options->transfer = 1;
2889 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER_REFERER")) {
2890 /* This is the referer */
2891 referer = ast_var_value(current);
2892 } else if (!strcasecmp(ast_var_name(current), "SIPTRANSFER_REPLACES")) {
2893 /* We're replacing a call. */
2894 p->options->replaces = ast_var_value(current);
2895 } else if (!strcasecmp(ast_var_name(current), "T38CALL")) {
2896 p->t38.state = T38_LOCAL_DIRECT;
2898 ast_log(LOG_DEBUG,"T38State change to %d on channel %s\n", p->t38.state, ast->name);
2904 ast_set_flag(&p->flags[0], SIP_OUTGOING);
2906 if (p->options->transfer) {
2910 if (sipdebug && option_debug > 2)
2911 ast_log(LOG_DEBUG, "Call for %s transfered by %s\n", p->username, referer);
2912 snprintf(buf, sizeof(buf)-1, "-> %s (via %s)", p->cid_name, referer);
2914 snprintf(buf, sizeof(buf)-1, "-> %s", p->cid_name);
2915 ast_string_field_set(p, cid_name, buf);
2918 ast_log(LOG_DEBUG, "Outgoing Call for %s\n", p->username);
2920 res = update_call_counter(p, INC_CALL_RINGING);
2925 p->callingpres = ast->cid.cid_pres;
2926 p->jointcapability = ast_translate_available_formats(p->capability, p->prefcodec);
2928 /* If there are no audio formats left to offer, punt */
2929 if (!(p->jointcapability & AST_FORMAT_AUDIO_MASK)) {
2930 ast_log(LOG_WARNING, "No audio format found to offer. Cancelling call to %s\n", p->username);
2933 p->t38.jointcapability = p->t38.capability;
2934 if (option_debug > 1)
2935 ast_log(LOG_DEBUG,"Our T38 capability (%d), joint T38 capability (%d)\n", p->t38.capability, p->t38.jointcapability);
2936 transmit_invite(p, SIP_INVITE, 1, 2);
2937 p->invitestate = INV_CALLING;
2939 /* Initialize auto-congest time */
2940 p->initid = ast_sched_add(sched, SIP_TRANS_TIMEOUT, auto_congest, p);
2946 /*! \brief Destroy registry object
2947 Objects created with the register= statement in static configuration */
2948 static void sip_registry_destroy(struct sip_registry *reg)
2951 if (option_debug > 2)
2952 ast_log(LOG_DEBUG, "Destroying registry entry for %s@%s\n", reg->username, reg->hostname);
2955 /* Clear registry before destroying to ensure
2956 we don't get reentered trying to grab the registry lock */
2957 reg->call->registry = NULL;
2958 if (option_debug > 2)
2959 ast_log(LOG_DEBUG, "Destroying active SIP dialog for registry %s@%s\n", reg->username, reg->hostname);
2960 sip_destroy(reg->call);
2962 if (reg->expire > -1)
2963 ast_sched_del(sched, reg->expire);
2964 if (reg->timeout > -1)
2965 ast_sched_del(sched, reg->timeout);
2966 ast_string_field_free_pools(reg);
2972 /*! \brief Execute destruction of SIP dialog structure, release memory */
2973 static void __sip_destroy(struct sip_pvt *p, int lockowner, int lockdialoglist)
2975 struct sip_pvt *cur, *prev = NULL;
2978 if (sip_debug_test_pvt(p) || option_debug > 2)
2979 ast_verbose("Really destroying SIP dialog '%s' Method: %s\n", p->callid, sip_methods[p->method].text);
2981 /* Remove link from peer to subscription of MWI */
2982 if (p->relatedpeer && p->relatedpeer->mwipvt)
2983 p->relatedpeer->mwipvt = NULL;
2986 sip_dump_history(p);
2991 if (p->stateid > -1)
2992 ast_extension_state_del(p->stateid, NULL);
2994 ast_sched_del(sched, p->initid);
2995 if (p->autokillid > -1)
2996 ast_sched_del(sched, p->autokillid);
2999 ast_rtp_destroy(p->rtp);
3001 ast_rtp_destroy(p->vrtp);
3003 ast_udptl_destroy(p->udptl);
3007 free_old_route(p->route);
3011 if (p->registry->call == p)
3012 p->registry->call = NULL;
3013 unref_registry(p->registry);
3016 /* Unlink us from the owner if we have one */
3019 ast_channel_lock(p->owner);
3021 ast_log(LOG_DEBUG, "Detaching from %s\n", p->owner->name);
3022 p->owner->tech_pvt = NULL;
3024 ast_channel_unlock(p->owner);
3028 struct sip_history *hist;
3029 while( (hist = AST_LIST_REMOVE_HEAD(p->history, list)) )
3035 /* Lock dialog list before removing ourselves from the list */
3038 for (prev = NULL, cur = dialoglist; cur; prev = cur, cur = cur->next) {
3040 UNLINK(cur, dialoglist, prev);
3045 dialoglist_unlock();
3047 ast_log(LOG_WARNING, "Trying to destroy \"%s\", not found in dialog list?!?! \n", p->callid);