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