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