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