res_pjsip: Add fax_detect_timeout endpoint option.
[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 };
759
760 /*!
761  * \brief Initialize an auth vector with the configured values.
762  *
763  * \param vector Vector to initialize
764  * \param auth_names Comma-separated list of names to set in the array
765  * \retval 0 Success
766  * \retval non-zero Failure
767  */
768 int ast_sip_auth_vector_init(struct ast_sip_auth_vector *vector, const char *auth_names);
769
770 /*!
771  * \brief Free contents of an auth vector.
772  *
773  * \param array Vector whose contents are to be freed
774  */
775 void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector);
776
777 /*!
778  * \brief Possible returns from ast_sip_check_authentication
779  */
780 enum ast_sip_check_auth_result {
781     /*! Authentication needs to be challenged */
782     AST_SIP_AUTHENTICATION_CHALLENGE,
783     /*! Authentication succeeded */
784     AST_SIP_AUTHENTICATION_SUCCESS,
785     /*! Authentication failed */
786     AST_SIP_AUTHENTICATION_FAILED,
787     /*! Authentication encountered some internal error */
788     AST_SIP_AUTHENTICATION_ERROR,
789 };
790
791 /*!
792  * \brief An interchangeable way of handling digest authentication for SIP.
793  *
794  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
795  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
796  * should take place and what credentials should be used when challenging and authenticating a request.
797  */
798 struct ast_sip_authenticator {
799     /*!
800      * \brief Check if a request requires authentication
801      * See ast_sip_requires_authentication for more details
802      */
803     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
804         /*!
805          * \brief Check that an incoming request passes authentication.
806          *
807          * The tdata parameter is useful for adding information such as digest challenges.
808          *
809          * \param endpoint The endpoint sending the incoming request
810          * \param rdata The incoming request
811          * \param tdata Tentative outgoing request.
812          */
813         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
814                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
815 };
816
817 /*!
818  * \brief an interchangeable way of responding to authentication challenges
819  *
820  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
821  * credentials.
822  */
823 struct ast_sip_outbound_authenticator {
824         /*!
825          * \brief Create a new request with authentication credentials
826          *
827          * \param auths A vector of IDs of auth sorcery objects
828          * \param challenge The SIP response with authentication challenge(s)
829          * \param old_request The request that received the auth challenge(s)
830          * \param new_request The new SIP request with challenge response(s)
831          * \retval 0 Successfully created new request
832          * \retval -1 Failed to create a new request
833          */
834         int (*create_request_with_auth)(const struct ast_sip_auth_vector *auths, struct pjsip_rx_data *challenge,
835                         struct pjsip_tx_data *old_request, struct pjsip_tx_data **new_request);
836 };
837
838 /*!
839  * \brief An entity responsible for identifying the source of a SIP message
840  */
841 struct ast_sip_endpoint_identifier {
842     /*!
843      * \brief Callback used to identify the source of a message.
844      * See ast_sip_identify_endpoint for more details
845      */
846     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
847 };
848
849 /*!
850  * \brief Register a SIP service in Asterisk.
851  *
852  * This is more-or-less a wrapper around pjsip_endpt_register_module().
853  * Registering a service makes it so that PJSIP will call into the
854  * service at appropriate times. For more information about PJSIP module
855  * callbacks, see the PJSIP documentation. Asterisk modules that call
856  * this function will likely do so at module load time.
857  *
858  * \param module The module that is to be registered with PJSIP
859  * \retval 0 Success
860  * \retval -1 Failure
861  */
862 int ast_sip_register_service(pjsip_module *module);
863
864 /*!
865  * This is the opposite of ast_sip_register_service().  Unregistering a
866  * service means that PJSIP will no longer call into the module any more.
867  * This will likely occur when an Asterisk module is unloaded.
868  *
869  * \param module The PJSIP module to unregister
870  */
871 void ast_sip_unregister_service(pjsip_module *module);
872
873 /*!
874  * \brief Register a SIP authenticator
875  *
876  * An authenticator has three main purposes:
877  * 1) Determining if authentication should be performed on an incoming request
878  * 2) Gathering credentials necessary for issuing an authentication challenge
879  * 3) Authenticating a request that has credentials
880  *
881  * Asterisk provides a default authenticator, but it may be replaced by a
882  * custom one if desired.
883  *
884  * \param auth The authenticator to register
885  * \retval 0 Success
886  * \retval -1 Failure
887  */
888 int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
889
890 /*!
891  * \brief Unregister a SIP authenticator
892  *
893  * When there is no authenticator registered, requests cannot be challenged
894  * or authenticated.
895  *
896  * \param auth The authenticator to unregister
897  */
898 void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
899
900  /*!
901  * \brief Register an outbound SIP authenticator
902  *
903  * An outbound authenticator is responsible for creating responses to
904  * authentication challenges by remote endpoints.
905  *
906  * \param auth The authenticator to register
907  * \retval 0 Success
908  * \retval -1 Failure
909  */
910 int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
911
912 /*!
913  * \brief Unregister an outbound SIP authenticator
914  *
915  * When there is no outbound authenticator registered, authentication challenges
916  * will be handled as any other final response would be.
917  *
918  * \param auth The authenticator to unregister
919  */
920 void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
921
922 /*!
923  * \brief Register a SIP endpoint identifier with a name.
924  *
925  * An endpoint identifier's purpose is to determine which endpoint a given SIP
926  * message has come from.
927  *
928  * Multiple endpoint identifiers may be registered so that if an endpoint
929  * cannot be identified by one identifier, it may be identified by another.
930  *
931  * \param identifier The SIP endpoint identifier to register
932  * \param name The name of the endpoint identifier
933  * \retval 0 Success
934  * \retval -1 Failure
935  */
936 int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
937                                                    const char *name);
938
939 /*!
940  * \brief Register a SIP endpoint identifier
941  *
942  * An endpoint identifier's purpose is to determine which endpoint a given SIP
943  * message has come from.
944  *
945  * Multiple endpoint identifiers may be registered so that if an endpoint
946  * cannot be identified by one identifier, it may be identified by another.
947  *
948  * Asterisk provides two endpoint identifiers. One identifies endpoints based
949  * on the user part of the From header URI. The other identifies endpoints based
950  * on the source IP address.
951  *
952  * If the order in which endpoint identifiers is run is important to you, then
953  * be sure to load individual endpoint identifier modules in the order you wish
954  * for them to be run in modules.conf
955  *
956  * \note endpoint identifiers registered using this method (no name specified)
957  *       are placed at the front of the endpoint identifiers list ahead of any
958  *       named identifiers.
959  *
960  * \param identifier The SIP endpoint identifier to register
961  * \retval 0 Success
962  * \retval -1 Failure
963  */
964 int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
965
966 /*!
967  * \brief Unregister a SIP endpoint identifier
968  *
969  * This stops an endpoint identifier from being used.
970  *
971  * \param identifier The SIP endoint identifier to unregister
972  */
973 void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
974
975 /*!
976  * \brief Allocate a new SIP endpoint
977  *
978  * This will return an endpoint with its refcount increased by one. This reference
979  * can be released using ao2_ref().
980  *
981  * \param name The name of the endpoint.
982  * \retval NULL Endpoint allocation failed
983  * \retval non-NULL The newly allocated endpoint
984  */
985 void *ast_sip_endpoint_alloc(const char *name);
986
987 /*!
988  * \brief Change state of a persistent endpoint.
989  *
990  * \param endpoint The SIP endpoint name to change state.
991  * \param state The new state
992  * \retval 0 Success
993  * \retval -1 Endpoint not found
994  */
995 int ast_sip_persistent_endpoint_update_state(const char *endpoint_name, enum ast_endpoint_state state);
996
997 /*!
998  * \brief Get a pointer to the PJSIP endpoint.
999  *
1000  * This is useful when modules have specific information they need
1001  * to register with the PJSIP core.
1002  * \retval NULL endpoint has not been created yet.
1003  * \retval non-NULL PJSIP endpoint.
1004  */
1005 pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
1006
1007 /*!
1008  * \brief Get a pointer to the SIP sorcery structure.
1009  *
1010  * \retval NULL sorcery has not been initialized
1011  * \retval non-NULL sorcery structure
1012  */
1013 struct ast_sorcery *ast_sip_get_sorcery(void);
1014
1015 /*!
1016  * \brief Retrieve a named AOR
1017  *
1018  * \param aor_name Name of the AOR
1019  *
1020  * \retval NULL if not found
1021  * \retval non-NULL if found
1022  */
1023 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
1024
1025 /*!
1026  * \brief Retrieve the first bound contact for an AOR
1027  *
1028  * \param aor Pointer to the AOR
1029  * \retval NULL if no contacts available
1030  * \retval non-NULL if contacts available
1031  */
1032 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
1033
1034 /*!
1035  * \brief Retrieve all contacts currently available for an AOR
1036  *
1037  * \param aor Pointer to the AOR
1038  *
1039  * \retval NULL if no contacts available
1040  * \retval non-NULL if contacts available
1041  *
1042  * \warning
1043  * Since this function prunes expired contacts before returning, it holds a named write
1044  * lock on the aor.  If you already hold the lock, call ast_sip_location_retrieve_aor_contacts_nolock instead.
1045  */
1046 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
1047
1048 /*!
1049  * \brief Retrieve all contacts currently available for an AOR without locking the AOR
1050  * \since 13.9.0
1051  *
1052  * \param aor Pointer to the AOR
1053  *
1054  * \retval NULL if no contacts available
1055  * \retval non-NULL if contacts available
1056  *
1057  * \warning
1058  * This function should only be called if you already hold a named write lock on the aor.
1059  */
1060 struct ao2_container *ast_sip_location_retrieve_aor_contacts_nolock(const struct ast_sip_aor *aor);
1061
1062 /*!
1063  * \brief Retrieve the first bound contact from a list of AORs
1064  *
1065  * \param aor_list A comma-separated list of AOR names
1066  * \retval NULL if no contacts available
1067  * \retval non-NULL if contacts available
1068  */
1069 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
1070
1071 /*!
1072  * \brief Retrieve all contacts from a list of AORs
1073  *
1074  * \param aor_list A comma-separated list of AOR names
1075  * \retval NULL if no contacts available
1076  * \retval non-NULL container (which must be freed) if contacts available
1077  */
1078 struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list);
1079
1080 /*!
1081  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs
1082  *
1083  * \param aor_list A comma-separated list of AOR names
1084  * \param aor The chosen AOR
1085  * \param contact The chosen contact
1086  */
1087  void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
1088         struct ast_sip_contact **contact);
1089
1090 /*!
1091  * \brief Retrieve a named contact
1092  *
1093  * \param contact_name Name of the contact
1094  *
1095  * \retval NULL if not found
1096  * \retval non-NULL if found
1097  */
1098 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
1099
1100 /*!
1101  * \brief Add a new contact to an AOR
1102  *
1103  * \param aor Pointer to the AOR
1104  * \param uri Full contact URI
1105  * \param expiration_time Optional expiration time of the contact
1106  * \param path_info Path information
1107  * \param user_agent User-Agent header from REGISTER request
1108  * \param endpoint The endpoint that resulted in the contact being added
1109  *
1110  * \retval -1 failure
1111  * \retval 0 success
1112  *
1113  * \warning
1114  * This function holds a named write lock on the aor.  If you already hold the lock
1115  * you should call ast_sip_location_add_contact_nolock instead.
1116  */
1117 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
1118         struct timeval expiration_time, const char *path_info, const char *user_agent,
1119         const char *via_addr, int via_port, const char *call_id,
1120         struct ast_sip_endpoint *endpoint);
1121
1122 /*!
1123  * \brief Add a new contact to an AOR without locking the AOR
1124  * \since 13.9.0
1125  *
1126  * \param aor Pointer to the AOR
1127  * \param uri Full contact URI
1128  * \param expiration_time Optional expiration time of the contact
1129  * \param path_info Path information
1130  * \param user_agent User-Agent header from REGISTER request
1131  * \param endpoint The endpoint that resulted in the contact being added
1132  *
1133  * \retval -1 failure
1134  * \retval 0 success
1135  *
1136  * \warning
1137  * This function should only be called if you already hold a named write lock on the aor.
1138  */
1139 int ast_sip_location_add_contact_nolock(struct ast_sip_aor *aor, const char *uri,
1140         struct timeval expiration_time, const char *path_info, const char *user_agent,
1141         const char *via_addr, int via_port, const char *call_id,
1142         struct ast_sip_endpoint *endpoint);
1143
1144 /*!
1145  * \brief Update a contact
1146  *
1147  * \param contact New contact object with details
1148  *
1149  * \retval -1 failure
1150  * \retval 0 success
1151  */
1152 int ast_sip_location_update_contact(struct ast_sip_contact *contact);
1153
1154 /*!
1155 * \brief Delete a contact
1156 *
1157 * \param contact Contact object to delete
1158 *
1159 * \retval -1 failure
1160 * \retval 0 success
1161 */
1162 int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
1163
1164 /*!
1165  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
1166  *
1167  * This callback will have the created request on it. The callback's purpose is to do any extra
1168  * housekeeping that needs to be done as well as to send the request out.
1169  *
1170  * This callback is only necessary if working with a PJSIP API that sits between the application
1171  * and the dialog layer.
1172  *
1173  * \param dlg The dialog to which the request belongs
1174  * \param tdata The created request to be sent out
1175  * \param user_data Data supplied with the callback
1176  *
1177  * \retval 0 Success
1178  * \retval -1 Failure
1179  */
1180 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
1181
1182 /*!
1183  * \brief Set up outbound authentication on a SIP dialog
1184  *
1185  * This sets up the infrastructure so that all requests associated with a created dialog
1186  * can be re-sent with authentication credentials if the original request is challenged.
1187  *
1188  * \param dlg The dialog on which requests will be authenticated
1189  * \param endpoint The endpoint whom this dialog pertains to
1190  * \param cb Callback to call to send requests with authentication
1191  * \param user_data Data to be provided to the callback when it is called
1192  *
1193  * \retval 0 Success
1194  * \retval -1 Failure
1195  */
1196 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
1197                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
1198
1199 /*!
1200  * \brief Retrieves a reference to the artificial auth.
1201  *
1202  * \retval The artificial auth
1203  */
1204 struct ast_sip_auth *ast_sip_get_artificial_auth(void);
1205
1206 /*!
1207  * \brief Retrieves a reference to the artificial endpoint.
1208  *
1209  * \retval The artificial endpoint
1210  */
1211 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
1212
1213 /*! \defgroup pjsip_threading PJSIP Threading Model
1214  * @{
1215  * \page PJSIP PJSIP Threading Model
1216  *
1217  * There are three major types of threads that SIP will have to deal with:
1218  * \li Asterisk threads
1219  * \li PJSIP threads
1220  * \li SIP threadpool threads (a.k.a. "servants")
1221  *
1222  * \par Asterisk Threads
1223  *
1224  * Asterisk threads are those that originate from outside of SIP but within
1225  * Asterisk. The most common of these threads are PBX (channel) threads and
1226  * the autoservice thread. Most interaction with these threads will be through
1227  * channel technology callbacks. Within these threads, it is fine to handle
1228  * Asterisk data from outside of SIP, but any handling of SIP data should be
1229  * left to servants, \b especially if you wish to call into PJSIP for anything.
1230  * Asterisk threads are not registered with PJLIB, so attempting to call into
1231  * PJSIP will cause an assertion to be triggered, thus causing the program to
1232  * crash.
1233  *
1234  * \par PJSIP Threads
1235  *
1236  * PJSIP threads are those that originate from handling of PJSIP events, such
1237  * as an incoming SIP request or response, or a transaction timeout. The role
1238  * of these threads is to process information as quickly as possible so that
1239  * the next item on the SIP socket(s) can be serviced. On incoming messages,
1240  * Asterisk automatically will push the request to a servant thread. When your
1241  * module callback is called, processing will already be in a servant. However,
1242  * for other PSJIP events, such as transaction state changes due to timer
1243  * expirations, your module will be called into from a PJSIP thread. If you
1244  * are called into from a PJSIP thread, then you should push whatever processing
1245  * is needed to a servant as soon as possible. You can discern if you are currently
1246  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
1247  *
1248  * \par Servants
1249  *
1250  * Servants are where the bulk of SIP work should be performed. These threads
1251  * exist in order to do the work that Asterisk threads and PJSIP threads hand
1252  * off to them. Servant threads register themselves with PJLIB, meaning that
1253  * they are capable of calling PJSIP and PJLIB functions if they wish.
1254  *
1255  * \par Serializer
1256  *
1257  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
1258  * The first parameter of this call is a serializer. If this pointer
1259  * is NULL, then the work will be handed off to whatever servant can currently handle
1260  * the task. If this pointer is non-NULL, then the task will not be executed until
1261  * previous tasks pushed with the same serializer have completed. For more information
1262  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
1263  *
1264  * \par Scheduler
1265  *
1266  * Some situations require that a task run periodically or at a future time.  Normally
1267  * the ast_sched functionality would be used but ast_sched only uses 1 thread for all
1268  * tasks and that thread isn't registered with PJLIB and therefore can't do any PJSIP
1269  * related work.
1270  *
1271  * ast_sip_sched uses ast_sched only as a scheduled queue.  When a task is ready to run,
1272  * it's pushed to a Serializer to be invoked asynchronously by a Servant.  This ensures
1273  * that the task is executed in a PJLIB registered thread and allows the ast_sched thread
1274  * to immediately continue processing the queue.  The Serializer used by ast_sip_sched
1275  * is one of your choosing or a random one from the res_pjsip pool if you don't choose one.
1276  *
1277  * \note
1278  *
1279  * Do not make assumptions about individual threads based on a corresponding serializer.
1280  * In other words, just because several tasks use the same serializer when being pushed
1281  * to servants, it does not mean that the same thread is necessarily going to execute those
1282  * tasks, even though they are all guaranteed to be executed in sequence.
1283  */
1284
1285 typedef int (*ast_sip_task)(void *user_data);
1286
1287 /*!
1288  * \brief Create a new serializer for SIP tasks
1289  * \since 13.8.0
1290  *
1291  * See \ref ast_threadpool_serializer for more information on serializers.
1292  * SIP creates serializers so that tasks operating on similar data will run
1293  * in sequence.
1294  *
1295  * \param name Name of the serializer. (must be unique)
1296  *
1297  * \retval NULL Failure
1298  * \retval non-NULL Newly-created serializer
1299  */
1300 struct ast_taskprocessor *ast_sip_create_serializer(const char *name);
1301
1302 struct ast_serializer_shutdown_group;
1303
1304 /*!
1305  * \brief Create a new serializer for SIP tasks
1306  * \since 13.8.0
1307  *
1308  * See \ref ast_threadpool_serializer for more information on serializers.
1309  * SIP creates serializers so that tasks operating on similar data will run
1310  * in sequence.
1311  *
1312  * \param name Name of the serializer. (must be unique)
1313  * \param shutdown_group Group shutdown controller. (NULL if no group association)
1314  *
1315  * \retval NULL Failure
1316  * \retval non-NULL Newly-created serializer
1317  */
1318 struct ast_taskprocessor *ast_sip_create_serializer_group(const char *name, struct ast_serializer_shutdown_group *shutdown_group);
1319
1320 /*!
1321  * \brief Determine the distributor serializer for the SIP message.
1322  * \since 13.10.0
1323  *
1324  * \param rdata The incoming message.
1325  *
1326  * \retval Calculated distributor serializer on success.
1327  * \retval NULL on error.
1328  */
1329 struct ast_taskprocessor *ast_sip_get_distributor_serializer(pjsip_rx_data *rdata);
1330
1331 /*!
1332  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
1333  *
1334  * Passing a NULL serializer is a way to remove a serializer from a dialog.
1335  *
1336  * \param dlg The SIP dialog itself
1337  * \param serializer The serializer to use
1338  */
1339 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
1340
1341 /*!
1342  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
1343  *
1344  * \param dlg The SIP dialog itself
1345  * \param endpoint The endpoint that this dialog is communicating with
1346  */
1347 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1348
1349 /*!
1350  * \brief Get the endpoint associated with this dialog
1351  *
1352  * This function increases the refcount of the endpoint by one. Release
1353  * the reference once you are finished with the endpoint.
1354  *
1355  * \param dlg The SIP dialog from which to retrieve the endpoint
1356  * \retval NULL No endpoint associated with this dialog
1357  * \retval non-NULL The endpoint.
1358  */
1359 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
1360
1361 /*!
1362  * \brief Pushes a task to SIP servants
1363  *
1364  * This uses the serializer provided to determine how to push the task.
1365  * If the serializer is NULL, then the task will be pushed to the
1366  * servants directly. If the serializer is non-NULL, then the task will be
1367  * queued behind other tasks associated with the same serializer.
1368  *
1369  * \param serializer The serializer to which the task belongs. Can be NULL
1370  * \param sip_task The task to execute
1371  * \param task_data The parameter to pass to the task when it executes
1372  * \retval 0 Success
1373  * \retval -1 Failure
1374  */
1375 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1376
1377 /*!
1378  * \brief Push a task to SIP servants and wait for it to complete
1379  *
1380  * Like \ref ast_sip_push_task except that it blocks until the task completes.
1381  *
1382  * \warning \b Never use this function in a SIP servant thread. This can potentially
1383  * cause a deadlock. If you are in a SIP servant thread, just call your function
1384  * in-line.
1385  *
1386  * \warning \b Never hold locks that may be acquired by a SIP servant thread when
1387  * calling this function. Doing so may cause a deadlock if all SIP servant threads
1388  * are blocked waiting to acquire the lock while the thread holding the lock is
1389  * waiting for a free SIP servant thread.
1390  *
1391  * \param serializer The SIP serializer to which the task belongs. May be NULL.
1392  * \param sip_task The task to execute
1393  * \param task_data The parameter to pass to the task when it executes
1394  * \retval 0 Success
1395  * \retval -1 Failure
1396  */
1397 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1398
1399 /*!
1400  * \brief Determine if the current thread is a SIP servant thread
1401  *
1402  * \retval 0 This is not a SIP servant thread
1403  * \retval 1 This is a SIP servant thread
1404  */
1405 int ast_sip_thread_is_servant(void);
1406
1407 /*!
1408  * \brief Task flags for the res_pjsip scheduler
1409  *
1410  * The default is AST_SIP_SCHED_TASK_FIXED
1411  *                | AST_SIP_SCHED_TASK_DATA_NOT_AO2
1412  *                | AST_SIP_SCHED_TASK_DATA_NO_CLEANUP
1413  *                | AST_SIP_SCHED_TASK_PERIODIC
1414  */
1415 enum ast_sip_scheduler_task_flags {
1416         /*!
1417          * The defaults
1418          */
1419         AST_SIP_SCHED_TASK_DEFAULTS = (0 << 0),
1420
1421         /*!
1422          * Run at a fixed interval.
1423          * Stop scheduling if the callback returns 0.
1424          * Any other value is ignored.
1425          */
1426         AST_SIP_SCHED_TASK_FIXED = (0 << 0),
1427         /*!
1428          * Run at a variable interval.
1429          * Stop scheduling if the callback returns 0.
1430          * Any other return value is used as the new interval.
1431          */
1432         AST_SIP_SCHED_TASK_VARIABLE = (1 << 0),
1433
1434         /*!
1435          * The task data is not an AO2 object.
1436          */
1437         AST_SIP_SCHED_TASK_DATA_NOT_AO2 = (0 << 1),
1438         /*!
1439          * The task data is an AO2 object.
1440          * A reference count will be held by the scheduler until
1441          * after the task has run for the final time (if ever).
1442          */
1443         AST_SIP_SCHED_TASK_DATA_AO2 = (1 << 1),
1444
1445         /*!
1446          * Don't take any cleanup action on the data
1447          */
1448         AST_SIP_SCHED_TASK_DATA_NO_CLEANUP = (0 << 3),
1449         /*!
1450          * If AST_SIP_SCHED_TASK_DATA_AO2 is set, decrement the reference count
1451          * otherwise call ast_free on it.
1452          */
1453         AST_SIP_SCHED_TASK_DATA_FREE = ( 1 << 3 ),
1454
1455         /*! \brief AST_SIP_SCHED_TASK_PERIODIC
1456          * The task is scheduled at multiples of interval
1457          * \see Interval
1458          */
1459         AST_SIP_SCHED_TASK_PERIODIC = (0 << 4),
1460         /*! \brief AST_SIP_SCHED_TASK_DELAY
1461          * The next invocation of the task is at last finish + interval
1462          * \see Interval
1463          */
1464         AST_SIP_SCHED_TASK_DELAY = (1 << 4),
1465 };
1466
1467 /*!
1468  * \brief Scheduler task data structure
1469  */
1470 struct ast_sip_sched_task;
1471
1472 /*!
1473  * \brief Schedule a task to run in the res_pjsip thread pool
1474  * \since 13.9.0
1475  *
1476  * \param serializer The serializer to use.  If NULL, don't use a serializer (see note below)
1477  * \param interval The invocation interval in milliseconds (see note below)
1478  * \param sip_task The task to invoke
1479  * \param name An optional name to associate with the task
1480  * \param task_data Optional data to pass to the task
1481  * \param flags One of enum ast_sip_scheduler_task_type
1482  *
1483  * \returns Pointer to \ref ast_sip_sched_task ao2 object which must be dereferenced when done.
1484  *
1485  * \paragraph Serialization
1486  *
1487  * Specifying a serializer guarantees serialized execution but NOT specifying a serializer
1488  * may still result in tasks being effectively serialized if the thread pool is busy.
1489  * The point of the serializer BTW is not to prevent parallel executions of the SAME task.
1490  * That happens automatically (see below).  It's to prevent the task from running at the same
1491  * time as other work using the same serializer, whether or not it's being run by the scheduler.
1492  *
1493  * \paragraph Interval
1494  *
1495  * The interval is used to calculate the next time the task should run.  There are two models.
1496  *
1497  * \ref AST_SIP_SCHED_TASK_PERIODIC specifies that the invocations of the task occur at the
1498  * specific interval.  That is, every \ref "interval" milliseconds, regardless of how long the task
1499  * takes. If the task takes longer than \ref interval, it will be scheduled at the next available
1500  * multiple of \ref interval.  For exmaple: If the task has an interval of 60 seconds and the task
1501  * takes 70 seconds, the next invocation will happen at 120 seconds.
1502  *
1503  * \ref AST_SIP_SCHED_TASK_DELAY specifies that the next invocation of the task should start
1504  * at \ref interval milliseconds after the current invocation has finished.
1505  *
1506  */
1507 struct ast_sip_sched_task *ast_sip_schedule_task(struct ast_taskprocessor *serializer,
1508         int interval, ast_sip_task sip_task, char *name, void *task_data,
1509         enum ast_sip_scheduler_task_flags flags);
1510
1511 /*!
1512  * \brief Cancels the next invocation of a task
1513  * \since 13.9.0
1514  *
1515  * \param schtd The task structure pointer
1516  * \retval 0 Success
1517  * \retval -1 Failure
1518  * \note Only cancels future invocations not the currently running invocation.
1519  */
1520 int ast_sip_sched_task_cancel(struct ast_sip_sched_task *schtd);
1521
1522 /*!
1523  * \brief Cancels the next invocation of a task by name
1524  * \since 13.9.0
1525  *
1526  * \param name The task name
1527  * \retval 0 Success
1528  * \retval -1 Failure
1529  * \note Only cancels future invocations not the currently running invocation.
1530  */
1531 int ast_sip_sched_task_cancel_by_name(const char *name);
1532
1533 /*!
1534  * \brief Gets the last start and end times of the task
1535  * \since 13.9.0
1536  *
1537  * \param schtd The task structure pointer
1538  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1539  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1540  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1541  * \retval 0 Success
1542  * \retval -1 Failure
1543  * \note Any of the pointers can be NULL if you don't need them.
1544  */
1545 int ast_sip_sched_task_get_times(struct ast_sip_sched_task *schtd,
1546         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1547
1548 /*!
1549  * \brief Gets the last start and end times of the task by name
1550  * \since 13.9.0
1551  *
1552  * \param name The task name
1553  * \param[out] when_queued Pointer to a timeval structure to contain the time when queued
1554  * \param[out] last_start Pointer to a timeval structure to contain the time when last started
1555  * \param[out] last_end Pointer to a timeval structure to contain the time when last ended
1556  * \retval 0 Success
1557  * \retval -1 Failure
1558  * \note Any of the pointers can be NULL if you don't need them.
1559  */
1560 int ast_sip_sched_task_get_times_by_name(const char *name,
1561         struct timeval *when_queued, struct timeval *last_start, struct timeval *last_end);
1562
1563 /*!
1564  * \brief Gets the number of milliseconds until the next invocation
1565  * \since 13.9.0
1566  *
1567  * \param schtd The task structure pointer
1568  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1569  */
1570 int ast_sip_sched_task_get_next_run(struct ast_sip_sched_task *schtd);
1571
1572 /*!
1573  * \brief Gets the number of milliseconds until the next invocation
1574  * \since 13.9.0
1575  *
1576  * \param name The task name
1577  * \return The number of milliseconds until the next invocation or -1 if the task isn't scheduled
1578  */
1579 int ast_sip_sched_task_get_next_run_by_name(const char *name);
1580
1581 /*!
1582  * \brief Checks if the task is currently running
1583  * \since 13.9.0
1584  *
1585  * \param schtd The task structure pointer
1586  * \retval 0 not running
1587  * \retval 1 running
1588  */
1589 int ast_sip_sched_is_task_running(struct ast_sip_sched_task *schtd);
1590
1591 /*!
1592  * \brief Checks if the task is currently running
1593  * \since 13.9.0
1594  *
1595  * \param name The task name
1596  * \retval 0 not running or not found
1597  * \retval 1 running
1598  */
1599 int ast_sip_sched_is_task_running_by_name(const char *name);
1600
1601 /*!
1602  * \brief Gets the task name
1603  * \since 13.9.0
1604  *
1605  * \param schtd The task structure pointer
1606  * \retval 0 success
1607  * \retval 1 failure
1608  */
1609 int ast_sip_sched_task_get_name(struct ast_sip_sched_task *schtd, char *name, size_t maxlen);
1610
1611 /*!
1612  *  @}
1613  */
1614
1615 /*!
1616  * \brief SIP body description
1617  *
1618  * This contains a type and subtype that will be added as
1619  * the "Content-Type" for the message as well as the body
1620  * text.
1621  */
1622 struct ast_sip_body {
1623         /*! Type of the body, such as "application" */
1624         const char *type;
1625         /*! Subtype of the body, such as "sdp" */
1626         const char *subtype;
1627         /*! The text to go in the body */
1628         const char *body_text;
1629 };
1630
1631 /*!
1632  * \brief General purpose method for creating a UAC dialog with an endpoint
1633  *
1634  * \param endpoint A pointer to the endpoint
1635  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
1636  * \param request_user Optional user to place into the target URI
1637  *
1638  * \retval non-NULL success
1639  * \retval NULL failure
1640  */
1641 pjsip_dialog *ast_sip_create_dialog_uac(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
1642
1643 /*!
1644  * \brief General purpose method for creating a UAS dialog with an endpoint
1645  *
1646  * \param endpoint A pointer to the endpoint
1647  * \param rdata The request that is starting the dialog
1648  * \param[out] status On failure, the reason for failure in creating the dialog
1649  */
1650 pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status);
1651
1652 /*!
1653  * \brief General purpose method for creating an rdata structure using specific information
1654  *
1655  * \param rdata[out] The rdata structure that will be populated
1656  * \param packet A SIP message
1657  * \param src_name The source IP address of the message
1658  * \param src_port The source port of the message
1659  * \param transport_type The type of transport the message was received on
1660  * \param local_name The local IP address the message was received on
1661  * \param local_port The local port the message was received on
1662  *
1663  * \retval 0 success
1664  * \retval -1 failure
1665  */
1666 int ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type,
1667         const char *local_name, int local_port);
1668
1669 /*!
1670  * \brief General purpose method for creating a SIP request
1671  *
1672  * Its typical use would be to create one-off requests such as an out of dialog
1673  * SIP MESSAGE.
1674  *
1675  * The request can either be in- or out-of-dialog. If in-dialog, the
1676  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
1677  * MUST be present. If both are present, then we will assume that the message
1678  * is to be sent in-dialog.
1679  *
1680  * The uri parameter can be specified if the request should be sent to an explicit
1681  * URI rather than one configured on the endpoint.
1682  *
1683  * \param method The method of the SIP request to send
1684  * \param dlg Optional. If specified, the dialog on which to request the message.
1685  * \param endpoint Optional. If specified, the request will be created out-of-dialog to the endpoint.
1686  * \param uri Optional. If specified, the request will be sent to this URI rather
1687  * than one configured for the endpoint.
1688  * \param contact The contact with which this request is associated for out-of-dialog requests.
1689  * \param[out] tdata The newly-created request
1690  *
1691  * The provided contact is attached to tdata with its reference bumped, but will
1692  * not survive for the entire lifetime of tdata since the contact is cleaned up
1693  * when all supplements have completed execution.
1694  *
1695  * \retval 0 Success
1696  * \retval -1 Failure
1697  */
1698 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
1699                 struct ast_sip_endpoint *endpoint, const char *uri,
1700                 struct ast_sip_contact *contact, pjsip_tx_data **tdata);
1701
1702 /*!
1703  * \brief General purpose method for sending a SIP request
1704  *
1705  * This is a companion function for \ref ast_sip_create_request. The request
1706  * created there can be passed to this function, though any request may be
1707  * passed in.
1708  *
1709  * This will automatically set up handling outbound authentication challenges if
1710  * they arrive.
1711  *
1712  * \param tdata The request to send
1713  * \param dlg Optional. The dialog in which the request is sent.  Otherwise it is out-of-dialog.
1714  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1715  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1716  * \param callback Callback to be called upon receipt of out-of-dialog response.
1717  *
1718  * \retval 0 Success
1719  * \retval -1 Failure (out-of-dialog callback will not be called.)
1720  */
1721 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg,
1722         struct ast_sip_endpoint *endpoint, void *token,
1723         void (*callback)(void *token, pjsip_event *e));
1724
1725 /*!
1726  * \brief General purpose method for sending an Out-Of-Dialog SIP request
1727  *
1728  * This is a companion function for \ref ast_sip_create_request. The request
1729  * created there can be passed to this function, though any request may be
1730  * passed in.
1731  *
1732  * This will automatically set up handling outbound authentication challenges if
1733  * they arrive.
1734  *
1735  * \param tdata The request to send
1736  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1737  * \param timeout.  If non-zero, after the timeout the transaction will be terminated
1738  * and the callback will be called with the PJSIP_EVENT_TIMER type.
1739  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1740  * \param callback Callback to be called upon receipt of out-of-dialog response.
1741  *
1742  * \retval 0 Success
1743  * \retval -1 Failure (out-of-dialog callback will not be called.)
1744  *
1745  * \note Timeout processing:
1746  * There are 2 timers associated with this request, PJSIP timer_b which is
1747  * set globally in the "system" section of pjsip.conf, and the timeout specified
1748  * on this call.  The timer that expires first (before normal completion) will
1749  * cause the callback to be run with e->body.tsx_state.type = PJSIP_EVENT_TIMER.
1750  * The timer that expires second is simply ignored and the callback is not run again.
1751  */
1752 int ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata,
1753         struct ast_sip_endpoint *endpoint, int timeout, void *token,
1754         void (*callback)(void *token, pjsip_event *e));
1755
1756 /*!
1757  * \brief General purpose method for creating a SIP response
1758  *
1759  * Its typical use would be to create responses for out of dialog
1760  * requests.
1761  *
1762  * \param rdata The rdata from the incoming request.
1763  * \param st_code The response code to transmit.
1764  * \param contact The contact with which this request is associated.
1765  * \param[out] tdata The newly-created response
1766  *
1767  * The provided contact is attached to tdata with its reference bumped, but will
1768  * not survive for the entire lifetime of tdata since the contact is cleaned up
1769  * when all supplements have completed execution.
1770  *
1771  * \retval 0 Success
1772  * \retval -1 Failure
1773  */
1774 int ast_sip_create_response(const pjsip_rx_data *rdata, int st_code,
1775         struct ast_sip_contact *contact, pjsip_tx_data **p_tdata);
1776
1777 /*!
1778  * \brief Send a response to an out of dialog request
1779  *
1780  * Use this function sparingly, since this does not create a transaction
1781  * within PJSIP. This means that if the request is retransmitted, it is
1782  * your responsibility to detect this and not process the same request
1783  * twice, and to send the same response for each retransmission.
1784  *
1785  * \param res_addr The response address for this response
1786  * \param tdata The response to send
1787  * \param endpoint The ast_sip_endpoint associated with this response
1788  *
1789  * \retval 0 Success
1790  * \retval -1 Failure
1791  */
1792 int ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1793
1794 /*!
1795  * \brief Send a stateful response to an out of dialog request
1796  *
1797  * This creates a transaction within PJSIP, meaning that if the request
1798  * that we are responding to is retransmitted, we will not attempt to
1799  * re-handle the request.
1800  *
1801  * \param rdata The request that is being responded to
1802  * \param tdata The response to send
1803  * \param endpoint The ast_sip_endpoint associated with this response
1804  *
1805  * \since 13.4.0
1806  *
1807  * \retval 0 Success
1808  * \retval -1 Failure
1809  */
1810 int ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1811
1812 /*!
1813  * \brief Determine if an incoming request requires authentication
1814  *
1815  * This calls into the registered authenticator's requires_authentication callback
1816  * in order to determine if the request requires authentication.
1817  *
1818  * If there is no registered authenticator, then authentication will be assumed
1819  * not to be required.
1820  *
1821  * \param endpoint The endpoint from which the request originates
1822  * \param rdata The incoming SIP request
1823  * \retval non-zero The request requires authentication
1824  * \retval 0 The request does not require authentication
1825  */
1826 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1827
1828 /*!
1829  * \brief Method to determine authentication status of an incoming request
1830  *
1831  * This will call into a registered authenticator. The registered authenticator will
1832  * do what is necessary to determine whether the incoming request passes authentication.
1833  * A tentative response is passed into this function so that if, say, a digest authentication
1834  * challenge should be sent in the ensuing response, it can be added to the response.
1835  *
1836  * \param endpoint The endpoint from the request was sent
1837  * \param rdata The request to potentially authenticate
1838  * \param tdata Tentative response to the request
1839  * \return The result of checking authentication.
1840  */
1841 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
1842                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1843
1844 /*!
1845  * \brief Create a response to an authentication challenge
1846  *
1847  * This will call into an outbound authenticator's create_request_with_auth callback
1848  * to create a new request with authentication credentials. See the create_request_with_auth
1849  * callback in the \ref ast_sip_outbound_authenticator structure for details about
1850  * the parameters and return values.
1851  */
1852 int ast_sip_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
1853                 pjsip_tx_data *tdata, pjsip_tx_data **new_request);
1854
1855 /*!
1856  * \brief Determine the endpoint that has sent a SIP message
1857  *
1858  * This will call into each of the registered endpoint identifiers'
1859  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
1860  * This will return an ao2 object. Its reference count will need to be
1861  * decremented when completed using the endpoint.
1862  *
1863  * \param rdata The inbound SIP message to use when identifying the endpoint.
1864  * \retval NULL No matching endpoint
1865  * \retval non-NULL The matching endpoint
1866  */
1867 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
1868
1869 /*!
1870  * \brief Set the outbound proxy for an outbound SIP message
1871  *
1872  * \param tdata The message to set the outbound proxy on
1873  * \param proxy SIP uri of the proxy
1874  * \retval 0 Success
1875  * \retval -1 Failure
1876  */
1877 int ast_sip_set_outbound_proxy(pjsip_tx_data *tdata, const char *proxy);
1878
1879 /*!
1880  * \brief Add a header to an outbound SIP message
1881  *
1882  * \param tdata The message to add the header to
1883  * \param name The header name
1884  * \param value The header value
1885  * \retval 0 Success
1886  * \retval -1 Failure
1887  */
1888 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
1889
1890 /*!
1891  * \brief Add a body to an outbound SIP message
1892  *
1893  * If this is called multiple times, the latest body will replace the current
1894  * body.
1895  *
1896  * \param tdata The message to add the body to
1897  * \param body The message body to add
1898  * \retval 0 Success
1899  * \retval -1 Failure
1900  */
1901 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
1902
1903 /*!
1904  * \brief Add a multipart body to an outbound SIP message
1905  *
1906  * This will treat each part of the input vector as part of a multipart body and
1907  * add each part to the SIP message.
1908  *
1909  * \param tdata The message to add the body to
1910  * \param bodies The parts of the body to add
1911  * \retval 0 Success
1912  * \retval -1 Failure
1913  */
1914 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
1915
1916 /*!
1917  * \brief Append body data to a SIP message
1918  *
1919  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
1920  * a body if it currently exists, it appends data to an existing body.
1921  *
1922  * \param tdata The message to append the body to
1923  * \param body The string to append to the end of the current body
1924  * \retval 0 Success
1925  * \retval -1 Failure
1926  */
1927 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
1928
1929 /*!
1930  * \brief Copy a pj_str_t into a standard character buffer.
1931  *
1932  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
1933  * terminated string needs to have the pj_str_t copied into a separate
1934  * buffer.
1935  *
1936  * This method copies the pj_str_t contents into the destination buffer
1937  * and NULL-terminates the buffer.
1938  *
1939  * \param dest The destination buffer
1940  * \param src The pj_str_t to copy
1941  * \param size The size of the destination buffer.
1942  */
1943 void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
1944
1945 /*!
1946  * \brief Get the looked-up endpoint on an out-of dialog request or response
1947  *
1948  * The function may ONLY be called on out-of-dialog requests or responses. For
1949  * in-dialog requests and responses, it is required that the user of the dialog
1950  * has the looked-up endpoint stored locally.
1951  *
1952  * This function should never return NULL if the message is out-of-dialog. It will
1953  * always return NULL if the message is in-dialog.
1954  *
1955  * This function will increase the reference count of the returned endpoint by one.
1956  * Release your reference using the ao2_ref function when finished.
1957  *
1958  * \param rdata Out-of-dialog request or response
1959  * \return The looked up endpoint
1960  */
1961 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
1962
1963 /*!
1964  * \brief Add 'user=phone' parameter to URI if enabled and user is a phone number.
1965  *
1966  * \param endpoint The endpoint to use for configuration
1967  * \param pool The memory pool to allocate the parameter from
1968  * \param uri The URI to check for user and to add parameter to
1969  */
1970 void ast_sip_add_usereqphone(const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri);
1971
1972 /*!
1973  * \brief Retrieve any endpoints available to sorcery.
1974  *
1975  * \retval Endpoints available to sorcery, NULL if no endpoints found.
1976  */
1977 struct ao2_container *ast_sip_get_endpoints(void);
1978
1979 /*!
1980  * \brief Retrieve the default outbound endpoint.
1981  *
1982  * \retval The default outbound endpoint, NULL if not found.
1983  */
1984 struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void);
1985
1986 /*!
1987  * \brief Retrieve relevant SIP auth structures from sorcery
1988  *
1989  * \param auths Vector of sorcery IDs of auth credentials to retrieve
1990  * \param[out] out The retrieved auths are stored here
1991  */
1992 int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out);
1993
1994 /*!
1995  * \brief Clean up retrieved auth structures from memory
1996  *
1997  * Call this function once you have completed operating on auths
1998  * retrieved from \ref ast_sip_retrieve_auths
1999  *
2000  * \param auths An vector of auth structures to clean up
2001  * \param num_auths The number of auths in the vector
2002  */
2003 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
2004
2005 /*!
2006  * \brief Checks if the given content type matches type/subtype.
2007  *
2008  * Compares the pjsip_media_type with the passed type and subtype and
2009  * returns the result of that comparison.  The media type parameters are
2010  * ignored.
2011  *
2012  * \param content_type The pjsip_media_type structure to compare
2013  * \param type The media type to compare
2014  * \param subtype The media subtype to compare
2015  * \retval 0 No match
2016  * \retval -1 Match
2017  */
2018 int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
2019
2020 /*!
2021  * \brief Send a security event notification for when an invalid endpoint is requested
2022  *
2023  * \param name Name of the endpoint requested
2024  * \param rdata Received message
2025  */
2026 void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
2027
2028 /*!
2029  * \brief Send a security event notification for when an ACL check fails
2030  *
2031  * \param endpoint Pointer to the endpoint in use
2032  * \param rdata Received message
2033  * \param name Name of the ACL
2034  */
2035 void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
2036
2037 /*!
2038  * \brief Send a security event notification for when a challenge response has failed
2039  *
2040  * \param endpoint Pointer to the endpoint in use
2041  * \param rdata Received message
2042  */
2043 void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2044
2045 /*!
2046  * \brief Send a security event notification for when authentication succeeds
2047  *
2048  * \param endpoint Pointer to the endpoint in use
2049  * \param rdata Received message
2050  */
2051 void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2052
2053 /*!
2054  * \brief Send a security event notification for when an authentication challenge is sent
2055  *
2056  * \param endpoint Pointer to the endpoint in use
2057  * \param rdata Received message
2058  * \param tdata Sent message
2059  */
2060 void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
2061
2062 /*!
2063  * \brief Send a security event notification for when a request is not supported
2064  *
2065  * \param endpoint Pointer to the endpoint in use
2066  * \param rdata Received message
2067  * \param req_type the type of request
2068  */
2069 void ast_sip_report_req_no_support(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata,
2070                                    const char* req_type);
2071
2072 /*!
2073  * \brief Send a security event notification for when a memory limit is hit.
2074  *
2075  * \param endpoint Pointer to the endpoint in use
2076  * \param rdata Received message
2077  */
2078 void ast_sip_report_mem_limit(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
2079
2080 int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
2081 int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
2082
2083 /*!
2084  * \brief Retrieves the value associated with the given key.
2085  *
2086  * \param ht the hash table/dictionary to search
2087  * \param key the key to find
2088  *
2089  * \retval the value associated with the key, NULL otherwise.
2090  */
2091 void *ast_sip_dict_get(void *ht, const char *key);
2092
2093 /*!
2094  * \brief Using the dictionary stored in mod_data array at a given id,
2095  *        retrieve the value associated with the given key.
2096  *
2097  * \param mod_data a module data array
2098  * \param id the mod_data array index
2099  * \param key the key to find
2100  *
2101  * \retval the value associated with the key, NULL otherwise.
2102  */
2103 #define ast_sip_mod_data_get(mod_data, id, key)         \
2104         ast_sip_dict_get(mod_data[id], key)
2105
2106 /*!
2107  * \brief Set the value for the given key.
2108  *
2109  * Note - if the hash table does not exist one is created first, the key/value
2110  * pair is set, and the hash table returned.
2111  *
2112  * \param pool the pool to allocate memory in
2113  * \param ht the hash table/dictionary in which to store the key/value pair
2114  * \param key the key to associate a value with
2115  * \param val the value to associate with a key
2116  *
2117  * \retval the given, or newly created, hash table.
2118  */
2119 void *ast_sip_dict_set(pj_pool_t* pool, void *ht,
2120                        const char *key, void *val);
2121
2122 /*!
2123  * \brief Utilizing a mod_data array for a given id, set the value
2124  *        associated with the given key.
2125  *
2126  * For a given structure's mod_data array set the element indexed by id to
2127  * be a dictionary containing the key/val pair.
2128  *
2129  * \param pool a memory allocation pool
2130  * \param mod_data a module data array
2131  * \param id the mod_data array index
2132  * \param key the key to find
2133  * \param val the value to associate with a key
2134  */
2135 #define ast_sip_mod_data_set(pool, mod_data, id, key, val)              \
2136         mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
2137
2138 /*!
2139  * \brief For every contact on an AOR call the given 'on_contact' handler.
2140  *
2141  * \param aor the aor containing a list of contacts to iterate
2142  * \param on_contact callback on each contact on an AOR.  The object
2143  * received by the callback will be a ast_sip_contact_wrapper structure.
2144  * \param arg user data passed to handler
2145  * \retval 0 Success, non-zero on failure
2146  */
2147 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
2148                 ao2_callback_fn on_contact, void *arg);
2149
2150 /*!
2151  * \brief Handler used to convert a contact to a string.
2152  *
2153  * \param object the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
2154  * \param arg user data passed to handler
2155  * \param flags
2156  * \retval 0 Success, non-zero on failure
2157  */
2158 int ast_sip_contact_to_str(void *object, void *arg, int flags);
2159
2160 /*!
2161  * \brief For every aor in the comma separated aors string call the
2162  *        given 'on_aor' handler.
2163  *
2164  * \param aors a comma separated list of aors
2165  * \param on_aor callback for each aor
2166  * \param arg user data passed to handler
2167  * \retval 0 Success, non-zero on failure
2168  */
2169 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg);
2170
2171 /*!
2172  * \brief For every auth in the array call the given 'on_auth' handler.
2173  *
2174  * \param array an array of auths
2175  * \param on_auth callback for each auth
2176  * \param arg user data passed to handler
2177  * \retval 0 Success, non-zero on failure
2178  */
2179 int ast_sip_for_each_auth(const struct ast_sip_auth_vector *array,
2180                           ao2_callback_fn on_auth, void *arg);
2181
2182 /*!
2183  * \brief Converts the given auth type to a string
2184  *
2185  * \param type the auth type to convert
2186  * \retval a string representative of the auth type
2187  */
2188 const char *ast_sip_auth_type_to_str(enum ast_sip_auth_type type);
2189
2190 /*!
2191  * \brief Converts an auths array to a string of comma separated values
2192  *
2193  * \param auths an auth array
2194  * \param buf the string buffer to write the object data
2195  * \retval 0 Success, non-zero on failure
2196  */
2197 int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf);
2198
2199 /*!
2200  * \brief AMI variable container
2201  */
2202 struct ast_sip_ami {
2203         /*! Manager session */
2204         struct mansession *s;
2205         /*! Manager message */
2206         const struct message *m;
2207         /*! Manager Action ID */
2208         const char *action_id;
2209         /*! user specified argument data */
2210         void *arg;
2211         /*! count of objects */
2212         int count;
2213 };
2214
2215 /*!
2216  * \brief Creates a string to store AMI event data in.
2217  *
2218  * \param event the event to set
2219  * \param ami AMI session and message container
2220  * \retval an initialized ast_str or NULL on error.
2221  */
2222 struct ast_str *ast_sip_create_ami_event(const char *event,
2223                                          struct ast_sip_ami *ami);
2224
2225 /*!
2226  * \brief An entity responsible formatting endpoint information.
2227  */
2228 struct ast_sip_endpoint_formatter {
2229         /*!
2230          * \brief Callback used to format endpoint information over AMI.
2231          */
2232         int (*format_ami)(const struct ast_sip_endpoint *endpoint,
2233                           struct ast_sip_ami *ami);
2234         AST_RWLIST_ENTRY(ast_sip_endpoint_formatter) next;
2235 };
2236
2237 /*!
2238  * \brief Register an endpoint formatter.
2239  *
2240  * \param obj the formatter to register
2241  * \retval 0 Success
2242  * \retval -1 Failure
2243  */
2244 int ast_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2245
2246 /*!
2247  * \brief Unregister an endpoint formatter.
2248  *
2249  * \param obj the formatter to unregister
2250  */
2251 void ast_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
2252
2253 /*!
2254  * \brief Converts a sorcery object to a string of object properties.
2255  *
2256  * \param obj the sorcery object to convert
2257  * \param str the string buffer to write the object data
2258  * \retval 0 Success, non-zero on failure
2259  */
2260 int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf);
2261
2262 /*!
2263  * \brief Formats the endpoint and sends over AMI.
2264  *
2265  * \param endpoint the endpoint to format and send
2266  * \param endpoint ami AMI variable container
2267  * \param count the number of formatters operated on
2268  * \retval 0 Success, otherwise non-zero on error
2269  */
2270 int ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint,
2271                                 struct ast_sip_ami *ami, int *count);
2272
2273 /*!
2274  * \brief Format auth details for AMI.
2275  *
2276  * \param auths an auth array
2277  * \param ami ami variable container
2278  * \retval 0 Success, non-zero on failure
2279  */
2280 int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths,
2281                              struct ast_sip_ami *ami);
2282
2283 /*!
2284  * \brief Retrieve the endpoint snapshot for an endpoint
2285  *
2286  * \param endpoint The endpoint whose snapshot is to be retreieved.
2287  * \retval The endpoint snapshot
2288  */
2289 struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
2290         const struct ast_sip_endpoint *endpoint);
2291
2292 /*!
2293  * \brief Retrieve the device state for an endpoint.
2294  *
2295  * \param endpoint The endpoint whose state is to be retrieved.
2296  * \retval The device state.
2297  */
2298 const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint);
2299
2300 /*!
2301  * \brief For every channel snapshot on an endpoint snapshot call the given
2302  *        'on_channel_snapshot' handler.
2303  *
2304  * \param endpoint_snapshot snapshot of an endpoint
2305  * \param on_channel_snapshot callback for each channel snapshot
2306  * \param arg user data passed to handler
2307  * \retval 0 Success, non-zero on failure
2308  */
2309 int ast_sip_for_each_channel_snapshot(const struct ast_endpoint_snapshot *endpoint_snapshot,
2310                 ao2_callback_fn on_channel_snapshot,
2311                                       void *arg);
2312
2313 /*!
2314  * \brief For every channel snapshot on an endpoint all the given
2315  *        'on_channel_snapshot' handler.
2316  *
2317  * \param endpoint endpoint
2318  * \param on_channel_snapshot callback for each channel snapshot
2319  * \param arg user data passed to handler
2320  * \retval 0 Success, non-zero on failure
2321  */
2322 int ast_sip_for_each_channel(const struct ast_sip_endpoint *endpoint,
2323                 ao2_callback_fn on_channel_snapshot,
2324                                       void *arg);
2325
2326 enum ast_sip_supplement_priority {
2327         /*! Top priority. Supplements with this priority are those that need to run before any others */
2328         AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
2329         /*! Channel creation priority.
2330          * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
2331          * or after channel creation, then set your priority to be lower or higher than this value.
2332          */
2333         AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
2334         /*! Lowest priority. Supplements with this priority should be run after all other supplements */
2335         AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
2336 };
2337
2338 /*!
2339  * \brief A supplement to SIP message processing
2340  *
2341  * These can be registered by any module in order to add
2342  * processing to incoming and outgoing SIP out of dialog
2343  * requests and responses
2344  */
2345 struct ast_sip_supplement {
2346         /*! Method on which to call the callbacks. If NULL, call on all methods */
2347         const char *method;
2348         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
2349         enum ast_sip_supplement_priority priority;
2350         /*!
2351          * \brief Called on incoming SIP request
2352          * This method can indicate a failure in processing in its return. If there
2353          * is a failure, it is required that this method sends a response to the request.
2354          * This method is always called from a SIP servant thread.
2355          *
2356          * \note
2357          * The following PJSIP methods will not work properly:
2358          * pjsip_rdata_get_dlg()
2359          * pjsip_rdata_get_tsx()
2360          * The reason is that the rdata passed into this function is a cloned rdata structure,
2361          * and its module data is not copied during the cloning operation.
2362          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2363          *
2364          * \note
2365          * There is no guarantee that a channel will be present on the session when this is called.
2366          */
2367         int (*incoming_request)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2368         /*!
2369          * \brief Called on an incoming SIP response
2370          * This method is always called from a SIP servant thread.
2371          *
2372          * \note
2373          * The following PJSIP methods will not work properly:
2374          * pjsip_rdata_get_dlg()
2375          * pjsip_rdata_get_tsx()
2376          * The reason is that the rdata passed into this function is a cloned rdata structure,
2377          * and its module data is not copied during the cloning operation.
2378          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2379          *
2380          * \note
2381          * There is no guarantee that a channel will be present on the session when this is called.
2382          */
2383         void (*incoming_response)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2384         /*!
2385          * \brief Called on an outgoing SIP request
2386          * This method is always called from a SIP servant thread.
2387          */
2388         void (*outgoing_request)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2389         /*!
2390          * \brief Called on an outgoing SIP response
2391          * This method is always called from a SIP servant thread.
2392          */
2393         void (*outgoing_response)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2394         /*! Next item in the list */
2395         AST_LIST_ENTRY(ast_sip_supplement) next;
2396 };
2397
2398 /*!
2399  * \brief Register a supplement to SIP out of dialog processing
2400  *
2401  * This allows for someone to insert themselves in the processing of out
2402  * of dialog SIP requests and responses. This, for example could allow for
2403  * a module to set channel data based on headers in an incoming message.
2404  * Similarly, a module could reject an incoming request if desired.
2405  *
2406  * \param supplement The supplement to register
2407  * \retval 0 Success
2408  * \retval -1 Failure
2409  */
2410 int ast_sip_register_supplement(struct ast_sip_supplement *supplement);
2411
2412 /*!
2413  * \brief Unregister a an supplement to SIP out of dialog processing
2414  *
2415  * \param supplement The supplement to unregister
2416  */
2417 void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement);
2418
2419 /*!
2420  * \brief Retrieve the system debug setting (yes|no|host).
2421  *
2422  * \note returned string needs to be de-allocated by caller.
2423  *
2424  * \retval the system debug setting.
2425  */
2426 char *ast_sip_get_debug(void);
2427
2428 /*!
2429  * \brief Retrieve the global regcontext setting.
2430  *
2431  * \since 13.8.0
2432  *
2433  * \note returned string needs to be de-allocated by caller.
2434  *
2435  * \retval the global regcontext setting
2436  */
2437 char *ast_sip_get_regcontext(void);
2438
2439 /*!
2440  * \brief Retrieve the global endpoint_identifier_order setting.
2441  *
2442  * Specifies the order by which endpoint identifiers should be regarded.
2443  *
2444  * \retval the global endpoint_identifier_order value
2445  */
2446 char *ast_sip_get_endpoint_identifier_order(void);
2447
2448 /*!
2449  * \brief Retrieve the default voicemail extension.
2450  * \since 13.9.0
2451  *
2452  * \note returned string needs to be de-allocated by caller.
2453  *
2454  * \retval the default voicemail extension
2455  */
2456 char *ast_sip_get_default_voicemail_extension(void);
2457
2458 /*!
2459  * \brief Retrieve the global default realm.
2460  *
2461  * This is the value placed in outbound challenges' realm if there
2462  * is no better option (such as an auth-configured realm).
2463  *
2464  * \param[out] realm The default realm
2465  * \param size The buffer size of realm
2466  * \return nothing
2467  */
2468 void ast_sip_get_default_realm(char *realm, size_t size);
2469
2470 /*!
2471  * \brief Retrieve the global default from user.
2472  *
2473  * This is the value placed in outbound requests' From header if there
2474  * is no better option (such as an endpoint-configured from_user or
2475  * caller ID number).
2476  *
2477  * \param[out] from_user The default from user
2478  * \param size The buffer size of from_user
2479  * \return nothing
2480  */
2481 void ast_sip_get_default_from_user(char *from_user, size_t size);
2482
2483 /*! \brief Determines whether the res_pjsip module is loaded */
2484 #define CHECK_PJSIP_MODULE_LOADED()                             \
2485         do {                                                    \
2486                 if (!ast_module_check("res_pjsip.so")           \
2487                         || !ast_sip_get_pjsip_endpoint()) {     \
2488                         return AST_MODULE_LOAD_DECLINE;         \
2489                 }                                               \
2490         } while(0)
2491
2492 /*!
2493  * \brief Retrieve the system keep alive interval setting.
2494  *
2495  * \retval the keep alive interval.
2496  */
2497 unsigned int ast_sip_get_keep_alive_interval(void);
2498
2499 /*!
2500  * \brief Retrieve the system contact expiration check interval setting.
2501  *
2502  * \retval the contact expiration check interval.
2503  */
2504 unsigned int ast_sip_get_contact_expiration_check_interval(void);
2505
2506 /*!
2507  * \brief Retrieve the system setting 'disable multi domain'.
2508  * \since 13.9.0
2509  *
2510  * \retval non zero if disable multi domain.
2511  */
2512 unsigned int ast_sip_get_disable_multi_domain(void);
2513
2514 /*!
2515  * \brief Retrieve the system max initial qualify time.
2516  *
2517  * \retval the maximum initial qualify time.
2518  */
2519 unsigned int ast_sip_get_max_initial_qualify_time(void);
2520
2521 /*!
2522  * \brief translate ast_sip_contact_status_type to character string.
2523  *
2524  * \retval the character string equivalent.
2525  */
2526
2527 const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status);
2528 const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status);
2529
2530 /*!
2531  * \brief Set a request to use the next value in the list of resolved addresses.
2532  *
2533  * \param tdata the tx data from the original request
2534  * \retval 0 No more addresses to try
2535  * \retval 1 The request was successfully re-intialized
2536  */
2537 int ast_sip_failover_request(pjsip_tx_data *tdata);
2538
2539 /*
2540  * \brief Retrieve the local host address in IP form
2541  *
2542  * \param af The address family to retrieve
2543  * \param addr A place to store the local host address
2544  *
2545  * \retval 0 success
2546  * \retval -1 failure
2547  *
2548  * \since 13.6.0
2549  */
2550 int ast_sip_get_host_ip(int af, pj_sockaddr *addr);
2551
2552 /*!
2553  * \brief Retrieve the local host address in string form
2554  *
2555  * \param af The address family to retrieve
2556  *
2557  * \retval non-NULL success
2558  * \retval NULL failure
2559  *
2560  * \since 13.6.0
2561  *
2562  * \note An empty string may be returned if the address family is valid but no local address exists
2563  */
2564 const char *ast_sip_get_host_ip_string(int af);
2565
2566 /*!
2567  * \brief Return the size of the SIP threadpool's task queue
2568  * \since 13.7.0
2569  */
2570 long ast_sip_threadpool_queue_size(void);
2571
2572 /*!
2573  * \brief Retrieve transport state
2574  * \since 13.7.1
2575  *
2576  * @param transport_id
2577  * @returns transport_state
2578  *
2579  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2580  */
2581 struct ast_sip_transport_state *ast_sip_get_transport_state(const char *transport_id);
2582
2583 /*!
2584  * \brief Retrieves all transport states
2585  * \since 13.7.1
2586  *
2587  * @returns ao2_container
2588  *
2589  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2590  */
2591 struct ao2_container *ast_sip_get_transport_states(void);
2592
2593 /*!
2594  * \brief Sets pjsip_tpselector from ast_sip_transport
2595  * \since 13.8.0
2596  *
2597  * \param transport The transport to be used
2598  * \param selector The selector to be populated
2599  * \retval 0 success
2600  * \retval -1 failure
2601  */
2602 int ast_sip_set_tpselector_from_transport(const struct ast_sip_transport *transport, pjsip_tpselector *selector);
2603
2604 /*!
2605  * \brief Sets pjsip_tpselector from ast_sip_transport
2606  * \since 13.8.0
2607  *
2608  * \param transport_name The name of the transport to be used
2609  * \param selector The selector to be populated
2610  * \retval 0 success
2611  * \retval -1 failure
2612  */
2613 int ast_sip_set_tpselector_from_transport_name(const char *transport_name, pjsip_tpselector *selector);
2614
2615 /*!
2616  * \brief Set name and number information on an identity header.
2617  *
2618  * \param pool Memory pool to use for string duplication
2619  * \param id_hdr A From, P-Asserted-Identity, or Remote-Party-ID header to modify
2620  * \param id The identity information to apply to the header
2621  */
2622 void ast_sip_modify_id_header(pj_pool_t *pool, pjsip_fromto_hdr *id_hdr,
2623         const struct ast_party_id *id);
2624
2625 /*!
2626  * \brief Retrieve the unidentified request security event thresholds
2627  * \since 13.8.0
2628  *
2629  * \param count The maximum number of unidentified requests per source ip to accumulate before emitting a security event
2630  * \param period The period in seconds over which to accumulate unidentified requests
2631  * \param prune_interval The interval in seconds at which expired entries will be pruned
2632  */
2633 void ast_sip_get_unidentified_request_thresholds(unsigned int *count, unsigned int *period,
2634         unsigned int *prune_interval);
2635
2636 #endif /* _RES_PJSIP_H */