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