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