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