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