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