Merge "pjsip: Fix a few media bugs with reinvites and asymmetric payloads."
[asterisk/asterisk.git] / include / asterisk / res_pjsip.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _RES_PJSIP_H
20 #define _RES_PJSIP_H
21
22 #include <pjsip.h>
23 /* Needed for SUBSCRIBE, NOTIFY, and PUBLISH method definitions */
24 #include <pjsip_simple.h>
25 #include <pjsip/sip_transaction.h>
26 #include <pj/timer.h>
27 #include <pjlib.h>
28
29 #include "asterisk/stringfields.h"
30 /* Needed for struct ast_sockaddr */
31 #include "asterisk/netsock2.h"
32 /* Needed for linked list macros */
33 #include "asterisk/linkedlists.h"
34 /* Needed for ast_party_id */
35 #include "asterisk/channel.h"
36 /* Needed for ast_sorcery */
37 #include "asterisk/sorcery.h"
38 /* Needed for ast_dnsmgr */
39 #include "asterisk/dnsmgr.h"
40 /* Needed for ast_endpoint */
41 #include "asterisk/endpoints.h"
42 /* Needed for ast_t38_ec_modes */
43 #include "asterisk/udptl.h"
44 /* Needed for pj_sockaddr */
45 #include <pjlib.h>
46 /* Needed for ast_rtp_dtls_cfg struct */
47 #include "asterisk/rtp_engine.h"
48 /* Needed for AST_VECTOR macro */
49 #include "asterisk/vector.h"
50 /* Needed for ast_sip_for_each_channel_snapshot struct */
51 #include "asterisk/stasis_channels.h"
52 #include "asterisk/stasis_endpoints.h"
53
54 /* Forward declarations of PJSIP stuff */
55 struct pjsip_rx_data;
56 struct pjsip_module;
57 struct pjsip_tx_data;
58 struct pjsip_dialog;
59 struct pjsip_transport;
60 struct pjsip_tpfactory;
61 struct pjsip_tls_setting;
62 struct pjsip_tpselector;
63
64 /*! \brief Maximum number of ciphers supported for a TLS transport */
65 #define SIP_TLS_MAX_CIPHERS 64
66
67 /*!
68  * \brief Structure for SIP transport information
69  */
70 struct ast_sip_transport_state {
71         /*! \brief Transport itself */
72         struct pjsip_transport *transport;
73         /*! \brief Transport factory */
74         struct pjsip_tpfactory *factory;
75         /*!
76          * Transport id
77          * \since 13.8.0
78          */
79         char *id;
80         /*!
81          * Transport type
82          * \since 13.8.0
83          */
84         enum ast_transport type;
85         /*!
86          * Address and port to bind to
87          * \since 13.8.0
88          */
89         pj_sockaddr host;
90         /*!
91          * TLS settings
92          * \since 13.8.0
93          */
94         pjsip_tls_setting tls;
95         /*!
96          * Configured TLS ciphers
97          * \since 13.8.0
98          */
99         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
100         /*!
101          * Optional local network information, used for NAT purposes
102          * \since 13.8.0
103          */
104         struct ast_ha *localnet;
105         /*!
106          * DNS manager for refreshing the external address
107          * \since 13.8.0
108          */
109         struct ast_dnsmgr_entry *external_address_refresher;
110         /*!
111          * Optional external address information
112          * \since 13.8.0
113          */
114         struct ast_sockaddr external_address;
115 };
116
117 /*
118  * \brief Transport to bind to
119  */
120 struct ast_sip_transport {
121         /*! Sorcery object details */
122         SORCERY_OBJECT(details);
123         AST_DECLARE_STRING_FIELDS(
124                 /*! Certificate of authority list file */
125                 AST_STRING_FIELD(ca_list_file);
126                 /*! Certificate of authority list path */
127                 AST_STRING_FIELD(ca_list_path);
128                 /*! Public certificate file */
129                 AST_STRING_FIELD(cert_file);
130                 /*! Optional private key of the certificate file */
131                 AST_STRING_FIELD(privkey_file);
132                 /*! Password to open the private key */
133                 AST_STRING_FIELD(password);
134                 /*! External signaling address */
135                 AST_STRING_FIELD(external_signaling_address);
136                 /*! External media address */
137                 AST_STRING_FIELD(external_media_address);
138                 /*! Optional domain to use for messages if provided could not be found */
139                 AST_STRING_FIELD(domain);
140                 );
141         /*! Type of transport */
142         enum ast_transport type;
143         /*!
144          * \deprecated Moved to ast_sip_transport_state
145          * \version 13.8.0 deprecated
146          * Address and port to bind to
147          */
148         pj_sockaddr host;
149         /*! Number of simultaneous asynchronous operations */
150         unsigned int async_operations;
151         /*! Optional external port for signaling */
152         unsigned int external_signaling_port;
153         /*!
154          * \deprecated Moved to ast_sip_transport_state
155          * \version 13.7.1 deprecated
156          * TLS settings
157          */
158         pjsip_tls_setting tls;
159         /*!
160          * \deprecated Moved to ast_sip_transport_state
161          * \version 13.7.1 deprecated
162          * Configured TLS ciphers
163          */
164         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
165         /*!
166          * \deprecated Moved to ast_sip_transport_state
167          * \version 13.7.1 deprecated
168          * Optional local network information, used for NAT purposes
169          */
170         struct ast_ha *localnet;
171         /*!
172          * \deprecated Moved to ast_sip_transport_state
173          * \version 13.7.1 deprecated
174          * DNS manager for refreshing the external address
175          */
176         struct ast_dnsmgr_entry *external_address_refresher;
177         /*!
178          * \deprecated Moved to ast_sip_transport_state
179          * \version 13.7.1 deprecated
180          * Optional external address information
181          */
182         struct ast_sockaddr external_address;
183         /*!
184          * \deprecated
185          * \version 13.7.1 deprecated
186          * Transport state information
187          */
188         struct ast_sip_transport_state *state;
189         /*! QOS DSCP TOS bits */
190         unsigned int tos;
191         /*! QOS COS value */
192         unsigned int cos;
193         /*! Write timeout */
194         int write_timeout;
195         /*! Allow reload */
196         int allow_reload;
197 };
198
199 #define SIP_SORCERY_DOMAIN_ALIAS_TYPE "domain_alias"
200
201 /*!
202  * Details about a SIP domain alias
203  */
204 struct ast_sip_domain_alias {
205         /*! Sorcery object details */
206         SORCERY_OBJECT(details);
207         AST_DECLARE_STRING_FIELDS(
208                 /*! Domain to be aliased to */
209                 AST_STRING_FIELD(domain);
210         );
211 };
212
213 /*!
214  * \brief Structure for SIP nat hook information
215  */
216 struct ast_sip_nat_hook {
217         /*! Sorcery object details */
218         SORCERY_OBJECT(details);
219         /*! Callback for when a message is going outside of our local network */
220         void (*outgoing_external_message)(struct pjsip_tx_data *tdata, struct ast_sip_transport *transport);
221 };
222
223 /*!
224  * \brief Contact associated with an address of record
225  */
226 struct ast_sip_contact {
227         /*! Sorcery object details, the id is the aor name plus a random string */
228         SORCERY_OBJECT(details);
229         AST_DECLARE_STRING_FIELDS(
230                 /*! Full URI of the contact */
231                 AST_STRING_FIELD(uri);
232                 /*! Outbound proxy to use for qualify */
233                 AST_STRING_FIELD(outbound_proxy);
234                 /*! Path information to place in Route headers */
235                 AST_STRING_FIELD(path);
236                 /*! Content of the User-Agent header in REGISTER request */
237                 AST_STRING_FIELD(user_agent);
238                 /*! The name of the aor this contact belongs to */
239                 AST_STRING_FIELD(aor);
240         );
241         /*! Absolute time that this contact is no longer valid after */
242         struct timeval expiration_time;
243         /*! Frequency to send OPTIONS requests to contact. 0 is disabled. */
244         unsigned int qualify_frequency;
245         /*! If true authenticate the qualify if needed */
246         int authenticate_qualify;
247         /*! Qualify timeout. 0 is diabled. */
248         double qualify_timeout;
249         /*! Endpoint that added the contact, only available in observers */
250         struct ast_sip_endpoint *endpoint;
251         /*! Asterisk Server name */
252         AST_STRING_FIELD_EXTENDED(reg_server);
253         /*! IP-address of the Via header in REGISTER request */
254         AST_STRING_FIELD_EXTENDED(via_addr);
255         /* Port of the Via header in REGISTER request */
256         int via_port;
257         /*! Content of the Call-ID header in REGISTER request */
258         AST_STRING_FIELD_EXTENDED(call_id);
259         /*! The name of the endpoint that added the contact */
260         AST_STRING_FIELD_EXTENDED(endpoint_name);
261 };
262
263 #define CONTACT_STATUS "contact_status"
264
265 /*!
266  * \brief Status type for a contact.
267  */
268 enum ast_sip_contact_status_type {
269         UNAVAILABLE,
270         AVAILABLE,
271         UNKNOWN,
272         CREATED,
273         REMOVED,
274 };
275
276 /*!
277  * \brief A contact's status.
278  *
279  * \detail Maintains a contact's current status and round trip time
280  *         if available.
281  */
282 struct ast_sip_contact_status {
283         SORCERY_OBJECT(details);
284         AST_DECLARE_STRING_FIELDS(
285                 /*! The original contact's URI */
286                 AST_STRING_FIELD(uri);
287                 /*! The name of the aor this contact_status belongs to */
288                 AST_STRING_FIELD(aor);
289         );
290         /*! Current status for a contact (default - unavailable) */
291         enum ast_sip_contact_status_type status;
292         /*! The round trip start time set before sending a qualify request */
293         struct timeval rtt_start;
294         /*! The round trip time in microseconds */
295         int64_t rtt;
296         /*! Last status for a contact (default - unavailable) */
297         enum ast_sip_contact_status_type last_status;
298         /*! TRUE if the contact was refreshed. e.g., re-registered */
299         unsigned int refresh:1;
300 };
301
302 /*!
303  * \brief A SIP address of record
304  */
305 struct ast_sip_aor {
306         /*! Sorcery object details, the id is the AOR name */
307         SORCERY_OBJECT(details);
308         AST_DECLARE_STRING_FIELDS(
309                 /*! Voicemail boxes for this AOR */
310                 AST_STRING_FIELD(mailboxes);
311                 /*! Outbound proxy for OPTIONS requests */
312                 AST_STRING_FIELD(outbound_proxy);
313         );
314         /*! Minimum expiration time */
315         unsigned int minimum_expiration;
316         /*! Maximum expiration time */
317         unsigned int maximum_expiration;
318         /*! Default contact expiration if one is not provided in the contact */
319         unsigned int default_expiration;
320         /*! Frequency to send OPTIONS requests to AOR contacts. 0 is disabled. */
321         unsigned int qualify_frequency;
322         /*! If true authenticate the qualify if needed */
323         int authenticate_qualify;
324         /*! Maximum number of external contacts, 0 to disable */
325         unsigned int max_contacts;
326         /*! Whether to remove any existing contacts not related to an incoming REGISTER when it comes in */
327         unsigned int remove_existing;
328         /*! Any permanent configured contacts */
329         struct ao2_container *permanent_contacts;
330         /*! Determines whether SIP Path headers are supported */
331         unsigned int support_path;
332         /*! Qualify timeout. 0 is diabled. */
333         double qualify_timeout;
334         /* Voicemail extension to set in Message-Account */
335         char *voicemail_extension;
336 };
337
338 /*!
339  * \brief A wrapper for contact that adds the aor_id and
340  * a consistent contact id.  Used by ast_sip_for_each_contact.
341  */
342 struct ast_sip_contact_wrapper {
343         /*! The id of the parent aor. */
344         char *aor_id;
345         /*! The id of contact in form of aor_id/contact_uri. */
346         char *contact_id;
347         /*! Pointer to the actual contact. */
348         struct ast_sip_contact *contact;
349 };
350
351 /*!
352  * \brief DTMF modes for SIP endpoints
353  */
354 enum ast_sip_dtmf_mode {
355         /*! No DTMF to be used */
356         AST_SIP_DTMF_NONE,
357         /* XXX Should this be 2833 instead? */
358         /*! Use RFC 4733 events for DTMF */
359         AST_SIP_DTMF_RFC_4733,
360         /*! Use DTMF in the audio stream */
361         AST_SIP_DTMF_INBAND,
362         /*! Use SIP INFO DTMF (blech) */
363         AST_SIP_DTMF_INFO,
364         /*! Use SIP 4733 if supported by the other side or INBAND if not */
365         AST_SIP_DTMF_AUTO,
366 };
367
368 /*!
369  * \brief Methods of storing SIP digest authentication credentials.
370  *
371  * Note that both methods result in MD5 digest authentication being
372  * used. The two methods simply alter how Asterisk determines the
373  * credentials for a SIP authentication
374  */
375 enum ast_sip_auth_type {
376         /*! Credentials stored as a username and password combination */
377         AST_SIP_AUTH_TYPE_USER_PASS,
378         /*! Credentials stored as an MD5 sum */
379         AST_SIP_AUTH_TYPE_MD5,
380         /*! Credentials not stored this is a fake auth */
381         AST_SIP_AUTH_TYPE_ARTIFICIAL
382 };
383
384 #define SIP_SORCERY_AUTH_TYPE "auth"
385
386 struct ast_sip_auth {
387         /*! Sorcery ID of the auth is its name */
388         SORCERY_OBJECT(details);
389         AST_DECLARE_STRING_FIELDS(
390                 /*! Identification for these credentials */
391                 AST_STRING_FIELD(realm);
392                 /*! Authentication username */
393                 AST_STRING_FIELD(auth_user);
394                 /*! Authentication password */
395                 AST_STRING_FIELD(auth_pass);
396                 /*! Authentication credentials in MD5 format (hash of user:realm:pass) */
397                 AST_STRING_FIELD(md5_creds);
398         );
399         /*! The time period (in seconds) that a nonce may be reused */
400         unsigned int nonce_lifetime;
401         /*! Used to determine what to use when authenticating */
402         enum ast_sip_auth_type type;
403 };
404
405 AST_VECTOR(ast_sip_auth_vector, const char *);
406
407 /*!
408  * \brief Different methods by which incoming requests can be matched to endpoints
409  */
410 enum ast_sip_endpoint_identifier_type {
411         /*! Identify based on user name in From header */
412         AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0),
413         /*! Identify based on user name in Auth header first, then From header */
414         AST_SIP_ENDPOINT_IDENTIFY_BY_AUTH_USERNAME = (1 << 1),
415 };
416 AST_VECTOR(ast_sip_identify_by_vector, enum ast_sip_endpoint_identifier_type);
417
418 enum ast_sip_session_refresh_method {
419         /*! Use reinvite to negotiate direct media */
420         AST_SIP_SESSION_REFRESH_METHOD_INVITE,
421         /*! Use UPDATE to negotiate direct media */
422         AST_SIP_SESSION_REFRESH_METHOD_UPDATE,
423 };
424
425 enum ast_sip_direct_media_glare_mitigation {
426         /*! Take no special action to mitigate reinvite glare */
427         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE,
428         /*! Do not send an initial direct media session refresh on outgoing call legs
429          * Subsequent session refreshes will be sent no matter the session direction
430          */
431         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING,
432         /*! Do not send an initial direct media session refresh on incoming call legs
433          * Subsequent session refreshes will be sent no matter the session direction
434          */
435         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING,
436 };
437
438 enum ast_sip_session_media_encryption {
439         /*! Invalid media encryption configuration */
440         AST_SIP_MEDIA_TRANSPORT_INVALID = 0,
441         /*! Do not allow any encryption of session media */
442         AST_SIP_MEDIA_ENCRYPT_NONE,
443         /*! Offer SDES-encrypted session media */
444         AST_SIP_MEDIA_ENCRYPT_SDES,
445         /*! Offer encrypted session media with datagram TLS key exchange */
446         AST_SIP_MEDIA_ENCRYPT_DTLS,
447 };
448
449 enum ast_sip_session_redirect {
450         /*! User portion of the target URI should be used as the target in the dialplan */
451         AST_SIP_REDIRECT_USER = 0,
452         /*! Target URI should be used as the target in the dialplan */
453         AST_SIP_REDIRECT_URI_CORE,
454         /*! Target URI should be used as the target within chan_pjsip itself */
455         AST_SIP_REDIRECT_URI_PJSIP,
456 };
457
458 /*!
459  * \brief Session timers options
460  */
461 struct ast_sip_timer_options {
462         /*! Minimum session expiration period, in seconds */
463         unsigned int min_se;
464         /*! Session expiration period, in seconds */
465         unsigned int sess_expires;
466 };
467
468 /*!
469  * \brief Endpoint configuration for SIP extensions.
470  *
471  * SIP extensions, in this case refers to features
472  * indicated in Supported or Required headers.
473  */
474 struct ast_sip_endpoint_extensions {
475         /*! Enabled SIP extensions */
476         unsigned int flags;
477         /*! Timer options */
478         struct ast_sip_timer_options timer;
479 };
480
481 /*!
482  * \brief Endpoint configuration for unsolicited MWI
483  */
484 struct ast_sip_mwi_configuration {
485         AST_DECLARE_STRING_FIELDS(
486                 /*! Configured voicemail boxes for this endpoint. Used for MWI */
487                 AST_STRING_FIELD(mailboxes);
488                 /*! Username to use when sending MWI NOTIFYs to this endpoint */
489                 AST_STRING_FIELD(fromuser);
490         );
491         /* Should mailbox states be combined into a single notification? */
492         unsigned int aggregate;
493         /* Should a subscribe replace unsolicited notifies? */
494         unsigned int subscribe_replaces_unsolicited;
495         /* Voicemail extension to set in Message-Account */
496         char *voicemail_extension;
497 };
498
499 /*!
500  * \brief Endpoint subscription configuration
501  */
502 struct ast_sip_endpoint_subscription_configuration {
503         /*! Indicates if endpoint is allowed to initiate subscriptions */
504         unsigned int allow;
505         /*! The minimum allowed expiration for subscriptions from endpoint */
506         unsigned int minexpiry;
507         /*! Message waiting configuration */
508         struct ast_sip_mwi_configuration mwi;
509         /* Context for SUBSCRIBE requests */
510         char context[AST_MAX_CONTEXT];
511 };
512
513 /*!
514  * \brief NAT configuration options for endpoints
515  */
516 struct ast_sip_endpoint_nat_configuration {
517         /*! Whether to force using the source IP address/port for sending responses */
518         unsigned int force_rport;
519         /*! Whether to rewrite the Contact header with the source IP address/port or not */
520         unsigned int rewrite_contact;
521 };
522
523 /*!
524  * \brief Party identification options for endpoints
525  *
526  * This includes caller ID, connected line, and redirecting-related options
527  */
528 struct ast_sip_endpoint_id_configuration {
529         struct ast_party_id self;
530         /*! Do we accept identification information from this endpoint */
531         unsigned int trust_inbound;
532         /*! Do we send private identification information to this endpoint? */
533         unsigned int trust_outbound;
534         /*! Do we send P-Asserted-Identity headers to this endpoint? */
535         unsigned int send_pai;
536         /*! Do we send Remote-Party-ID headers to this endpoint? */
537         unsigned int send_rpid;
538         /*! Do we send messages for connected line updates for unanswered incoming calls immediately to this endpoint? */
539         unsigned int rpid_immediate;
540         /*! Do we add Diversion headers to applicable outgoing requests/responses? */
541         unsigned int send_diversion;
542         /*! When performing connected line update, which method should be used */
543         enum ast_sip_session_refresh_method refresh_method;
544 };
545
546 /*!
547  * \brief Call pickup configuration options for endpoints
548  */
549 struct ast_sip_endpoint_pickup_configuration {
550         /*! Call group */
551         ast_group_t callgroup;
552         /*! Pickup group */
553         ast_group_t pickupgroup;
554         /*! Named call group */
555         struct ast_namedgroups *named_callgroups;
556         /*! Named pickup group */
557         struct ast_namedgroups *named_pickupgroups;
558 };
559
560 /*!
561  * \brief Configuration for one-touch INFO recording
562  */
563 struct ast_sip_info_recording_configuration {
564         AST_DECLARE_STRING_FIELDS(
565                 /*! Feature to enact when one-touch recording INFO with Record: On is received */
566                 AST_STRING_FIELD(onfeature);
567                 /*! Feature to enact when one-touch recording INFO with Record: Off is received */
568                 AST_STRING_FIELD(offfeature);
569         );
570         /*! Is one-touch recording permitted? */
571         unsigned int enabled;
572 };
573
574 /*!
575  * \brief Endpoint configuration options for INFO packages
576  */
577 struct ast_sip_endpoint_info_configuration {
578         /*! Configuration for one-touch recording */
579         struct ast_sip_info_recording_configuration recording;
580 };
581
582 /*!
583  * \brief RTP configuration for SIP endpoints
584  */
585 struct ast_sip_media_rtp_configuration {
586         AST_DECLARE_STRING_FIELDS(
587                 /*! Configured RTP engine for this endpoint. */
588                 AST_STRING_FIELD(engine);
589         );
590         /*! Whether IPv6 RTP is enabled or not */
591         unsigned int ipv6;
592         /*! Whether symmetric RTP is enabled or not */
593         unsigned int symmetric;
594         /*! Whether ICE support is enabled or not */
595         unsigned int ice_support;
596         /*! Whether to use the "ptime" attribute received from the endpoint or not */
597         unsigned int use_ptime;
598         /*! Do we use AVPF exclusively for this endpoint? */
599         unsigned int use_avpf;
600         /*! Do we force AVP, AVPF, SAVP, or SAVPF even for DTLS media streams? */
601         unsigned int force_avp;
602         /*! Do we use the received media transport in our answer SDP */
603         unsigned int use_received_transport;
604         /*! \brief DTLS-SRTP configuration information */
605         struct ast_rtp_dtls_cfg dtls_cfg;
606         /*! Should SRTP use a 32 byte tag instead of an 80 byte tag? */
607         unsigned int srtp_tag_32;
608         /*! Do we use media encryption? what type? */
609         enum ast_sip_session_media_encryption encryption;
610         /*! Do we want to optimistically support encryption if possible? */
611         unsigned int encryption_optimistic;
612         /*! Number of seconds between RTP keepalive packets */
613         unsigned int keepalive;
614         /*! Number of seconds before terminating channel due to lack of RTP (when not on hold) */
615         unsigned int timeout;
616         /*! Number of seconds before terminating channel due to lack of RTP (when on hold) */
617         unsigned int timeout_hold;
618 };
619
620 /*!
621  * \brief Direct media options for SIP endpoints
622  */
623 struct ast_sip_direct_media_configuration {
624         /*! Boolean indicating if direct_media is permissible */
625         unsigned int enabled;
626         /*! When using direct media, which method should be used */
627         enum ast_sip_session_refresh_method method;
628         /*! Take steps to mitigate glare for direct media */
629         enum ast_sip_direct_media_glare_mitigation glare_mitigation;
630         /*! Do not attempt direct media session refreshes if a media NAT is detected */
631         unsigned int disable_on_nat;
632 };
633
634 struct ast_sip_t38_configuration {
635         /*! Whether T.38 UDPTL support is enabled or not */
636         unsigned int enabled;
637         /*! Error correction setting for T.38 UDPTL */
638         enum ast_t38_ec_modes error_correction;
639         /*! Explicit T.38 max datagram value, may be 0 to indicate the remote side can be trusted */
640         unsigned int maxdatagram;
641         /*! Whether NAT Support is enabled for T.38 UDPTL sessions or not */
642         unsigned int nat;
643         /*! Whether to use IPv6 for UDPTL or not */
644         unsigned int ipv6;
645 };
646
647 /*!
648  * \brief Media configuration for SIP endpoints
649  */
650 struct ast_sip_endpoint_media_configuration {
651         AST_DECLARE_STRING_FIELDS(
652                 /*! Optional media address to use in SDP */
653                 AST_STRING_FIELD(address);
654                 /*! SDP origin username */
655                 AST_STRING_FIELD(sdpowner);
656                 /*! SDP session name */
657                 AST_STRING_FIELD(sdpsession);
658         );
659         /*! RTP media configuration */
660         struct ast_sip_media_rtp_configuration rtp;
661         /*! Direct media options */
662         struct ast_sip_direct_media_configuration direct_media;
663         /*! T.38 (FoIP) options */
664         struct ast_sip_t38_configuration t38;
665         /*! Configured codecs */
666         struct ast_format_cap *codecs;
667         /*! DSCP TOS bits for audio streams */
668         unsigned int tos_audio;
669         /*! Priority for audio streams */
670         unsigned int cos_audio;
671         /*! DSCP TOS bits for video streams */
672         unsigned int tos_video;
673         /*! Priority for video streams */
674         unsigned int cos_video;
675         /*! Is g.726 packed in a non standard way */
676         unsigned int g726_non_standard;
677         /*! Bind the RTP instance to the media_address */
678         unsigned int bind_rtp_to_media_address;
679 };
680
681 /*!
682  * \brief An entity with which Asterisk communicates
683  */
684 struct ast_sip_endpoint {
685         SORCERY_OBJECT(details);
686         AST_DECLARE_STRING_FIELDS(
687                 /*! Context to send incoming calls to */
688                 AST_STRING_FIELD(context);
689                 /*! Name of an explicit transport to use */
690                 AST_STRING_FIELD(transport);
691                 /*! Outbound proxy to use */
692                 AST_STRING_FIELD(outbound_proxy);
693                 /*! Explicit AORs to dial if none are specified */
694                 AST_STRING_FIELD(aors);
695                 /*! Musiconhold class to suggest that the other side use when placing on hold */
696                 AST_STRING_FIELD(mohsuggest);
697                 /*! Configured tone zone for this endpoint. */
698                 AST_STRING_FIELD(zone);
699                 /*! Configured language for this endpoint. */
700                 AST_STRING_FIELD(language);
701                 /*! Default username to place in From header */
702                 AST_STRING_FIELD(fromuser);
703                 /*! Domain to place in From header */
704                 AST_STRING_FIELD(fromdomain);
705                 /*! Context to route incoming MESSAGE requests to */
706                 AST_STRING_FIELD(message_context);
707                 /*! Accountcode to auto-set on channels */
708                 AST_STRING_FIELD(accountcode);
709         );
710         /*! Configuration for extensions */
711         struct ast_sip_endpoint_extensions extensions;
712         /*! Configuration relating to media */
713         struct ast_sip_endpoint_media_configuration media;
714         /*! SUBSCRIBE/NOTIFY configuration options */
715         struct ast_sip_endpoint_subscription_configuration subscription;
716         /*! NAT configuration */
717         struct ast_sip_endpoint_nat_configuration nat;
718         /*! Party identification options */
719         struct ast_sip_endpoint_id_configuration id;
720         /*! Configuration options for INFO packages */
721         struct ast_sip_endpoint_info_configuration info;
722         /*! Call pickup configuration */
723         struct ast_sip_endpoint_pickup_configuration pickup;
724         /*! Inbound authentication credentials */
725         struct ast_sip_auth_vector inbound_auths;
726         /*! Outbound authentication credentials */
727         struct ast_sip_auth_vector outbound_auths;
728         /*! DTMF mode to use with this endpoint */
729         enum ast_sip_dtmf_mode dtmf;
730         /*! Method(s) by which the endpoint should be identified. */
731         enum ast_sip_endpoint_identifier_type ident_method;
732         /*! Order of the method(s) by which the endpoint should be identified. */
733         struct ast_sip_identify_by_vector ident_method_order;
734         /*! Boolean indicating if ringing should be sent as inband progress */
735         unsigned int inband_progress;
736         /*! Pointer to the persistent Asterisk endpoint */
737         struct ast_endpoint *persistent;
738         /*! The number of channels at which busy device state is returned */
739         unsigned int devicestate_busy_at;
740         /*! Whether fax detection is enabled or not (CNG tone detection) */
741         unsigned int faxdetect;
742         /*! Determines if transfers (using REFER) are allowed by this endpoint */
743         unsigned int allowtransfer;
744         /*! Method used when handling redirects */
745         enum ast_sip_session_redirect redirect_method;
746         /*! Variables set on channel creation */
747         struct ast_variable *channel_vars;
748         /*! Whether to place a 'user=phone' parameter into the request URI if user is a number */
749         unsigned int usereqphone;
750         /*! Whether to pass through hold and unhold using re-invites with recvonly and sendrecv */
751         unsigned int moh_passthrough;
752         /*! Access control list */
753         struct ast_acl_list *acl;
754         /*! Restrict what IPs are allowed in the Contact header (for registration) */
755         struct ast_acl_list *contact_acl;
756         /*! The number of seconds into call to disable fax detection.  (0 = disabled) */
757         unsigned int faxdetect_timeout;
758         /*! Override the user on the outgoing Contact header with this value. */
759         char *contact_user;
760         /*! Whether to response SDP offer with single most preferred codec. */
761         unsigned int preferred_codec_only;
762         /*! Do we allow an asymmetric RTP codec? */
763         unsigned int asymmetric_rtp_codec;
764 };
765
766 /*!
767  * \brief Initialize an auth vector with the configured values.
768  *
769  * \param vector Vector to initialize
770  * \param auth_names Comma-separated list of names to set in the array
771  * \retval 0 Success
772  * \retval non-zero Failure
773  */
774 int ast_sip_auth_vector_init(struct ast_sip_auth_vector *vector, const char *auth_names);
775
776 /*!
777  * \brief Free contents of an auth vector.
778  *
779  * \param array Vector whose contents are to be freed
780  */
781 void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector);
782
783 /*!
784  * \brief Possible returns from ast_sip_check_authentication
785  */
786 enum ast_sip_check_auth_result {
787     /*! Authentication needs to be challenged */
788     AST_SIP_AUTHENTICATION_CHALLENGE,
789     /*! Authentication succeeded */
790     AST_SIP_AUTHENTICATION_SUCCESS,
791     /*! Authentication failed */
792     AST_SIP_AUTHENTICATION_FAILED,
793     /*! Authentication encountered some internal error */
794     AST_SIP_AUTHENTICATION_ERROR,
795 };
796
797 /*!
798  * \brief An interchangeable way of handling digest authentication for SIP.
799  *
800  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
801  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
802  * should take place and what credentials should be used when challenging and authenticating a request.
803  */
804 struct ast_sip_authenticator {
805     /*!
806      * \brief Check if a request requires authentication
807      * See ast_sip_requires_authentication for more details
808      */
809     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
810         /*!
811          * \brief Check that an incoming request passes authentication.
812          *
813          * The tdata parameter is useful for adding information such as digest challenges.
814          *
815          * \param endpoint The endpoint sending the incoming request
816          * \param rdata The incoming request
817          * \param tdata Tentative outgoing request.
818          */
819         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
820                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
821 };
822
823 /*!
824  * \brief an interchangeable way of responding to authentication challenges
825  *
826  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
827  * credentials.
828  */
829 struct ast_sip_outbound_authenticator {
830         /*!
831          * \brief Create a new request with authentication credentials
832          *
833          * \param auths A vector of IDs of auth sorcery objects
834          * \param challenge The SIP response with authentication challenge(s)
835          * \param old_request The request that received the auth challenge(s)
836          * \param new_request The new SIP request with challenge response(s)
837          * \retval 0 Successfully created new request
838          * \retval -1 Failed to create a new request
839          */
840         int (*create_request_with_auth)(const struct ast_sip_auth_vector *auths, struct pjsip_rx_data *challenge,
841                         struct pjsip_tx_data *old_request, struct pjsip_tx_data **new_request);
842 };
843
844 /*!
845  * \brief An entity responsible for identifying the source of a SIP message
846  */
847 struct ast_sip_endpoint_identifier {
848     /*!
849      * \brief Callback used to identify the source of a message.
850      * See ast_sip_identify_endpoint for more details
851      */
852     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
853 };
854
855 /*!
856  * \brief Register a SIP service in Asterisk.
857  *
858  * This is more-or-less a wrapper around pjsip_endpt_register_module().
859  * Registering a service makes it so that PJSIP will call into the
860  * service at appropriate times. For more information about PJSIP module
861  * callbacks, see the PJSIP documentation. Asterisk modules that call
862  * this function will likely do so at module load time.
863  *
864  * \param module The module that is to be registered with PJSIP
865  * \retval 0 Success
866  * \retval -1 Failure
867  */
868 int ast_sip_register_service(pjsip_module *module);
869
870 /*!
871  * This is the opposite of ast_sip_register_service().  Unregistering a
872  * service means that PJSIP will no longer call into the module any more.
873  * This will likely occur when an Asterisk module is unloaded.
874  *
875  * \param module The PJSIP module to unregister
876  */
877 void ast_sip_unregister_service(pjsip_module *module);
878
879 /*!
880  * \brief Register a SIP authenticator
881  *
882  * An authenticator has three main purposes:
883  * 1) Determining if authentication should be performed on an incoming request
884  * 2) Gathering credentials necessary for issuing an authentication challenge
885  * 3) Authenticating a request that has credentials
886  *
887  * Asterisk provides a default authenticator, but it may be replaced by a
888  * custom one if desired.
889  *
890  * \param auth The authenticator to register
891  * \retval 0 Success
892  * \retval -1 Failure
893  */
894 int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
895
896 /*!
897  * \brief Unregister a SIP authenticator
898  *
899  * When there is no authenticator registered, requests cannot be challenged
900  * or authenticated.
901  *
902  * \param auth The authenticator to unregister
903  */
904 void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
905
906  /*!
907  * \brief Register an outbound SIP authenticator
908  *
909  * An outbound authenticator is responsible for creating responses to
910  * authentication challenges by remote endpoints.
911  *
912  * \param auth The authenticator to register
913  * \retval 0 Success
914  * \retval -1 Failure
915  */
916 int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
917
918 /*!
919  * \brief Unregister an outbound SIP authenticator
920  *
921  * When there is no outbound authenticator registered, authentication challenges
922  * will be handled as any other final response would be.
923  *
924  * \param auth The authenticator to unregister
925  */
926 void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
927
928 /*!
929  * \brief Register a SIP endpoint identifier with a name.
930  *
931  * An endpoint identifier's purpose is to determine which endpoint a given SIP
932  * message has come from.
933  *
934  * Multiple endpoint identifiers may be registered so that if an endpoint
935  * cannot be identified by one identifier, it may be identified by another.
936  *
937  * \param identifier The SIP endpoint identifier to register
938  * \param name The name of the endpoint identifier
939  * \retval 0 Success
940  * \retval -1 Failure
941  */
942 int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
943                                                    const char *name);
944
945 /*!
946  * \brief Register a SIP endpoint identifier
947  *
948  * An endpoint identifier's purpose is to determine which endpoint a given SIP
949  * message has come from.
950  *
951  * Multiple endpoint identifiers may be registered so that if an endpoint
952  * cannot be identified by one identifier, it may be identified by another.
953  *
954  * Asterisk provides two endpoint identifiers. One identifies endpoints based
955  * on the user part of the From header URI. The other identifies endpoints based
956  * on the source IP address.
957  *
958  * If the order in which endpoint identifiers is run is important to you, then
959  * be sure to load individual endpoint identifier modules in the order you wish
960  * for them to be run in modules.conf
961  *
962  * \note endpoint identifiers registered using this method (no name specified)
963  *       are placed at the front of the endpoint identifiers list ahead of any
964  *       named identifiers.
965  *
966  * \param identifier The SIP endpoint identifier to register
967  * \retval 0 Success
968  * \retval -1 Failure
969  */
970 int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
971
972 /*!
973  * \brief Unregister a SIP endpoint identifier
974  *
975  * This stops an endpoint identifier from being used.
976  *
977  * \param identifier The SIP endoint identifier to unregister
978  */
979 void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
980
981 /*!
982  * \brief Allocate a new SIP endpoint
983  *
984  * This will return an endpoint with its refcount increased by one. This reference
985  * can be released using ao2_ref().
986  *
987  * \param name The name of the endpoint.
988  * \retval NULL Endpoint allocation failed
989  * \retval non-NULL The newly allocated endpoint
990  */
991 void *ast_sip_endpoint_alloc(const char *name);
992
993 /*!
994  * \brief Change state of a persistent endpoint.
995  *
996  * \param endpoint The SIP endpoint name to change state.
997  * \param state The new state
998  * \retval 0 Success
999  * \retval -1 Endpoint not found
1000  */
1001 int ast_sip_persistent_endpoint_update_state(const char *endpoint_name, enum ast_endpoint_state state);
1002
1003 /*!
1004  * \brief Get a pointer to the PJSIP endpoint.
1005  *
1006  * This is useful when modules have specific information they need
1007  * to register with the PJSIP core.
1008  * \retval NULL endpoint has not been created yet.
1009  * \retval non-NULL PJSIP endpoint.
1010  */
1011 pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
1012
1013 /*!
1014  * \brief Get a pointer to the SIP sorcery structure.
1015  *
1016  * \retval NULL sorcery has not been initialized
1017  * \retval non-NULL sorcery structure
1018  */
1019 struct ast_sorcery *ast_sip_get_sorcery(void);
1020
1021 /*!
1022  * \brief Retrieve a named AOR
1023  *
1024  * \param aor_name Name of the AOR
1025  *
1026  * \retval NULL if not found
1027  * \retval non-NULL if found
1028  */
1029 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
1030
1031 /*!
1032  * \brief Retrieve the first bound contact for an AOR
1033  *
1034  * \param aor Pointer to the AOR
1035  * \retval NULL if no contacts available
1036  * \retval non-NULL if contacts available
1037  */
1038 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
1039
1040 /*!
1041  * \brief Retrieve all contacts currently available for an AOR
1042  *
1043  * \param aor Pointer to the AOR
1044  *
1045  * \retval NULL if no contacts available
1046  * \retval non-NULL if contacts available
1047  *
1048  * \warning
1049  * Since this function prunes expired contacts before returning, it holds a named write
1050  * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
1051  */
1052 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
1053
1054 /*!
1055  * \brief Retrieve all contacts currently available for an AOR without locking the AOR
1056  * \since 13.9.0
1057  *
1058  * \param aor Pointer to the AOR
1059  *
1060  * \retval NULL if no contacts available
1061  * \retval non-NULL if contacts available
1062  *
1063  * \warning
1064  * This function should only be called if you already hold a named write lock on the aor.
1065  */
1066 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock(const struct ast_sip_aor *aor);
1067
1068 /*!
1069  * \brief Retrieve the first bound contact from a list of AORs
1070  *
1071  * \param aor_list A comma-separated list of AOR names
1072  * \retval NULL if no contacts available
1073  * \retval non-NULL if contacts available
1074  */
1075 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
1076
1077 /*!
1078  * \brief Retrieve all contacts from a list of AORs
1079  *
1080  * \param aor_list A comma-separated list of AOR names
1081  * \retval NULL if no contacts available
1082  * \retval non-NULL container (which must be freed) if contacts available
1083  */
1084 struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list);
1085
1086 /*!
1087  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs
1088  *
1089  * \param aor_list A comma-separated list of AOR names
1090  * \param aor The chosen AOR
1091  * \param contact The chosen contact
1092  */
1093  void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
1094         struct ast_sip_contact **contact);
1095
1096 /*!
1097  * \brief Retrieve a named contact
1098  *
1099  * \param contact_name Name of the contact
1100  *
1101  * \retval NULL if not found
1102  * \retval non-NULL if found
1103  */
1104 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
1105
1106 /*!
1107  * \brief Add a new contact to an AOR
1108  *
1109  * \param aor Pointer to the AOR
1110  * \param uri Full contact URI
1111  * \param expiration_time Optional expiration time of the contact
1112  * \param path_info Path information
1113  * \param user_agent User-Agent header from REGISTER request
1114  * \param endpoint The endpoint that resulted in the contact being added
1115  *
1116  * \retval -1 failure
1117  * \retval 0 success
1118  *
1119  * \warning
1120  * This function holds a named write lock on the aor.  If you already hold the lock
1121  * you should call ast_sip_location_add_contact_nolock instead.
1122  */
1123 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
1124         struct timeval expiration_time, const char *path_info, const char *user_agent,
1125         const char *via_addr, int via_port, const char *call_id,
1126         struct ast_sip_endpoint *endpoint);
1127
1128 /*!
1129  * \brief Add a new contact to an AOR without locking the AOR
1130  * \since 13.9.0
1131  *
1132  * \param aor Pointer to the AOR
1133  * \param uri Full contact URI
1134  * \param expiration_time Optional expiration time of the contact
1135  * \param path_info Path information
1136  * \param user_agent User-Agent header from REGISTER request
1137  * \param endpoint The endpoint that resulted in the contact being added
1138  *
1139  * \retval -1 failure
1140  * \retval 0 success
1141  *
1142  * \warning
1143  * This function should only be called if you already hold a named write lock on the aor.
1144  */
1145 int ast_sip_location_add_contact_nolock(struct ast_sip_aor *aor, const char *uri,
1146         struct timeval expiration_time, const char *path_info, const char *user_agent,
1147         const char *via_addr, int via_port, const char *call_id,
1148         struct ast_sip_endpoint *endpoint);
1149
1150 /*!
1151  * \brief Update a contact
1152  *
1153  * \param contact New contact object with details
1154  *
1155  * \retval -1 failure
1156  * \retval 0 success
1157  */
1158 int ast_sip_location_update_contact(struct ast_sip_contact *contact);
1159
1160 /*!
1161 * \brief Delete a contact
1162 *
1163 * \param contact Contact object to delete
1164 *
1165 * \retval -1 failure
1166 * \retval 0 success
1167 */
1168 int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
1169
1170 /*!
1171  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
1172  *
1173  * This callback will have the created request on it. The callback's purpose is to do any extra
1174  * housekeeping that needs to be done as well as to send the request out.
1175  *
1176  * This callback is only necessary if working with a PJSIP API that sits between the application
1177  * and the dialog layer.
1178  *
1179  * \param dlg The dialog to which the request belongs
1180  * \param tdata The created request to be sent out
1181  * \param user_data Data supplied with the callback
1182  *
1183  * \retval 0 Success
1184  * \retval -1 Failure
1185  */
1186 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
1187
1188 /*!
1189  * \brief Set up outbound authentication on a SIP dialog
1190  *
1191  * This sets up the infrastructure so that all requests associated with a created dialog
1192  * can be re-sent with authentication credentials if the original request is challenged.
1193  *
1194  * \param dlg The dialog on which requests will be authenticated
1195  * \param endpoint The endpoint whom this dialog pertains to
1196  * \param cb Callback to call to send requests with authentication
1197  * \param user_data Data to be provided to the callback when it is called
1198  *
1199  * \retval 0 Success
1200  * \retval -1 Failure
1201  */
1202 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
1203                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
1204
1205 /*!
1206  * \brief Retrieves a reference to the artificial auth.
1207  *
1208  * \retval The artificial auth
1209  */
1210 struct ast_sip_auth *ast_sip_get_artificial_auth(void);
1211
1212 /*!
1213  * \brief Retrieves a reference to the artificial endpoint.
1214  *
1215  * \retval The artificial endpoint
1216  */
1217 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
1218
1219 /*! \defgroup pjsip_threading PJSIP Threading Model
1220  * @{
1221  * \page PJSIP PJSIP Threading Model
1222  *
1223  * There are three major types of threads that SIP will have to deal with:
1224  * \li Asterisk threads
1225  * \li PJSIP threads
1226  * \li SIP threadpool threads (a.k.a. "servants")
1227  *
1228  * \par Asterisk Threads
1229  *
1230  * Asterisk threads are those that originate from outside of SIP but within
1231  * Asterisk. The most common of these threads are PBX (channel) threads and
1232  * the autoservice thread. Most interaction with these threads will be through
1233  * channel technology callbacks. Within these threads, it is fine to handle
1234  * Asterisk data from outside of SIP, but any handling of SIP data should be
1235  * left to servants, \b especially if you wish to call into PJSIP for anything.
1236  * Asterisk threads are not registered with PJLIB, so attempting to call into
1237  * PJSIP will cause an assertion to be triggered, thus causing the program to
1238  * crash.
1239  *
1240  * \par PJSIP Threads
1241  *
1242  * PJSIP threads are those that originate from handling of PJSIP events, such
1243  * as an incoming SIP request or response, or a transaction timeout. The role
1244  * of these threads is to process information as quickly as possible so that
1245  * the next item on the SIP socket(s) can be serviced. On incoming messages,
1246  * Asterisk automatically will push the request to a servant thread. When your
1247  * module callback is called, processing will already be in a servant. However,
1248  * for other PSJIP events, such as transaction state changes due to timer
1249  * expirations, your module will be called into from a PJSIP thread. If you
1250  * are called into from a PJSIP thread, then you should push whatever processing
1251  * is needed to a servant as soon as possible. You can discern if you are currently
1252  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
1253  *
1254  * \par Servants
1255  *
1256  * Servants are where the bulk of SIP work should be performed. These threads
1257  * exist in order to do the work that Asterisk threads and PJSIP threads hand
1258  * off to them. Servant threads register themselves with PJLIB, meaning that
1259  * they are capable of calling PJSIP and PJLIB functions if they wish.
1260  *
1261  * \par Serializer
1262  *
1263  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
1264  * The first parameter of this call is a serializer. If this pointer
1265  * is NULL, then the work will be handed off to whatever servant can currently handle
1266  * the task. If this pointer is non-NULL, then the task will not be executed until
1267  * previous tasks pushed with the same serializer have completed. For more information
1268  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
1269  *
1270  * \par Scheduler
1271  *
1272  * Some situations require that a task run periodically or at a future time.  Normally
1273  * the ast_sched functionality would be used but ast_sched only uses 1 thread for all
1274  * tasks and that thread isn't registered with PJLIB and therefore can't do any PJSIP
1275  * related work.
1276  *
1277  * ast_sip_sched uses ast_sched only as a scheduled queue.  When a task is ready to run,
1278  * it's pushed to a Serializer to be invoked asynchronously by a Servant.  This ensures
1279  * that the task is executed in a PJLIB registered thread and allows the ast_sched thread
1280  * to immediately continue processing the queue.  The Serializer used by ast_sip_sched
1281  * is one of your choosing or a random one from the res_pjsip pool if you don't choose one.
1282  *
1283  * \note
1284  *
1285  * Do not make assumptions about individual threads based on a corresponding serializer.
1286  * In other words, just because several tasks use the same serializer when being pushed
1287  * to servants, it does not mean that the same thread is necessarily going to execute those
1288  * tasks, even though they are all guaranteed to be executed in sequence.
1289  */
1290
1291 typedef int (*ast_sip_task)(void *user_data);
1292
1293 /*!
1294  * \brief Create a new serializer for SIP tasks
1295  * \since 13.8.0
1296  *
1297  * See \ref ast_threadpool_serializer for more information on serializers.
1298  * SIP creates serializers so that tasks operating on similar data will run
1299  * in sequence.
1300  *
1301  * \param name Name of the serializer. (must be unique)
1302  *
1303  * \retval NULL Failure
1304  * \retval non-NULL Newly-created serializer
1305  */
1306 struct ast_taskprocessor *ast_sip_create_serializer(const char *name);
1307
1308 struct ast_serializer_shutdown_group;
1309
1310 /*!
1311  * \brief Create a new serializer for SIP tasks
1312  * \since 13.8.0
1313  *
1314  * See \ref ast_threadpool_serializer for more information on serializers.
1315  * SIP creates serializers so that tasks operating on similar data will run
1316  * in sequence.
1317  *
1318  * \param name Name of the serializer. (must be unique)
1319  * \param shutdown_group Group shutdown controller. (NULL if no group association)
1320  *
1321  * \retval NULL Failure
1322  * \retval non-NULL Newly-created serializer
1323  */
1324 struct ast_taskprocessor *ast_sip_create_serializer_group(const char *name, struct ast_serializer_shutdown_group *shutdown_group);
1325
1326 /*!
1327  * \brief Determine the distributor serializer for the SIP message.
1328  * \since 13.10.0
1329  *
1330  * \param rdata The incoming message.
1331  *
1332  * \retval Calculated distributor serializer on success.
1333  * \retval NULL on error.
1334  */
1335 struct ast_taskprocessor *ast_sip_get_distributor_serializer(pjsip_rx_data *rdata);
1336
1337 /*!
1338  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
1339  *
1340  * Passing a NULL serializer is a way to remove a serializer from a dialog.
1341  *
1342  * \param dlg The SIP dialog itself
1343  * \param serializer The serializer to use
1344  */
1345 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
1346
1347 /*!
1348  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
1349  *
1350  * \param dlg The SIP dialog itself
1351  * \param endpoint The endpoint that this dialog is communicating with
1352  */
1353 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1354
1355 /*!
1356  * \brief Get the endpoint associated with this dialog
1357  *
1358  * This function increases the refcount of the endpoint by one. Release
1359  * the reference once you are finished with the endpoint.
1360  *
1361  * \param dlg The SIP dialog from which to retrieve the endpoint
1362  * \retval NULL No endpoint associated with this dialog
1363  * \retval non-NULL The endpoint.
1364  */
1365 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
1366
1367 /*!
1368  * \brief Pushes a task to SIP servants
1369  *
1370  * This uses the serializer provided to determine how to push the task.
1371  * If the serializer is NULL, then the task will be pushed to the
1372  * servants directly. If the serializer is non-NULL, then the task will be
1373  * queued behind other tasks associated with the same serializer.
1374  *
1375  * \param serializer The serializer to which the task belongs. Can be NULL
1376  * \param sip_task The task to execute
1377  * \param task_data The parameter to pass to the task when it executes
1378  * \retval 0 Success
1379  * \retval -1 Failure
1380  */
1381 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1382
1383 /*!
1384  * \brief Push a task to SIP servants and wait for it to complete
1385  *
1386  * Like \ref ast_sip_push_task except that it blocks until the task completes.
1387  *
1388  * \warning \b Never use this function in a SIP servant thread. This can potentially
1389  * cause a deadlock. If you are in a SIP servant thread, just call your function
1390  * in-line.
1391  *
1392  * \warning \b Never hold locks that may be acquired by a SIP servant thread when
1393  * calling this function. Doing so may cause a deadlock if all SIP servant threads
1394  * are blocked waiting to acquire the lock while the thread holding the lock is
1395  * waiting for a free SIP servant thread.
1396  *
1397  * \param serializer The SIP serializer to which the task belongs. May be NULL.
1398  * \param sip_task The task to execute
1399  * \param task_data The parameter to pass to the task when it executes
1400  * \retval 0 Success
1401  * \retval -1 Failure
1402  */
1403 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1404
1405 /*!
1406  * \brief Determine if the current thread is a SIP servant thread
1407  *
1408  * \retval 0 This is not a SIP servant thread
1409  * \retval 1 This is a SIP servant thread
1410  */
1411 int ast_sip_thread_is_servant(void);
1412
1413 /*!
1414  * \brief Task flags for the res_pjsip scheduler
1415  *
1416  * The default is AST_SIP_SCHED_TASK_FIXED
1417  *                | AST_SIP_SCHED_TASK_DATA_NOT_AO2
1418  *                | AST_SIP_SCHED_TASK_DATA_NO_CLEANUP
1419  *                | AST_SIP_SCHED_TASK_PERIODIC
1420  */
1421 enum ast_sip_scheduler_task_flags {
1422         /*!
1423          * The defaults
1424          */
1425         AST_SIP_SCHED_TASK_DEFAULTS = (0 << 0),
1426
1427         /*!
1428          * Run at a fixed interval.
1429          * Stop scheduling if the callback returns 0.
1430          * Any other value is ignored.
1431          */
1432         AST_SIP_SCHED_TASK_FIXED = (0 << 0),
1433         /*!
1434          * Run at a variable interval.
1435          * Stop scheduling if the callback returns 0.
1436          * Any other return value is used as the new interval.
1437          */
1438         AST_SIP_SCHED_TASK_VARIABLE = (1 << 0),
1439
1440         /*!
1441          * The task data is not an AO2 object.
1442          */
1443         AST_SIP_SCHED_TASK_DATA_NOT_AO2 = (0 << 1),
1444         /*!
1445          * The task data is an AO2 object.
1446          * A reference count will be held by the scheduler until
1447          * after the task has run for the final time (if ever).
1448          */
1449         AST_SIP_SCHED_TASK_DATA_AO2 = (1 << 1),
1450
1451         /*!
1452          * Don't take any cleanup action on the data
1453          */
1454         AST_SIP_SCHED_TASK_DATA_NO_CLEANUP = (0 << 3),
1455         /*!
1456          * If AST_SIP_SCHED_TASK_DATA_AO2 is set, decrement the reference count
1457          * otherwise call ast_free on it.
1458          */
1459         AST_SIP_SCHED_TASK_DATA_FREE = ( 1 << 3 ),
1460
1461         /*! \brief AST_SIP_SCHED_TASK_PERIODIC
1462          * The task is scheduled at multiples of interval
1463          * \see Interval
1464          */
1465         AST_SIP_SCHED_TASK_PERIODIC = (0 << 4),
1466         /*! \brief AST_SIP_SCHED_TASK_DELAY
1467          * The next invocation of the task is at last finish + interval
1468          * \see Interval
1469          */
1470         AST_SIP_SCHED_TASK_DELAY = (1 << 4),
1471 };
1472
1473 /*!
1474  * \brief Scheduler task data structure
1475  */
1476 struct ast_sip_sched_task;
1477
1478 /*!
1479  * \brief Schedule a task to run in the res_pjsip thread pool
1480  * \since 13.9.0
1481  *
1482  * \param serializer The serializer to use.  If NULL, don't use a serializer (see note below)
1483  * \param interval The invocation interval in milliseconds (see note below)
1484  * \param sip_task The task to invoke
1485  * \param name An optional name to associate with the task
1486  * \param task_data Optional data to pass to the task
1487  * \param flags One of enum ast_sip_scheduler_task_type
1488  *
1489  * \returns Pointer to \ref ast_sip_sched_task ao2 object which must be dereferenced when done.
1490  *
1491  * \paragraph Serialization
1492  *
1493  * Specifying a serializer guarantees serialized execution but NOT specifying a serializer
1494  * may still result in tasks being effectively serialized if the thread pool is busy.
1495  * The point of the serializer BTW is not to prevent parallel executions of the SAME task.
1496  * That happens automatically (see below).  It's to prevent the task from running at the same
1497  * time as other work using the same serializer, whether or not it's being run by the scheduler.
1498  *
1499  * \paragraph Interval
1500  *
1501  * The interval is used to calculate the next time the task should run.  There are two models.
1502  *
1503  * \ref AST_SIP_SCHED_TASK_PERIODIC specifies that the invocations of the task occur at the
1504  * specific interval.  That is, every \ref "interval" milliseconds, regardless of how long the task
1505  * takes. If the task takes longer than \ref interval, it will be scheduled at the next available
1506  * multiple of \ref interval.  For exmaple: If the task has an interval of 60 seconds and the task
1507  * takes 70 seconds, the next invocation will happen at 120 seconds.
1508  *
1509  * \ref AST_SIP_SCHED_TASK_DELAY specifies that the next invocation of the task should start
1510  * at \ref interval milliseconds after the current invocation has finished.
1511  *
1512  */
1513 struct ast_sip_sched_task *ast_sip_schedule_task(struct ast_taskprocessor *serializer,
1514         int interval, ast_sip_task sip_task, char *name, void *task_data,
1515         enum ast_sip_scheduler_task_flags flags);
1516
1517 /*!
1518  * \brief Cancels the next invocation of a task
1519  * \since 13.9.0
1520  *
1521  * \param schtd The task structure pointer
1522  * \retval 0 Success
1523  * \retval -1 Failure
1524  * \note Only cancels future invocations not the currently running invocation.
1525  */
1526 int ast_sip_sched_task_cancel(struct ast_sip_sched_task *schtd);
1527
1528 /*!
1529  * \brief Cancels the next invocation of a task by name
1530  * \since 13.9.0
1531  *
1532  * \param name The task name
1533  * \retval 0 Success
1534  * \retval -1 Failure
1535  * \note Only cancels future invocations not the currently running invocation.
1536  */
1537 int ast_sip_sched_task_cancel_by_name(const char *name);
1538
1539 /*!
1540  * \brief Gets the last start and end times of the task
1541  * \since 13.9.0
1542  *
1543  * \param schtd The task structure pointer
1544  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1545  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1546  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1547  * \retval 0 Success
1548  * \retval -1 Failure
1549  * \note Any of the pointers can be NULL if you don't need them.
1550  */
1551 int ast_sip_sched_task_get_times(struct ast_sip_sched_task *schtd,
1552         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1553
1554 /*!
1555  * \brief Gets the last start and end times of the task by name
1556  * \since 13.9.0
1557  *
1558  * \param name The task name
1559  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1560  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1561  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1562  * \retval 0 Success
1563  * \retval -1 Failure
1564  * \note Any of the pointers can be NULL if you don't need them.
1565  */
1566 int ast_sip_sched_task_get_times_by_name(const char *name,
1567         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1568
1569 /*!
1570  * \brief Gets the number of milliseconds until the next invocation
1571  * \since 13.9.0
1572  *
1573  * \param schtd The task structure pointer
1574  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1575  */
1576 int ast_sip_sched_task_get_next_run(struct ast_sip_sched_task *schtd);
1577
1578 /*!
1579  * \brief Gets the number of milliseconds until the next invocation
1580  * \since 13.9.0
1581  *
1582  * \param name The task name
1583  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1584  */
1585 int ast_sip_sched_task_get_next_run_by_name(const char *name);
1586
1587 /*!
1588  * \brief Checks if the task is currently running
1589  * \since 13.9.0
1590  *
1591  * \param schtd The task structure pointer
1592  * \retval 0 not running
1593  * \retval 1 running
1594  */
1595 int ast_sip_sched_is_task_running(struct ast_sip_sched_task *schtd);
1596
1597 /*!
1598  * \brief Checks if the task is currently running
1599  * \since 13.9.0
1600  *
1601  * \param name The task name
1602  * \retval 0 not running or not found
1603  * \retval 1 running
1604  */
1605 int ast_sip_sched_is_task_running_by_name(const char *name);
1606
1607 /*!
1608  * \brief Gets the task name
1609  * \since 13.9.0
1610  *
1611  * \param schtd The task structure pointer
1612  * \retval 0 success
1613  * \retval 1 failure
1614  */
1615 int ast_sip_sched_task_get_name(struct ast_sip_sched_task *schtd, char *name, size_t maxlen);
1616
1617 /*!
1618  *  @}
1619  */
1620
1621 /*!
1622  * \brief SIP body description
1623  *
1624  * This contains a type and subtype that will be added as
1625  * the "Content-Type" for the message as well as the body
1626  * text.
1627  */
1628 struct ast_sip_body {
1629         /*! Type of the body, such as "application" */
1630         const char *type;
1631         /*! Subtype of the body, such as "sdp" */
1632         const char *subtype;
1633         /*! The text to go in the body */
1634         const char *body_text;
1635 };
1636
1637 /*!
1638  * \brief General purpose method for creating a UAC dialog with an endpoint
1639  *
1640  * \param endpoint A pointer to the endpoint
1641  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
1642  * \param request_user Optional user to place into the target URI
1643  *
1644  * \retval non-NULL success
1645  * \retval NULL failure
1646  */
1647 pjsip_dialog *ast_sip_create_dialog_uac(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
1648
1649 /*!
1650  * \brief General purpose method for creating a UAS dialog with an endpoint
1651  *
1652  * \param endpoint A pointer to the endpoint
1653  * \param rdata The request that is starting the dialog
1654  * \param[out] status On failure, the reason for failure in creating the dialog
1655  */
1656 pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status);
1657
1658 /*!
1659  * \brief General purpose method for creating an rdata structure using specific information
1660  *
1661  * \param rdata[out] The rdata structure that will be populated
1662  * \param packet A SIP message
1663  * \param src_name The source IP address of the message
1664  * \param src_port The source port of the message
1665  * \param transport_type The type of transport the message was received on
1666  * \param local_name The local IP address the message was received on
1667  * \param local_port The local port the message was received on
1668  *
1669  * \retval 0 success
1670  * \retval -1 failure
1671  */
1672 int ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type,
1673         const char *local_name, int local_port);
1674
1675 /*!
1676  * \brief General purpose method for creating a SIP request
1677  *
1678  * Its typical use would be to create one-off requests such as an out of dialog
1679  * SIP MESSAGE.
1680  *
1681  * The request can either be in- or out-of-dialog. If in-dialog, the
1682  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
1683  * MUST be present. If both are present, then we will assume that the message
1684  * is to be sent in-dialog.
1685  *
1686  * The uri parameter can be specified if the request should be sent to an explicit
1687  * URI rather than one configured on the endpoint.
1688  *
1689  * \param method The method of the SIP request to send
1690  * \param dlg Optional. If specified, the dialog on which to request the message.
1691  * \param endpoint Optional. If specified, the request will be created out-of-dialog to the endpoint.
1692  * \param uri Optional. If specified, the request will be sent to this URI rather
1693  * than one configured for the endpoint.
1694  * \param contact The contact with which this request is associated for out-of-dialog requests.
1695  * \param[out] tdata The newly-created request
1696  *
1697  * The provided contact is attached to tdata with its reference bumped, but will
1698  * not survive for the entire lifetime of tdata since the contact is cleaned up
1699  * when all supplements have completed execution.
1700  *
1701  * \retval 0 Success
1702  * \retval -1 Failure
1703  */
1704 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
1705                 struct ast_sip_endpoint *endpoint, const char *uri,
1706                 struct ast_sip_contact *contact, pjsip_tx_data **tdata);
1707
1708 /*!
1709  * \brief General purpose method for sending a SIP request
1710  *
1711  * This is a companion function for \ref ast_sip_create_request. The request
1712  * created there can be passed to this function, though any request may be
1713  * passed in.
1714  *
1715  * This will automatically set up handling outbound authentication challenges if
1716  * they arrive.
1717  *
1718  * \param tdata The request to send
1719  * \param dlg Optional. The dialog in which the request is sent.  Otherwise it is out-of-dialog.
1720  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1721  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1722  * \param callback Callback to be called upon receipt of out-of-dialog response.
1723  *
1724  * \retval 0 Success
1725  * \retval -1 Failure (out-of-dialog callback will not be called.)
1726  */
1727 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg,
1728         struct ast_sip_endpoint *endpoint, void *token,
1729         void (*callback)(void *token, pjsip_event *e));
1730
1731 /*!
1732  * \brief General purpose method for sending an Out-Of-Dialog SIP request
1733  *
1734  * This is a companion function for \ref ast_sip_create_request. The request
1735  * created there can be passed to this function, though any request may be
1736  * passed in.
1737  *
1738  * This will automatically set up handling outbound authentication challenges if
1739  * they arrive.
1740  *
1741  * \param tdata The request to send
1742  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1743  * \param timeout.  If non-zero, after the timeout the transaction will be terminated
1744  * and the callback will be called with the PJSIP_EVENT_TIMER type.
1745  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1746  * \param callback Callback to be called upon receipt of out-of-dialog response.
1747  *
1748  * \retval 0 Success
1749  * \retval -1 Failure (out-of-dialog callback will not be called.)
1750  *
1751  * \note Timeout processing:
1752  * There are 2 timers associated with this request, PJSIP timer_b which is
1753  * set globally in the "system" section of pjsip.conf, and the timeout specified
1754  * on this call.  The timer that expires first (before normal completion) will
1755  * cause the callback to be run with e->body.tsx_state.type = PJSIP_EVENT_TIMER.
1756  * The timer that expires second is simply ignored and the callback is not run again.
1757  */
1758 int ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata,
1759         struct ast_sip_endpoint *endpoint, int timeout, void *token,
1760         void (*callback)(void *token, pjsip_event *e));
1761
1762 /*!
1763  * \brief General purpose method for creating a SIP response
1764  *
1765  * Its typical use would be to create responses for out of dialog
1766  * requests.
1767  *
1768  * \param rdata The rdata from the incoming request.
1769  * \param st_code The response code to transmit.
1770  * \param contact The contact with which this request is associated.
1771  * \param[out] tdata The newly-created response
1772  *
1773  * The provided contact is attached to tdata with its reference bumped, but will
1774  * not survive for the entire lifetime of tdata since the contact is cleaned up
1775  * when all supplements have completed execution.
1776  *
1777  * \retval 0 Success
1778  * \retval -1 Failure
1779  */
1780 int ast_sip_create_response(const pjsip_rx_data *rdata, int st_code,
1781         struct ast_sip_contact *contact, pjsip_tx_data **p_tdata);
1782
1783 /*!
1784  * \brief Send a response to an out of dialog request
1785  *
1786  * Use this function sparingly, since this does not create a transaction
1787  * within PJSIP. This means that if the request is retransmitted, it is
1788  * your responsibility to detect this and not process the same request
1789  * twice, and to send the same response for each retransmission.
1790  *
1791  * \param res_addr The response address for this response
1792  * \param tdata The response to send
1793  * \param endpoint The ast_sip_endpoint associated with this response
1794  *
1795  * \retval 0 Success
1796  * \retval -1 Failure
1797  */
1798 int ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1799
1800 /*!
1801  * \brief Send a stateful response to an out of dialog request
1802  *
1803  * This creates a transaction within PJSIP, meaning that if the request
1804  * that we are responding to is retransmitted, we will not attempt to
1805  * re-handle the request.
1806  *
1807  * \param rdata The request that is being responded to
1808  * \param tdata The response to send
1809  * \param endpoint The ast_sip_endpoint associated with this response
1810  *
1811  * \since 13.4.0
1812  *
1813  * \retval 0 Success
1814  * \retval -1 Failure
1815  */
1816 int ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1817
1818 /*!
1819  * \brief Determine if an incoming request requires authentication
1820  *
1821  * This calls into the registered authenticator's requires_authentication callback
1822  * in order to determine if the request requires authentication.
1823  *
1824  * If there is no registered authenticator, then authentication will be assumed
1825  * not to be required.
1826  *
1827  * \param endpoint The endpoint from which the request originates
1828  * \param rdata The incoming SIP request
1829  * \retval non-zero The request requires authentication
1830  * \retval 0 The request does not require authentication
1831  */
1832 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1833
1834 /*!
1835  * \brief Method to determine authentication status of an incoming request
1836  *
1837  * This will call into a registered authenticator. The registered authenticator will
1838  * do what is necessary to determine whether the incoming request passes authentication.
1839  * A tentative response is passed into this function so that if, say, a digest authentication
1840  * challenge should be sent in the ensuing response, it can be added to the response.
1841  *
1842  * \param endpoint The endpoint from the request was sent
1843  * \param rdata The request to potentially authenticate
1844  * \param tdata Tentative response to the request
1845  * \return The result of checking authentication.
1846  */
1847 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
1848                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1849
1850 /*!
1851  * \brief Create a response to an authentication challenge
1852  *
1853  * This will call into an outbound authenticator's create_request_with_auth callback
1854  * to create a new request with authentication credentials. See the create_request_with_auth
1855  * callback in the \ref ast_sip_outbound_authenticator structure for details about
1856  * the parameters and return values.
1857  */
1858 int ast_sip_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
1859                 pjsip_tx_data *tdata, pjsip_tx_data **new_request);
1860
1861 /*!
1862  * \brief Determine the endpoint that has sent a SIP message
1863  *
1864  * This will call into each of the registered endpoint identifiers'
1865  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
1866  * This will return an ao2 object. Its reference count will need to be
1867  * decremented when completed using the endpoint.
1868  *
1869  * \param rdata The inbound SIP message to use when identifying the endpoint.
1870  * \retval NULL No matching endpoint
1871  * \retval non-NULL The matching endpoint
1872  */
1873 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
1874
1875 /*!
1876  * \brief Set the outbound proxy for an outbound SIP message
1877  *
1878  * \param tdata The message to set the outbound proxy on
1879  * \param proxy SIP uri of the proxy
1880  * \retval 0 Success
1881  * \retval -1 Failure
1882  */
1883 int ast_sip_set_outbound_proxy(pjsip_tx_data *tdata, const char *proxy);
1884
1885 /*!
1886  * \brief Add a header to an outbound SIP message
1887  *
1888  * \param tdata The message to add the header to
1889  * \param name The header name
1890  * \param value The header value
1891  * \retval 0 Success
1892  * \retval -1 Failure
1893  */
1894 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
1895
1896 /*!
1897  * \brief Add a body to an outbound SIP message
1898  *
1899  * If this is called multiple times, the latest body will replace the current
1900  * body.
1901  *
1902  * \param tdata The message to add the body to
1903  * \param body The message body to add
1904  * \retval 0 Success
1905  * \retval -1 Failure
1906  */
1907 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
1908
1909 /*!
1910  * \brief Add a multipart body to an outbound SIP message
1911  *
1912  * This will treat each part of the input vector as part of a multipart body and
1913  * add each part to the SIP message.
1914  *
1915  * \param tdata The message to add the body to
1916  * \param bodies The parts of the body to add
1917  * \retval 0 Success
1918  * \retval -1 Failure
1919  */
1920 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
1921
1922 /*!
1923  * \brief Append body data to a SIP message
1924  *
1925  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
1926  * a body if it currently exists, it appends data to an existing body.
1927  *
1928  * \param tdata The message to append the body to
1929  * \param body The string to append to the end of the current body
1930  * \retval 0 Success
1931  * \retval -1 Failure
1932  */
1933 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
1934
1935 /*!
1936  * \brief Copy a pj_str_t into a standard character buffer.
1937  *
1938  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
1939  * terminated string needs to have the pj_str_t copied into a separate
1940  * buffer.
1941  *
1942  * This method copies the pj_str_t contents into the destination buffer
1943  * and NULL-terminates the buffer.
1944  *
1945  * \param dest The destination buffer
1946  * \param src The pj_str_t to copy
1947  * \param size The size of the destination buffer.
1948  */
1949 void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
1950
1951 /*!
1952  * \brief Get the looked-up endpoint on an out-of dialog request or response
1953  *
1954  * The function may ONLY be called on out-of-dialog requests or responses. For
1955  * in-dialog requests and responses, it is required that the user of the dialog
1956  * has the looked-up endpoint stored locally.
1957  *
1958  * This function should never return NULL if the message is out-of-dialog. It will
1959  * always return NULL if the message is in-dialog.
1960  *
1961  * This function will increase the reference count of the returned endpoint by one.
1962  * Release your reference using the ao2_ref function when finished.
1963  *
1964  * \param rdata Out-of-dialog request or response
1965  * \return The looked up endpoint
1966  */
1967 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
1968
1969 /*!
1970  * \brief Add 'user=phone' parameter to URI if enabled and user is a phone number.
1971  *
1972  * \param endpoint The endpoint to use for configuration
1973  * \param pool The memory pool to allocate the parameter from
1974  * \param uri The URI to check for user and to add parameter to
1975  */
1976 void ast_sip_add_usereqphone(const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri);
1977
1978 /*!
1979  * \brief Retrieve any endpoints available to sorcery.
1980  *
1981  * \retval Endpoints available to sorcery, NULL if no endpoints found.
1982  */
1983 struct ao2_container *ast_sip_get_endpoints(void);
1984
1985 /*!
1986  * \brief Retrieve the default outbound endpoint.
1987  *
1988  * \retval The default outbound endpoint, NULL if not found.
1989  */
1990 struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void);
1991
1992 /*!
1993  * \brief Retrieve relevant SIP auth structures from sorcery
1994  *
1995  * \param auths Vector of sorcery IDs of auth credentials to retrieve
1996  * \param[out] out The retrieved auths are stored here
1997  */
1998 int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out);
1999
2000 /*!
2001  * \brief Clean up retrieved auth structures from memory
2002  *
2003  * Call this function once you have completed operating on auths
2004  * retrieved from \ref ast_sip_retrieve_auths
2005  *
2006  * \param auths An vector of auth structures to clean up
2007  * \param num_auths The number of auths in the vector
2008  */
2009 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
2010
2011 /*!
2012  * \brief Checks if the given content type matches type/subtype.
2013  *
2014  * Compares the pjsip_media_type with the passed type and subtype and
2015  * returns the result of that comparison.  The media type parameters are
2016  * ignored.
2017  *
2018  * \param content_type The pjsip_media_type structure to compare
2019  * \param type The media type to compare
2020  * \param subtype The media subtype to compare
2021  * \retval 0 No match
2022  * \retval -1 Match
2023  */
2024 int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
2025
2026 /*!
2027  * \brief Send a security event notification for when an invalid endpoint is requested
2028  *
2029  * \param name Name of the endpoint requested
2030  * \param rdata Received message
2031  */
2032 void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
2033
2034 /*!
2035  * \brief Send a security event notification for when an ACL check fails
2036  *
2037  * \param endpoint Pointer to the endpoint in use
2038  * \param rdata Received message
2039  * \param name Name of the ACL
2040  */
2041 void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
2042
2043 /*!
2044  * \brief Send a security event notification for when a challenge response has failed
2045  *
2046  * \param endpoint Pointer to the endpoint in use
2047  * \param rdata Received message
2048  */
2049 void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2050
2051 /*!
2052  * \brief Send a security event notification for when authentication succeeds
2053  *
2054  * \param endpoint Pointer to the endpoint in use
2055  * \param rdata Received message
2056  */
2057 void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2058
2059 /*!
2060  * \brief Send a security event notification for when an authentication challenge is sent
2061  *
2062  * \param endpoint Pointer to the endpoint in use
2063  * \param rdata Received message
2064  * \param tdata Sent message
2065  */
2066 void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
2067
2068 /*!
2069  * \brief Send a security event notification for when a request is not supported
2070  *
2071  * \param endpoint Pointer to the endpoint in use
2072  * \param rdata Received message
2073  * \param req_type the type of request
2074  */
2075 void ast_sip_report_req_no_support(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata,
2076                                    const char* req_type);
2077
2078 /*!
2079  * \brief Send a security event notification for when a memory limit is hit.
2080  *
2081  * \param endpoint Pointer to the endpoint in use
2082  * \param rdata Received message
2083  */
2084 void ast_sip_report_mem_limit(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2085
2086 int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
2087 int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
2088
2089 /*!
2090  * \brief Retrieves the value associated with the given key.
2091  *
2092  * \param ht the hash table/dictionary to search
2093  * \param key the key to find
2094  *
2095  * \retval the value associated with the key, NULL otherwise.
2096  */
2097 void *ast_sip_dict_get(void *ht, const char *key);
2098
2099 /*!
2100  * \brief Using the dictionary stored in mod_data array at a given id,
2101  *        retrieve the value associated with the given key.
2102  *
2103  * \param mod_data a module data array
2104  * \param id the mod_data array index
2105  * \param key the key to find
2106  *
2107  * \retval the value associated with the key, NULL otherwise.
2108  */
2109 #define ast_sip_mod_data_get(mod_data, id, key)         \
2110         ast_sip_dict_get(mod_data[id], key)
2111
2112 /*!
2113  * \brief Set the value for the given key.
2114  *
2115  * Note - if the hash table does not exist one is created first, the key/value
2116  * pair is set, and the hash table returned.
2117  *
2118  * \param pool the pool to allocate memory in
2119  * \param ht the hash table/dictionary in which to store the key/value pair
2120  * \param key the key to associate a value with
2121  * \param val the value to associate with a key
2122  *
2123  * \retval the given, or newly created, hash table.
2124  */
2125 void *ast_sip_dict_set(pj_pool_t* pool, void *ht,
2126                        const char *key, void *val);
2127
2128 /*!
2129  * \brief Utilizing a mod_data array for a given id, set the value
2130  *        associated with the given key.
2131  *
2132  * For a given structure's mod_data array set the element indexed by id to
2133  * be a dictionary containing the key/val pair.
2134  *
2135  * \param pool a memory allocation pool
2136  * \param mod_data a module data array
2137  * \param id the mod_data array index
2138  * \param key the key to find
2139  * \param val the value to associate with a key
2140  */
2141 #define ast_sip_mod_data_set(pool, mod_data, id, key, val)              \
2142         mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
2143
2144 /*!
2145  * \brief For every contact on an AOR call the given 'on_contact' handler.
2146  *
2147  * \param aor the aor containing a list of contacts to iterate
2148  * \param on_contact callback on each contact on an AOR.  The object
2149  * received by the callback will be a ast_sip_contact_wrapper structure.
2150  * \param arg user data passed to handler
2151  * \retval 0 Success, non-zero on failure
2152  */
2153 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
2154                 ao2_callback_fn on_contact, void *arg);
2155
2156 /*!
2157  * \brief Handler used to convert a contact to a string.
2158  *
2159  * \param object the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
2160  * \param arg user data passed to handler
2161  * \param flags
2162  * \retval 0 Success, non-zero on failure
2163  */
2164 int ast_sip_contact_to_str(void *object, void *arg, int flags);
2165
2166 /*!
2167  * \brief For every aor in the comma separated aors string call the
2168  *        given 'on_aor' handler.
2169  *
2170  * \param aors a comma separated list of aors
2171  * \param on_aor callback for each aor
2172  * \param arg user data passed to handler
2173  * \retval 0 Success, non-zero on failure
2174  */
2175 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg);
2176
2177 /*!
2178  * \brief For every auth in the array call the given 'on_auth' handler.
2179  *
2180  * \param array an array of auths
2181  * \param on_auth callback for each auth
2182  * \param arg user data passed to handler
2183  * \retval 0 Success, non-zero on failure
2184  */
2185 int ast_sip_for_each_auth(const struct ast_sip_auth_vector *array,
2186                           ao2_callback_fn on_auth, void *arg);
2187
2188 /*!
2189  * \brief Converts the given auth type to a string
2190  *
2191  * \param type the auth type to convert
2192  * \retval a string representative of the auth type
2193  */
2194 const char *ast_sip_auth_type_to_str(enum ast_sip_auth_type type);
2195
2196 /*!
2197  * \brief Converts an auths array to a string of comma separated values
2198  *
2199  * \param auths an auth array
2200  * \param buf the string buffer to write the object data
2201  * \retval 0 Success, non-zero on failure
2202  */
2203 int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf);
2204
2205 /*!
2206  * \brief AMI variable container
2207  */
2208 struct ast_sip_ami {
2209         /*! Manager session */
2210         struct mansession *s;
2211         /*! Manager message */
2212         const struct message *m;
2213         /*! Manager Action ID */
2214         const char *action_id;
2215         /*! user specified argument data */
2216         void *arg;
2217         /*! count of objects */
2218         int count;
2219 };
2220
2221 /*!
2222  * \brief Creates a string to store AMI event data in.
2223  *
2224  * \param event the event to set
2225  * \param ami AMI session and message container
2226  * \retval an initialized ast_str or NULL on error.
2227  */
2228 struct ast_str *ast_sip_create_ami_event(const char *event,
2229                                          struct ast_sip_ami *ami);
2230
2231 /*!
2232  * \brief An entity responsible formatting endpoint information.
2233  */
2234 struct ast_sip_endpoint_formatter {
2235         /*!
2236          * \brief Callback used to format endpoint information over AMI.
2237          */
2238         int (*format_ami)(const struct ast_sip_endpoint *endpoint,
2239                           struct ast_sip_ami *ami);
2240         AST_RWLIST_ENTRY(ast_sip_endpoint_formatter) next;
2241 };
2242
2243 /*!
2244  * \brief Register an endpoint formatter.
2245  *
2246  * \param obj the formatter to register
2247  * \retval 0 Success
2248  * \retval -1 Failure
2249  */
2250 int ast_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2251
2252 /*!
2253  * \brief Unregister an endpoint formatter.
2254  *
2255  * \param obj the formatter to unregister
2256  */
2257 void ast_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2258
2259 /*!
2260  * \brief Converts a sorcery object to a string of object properties.
2261  *
2262  * \param obj the sorcery object to convert
2263  * \param str the string buffer to write the object data
2264  * \retval 0 Success, non-zero on failure
2265  */
2266 int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf);
2267
2268 /*!
2269  * \brief Formats the endpoint and sends over AMI.
2270  *
2271  * \param endpoint the endpoint to format and send
2272  * \param endpoint ami AMI variable container
2273  * \param count the number of formatters operated on
2274  * \retval 0 Success, otherwise non-zero on error
2275  */
2276 int ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint,
2277                                 struct ast_sip_ami *ami, int *count);
2278
2279 /*!
2280  * \brief Format auth details for AMI.
2281  *
2282  * \param auths an auth array
2283  * \param ami ami variable container
2284  * \retval 0 Success, non-zero on failure
2285  */
2286 int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths,
2287                              struct ast_sip_ami *ami);
2288
2289 /*!
2290  * \brief Retrieve the endpoint snapshot for an endpoint
2291  *
2292  * \param endpoint The endpoint whose snapshot is to be retreieved.
2293  * \retval The endpoint snapshot
2294  */
2295 struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
2296         const struct ast_sip_endpoint *endpoint);
2297
2298 /*!
2299  * \brief Retrieve the device state for an endpoint.
2300  *
2301  * \param endpoint The endpoint whose state is to be retrieved.
2302  * \retval The device state.
2303  */
2304 const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint);
2305
2306 /*!
2307  * \brief For every channel snapshot on an endpoint snapshot call the given
2308  *        'on_channel_snapshot' handler.
2309  *
2310  * \param endpoint_snapshot snapshot of an endpoint
2311  * \param on_channel_snapshot callback for each channel snapshot
2312  * \param arg user data passed to handler
2313  * \retval 0 Success, non-zero on failure
2314  */
2315 int ast_sip_for_each_channel_snapshot(const struct ast_endpoint_snapshot *endpoint_snapshot,
2316                 ao2_callback_fn on_channel_snapshot,
2317                                       void *arg);
2318
2319 /*!
2320  * \brief For every channel snapshot on an endpoint all the given
2321  *        'on_channel_snapshot' handler.
2322  *
2323  * \param endpoint endpoint
2324  * \param on_channel_snapshot callback for each channel snapshot
2325  * \param arg user data passed to handler
2326  * \retval 0 Success, non-zero on failure
2327  */
2328 int ast_sip_for_each_channel(const struct ast_sip_endpoint *endpoint,
2329                 ao2_callback_fn on_channel_snapshot,
2330                                       void *arg);
2331
2332 enum ast_sip_supplement_priority {
2333         /*! Top priority. Supplements with this priority are those that need to run before any others */
2334         AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
2335         /*! Channel creation priority.
2336          * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
2337          * or after channel creation, then set your priority to be lower or higher than this value.
2338          */
2339         AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
2340         /*! Lowest priority. Supplements with this priority should be run after all other supplements */
2341         AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
2342 };
2343
2344 /*!
2345  * \brief A supplement to SIP message processing
2346  *
2347  * These can be registered by any module in order to add
2348  * processing to incoming and outgoing SIP out of dialog
2349  * requests and responses
2350  */
2351 struct ast_sip_supplement {
2352         /*! Method on which to call the callbacks. If NULL, call on all methods */
2353         const char *method;
2354         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
2355         enum ast_sip_supplement_priority priority;
2356         /*!
2357          * \brief Called on incoming SIP request
2358          * This method can indicate a failure in processing in its return. If there
2359          * is a failure, it is required that this method sends a response to the request.
2360          * This method is always called from a SIP servant thread.
2361          *
2362          * \note
2363          * The following PJSIP methods will not work properly:
2364          * pjsip_rdata_get_dlg()
2365          * pjsip_rdata_get_tsx()
2366          * The reason is that the rdata passed into this function is a cloned rdata structure,
2367          * and its module data is not copied during the cloning operation.
2368          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2369          *
2370          * \note
2371          * There is no guarantee that a channel will be present on the session when this is called.
2372          */
2373         int (*incoming_request)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2374         /*!
2375          * \brief Called on an incoming SIP response
2376          * This method is always called from a SIP servant thread.
2377          *
2378          * \note
2379          * The following PJSIP methods will not work properly:
2380          * pjsip_rdata_get_dlg()
2381          * pjsip_rdata_get_tsx()
2382          * The reason is that the rdata passed into this function is a cloned rdata structure,
2383          * and its module data is not copied during the cloning operation.
2384          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2385          *
2386          * \note
2387          * There is no guarantee that a channel will be present on the session when this is called.
2388          */
2389         void (*incoming_response)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2390         /*!
2391          * \brief Called on an outgoing SIP request
2392          * This method is always called from a SIP servant thread.
2393          */
2394         void (*outgoing_request)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2395         /*!
2396          * \brief Called on an outgoing SIP response
2397          * This method is always called from a SIP servant thread.
2398          */
2399         void (*outgoing_response)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2400         /*! Next item in the list */
2401         AST_LIST_ENTRY(ast_sip_supplement) next;
2402 };
2403
2404 /*!
2405  * \brief Register a supplement to SIP out of dialog processing
2406  *
2407  * This allows for someone to insert themselves in the processing of out
2408  * of dialog SIP requests and responses. This, for example could allow for
2409  * a module to set channel data based on headers in an incoming message.
2410  * Similarly, a module could reject an incoming request if desired.
2411  *
2412  * \param supplement The supplement to register
2413  * \retval 0 Success
2414  * \retval -1 Failure
2415  */
2416 int ast_sip_register_supplement(struct ast_sip_supplement *supplement);
2417
2418 /*!
2419  * \brief Unregister a an supplement to SIP out of dialog processing
2420  *
2421  * \param supplement The supplement to unregister
2422  */
2423 void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement);
2424
2425 /*!
2426  * \brief Retrieve the global MWI taskprocessor high water alert trigger level.
2427  *
2428  * \since 13.12.0
2429  *
2430  * \retval the system MWI taskprocessor high water alert trigger level
2431  */
2432 unsigned int ast_sip_get_mwi_tps_queue_high(void);
2433
2434 /*!
2435  * \brief Retrieve the global MWI taskprocessor low water clear alert level.
2436  *
2437  * \since 13.12.0
2438  *
2439  * \retval the system MWI taskprocessor low water clear alert level
2440  */
2441 int ast_sip_get_mwi_tps_queue_low(void);
2442
2443 /*!
2444  * \brief Retrieve the global setting 'disable sending unsolicited mwi on startup'.
2445  * \since 13.12.0
2446  *
2447  * \retval non zero if disable.
2448  */
2449 unsigned int ast_sip_get_mwi_disable_initial_unsolicited(void);
2450
2451 /*!
2452  * \brief Retrieve the global setting 'ignore_uri_user_options'.
2453  * \since 13.12.0
2454  *
2455  * \retval non zero if ignore the user field options.
2456  */
2457 unsigned int ast_sip_get_ignore_uri_user_options(void);
2458
2459 /*!
2460  * \brief Truncate the URI user field options string if enabled.
2461  * \since 13.12.0
2462  *
2463  * \param str URI user field string to truncate if enabled
2464  *
2465  * \details
2466  * We need to be able to handle URI's looking like
2467  * "sip:1235557890;phone-context=national@x.x.x.x;user=phone"
2468  *
2469  * Where the URI user field is:
2470  * "1235557890;phone-context=national"
2471  *
2472  * When truncated the string will become:
2473  * "1235557890"
2474  */
2475 #define AST_SIP_USER_OPTIONS_TRUNCATE_CHECK(str)                                \
2476         do {                                                                                                            \
2477                 char *__semi = strchr((str), ';');                                              \
2478                 if (__semi && ast_sip_get_ignore_uri_user_options()) {  \
2479                         *__semi = '\0';                                                                         \
2480                 }                                                                                                               \
2481         } while (0)
2482
2483 /*!
2484  * \brief Retrieve the system debug setting (yes|no|host).
2485  *
2486  * \note returned string needs to be de-allocated by caller.
2487  *
2488  * \retval the system debug setting.
2489  */
2490 char *ast_sip_get_debug(void);
2491
2492 /*!
2493  * \brief Retrieve the global regcontext setting.
2494  *
2495  * \since 13.8.0
2496  *
2497  * \note returned string needs to be de-allocated by caller.
2498  *
2499  * \retval the global regcontext setting
2500  */
2501 char *ast_sip_get_regcontext(void);
2502
2503 /*!
2504  * \brief Retrieve the global endpoint_identifier_order setting.
2505  *
2506  * Specifies the order by which endpoint identifiers should be regarded.
2507  *
2508  * \retval the global endpoint_identifier_order value
2509  */
2510 char *ast_sip_get_endpoint_identifier_order(void);
2511
2512 /*!
2513  * \brief Retrieve the default voicemail extension.
2514  * \since 13.9.0
2515  *
2516  * \note returned string needs to be de-allocated by caller.
2517  *
2518  * \retval the default voicemail extension
2519  */
2520 char *ast_sip_get_default_voicemail_extension(void);
2521
2522 /*!
2523  * \brief Retrieve the global default realm.
2524  *
2525  * This is the value placed in outbound challenges' realm if there
2526  * is no better option (such as an auth-configured realm).
2527  *
2528  * \param[out] realm The default realm
2529  * \param size The buffer size of realm
2530  * \return nothing
2531  */
2532 void ast_sip_get_default_realm(char *realm, size_t size);
2533
2534 /*!
2535  * \brief Retrieve the global default from user.
2536  *
2537  * This is the value placed in outbound requests' From header if there
2538  * is no better option (such as an endpoint-configured from_user or
2539  * caller ID number).
2540  *
2541  * \param[out] from_user The default from user
2542  * \param size The buffer size of from_user
2543  * \return nothing
2544  */
2545 void ast_sip_get_default_from_user(char *from_user, size_t size);
2546
2547 /*! \brief Determines whether the res_pjsip module is loaded */
2548 #define CHECK_PJSIP_MODULE_LOADED()                             \
2549         do {                                                    \
2550                 if (!ast_module_check("res_pjsip.so")           \
2551                         || !ast_sip_get_pjsip_endpoint()) {     \
2552                         return AST_MODULE_LOAD_DECLINE;         \
2553                 }                                               \
2554         } while(0)
2555
2556 /*!
2557  * \brief Retrieve the system keep alive interval setting.
2558  *
2559  * \retval the keep alive interval.
2560  */
2561 unsigned int ast_sip_get_keep_alive_interval(void);
2562
2563 /*!
2564  * \brief Retrieve the system contact expiration check interval setting.
2565  *
2566  * \retval the contact expiration check interval.
2567  */
2568 unsigned int ast_sip_get_contact_expiration_check_interval(void);
2569
2570 /*!
2571  * \brief Retrieve the system setting 'disable multi domain'.
2572  * \since 13.9.0
2573  *
2574  * \retval non zero if disable multi domain.
2575  */
2576 unsigned int ast_sip_get_disable_multi_domain(void);
2577
2578 /*!
2579  * \brief Retrieve the system max initial qualify time.
2580  *
2581  * \retval the maximum initial qualify time.
2582  */
2583 unsigned int ast_sip_get_max_initial_qualify_time(void);
2584
2585 /*!
2586  * \brief translate ast_sip_contact_status_type to character string.
2587  *
2588  * \retval the character string equivalent.
2589  */
2590
2591 const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status);
2592 const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status);
2593
2594 /*!
2595  * \brief Set a request to use the next value in the list of resolved addresses.
2596  *
2597  * \param tdata the tx data from the original request
2598  * \retval 0 No more addresses to try
2599  * \retval 1 The request was successfully re-intialized
2600  */
2601 int ast_sip_failover_request(pjsip_tx_data *tdata);
2602
2603 /*
2604  * \brief Retrieve the local host address in IP form
2605  *
2606  * \param af The address family to retrieve
2607  * \param addr A place to store the local host address
2608  *
2609  * \retval 0 success
2610  * \retval -1 failure
2611  *
2612  * \since 13.6.0
2613  */
2614 int ast_sip_get_host_ip(int af, pj_sockaddr *addr);
2615
2616 /*!
2617  * \brief Retrieve the local host address in string form
2618  *
2619  * \param af The address family to retrieve
2620  *
2621  * \retval non-NULL success
2622  * \retval NULL failure
2623  *
2624  * \since 13.6.0
2625  *
2626  * \note An empty string may be returned if the address family is valid but no local address exists
2627  */
2628 const char *ast_sip_get_host_ip_string(int af);
2629
2630 /*!
2631  * \brief Return the size of the SIP threadpool's task queue
2632  * \since 13.7.0
2633  */
2634 long ast_sip_threadpool_queue_size(void);
2635
2636 /*!
2637  * \brief Retrieve transport state
2638  * \since 13.7.1
2639  *
2640  * @param transport_id
2641  * @returns transport_state
2642  *
2643  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2644  */
2645 struct ast_sip_transport_state *ast_sip_get_transport_state(const char *transport_id);
2646
2647 /*!
2648  * \brief Retrieves all transport states
2649  * \since 13.7.1
2650  *
2651  * @returns ao2_container
2652  *
2653  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2654  */
2655 struct ao2_container *ast_sip_get_transport_states(void);
2656
2657 /*!
2658  * \brief Sets pjsip_tpselector from ast_sip_transport
2659  * \since 13.8.0
2660  *
2661  * \param transport The transport to be used
2662  * \param selector The selector to be populated
2663  * \retval 0 success
2664  * \retval -1 failure
2665  */
2666 int ast_sip_set_tpselector_from_transport(const struct ast_sip_transport *transport, pjsip_tpselector *selector);
2667
2668 /*!
2669  * \brief Sets pjsip_tpselector from ast_sip_transport
2670  * \since 13.8.0
2671  *
2672  * \param transport_name The name of the transport to be used
2673  * \param selector The selector to be populated
2674  * \retval 0 success
2675  * \retval -1 failure
2676  */
2677 int ast_sip_set_tpselector_from_transport_name(const char *transport_name, pjsip_tpselector *selector);
2678
2679 /*!
2680  * \brief Set name and number information on an identity header.
2681  *
2682  * \param pool Memory pool to use for string duplication
2683  * \param id_hdr A From, P-Asserted-Identity, or Remote-Party-ID header to modify
2684  * \param id The identity information to apply to the header
2685  */
2686 void ast_sip_modify_id_header(pj_pool_t *pool, pjsip_fromto_hdr *id_hdr,
2687         const struct ast_party_id *id);
2688
2689 /*!
2690  * \brief Retrieve the unidentified request security event thresholds
2691  * \since 13.8.0
2692  *
2693  * \param count The maximum number of unidentified requests per source ip to accumulate before emitting a security event
2694  * \param period The period in seconds over which to accumulate unidentified requests
2695  * \param prune_interval The interval in seconds at which expired entries will be pruned
2696  */
2697 void ast_sip_get_unidentified_request_thresholds(unsigned int *count, unsigned int *period,
2698         unsigned int *prune_interval);
2699
2700 #endif /* _RES_PJSIP_H */