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