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