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