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