res_pjsip/config_transport: Allow reloading transports.
[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 "asterisk/stringfields.h"
23 /* Needed for struct ast_sockaddr */
24 #include "asterisk/netsock2.h"
25 /* Needed for linked list macros */
26 #include "asterisk/linkedlists.h"
27 /* Needed for ast_party_id */
28 #include "asterisk/channel.h"
29 /* Needed for ast_sorcery */
30 #include "asterisk/sorcery.h"
31 /* Needed for ast_dnsmgr */
32 #include "asterisk/dnsmgr.h"
33 /* Needed for ast_endpoint */
34 #include "asterisk/endpoints.h"
35 /* Needed for ast_t38_ec_modes */
36 #include "asterisk/udptl.h"
37 /* Needed for pj_sockaddr */
38 #include <pjlib.h>
39 /* Needed for ast_rtp_dtls_cfg struct */
40 #include "asterisk/rtp_engine.h"
41 /* Needed for AST_VECTOR macro */
42 #include "asterisk/vector.h"
43 /* Needed for ast_sip_for_each_channel_snapshot struct */
44 #include "asterisk/stasis_channels.h"
45 #include "asterisk/stasis_endpoints.h"
46
47 /* Forward declarations of PJSIP stuff */
48 struct pjsip_rx_data;
49 struct pjsip_module;
50 struct pjsip_tx_data;
51 struct pjsip_dialog;
52 struct pjsip_transport;
53 struct pjsip_tpfactory;
54 struct pjsip_tls_setting;
55 struct pjsip_tpselector;
56
57 /*! \brief Maximum number of ciphers supported for a TLS transport */
58 #define SIP_TLS_MAX_CIPHERS 64
59
60 /*!
61  * \brief Structure for SIP transport information
62  */
63 struct ast_sip_transport_state {
64         /*! \brief Transport itself */
65         struct pjsip_transport *transport;
66         /*! \brief Transport factory */
67         struct pjsip_tpfactory *factory;
68         /*!
69          * Transport id
70          * \since 13.8.0
71          */
72         char *id;
73         /*!
74          * Transport type
75          * \since 13.8.0
76          */
77         enum ast_transport type;
78         /*!
79          * Address and port to bind to
80          * \since 13.8.0
81          */
82         pj_sockaddr host;
83         /*!
84          * TLS settings
85          * \since 13.8.0
86          */
87         pjsip_tls_setting tls;
88         /*!
89          * Configured TLS ciphers
90          * \since 13.8.0
91          */
92         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
93         /*!
94          * Optional local network information, used for NAT purposes
95          * \since 13.8.0
96          */
97         struct ast_ha *localnet;
98         /*!
99          * DNS manager for refreshing the external address
100          * \since 13.8.0
101          */
102         struct ast_dnsmgr_entry *external_address_refresher;
103         /*!
104          * Optional external address information
105          * \since 13.8.0
106          */
107         struct ast_sockaddr external_address;
108 };
109
110 /*
111  * \brief Transport to bind to
112  */
113 struct ast_sip_transport {
114         /*! Sorcery object details */
115         SORCERY_OBJECT(details);
116         AST_DECLARE_STRING_FIELDS(
117                 /*! Certificate of authority list file */
118                 AST_STRING_FIELD(ca_list_file);
119                 /*! Certificate of authority list path */
120                 AST_STRING_FIELD(ca_list_path);
121                 /*! Public certificate file */
122                 AST_STRING_FIELD(cert_file);
123                 /*! Optional private key of the certificate file */
124                 AST_STRING_FIELD(privkey_file);
125                 /*! Password to open the private key */
126                 AST_STRING_FIELD(password);
127                 /*! External signaling address */
128                 AST_STRING_FIELD(external_signaling_address);
129                 /*! External media address */
130                 AST_STRING_FIELD(external_media_address);
131                 /*! Optional domain to use for messages if provided could not be found */
132                 AST_STRING_FIELD(domain);
133                 );
134         /*! Type of transport */
135         enum ast_transport type;
136         /*!
137          * \deprecated Moved to ast_sip_transport_state
138          * \version 13.8.0 deprecated
139          * Address and port to bind to
140          */
141         pj_sockaddr host;
142         /*! Number of simultaneous asynchronous operations */
143         unsigned int async_operations;
144         /*! Optional external port for signaling */
145         unsigned int external_signaling_port;
146         /*!
147          * \deprecated Moved to ast_sip_transport_state
148          * \version 13.7.1 deprecated
149          * TLS settings
150          */
151         pjsip_tls_setting tls;
152         /*!
153          * \deprecated Moved to ast_sip_transport_state
154          * \version 13.7.1 deprecated
155          * Configured TLS ciphers
156          */
157         pj_ssl_cipher ciphers[SIP_TLS_MAX_CIPHERS];
158         /*!
159          * \deprecated Moved to ast_sip_transport_state
160          * \version 13.7.1 deprecated
161          * Optional local network information, used for NAT purposes
162          */
163         struct ast_ha *localnet;
164         /*!
165          * \deprecated Moved to ast_sip_transport_state
166          * \version 13.7.1 deprecated
167          * DNS manager for refreshing the external address
168          */
169         struct ast_dnsmgr_entry *external_address_refresher;
170         /*!
171          * \deprecated Moved to ast_sip_transport_state
172          * \version 13.7.1 deprecated
173          * Optional external address information
174          */
175         struct ast_sockaddr external_address;
176         /*!
177          * \deprecated
178          * \version 13.7.1 deprecated
179          * Transport state information
180          */
181         struct ast_sip_transport_state *state;
182         /*! QOS DSCP TOS bits */
183         unsigned int tos;
184         /*! QOS COS value */
185         unsigned int cos;
186         /*! Write timeout */
187         int write_timeout;
188         /*! Allow reload */
189         int allow_reload;
190 };
191
192 #define SIP_SORCERY_DOMAIN_ALIAS_TYPE "domain_alias"
193
194 /*!
195  * Details about a SIP domain alias
196  */
197 struct ast_sip_domain_alias {
198         /*! Sorcery object details */
199         SORCERY_OBJECT(details);
200         AST_DECLARE_STRING_FIELDS(
201                 /*! Domain to be aliased to */
202                 AST_STRING_FIELD(domain);
203         );
204 };
205
206 /*!
207  * \brief Structure for SIP nat hook information
208  */
209 struct ast_sip_nat_hook {
210         /*! Sorcery object details */
211         SORCERY_OBJECT(details);
212         /*! Callback for when a message is going outside of our local network */
213         void (*outgoing_external_message)(struct pjsip_tx_data *tdata, struct ast_sip_transport *transport);
214 };
215
216 /*!
217  * \brief Contact associated with an address of record
218  */
219 struct ast_sip_contact {
220         /*! Sorcery object details, the id is the aor name plus a random string */
221         SORCERY_OBJECT(details);
222         AST_DECLARE_STRING_FIELDS(
223                 /*! Full URI of the contact */
224                 AST_STRING_FIELD(uri);
225                 /*! Outbound proxy to use for qualify */
226                 AST_STRING_FIELD(outbound_proxy);
227                 /*! Path information to place in Route headers */
228                 AST_STRING_FIELD(path);
229                 /*! Content of the User-Agent header in REGISTER request */
230                 AST_STRING_FIELD(user_agent);
231                 /*! The name of the aor this contact belongs to */
232                 AST_STRING_FIELD(aor);
233         );
234         /*! Absolute time that this contact is no longer valid after */
235         struct timeval expiration_time;
236         /*! Frequency to send OPTIONS requests to contact. 0 is disabled. */
237         unsigned int qualify_frequency;
238         /*! If true authenticate the qualify if needed */
239         int authenticate_qualify;
240         /*! Qualify timeout. 0 is diabled. */
241         double qualify_timeout;
242         /*! Endpoint that added the contact, only available in observers */
243         struct ast_sip_endpoint *endpoint;
244 };
245
246 #define CONTACT_STATUS "contact_status"
247
248 /*!
249  * \brief Status type for a contact.
250  */
251 enum ast_sip_contact_status_type {
252         UNAVAILABLE,
253         AVAILABLE,
254         UNKNOWN,
255         CREATED,
256         REMOVED,
257 };
258
259 /*!
260  * \brief A contact's status.
261  *
262  * \detail Maintains a contact's current status and round trip time
263  *         if available.
264  */
265 struct ast_sip_contact_status {
266         SORCERY_OBJECT(details);
267         AST_DECLARE_STRING_FIELDS(
268                 /*! The original contact's URI */
269                 AST_STRING_FIELD(uri);
270                 /*! The name of the aor this contact_status belongs to */
271                 AST_STRING_FIELD(aor);
272         );
273         /*! Current status for a contact (default - unavailable) */
274         enum ast_sip_contact_status_type status;
275         /*! The round trip start time set before sending a qualify request */
276         struct timeval rtt_start;
277         /*! The round trip time in microseconds */
278         int64_t rtt;
279         /*! Last status for a contact (default - unavailable) */
280         enum ast_sip_contact_status_type last_status;
281 };
282
283 /*!
284  * \brief A SIP address of record
285  */
286 struct ast_sip_aor {
287         /*! Sorcery object details, the id is the AOR name */
288         SORCERY_OBJECT(details);
289         AST_DECLARE_STRING_FIELDS(
290                 /*! Voicemail boxes for this AOR */
291                 AST_STRING_FIELD(mailboxes);
292                 /*! Outbound proxy for OPTIONS requests */
293                 AST_STRING_FIELD(outbound_proxy);
294         );
295         /*! Minimum expiration time */
296         unsigned int minimum_expiration;
297         /*! Maximum expiration time */
298         unsigned int maximum_expiration;
299         /*! Default contact expiration if one is not provided in the contact */
300         unsigned int default_expiration;
301         /*! Frequency to send OPTIONS requests to AOR contacts. 0 is disabled. */
302         unsigned int qualify_frequency;
303         /*! If true authenticate the qualify if needed */
304         int authenticate_qualify;
305         /*! Maximum number of external contacts, 0 to disable */
306         unsigned int max_contacts;
307         /*! Whether to remove any existing contacts not related to an incoming REGISTER when it comes in */
308         unsigned int remove_existing;
309         /*! Any permanent configured contacts */
310         struct ao2_container *permanent_contacts;
311         /*! Determines whether SIP Path headers are supported */
312         unsigned int support_path;
313         /*! Qualify timeout. 0 is diabled. */
314         double qualify_timeout;
315 };
316
317 /*!
318  * \brief A wrapper for contact that adds the aor_id and
319  * a consistent contact id.  Used by ast_sip_for_each_contact.
320  */
321 struct ast_sip_contact_wrapper {
322         /*! The id of the parent aor. */
323         char *aor_id;
324         /*! The id of contact in form of aor_id/contact_uri. */
325         char *contact_id;
326         /*! Pointer to the actual contact. */
327         struct ast_sip_contact *contact;
328 };
329
330 /*!
331  * \brief DTMF modes for SIP endpoints
332  */
333 enum ast_sip_dtmf_mode {
334         /*! No DTMF to be used */
335         AST_SIP_DTMF_NONE,
336         /* XXX Should this be 2833 instead? */
337         /*! Use RFC 4733 events for DTMF */
338         AST_SIP_DTMF_RFC_4733,
339         /*! Use DTMF in the audio stream */
340         AST_SIP_DTMF_INBAND,
341         /*! Use SIP INFO DTMF (blech) */
342         AST_SIP_DTMF_INFO,
343         /*! Use SIP 4733 if supported by the other side or INBAND if not */
344         AST_SIP_DTMF_AUTO,
345 };
346
347 /*!
348  * \brief Methods of storing SIP digest authentication credentials.
349  *
350  * Note that both methods result in MD5 digest authentication being
351  * used. The two methods simply alter how Asterisk determines the
352  * credentials for a SIP authentication
353  */
354 enum ast_sip_auth_type {
355         /*! Credentials stored as a username and password combination */
356         AST_SIP_AUTH_TYPE_USER_PASS,
357         /*! Credentials stored as an MD5 sum */
358         AST_SIP_AUTH_TYPE_MD5,
359         /*! Credentials not stored this is a fake auth */
360         AST_SIP_AUTH_TYPE_ARTIFICIAL
361 };
362
363 #define SIP_SORCERY_AUTH_TYPE "auth"
364
365 struct ast_sip_auth {
366         /*! Sorcery ID of the auth is its name */
367         SORCERY_OBJECT(details);
368         AST_DECLARE_STRING_FIELDS(
369                 /*! Identification for these credentials */
370                 AST_STRING_FIELD(realm);
371                 /*! Authentication username */
372                 AST_STRING_FIELD(auth_user);
373                 /*! Authentication password */
374                 AST_STRING_FIELD(auth_pass);
375                 /*! Authentication credentials in MD5 format (hash of user:realm:pass) */
376                 AST_STRING_FIELD(md5_creds);
377         );
378         /*! The time period (in seconds) that a nonce may be reused */
379         unsigned int nonce_lifetime;
380         /*! Used to determine what to use when authenticating */
381         enum ast_sip_auth_type type;
382 };
383
384 AST_VECTOR(ast_sip_auth_vector, const char *);
385
386 /*!
387  * \brief Different methods by which incoming requests can be matched to endpoints
388  */
389 enum ast_sip_endpoint_identifier_type {
390         /*! Identify based on user name in From header */
391         AST_SIP_ENDPOINT_IDENTIFY_BY_USERNAME = (1 << 0),
392 };
393
394 enum ast_sip_session_refresh_method {
395         /*! Use reinvite to negotiate direct media */
396         AST_SIP_SESSION_REFRESH_METHOD_INVITE,
397         /*! Use UPDATE to negotiate direct media */
398         AST_SIP_SESSION_REFRESH_METHOD_UPDATE,
399 };
400
401 enum ast_sip_direct_media_glare_mitigation {
402         /*! Take no special action to mitigate reinvite glare */
403         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_NONE,
404         /*! Do not send an initial direct media session refresh on outgoing call legs
405          * Subsequent session refreshes will be sent no matter the session direction
406          */
407         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_OUTGOING,
408         /*! Do not send an initial direct media session refresh on incoming call legs
409          * Subsequent session refreshes will be sent no matter the session direction
410          */
411         AST_SIP_DIRECT_MEDIA_GLARE_MITIGATION_INCOMING,
412 };
413
414 enum ast_sip_session_media_encryption {
415         /*! Invalid media encryption configuration */
416         AST_SIP_MEDIA_TRANSPORT_INVALID = 0,
417         /*! Do not allow any encryption of session media */
418         AST_SIP_MEDIA_ENCRYPT_NONE,
419         /*! Offer SDES-encrypted session media */
420         AST_SIP_MEDIA_ENCRYPT_SDES,
421         /*! Offer encrypted session media with datagram TLS key exchange */
422         AST_SIP_MEDIA_ENCRYPT_DTLS,
423 };
424
425 enum ast_sip_session_redirect {
426         /*! User portion of the target URI should be used as the target in the dialplan */
427         AST_SIP_REDIRECT_USER = 0,
428         /*! Target URI should be used as the target in the dialplan */
429         AST_SIP_REDIRECT_URI_CORE,
430         /*! Target URI should be used as the target within chan_pjsip itself */
431         AST_SIP_REDIRECT_URI_PJSIP,
432 };
433
434 /*!
435  * \brief Session timers options
436  */
437 struct ast_sip_timer_options {
438         /*! Minimum session expiration period, in seconds */
439         unsigned int min_se;
440         /*! Session expiration period, in seconds */
441         unsigned int sess_expires;
442 };
443
444 /*!
445  * \brief Endpoint configuration for SIP extensions.
446  *
447  * SIP extensions, in this case refers to features
448  * indicated in Supported or Required headers.
449  */
450 struct ast_sip_endpoint_extensions {
451         /*! Enabled SIP extensions */
452         unsigned int flags;
453         /*! Timer options */
454         struct ast_sip_timer_options timer;
455 };
456
457 /*!
458  * \brief Endpoint configuration for unsolicited MWI
459  */
460 struct ast_sip_mwi_configuration {
461         AST_DECLARE_STRING_FIELDS(
462                 /*! Configured voicemail boxes for this endpoint. Used for MWI */
463                 AST_STRING_FIELD(mailboxes);
464                 /*! Username to use when sending MWI NOTIFYs to this endpoint */
465                 AST_STRING_FIELD(fromuser);
466         );
467         /* Should mailbox states be combined into a single notification? */
468         unsigned int aggregate;
469 };
470
471 /*!
472  * \brief Endpoint subscription configuration
473  */
474 struct ast_sip_endpoint_subscription_configuration {
475         /*! Indicates if endpoint is allowed to initiate subscriptions */
476         unsigned int allow;
477         /*! The minimum allowed expiration for subscriptions from endpoint */
478         unsigned int minexpiry;
479         /*! Message waiting configuration */
480         struct ast_sip_mwi_configuration mwi;
481 };
482
483 /*!
484  * \brief NAT configuration options for endpoints
485  */
486 struct ast_sip_endpoint_nat_configuration {
487         /*! Whether to force using the source IP address/port for sending responses */
488         unsigned int force_rport;
489         /*! Whether to rewrite the Contact header with the source IP address/port or not */
490         unsigned int rewrite_contact;
491 };
492
493 /*!
494  * \brief Party identification options for endpoints
495  *
496  * This includes caller ID, connected line, and redirecting-related options
497  */
498 struct ast_sip_endpoint_id_configuration {
499         struct ast_party_id self;
500         /*! Do we accept identification information from this endpoint */
501         unsigned int trust_inbound;
502         /*! Do we send private identification information to this endpoint? */
503         unsigned int trust_outbound;
504         /*! Do we send P-Asserted-Identity headers to this endpoint? */
505         unsigned int send_pai;
506         /*! Do we send Remote-Party-ID headers to this endpoint? */
507         unsigned int send_rpid;
508         /*! Do we send messages for connected line updates for unanswered incoming calls immediately to this endpoint? */
509         unsigned int rpid_immediate;
510         /*! Do we add Diversion headers to applicable outgoing requests/responses? */
511         unsigned int send_diversion;
512         /*! When performing connected line update, which method should be used */
513         enum ast_sip_session_refresh_method refresh_method;
514 };
515
516 /*!
517  * \brief Call pickup configuration options for endpoints
518  */
519 struct ast_sip_endpoint_pickup_configuration {
520         /*! Call group */
521         ast_group_t callgroup;
522         /*! Pickup group */
523         ast_group_t pickupgroup;
524         /*! Named call group */
525         struct ast_namedgroups *named_callgroups;
526         /*! Named pickup group */
527         struct ast_namedgroups *named_pickupgroups;
528 };
529
530 /*!
531  * \brief Configuration for one-touch INFO recording
532  */
533 struct ast_sip_info_recording_configuration {
534         AST_DECLARE_STRING_FIELDS(
535                 /*! Feature to enact when one-touch recording INFO with Record: On is received */
536                 AST_STRING_FIELD(onfeature);
537                 /*! Feature to enact when one-touch recording INFO with Record: Off is received */
538                 AST_STRING_FIELD(offfeature);
539         );
540         /*! Is one-touch recording permitted? */
541         unsigned int enabled;
542 };
543
544 /*!
545  * \brief Endpoint configuration options for INFO packages
546  */
547 struct ast_sip_endpoint_info_configuration {
548         /*! Configuration for one-touch recording */
549         struct ast_sip_info_recording_configuration recording;
550 };
551
552 /*!
553  * \brief RTP configuration for SIP endpoints
554  */
555 struct ast_sip_media_rtp_configuration {
556         AST_DECLARE_STRING_FIELDS(
557                 /*! Configured RTP engine for this endpoint. */
558                 AST_STRING_FIELD(engine);
559         );
560         /*! Whether IPv6 RTP is enabled or not */
561         unsigned int ipv6;
562         /*! Whether symmetric RTP is enabled or not */
563         unsigned int symmetric;
564         /*! Whether ICE support is enabled or not */
565         unsigned int ice_support;
566         /*! Whether to use the "ptime" attribute received from the endpoint or not */
567         unsigned int use_ptime;
568         /*! Do we use AVPF exclusively for this endpoint? */
569         unsigned int use_avpf;
570         /*! Do we force AVP, AVPF, SAVP, or SAVPF even for DTLS media streams? */
571         unsigned int force_avp;
572         /*! Do we use the received media transport in our answer SDP */
573         unsigned int use_received_transport;
574         /*! \brief DTLS-SRTP configuration information */
575         struct ast_rtp_dtls_cfg dtls_cfg;
576         /*! Should SRTP use a 32 byte tag instead of an 80 byte tag? */
577         unsigned int srtp_tag_32;
578         /*! Do we use media encryption? what type? */
579         enum ast_sip_session_media_encryption encryption;
580         /*! Do we want to optimistically support encryption if possible? */
581         unsigned int encryption_optimistic;
582         /*! Number of seconds between RTP keepalive packets */
583         unsigned int keepalive;
584         /*! Number of seconds before terminating channel due to lack of RTP (when not on hold) */
585         unsigned int timeout;
586         /*! Number of seconds before terminating channel due to lack of RTP (when on hold) */
587         unsigned int timeout_hold;
588 };
589
590 /*!
591  * \brief Direct media options for SIP endpoints
592  */
593 struct ast_sip_direct_media_configuration {
594         /*! Boolean indicating if direct_media is permissible */
595         unsigned int enabled;
596         /*! When using direct media, which method should be used */
597         enum ast_sip_session_refresh_method method;
598         /*! Take steps to mitigate glare for direct media */
599         enum ast_sip_direct_media_glare_mitigation glare_mitigation;
600         /*! Do not attempt direct media session refreshes if a media NAT is detected */
601         unsigned int disable_on_nat;
602 };
603
604 struct ast_sip_t38_configuration {
605         /*! Whether T.38 UDPTL support is enabled or not */
606         unsigned int enabled;
607         /*! Error correction setting for T.38 UDPTL */
608         enum ast_t38_ec_modes error_correction;
609         /*! Explicit T.38 max datagram value, may be 0 to indicate the remote side can be trusted */
610         unsigned int maxdatagram;
611         /*! Whether NAT Support is enabled for T.38 UDPTL sessions or not */
612         unsigned int nat;
613         /*! Whether to use IPv6 for UDPTL or not */
614         unsigned int ipv6;
615 };
616
617 /*!
618  * \brief Media configuration for SIP endpoints
619  */
620 struct ast_sip_endpoint_media_configuration {
621         AST_DECLARE_STRING_FIELDS(
622                 /*! Optional media address to use in SDP */
623                 AST_STRING_FIELD(address);
624                 /*! SDP origin username */
625                 AST_STRING_FIELD(sdpowner);
626                 /*! SDP session name */
627                 AST_STRING_FIELD(sdpsession);
628         );
629         /*! RTP media configuration */
630         struct ast_sip_media_rtp_configuration rtp;
631         /*! Direct media options */
632         struct ast_sip_direct_media_configuration direct_media;
633         /*! T.38 (FoIP) options */
634         struct ast_sip_t38_configuration t38;
635         /*! Configured codecs */
636         struct ast_format_cap *codecs;
637         /*! DSCP TOS bits for audio streams */
638         unsigned int tos_audio;
639         /*! Priority for audio streams */
640         unsigned int cos_audio;
641         /*! DSCP TOS bits for video streams */
642         unsigned int tos_video;
643         /*! Priority for video streams */
644         unsigned int cos_video;
645         /*! Is g.726 packed in a non standard way */
646         unsigned int g726_non_standard;
647         /*! Bind the RTP instance to the media_address */
648         unsigned int bind_rtp_to_media_address;
649 };
650
651 /*!
652  * \brief An entity with which Asterisk communicates
653  */
654 struct ast_sip_endpoint {
655         SORCERY_OBJECT(details);
656         AST_DECLARE_STRING_FIELDS(
657                 /*! Context to send incoming calls to */
658                 AST_STRING_FIELD(context);
659                 /*! Name of an explicit transport to use */
660                 AST_STRING_FIELD(transport);
661                 /*! Outbound proxy to use */
662                 AST_STRING_FIELD(outbound_proxy);
663                 /*! Explicit AORs to dial if none are specified */
664                 AST_STRING_FIELD(aors);
665                 /*! Musiconhold class to suggest that the other side use when placing on hold */
666                 AST_STRING_FIELD(mohsuggest);
667                 /*! Configured tone zone for this endpoint. */
668                 AST_STRING_FIELD(zone);
669                 /*! Configured language for this endpoint. */
670                 AST_STRING_FIELD(language);
671                 /*! Default username to place in From header */
672                 AST_STRING_FIELD(fromuser);
673                 /*! Domain to place in From header */
674                 AST_STRING_FIELD(fromdomain);
675                 /*! Context to route incoming MESSAGE requests to */
676                 AST_STRING_FIELD(message_context);
677                 /*! Accountcode to auto-set on channels */
678                 AST_STRING_FIELD(accountcode);
679         );
680         /*! Configuration for extensions */
681         struct ast_sip_endpoint_extensions extensions;
682         /*! Configuration relating to media */
683         struct ast_sip_endpoint_media_configuration media;
684         /*! SUBSCRIBE/NOTIFY configuration options */
685         struct ast_sip_endpoint_subscription_configuration subscription;
686         /*! NAT configuration */
687         struct ast_sip_endpoint_nat_configuration nat;
688         /*! Party identification options */
689         struct ast_sip_endpoint_id_configuration id;
690         /*! Configuration options for INFO packages */
691         struct ast_sip_endpoint_info_configuration info;
692         /*! Call pickup configuration */
693         struct ast_sip_endpoint_pickup_configuration pickup;
694         /*! Inbound authentication credentials */
695         struct ast_sip_auth_vector inbound_auths;
696         /*! Outbound authentication credentials */
697         struct ast_sip_auth_vector outbound_auths;
698         /*! DTMF mode to use with this endpoint */
699         enum ast_sip_dtmf_mode dtmf;
700         /*! Method(s) by which the endpoint should be identified. */
701         enum ast_sip_endpoint_identifier_type ident_method;
702         /*! Boolean indicating if ringing should be sent as inband progress */
703         unsigned int inband_progress;
704         /*! Pointer to the persistent Asterisk endpoint */
705         struct ast_endpoint *persistent;
706         /*! The number of channels at which busy device state is returned */
707         unsigned int devicestate_busy_at;
708         /*! Whether fax detection is enabled or not (CNG tone detection) */
709         unsigned int faxdetect;
710         /*! Determines if transfers (using REFER) are allowed by this endpoint */
711         unsigned int allowtransfer;
712         /*! Method used when handling redirects */
713         enum ast_sip_session_redirect redirect_method;
714         /*! Variables set on channel creation */
715         struct ast_variable *channel_vars;
716         /*! Whether to place a 'user=phone' parameter into the request URI if user is a number */
717         unsigned int usereqphone;
718         /*! Whether to pass through hold and unhold using re-invites with recvonly and sendrecv */
719         unsigned int moh_passthrough;
720 };
721
722 /*!
723  * \brief Initialize an auth vector with the configured values.
724  *
725  * \param vector Vector to initialize
726  * \param auth_names Comma-separated list of names to set in the array
727  * \retval 0 Success
728  * \retval non-zero Failure
729  */
730 int ast_sip_auth_vector_init(struct ast_sip_auth_vector *vector, const char *auth_names);
731
732 /*!
733  * \brief Free contents of an auth vector.
734  *
735  * \param array Vector whose contents are to be freed
736  */
737 void ast_sip_auth_vector_destroy(struct ast_sip_auth_vector *vector);
738
739 /*!
740  * \brief Possible returns from ast_sip_check_authentication
741  */
742 enum ast_sip_check_auth_result {
743     /*! Authentication needs to be challenged */
744     AST_SIP_AUTHENTICATION_CHALLENGE,
745     /*! Authentication succeeded */
746     AST_SIP_AUTHENTICATION_SUCCESS,
747     /*! Authentication failed */
748     AST_SIP_AUTHENTICATION_FAILED,
749     /*! Authentication encountered some internal error */
750     AST_SIP_AUTHENTICATION_ERROR,
751 };
752
753 /*!
754  * \brief An interchangeable way of handling digest authentication for SIP.
755  *
756  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
757  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
758  * should take place and what credentials should be used when challenging and authenticating a request.
759  */
760 struct ast_sip_authenticator {
761     /*!
762      * \brief Check if a request requires authentication
763      * See ast_sip_requires_authentication for more details
764      */
765     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
766         /*!
767          * \brief Check that an incoming request passes authentication.
768          *
769          * The tdata parameter is useful for adding information such as digest challenges.
770          *
771          * \param endpoint The endpoint sending the incoming request
772          * \param rdata The incoming request
773          * \param tdata Tentative outgoing request.
774          */
775         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
776                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
777 };
778
779 /*!
780  * \brief an interchangeable way of responding to authentication challenges
781  *
782  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
783  * credentials.
784  */
785 struct ast_sip_outbound_authenticator {
786         /*!
787          * \brief Create a new request with authentication credentials
788          *
789          * \param auths A vector of IDs of auth sorcery objects
790          * \param challenge The SIP response with authentication challenge(s)
791          * \param old_request The request that received the auth challenge(s)
792          * \param new_request The new SIP request with challenge response(s)
793          * \retval 0 Successfully created new request
794          * \retval -1 Failed to create a new request
795          */
796         int (*create_request_with_auth)(const struct ast_sip_auth_vector *auths, struct pjsip_rx_data *challenge,
797                         struct pjsip_tx_data *old_request, struct pjsip_tx_data **new_request);
798 };
799
800 /*!
801  * \brief An entity responsible for identifying the source of a SIP message
802  */
803 struct ast_sip_endpoint_identifier {
804     /*!
805      * \brief Callback used to identify the source of a message.
806      * See ast_sip_identify_endpoint for more details
807      */
808     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
809 };
810
811 /*!
812  * \brief Register a SIP service in Asterisk.
813  *
814  * This is more-or-less a wrapper around pjsip_endpt_register_module().
815  * Registering a service makes it so that PJSIP will call into the
816  * service at appropriate times. For more information about PJSIP module
817  * callbacks, see the PJSIP documentation. Asterisk modules that call
818  * this function will likely do so at module load time.
819  *
820  * \param module The module that is to be registered with PJSIP
821  * \retval 0 Success
822  * \retval -1 Failure
823  */
824 int ast_sip_register_service(pjsip_module *module);
825
826 /*!
827  * This is the opposite of ast_sip_register_service().  Unregistering a
828  * service means that PJSIP will no longer call into the module any more.
829  * This will likely occur when an Asterisk module is unloaded.
830  *
831  * \param module The PJSIP module to unregister
832  */
833 void ast_sip_unregister_service(pjsip_module *module);
834
835 /*!
836  * \brief Register a SIP authenticator
837  *
838  * An authenticator has three main purposes:
839  * 1) Determining if authentication should be performed on an incoming request
840  * 2) Gathering credentials necessary for issuing an authentication challenge
841  * 3) Authenticating a request that has credentials
842  *
843  * Asterisk provides a default authenticator, but it may be replaced by a
844  * custom one if desired.
845  *
846  * \param auth The authenticator to register
847  * \retval 0 Success
848  * \retval -1 Failure
849  */
850 int ast_sip_register_authenticator(struct ast_sip_authenticator *auth);
851
852 /*!
853  * \brief Unregister a SIP authenticator
854  *
855  * When there is no authenticator registered, requests cannot be challenged
856  * or authenticated.
857  *
858  * \param auth The authenticator to unregister
859  */
860 void ast_sip_unregister_authenticator(struct ast_sip_authenticator *auth);
861
862  /*!
863  * \brief Register an outbound SIP authenticator
864  *
865  * An outbound authenticator is responsible for creating responses to
866  * authentication challenges by remote endpoints.
867  *
868  * \param auth The authenticator to register
869  * \retval 0 Success
870  * \retval -1 Failure
871  */
872 int ast_sip_register_outbound_authenticator(struct ast_sip_outbound_authenticator *outbound_auth);
873
874 /*!
875  * \brief Unregister an outbound SIP authenticator
876  *
877  * When there is no outbound authenticator registered, authentication challenges
878  * will be handled as any other final response would be.
879  *
880  * \param auth The authenticator to unregister
881  */
882 void ast_sip_unregister_outbound_authenticator(struct ast_sip_outbound_authenticator *auth);
883
884 /*!
885  * \brief Register a SIP endpoint identifier with a name.
886  *
887  * An endpoint identifier's purpose is to determine which endpoint a given SIP
888  * message has come from.
889  *
890  * Multiple endpoint identifiers may be registered so that if an endpoint
891  * cannot be identified by one identifier, it may be identified by another.
892  *
893  * \param identifier The SIP endpoint identifier to register
894  * \param name The name of the endpoint identifier
895  * \retval 0 Success
896  * \retval -1 Failure
897  */
898 int ast_sip_register_endpoint_identifier_with_name(struct ast_sip_endpoint_identifier *identifier,
899                                                    const char *name);
900
901 /*!
902  * \brief Register a SIP endpoint identifier
903  *
904  * An endpoint identifier's purpose is to determine which endpoint a given SIP
905  * message has come from.
906  *
907  * Multiple endpoint identifiers may be registered so that if an endpoint
908  * cannot be identified by one identifier, it may be identified by another.
909  *
910  * Asterisk provides two endpoint identifiers. One identifies endpoints based
911  * on the user part of the From header URI. The other identifies endpoints based
912  * on the source IP address.
913  *
914  * If the order in which endpoint identifiers is run is important to you, then
915  * be sure to load individual endpoint identifier modules in the order you wish
916  * for them to be run in modules.conf
917  *
918  * \note endpoint identifiers registered using this method (no name specified)
919  *       are placed at the front of the endpoint identifiers list ahead of any
920  *       named identifiers.
921  *
922  * \param identifier The SIP endpoint identifier to register
923  * \retval 0 Success
924  * \retval -1 Failure
925  */
926 int ast_sip_register_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
927
928 /*!
929  * \brief Unregister a SIP endpoint identifier
930  *
931  * This stops an endpoint identifier from being used.
932  *
933  * \param identifier The SIP endoint identifier to unregister
934  */
935 void ast_sip_unregister_endpoint_identifier(struct ast_sip_endpoint_identifier *identifier);
936
937 /*!
938  * \brief Allocate a new SIP endpoint
939  *
940  * This will return an endpoint with its refcount increased by one. This reference
941  * can be released using ao2_ref().
942  *
943  * \param name The name of the endpoint.
944  * \retval NULL Endpoint allocation failed
945  * \retval non-NULL The newly allocated endpoint
946  */
947 void *ast_sip_endpoint_alloc(const char *name);
948
949 /*!
950  * \brief Get a pointer to the PJSIP endpoint.
951  *
952  * This is useful when modules have specific information they need
953  * to register with the PJSIP core.
954  * \retval NULL endpoint has not been created yet.
955  * \retval non-NULL PJSIP endpoint.
956  */
957 pjsip_endpoint *ast_sip_get_pjsip_endpoint(void);
958
959 /*!
960  * \brief Get a pointer to the SIP sorcery structure.
961  *
962  * \retval NULL sorcery has not been initialized
963  * \retval non-NULL sorcery structure
964  */
965 struct ast_sorcery *ast_sip_get_sorcery(void);
966
967 /*!
968  * \brief Retrieve a named AOR
969  *
970  * \param aor_name Name of the AOR
971  *
972  * \retval NULL if not found
973  * \retval non-NULL if found
974  */
975 struct ast_sip_aor *ast_sip_location_retrieve_aor(const char *aor_name);
976
977 /*!
978  * \brief Retrieve the first bound contact for an AOR
979  *
980  * \param aor Pointer to the AOR
981  * \retval NULL if no contacts available
982  * \retval non-NULL if contacts available
983  */
984 struct ast_sip_contact *ast_sip_location_retrieve_first_aor_contact(const struct ast_sip_aor *aor);
985
986 /*!
987  * \brief Retrieve all contacts currently available for an AOR
988  *
989  * \param aor Pointer to the AOR
990  *
991  * \retval NULL if no contacts available
992  * \retval non-NULL if contacts available
993  */
994 struct ao2_container *ast_sip_location_retrieve_aor_contacts(const struct ast_sip_aor *aor);
995
996 /*!
997  * \brief Retrieve the first bound contact from a list of AORs
998  *
999  * \param aor_list A comma-separated list of AOR names
1000  * \retval NULL if no contacts available
1001  * \retval non-NULL if contacts available
1002  */
1003 struct ast_sip_contact *ast_sip_location_retrieve_contact_from_aor_list(const char *aor_list);
1004
1005 /*!
1006  * \brief Retrieve all contacts from a list of AORs
1007  *
1008  * \param aor_list A comma-separated list of AOR names
1009  * \retval NULL if no contacts available
1010  * \retval non-NULL container (which must be freed) if contacts available
1011  */
1012 struct ao2_container *ast_sip_location_retrieve_contacts_from_aor_list(const char *aor_list);
1013
1014 /*!
1015  * \brief Retrieve the first bound contact AND the AOR chosen from a list of AORs
1016  *
1017  * \param aor_list A comma-separated list of AOR names
1018  * \param aor The chosen AOR
1019  * \param contact The chosen contact
1020  */
1021  void ast_sip_location_retrieve_contact_and_aor_from_list(const char *aor_list, struct ast_sip_aor **aor,
1022         struct ast_sip_contact **contact);
1023
1024 /*!
1025  * \brief Retrieve a named contact
1026  *
1027  * \param contact_name Name of the contact
1028  *
1029  * \retval NULL if not found
1030  * \retval non-NULL if found
1031  */
1032 struct ast_sip_contact *ast_sip_location_retrieve_contact(const char *contact_name);
1033
1034 /*!
1035  * \brief Add a new contact to an AOR
1036  *
1037  * \param aor Pointer to the AOR
1038  * \param uri Full contact URI
1039  * \param expiration_time Optional expiration time of the contact
1040  * \param path_info Path information
1041  * \param user_agent User-Agent header from REGISTER request
1042  * \param endpoint The endpoint that resulted in the contact being added
1043  *
1044  * \retval -1 failure
1045  * \retval 0 success
1046  */
1047 int ast_sip_location_add_contact(struct ast_sip_aor *aor, const char *uri,
1048         struct timeval expiration_time, const char *path_info, const char *user_agent,
1049         struct ast_sip_endpoint *endpoint);
1050
1051 /*!
1052  * \brief Update a contact
1053  *
1054  * \param contact New contact object with details
1055  *
1056  * \retval -1 failure
1057  * \retval 0 success
1058  */
1059 int ast_sip_location_update_contact(struct ast_sip_contact *contact);
1060
1061 /*!
1062 * \brief Delete a contact
1063 *
1064 * \param contact Contact object to delete
1065 *
1066 * \retval -1 failure
1067 * \retval 0 success
1068 */
1069 int ast_sip_location_delete_contact(struct ast_sip_contact *contact);
1070
1071 /*!
1072  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
1073  *
1074  * This callback will have the created request on it. The callback's purpose is to do any extra
1075  * housekeeping that needs to be done as well as to send the request out.
1076  *
1077  * This callback is only necessary if working with a PJSIP API that sits between the application
1078  * and the dialog layer.
1079  *
1080  * \param dlg The dialog to which the request belongs
1081  * \param tdata The created request to be sent out
1082  * \param user_data Data supplied with the callback
1083  *
1084  * \retval 0 Success
1085  * \retval -1 Failure
1086  */
1087 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
1088
1089 /*!
1090  * \brief Set up outbound authentication on a SIP dialog
1091  *
1092  * This sets up the infrastructure so that all requests associated with a created dialog
1093  * can be re-sent with authentication credentials if the original request is challenged.
1094  *
1095  * \param dlg The dialog on which requests will be authenticated
1096  * \param endpoint The endpoint whom this dialog pertains to
1097  * \param cb Callback to call to send requests with authentication
1098  * \param user_data Data to be provided to the callback when it is called
1099  *
1100  * \retval 0 Success
1101  * \retval -1 Failure
1102  */
1103 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
1104                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
1105
1106 /*!
1107  * \brief Retrieves a reference to the artificial auth.
1108  *
1109  * \retval The artificial auth
1110  */
1111 struct ast_sip_auth *ast_sip_get_artificial_auth(void);
1112
1113 /*!
1114  * \brief Retrieves a reference to the artificial endpoint.
1115  *
1116  * \retval The artificial endpoint
1117  */
1118 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
1119
1120 /*!
1121  * \page Threading model for SIP
1122  *
1123  * There are three major types of threads that SIP will have to deal with:
1124  * \li Asterisk threads
1125  * \li PJSIP threads
1126  * \li SIP threadpool threads (a.k.a. "servants")
1127  *
1128  * \par Asterisk Threads
1129  *
1130  * Asterisk threads are those that originate from outside of SIP but within
1131  * Asterisk. The most common of these threads are PBX (channel) threads and
1132  * the autoservice thread. Most interaction with these threads will be through
1133  * channel technology callbacks. Within these threads, it is fine to handle
1134  * Asterisk data from outside of SIP, but any handling of SIP data should be
1135  * left to servants, \b especially if you wish to call into PJSIP for anything.
1136  * Asterisk threads are not registered with PJLIB, so attempting to call into
1137  * PJSIP will cause an assertion to be triggered, thus causing the program to
1138  * crash.
1139  *
1140  * \par PJSIP Threads
1141  *
1142  * PJSIP threads are those that originate from handling of PJSIP events, such
1143  * as an incoming SIP request or response, or a transaction timeout. The role
1144  * of these threads is to process information as quickly as possible so that
1145  * the next item on the SIP socket(s) can be serviced. On incoming messages,
1146  * Asterisk automatically will push the request to a servant thread. When your
1147  * module callback is called, processing will already be in a servant. However,
1148  * for other PSJIP events, such as transaction state changes due to timer
1149  * expirations, your module will be called into from a PJSIP thread. If you
1150  * are called into from a PJSIP thread, then you should push whatever processing
1151  * is needed to a servant as soon as possible. You can discern if you are currently
1152  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
1153  *
1154  * \par Servants
1155  *
1156  * Servants are where the bulk of SIP work should be performed. These threads
1157  * exist in order to do the work that Asterisk threads and PJSIP threads hand
1158  * off to them. Servant threads register themselves with PJLIB, meaning that
1159  * they are capable of calling PJSIP and PJLIB functions if they wish.
1160  *
1161  * \par Serializer
1162  *
1163  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
1164  * The first parameter of this call is a serializer. If this pointer
1165  * is NULL, then the work will be handed off to whatever servant can currently handle
1166  * the task. If this pointer is non-NULL, then the task will not be executed until
1167  * previous tasks pushed with the same serializer have completed. For more information
1168  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
1169  *
1170  * \note
1171  *
1172  * Do not make assumptions about individual threads based on a corresponding serializer.
1173  * In other words, just because several tasks use the same serializer when being pushed
1174  * to servants, it does not mean that the same thread is necessarily going to execute those
1175  * tasks, even though they are all guaranteed to be executed in sequence.
1176  */
1177
1178 /*!
1179  * \brief Create a new serializer for SIP tasks
1180  * \since 13.8.0
1181  *
1182  * See \ref ast_threadpool_serializer for more information on serializers.
1183  * SIP creates serializers so that tasks operating on similar data will run
1184  * in sequence.
1185  *
1186  * \param name Name of the serializer. (must be unique)
1187  *
1188  * \retval NULL Failure
1189  * \retval non-NULL Newly-created serializer
1190  */
1191 struct ast_taskprocessor *ast_sip_create_serializer(const char *name);
1192
1193 struct ast_serializer_shutdown_group;
1194
1195 /*!
1196  * \brief Create a new serializer for SIP tasks
1197  * \since 13.8.0
1198  *
1199  * See \ref ast_threadpool_serializer for more information on serializers.
1200  * SIP creates serializers so that tasks operating on similar data will run
1201  * in sequence.
1202  *
1203  * \param name Name of the serializer. (must be unique)
1204  * \param shutdown_group Group shutdown controller. (NULL if no group association)
1205  *
1206  * \retval NULL Failure
1207  * \retval non-NULL Newly-created serializer
1208  */
1209 struct ast_taskprocessor *ast_sip_create_serializer_group(const char *name, struct ast_serializer_shutdown_group *shutdown_group);
1210
1211 /*!
1212  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
1213  *
1214  * Passing a NULL serializer is a way to remove a serializer from a dialog.
1215  *
1216  * \param dlg The SIP dialog itself
1217  * \param serializer The serializer to use
1218  */
1219 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
1220
1221 /*!
1222  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
1223  *
1224  * \param dlg The SIP dialog itself
1225  * \param endpoint The endpoint that this dialog is communicating with
1226  */
1227 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1228
1229 /*!
1230  * \brief Get the endpoint associated with this dialog
1231  *
1232  * This function increases the refcount of the endpoint by one. Release
1233  * the reference once you are finished with the endpoint.
1234  *
1235  * \param dlg The SIP dialog from which to retrieve the endpoint
1236  * \retval NULL No endpoint associated with this dialog
1237  * \retval non-NULL The endpoint.
1238  */
1239 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
1240
1241 /*!
1242  * \brief Pushes a task to SIP servants
1243  *
1244  * This uses the serializer provided to determine how to push the task.
1245  * If the serializer is NULL, then the task will be pushed to the
1246  * servants directly. If the serializer is non-NULL, then the task will be
1247  * queued behind other tasks associated with the same serializer.
1248  *
1249  * \param serializer The serializer to which the task belongs. Can be NULL
1250  * \param sip_task The task to execute
1251  * \param task_data The parameter to pass to the task when it executes
1252  * \retval 0 Success
1253  * \retval -1 Failure
1254  */
1255 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1256
1257 /*!
1258  * \brief Push a task to SIP servants and wait for it to complete
1259  *
1260  * Like \ref ast_sip_push_task except that it blocks until the task completes.
1261  *
1262  * \warning \b Never use this function in a SIP servant thread. This can potentially
1263  * cause a deadlock. If you are in a SIP servant thread, just call your function
1264  * in-line.
1265  *
1266  * \warning \b Never hold locks that may be acquired by a SIP servant thread when
1267  * calling this function. Doing so may cause a deadlock if all SIP servant threads
1268  * are blocked waiting to acquire the lock while the thread holding the lock is
1269  * waiting for a free SIP servant thread.
1270  *
1271  * \param serializer The SIP serializer to which the task belongs. May be NULL.
1272  * \param sip_task The task to execute
1273  * \param task_data The parameter to pass to the task when it executes
1274  * \retval 0 Success
1275  * \retval -1 Failure
1276  */
1277 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1278
1279 /*!
1280  * \brief Determine if the current thread is a SIP servant thread
1281  *
1282  * \retval 0 This is not a SIP servant thread
1283  * \retval 1 This is a SIP servant thread
1284  */
1285 int ast_sip_thread_is_servant(void);
1286
1287 /*!
1288  * \brief SIP body description
1289  *
1290  * This contains a type and subtype that will be added as
1291  * the "Content-Type" for the message as well as the body
1292  * text.
1293  */
1294 struct ast_sip_body {
1295         /*! Type of the body, such as "application" */
1296         const char *type;
1297         /*! Subtype of the body, such as "sdp" */
1298         const char *subtype;
1299         /*! The text to go in the body */
1300         const char *body_text;
1301 };
1302
1303 /*!
1304  * \brief General purpose method for creating a UAC dialog with an endpoint
1305  *
1306  * \param endpoint A pointer to the endpoint
1307  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
1308  * \param request_user Optional user to place into the target URI
1309  *
1310  * \retval non-NULL success
1311  * \retval NULL failure
1312  */
1313 pjsip_dialog *ast_sip_create_dialog_uac(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
1314
1315 /*!
1316  * \brief General purpose method for creating a UAS dialog with an endpoint
1317  *
1318  * \param endpoint A pointer to the endpoint
1319  * \param rdata The request that is starting the dialog
1320  * \param[out] status On failure, the reason for failure in creating the dialog
1321  */
1322 pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pj_status_t *status);
1323
1324 /*!
1325  * \brief General purpose method for creating an rdata structure using specific information
1326  *
1327  * \param rdata[out] The rdata structure that will be populated
1328  * \param packet A SIP message
1329  * \param src_name The source IP address of the message
1330  * \param src_port The source port of the message
1331  * \param transport_type The type of transport the message was received on
1332  * \param local_name The local IP address the message was received on
1333  * \param local_port The local port the message was received on
1334  *
1335  * \retval 0 success
1336  * \retval -1 failure
1337  */
1338 int ast_sip_create_rdata(pjsip_rx_data *rdata, char *packet, const char *src_name, int src_port, char *transport_type,
1339         const char *local_name, int local_port);
1340
1341 /*!
1342  * \brief General purpose method for creating a SIP request
1343  *
1344  * Its typical use would be to create one-off requests such as an out of dialog
1345  * SIP MESSAGE.
1346  *
1347  * The request can either be in- or out-of-dialog. If in-dialog, the
1348  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
1349  * MUST be present. If both are present, then we will assume that the message
1350  * is to be sent in-dialog.
1351  *
1352  * The uri parameter can be specified if the request should be sent to an explicit
1353  * URI rather than one configured on the endpoint.
1354  *
1355  * \param method The method of the SIP request to send
1356  * \param dlg Optional. If specified, the dialog on which to request the message.
1357  * \param endpoint Optional. If specified, the request will be created out-of-dialog to the endpoint.
1358  * \param uri Optional. If specified, the request will be sent to this URI rather
1359  * than one configured for the endpoint.
1360  * \param contact The contact with which this request is associated for out-of-dialog requests.
1361  * \param[out] tdata The newly-created request
1362  *
1363  * The provided contact is attached to tdata with its reference bumped, but will
1364  * not survive for the entire lifetime of tdata since the contact is cleaned up
1365  * when all supplements have completed execution.
1366  *
1367  * \retval 0 Success
1368  * \retval -1 Failure
1369  */
1370 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
1371                 struct ast_sip_endpoint *endpoint, const char *uri,
1372                 struct ast_sip_contact *contact, pjsip_tx_data **tdata);
1373
1374 /*!
1375  * \brief General purpose method for sending a SIP request
1376  *
1377  * This is a companion function for \ref ast_sip_create_request. The request
1378  * created there can be passed to this function, though any request may be
1379  * passed in.
1380  *
1381  * This will automatically set up handling outbound authentication challenges if
1382  * they arrive.
1383  *
1384  * \param tdata The request to send
1385  * \param dlg Optional. The dialog in which the request is sent.  Otherwise it is out-of-dialog.
1386  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1387  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1388  * \param callback Callback to be called upon receipt of out-of-dialog response.
1389  *
1390  * \retval 0 Success
1391  * \retval -1 Failure (out-of-dialog callback will not be called.)
1392  */
1393 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg,
1394         struct ast_sip_endpoint *endpoint, void *token,
1395         void (*callback)(void *token, pjsip_event *e));
1396
1397 /*!
1398  * \brief General purpose method for sending an Out-Of-Dialog SIP request
1399  *
1400  * This is a companion function for \ref ast_sip_create_request. The request
1401  * created there can be passed to this function, though any request may be
1402  * passed in.
1403  *
1404  * This will automatically set up handling outbound authentication challenges if
1405  * they arrive.
1406  *
1407  * \param tdata The request to send
1408  * \param endpoint Optional. If specified, the out-of-dialog request is sent to the endpoint.
1409  * \param timeout.  If non-zero, after the timeout the transaction will be terminated
1410  * and the callback will be called with the PJSIP_EVENT_TIMER type.
1411  * \param token Data to be passed to the callback upon receipt of out-of-dialog response.
1412  * \param callback Callback to be called upon receipt of out-of-dialog response.
1413  *
1414  * \retval 0 Success
1415  * \retval -1 Failure (out-of-dialog callback will not be called.)
1416  *
1417  * \note Timeout processing:
1418  * There are 2 timers associated with this request, PJSIP timer_b which is
1419  * set globally in the "system" section of pjsip.conf, and the timeout specified
1420  * on this call.  The timer that expires first (before normal completion) will
1421  * cause the callback to be run with e->body.tsx_state.type = PJSIP_EVENT_TIMER.
1422  * The timer that expires second is simply ignored and the callback is not run again.
1423  */
1424 int ast_sip_send_out_of_dialog_request(pjsip_tx_data *tdata,
1425         struct ast_sip_endpoint *endpoint, int timeout, void *token,
1426         void (*callback)(void *token, pjsip_event *e));
1427
1428 /*!
1429  * \brief General purpose method for creating a SIP response
1430  *
1431  * Its typical use would be to create responses for out of dialog
1432  * requests.
1433  *
1434  * \param rdata The rdata from the incoming request.
1435  * \param st_code The response code to transmit.
1436  * \param contact The contact with which this request is associated.
1437  * \param[out] tdata The newly-created response
1438  *
1439  * The provided contact is attached to tdata with its reference bumped, but will
1440  * not survive for the entire lifetime of tdata since the contact is cleaned up
1441  * when all supplements have completed execution.
1442  *
1443  * \retval 0 Success
1444  * \retval -1 Failure
1445  */
1446 int ast_sip_create_response(const pjsip_rx_data *rdata, int st_code,
1447         struct ast_sip_contact *contact, pjsip_tx_data **p_tdata);
1448
1449 /*!
1450  * \brief Send a response to an out of dialog request
1451  *
1452  * Use this function sparingly, since this does not create a transaction
1453  * within PJSIP. This means that if the request is retransmitted, it is
1454  * your responsibility to detect this and not process the same request
1455  * twice, and to send the same response for each retransmission.
1456  *
1457  * \param res_addr The response address for this response
1458  * \param tdata The response to send
1459  * \param endpoint The ast_sip_endpoint associated with this response
1460  *
1461  * \retval 0 Success
1462  * \retval -1 Failure
1463  */
1464 int ast_sip_send_response(pjsip_response_addr *res_addr, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1465
1466 /*!
1467  * \brief Send a stateful response to an out of dialog request
1468  *
1469  * This creates a transaction within PJSIP, meaning that if the request
1470  * that we are responding to is retransmitted, we will not attempt to
1471  * re-handle the request.
1472  *
1473  * \param rdata The request that is being responded to
1474  * \param tdata The response to send
1475  * \param endpoint The ast_sip_endpoint associated with this response
1476  *
1477  * \since 13.4.0
1478  *
1479  * \retval 0 Success
1480  * \retval -1 Failure
1481  */
1482 int ast_sip_send_stateful_response(pjsip_rx_data *rdata, pjsip_tx_data *tdata, struct ast_sip_endpoint *sip_endpoint);
1483
1484 /*!
1485  * \brief Determine if an incoming request requires authentication
1486  *
1487  * This calls into the registered authenticator's requires_authentication callback
1488  * in order to determine if the request requires authentication.
1489  *
1490  * If there is no registered authenticator, then authentication will be assumed
1491  * not to be required.
1492  *
1493  * \param endpoint The endpoint from which the request originates
1494  * \param rdata The incoming SIP request
1495  * \retval non-zero The request requires authentication
1496  * \retval 0 The request does not require authentication
1497  */
1498 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1499
1500 /*!
1501  * \brief Method to determine authentication status of an incoming request
1502  *
1503  * This will call into a registered authenticator. The registered authenticator will
1504  * do what is necessary to determine whether the incoming request passes authentication.
1505  * A tentative response is passed into this function so that if, say, a digest authentication
1506  * challenge should be sent in the ensuing response, it can be added to the response.
1507  *
1508  * \param endpoint The endpoint from the request was sent
1509  * \param rdata The request to potentially authenticate
1510  * \param tdata Tentative response to the request
1511  * \return The result of checking authentication.
1512  */
1513 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
1514                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1515
1516 /*!
1517  * \brief Create a response to an authentication challenge
1518  *
1519  * This will call into an outbound authenticator's create_request_with_auth callback
1520  * to create a new request with authentication credentials. See the create_request_with_auth
1521  * callback in the \ref ast_sip_outbound_authenticator structure for details about
1522  * the parameters and return values.
1523  */
1524 int ast_sip_create_request_with_auth(const struct ast_sip_auth_vector *auths, pjsip_rx_data *challenge,
1525                 pjsip_tx_data *tdata, pjsip_tx_data **new_request);
1526
1527 /*!
1528  * \brief Determine the endpoint that has sent a SIP message
1529  *
1530  * This will call into each of the registered endpoint identifiers'
1531  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
1532  * This will return an ao2 object. Its reference count will need to be
1533  * decremented when completed using the endpoint.
1534  *
1535  * \param rdata The inbound SIP message to use when identifying the endpoint.
1536  * \retval NULL No matching endpoint
1537  * \retval non-NULL The matching endpoint
1538  */
1539 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
1540
1541 /*!
1542  * \brief Set the outbound proxy for an outbound SIP message
1543  *
1544  * \param tdata The message to set the outbound proxy on
1545  * \param proxy SIP uri of the proxy
1546  * \retval 0 Success
1547  * \retval -1 Failure
1548  */
1549 int ast_sip_set_outbound_proxy(pjsip_tx_data *tdata, const char *proxy);
1550
1551 /*!
1552  * \brief Add a header to an outbound SIP message
1553  *
1554  * \param tdata The message to add the header to
1555  * \param name The header name
1556  * \param value The header value
1557  * \retval 0 Success
1558  * \retval -1 Failure
1559  */
1560 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
1561
1562 /*!
1563  * \brief Add a body to an outbound SIP message
1564  *
1565  * If this is called multiple times, the latest body will replace the current
1566  * body.
1567  *
1568  * \param tdata The message to add the body to
1569  * \param body The message body to add
1570  * \retval 0 Success
1571  * \retval -1 Failure
1572  */
1573 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
1574
1575 /*!
1576  * \brief Add a multipart body to an outbound SIP message
1577  *
1578  * This will treat each part of the input vector as part of a multipart body and
1579  * add each part to the SIP message.
1580  *
1581  * \param tdata The message to add the body to
1582  * \param bodies The parts of the body to add
1583  * \retval 0 Success
1584  * \retval -1 Failure
1585  */
1586 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
1587
1588 /*!
1589  * \brief Append body data to a SIP message
1590  *
1591  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
1592  * a body if it currently exists, it appends data to an existing body.
1593  *
1594  * \param tdata The message to append the body to
1595  * \param body The string to append to the end of the current body
1596  * \retval 0 Success
1597  * \retval -1 Failure
1598  */
1599 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
1600
1601 /*!
1602  * \brief Copy a pj_str_t into a standard character buffer.
1603  *
1604  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
1605  * terminated string needs to have the pj_str_t copied into a separate
1606  * buffer.
1607  *
1608  * This method copies the pj_str_t contents into the destination buffer
1609  * and NULL-terminates the buffer.
1610  *
1611  * \param dest The destination buffer
1612  * \param src The pj_str_t to copy
1613  * \param size The size of the destination buffer.
1614  */
1615 void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
1616
1617 /*!
1618  * \brief Get the looked-up endpoint on an out-of dialog request or response
1619  *
1620  * The function may ONLY be called on out-of-dialog requests or responses. For
1621  * in-dialog requests and responses, it is required that the user of the dialog
1622  * has the looked-up endpoint stored locally.
1623  *
1624  * This function should never return NULL if the message is out-of-dialog. It will
1625  * always return NULL if the message is in-dialog.
1626  *
1627  * This function will increase the reference count of the returned endpoint by one.
1628  * Release your reference using the ao2_ref function when finished.
1629  *
1630  * \param rdata Out-of-dialog request or response
1631  * \return The looked up endpoint
1632  */
1633 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
1634
1635 /*!
1636  * \brief Add 'user=phone' parameter to URI if enabled and user is a phone number.
1637  *
1638  * \param endpoint The endpoint to use for configuration
1639  * \param pool The memory pool to allocate the parameter from
1640  * \param uri The URI to check for user and to add parameter to
1641  */
1642 void ast_sip_add_usereqphone(const struct ast_sip_endpoint *endpoint, pj_pool_t *pool, pjsip_uri *uri);
1643
1644 /*!
1645  * \brief Retrieve any endpoints available to sorcery.
1646  *
1647  * \retval Endpoints available to sorcery, NULL if no endpoints found.
1648  */
1649 struct ao2_container *ast_sip_get_endpoints(void);
1650
1651 /*!
1652  * \brief Retrieve the default outbound endpoint.
1653  *
1654  * \retval The default outbound endpoint, NULL if not found.
1655  */
1656 struct ast_sip_endpoint *ast_sip_default_outbound_endpoint(void);
1657
1658 /*!
1659  * \brief Retrieve relevant SIP auth structures from sorcery
1660  *
1661  * \param auths Vector of sorcery IDs of auth credentials to retrieve
1662  * \param[out] out The retrieved auths are stored here
1663  */
1664 int ast_sip_retrieve_auths(const struct ast_sip_auth_vector *auths, struct ast_sip_auth **out);
1665
1666 /*!
1667  * \brief Clean up retrieved auth structures from memory
1668  *
1669  * Call this function once you have completed operating on auths
1670  * retrieved from \ref ast_sip_retrieve_auths
1671  *
1672  * \param auths An vector of auth structures to clean up
1673  * \param num_auths The number of auths in the vector
1674  */
1675 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
1676
1677 /*!
1678  * \brief Checks if the given content type matches type/subtype.
1679  *
1680  * Compares the pjsip_media_type with the passed type and subtype and
1681  * returns the result of that comparison.  The media type parameters are
1682  * ignored.
1683  *
1684  * \param content_type The pjsip_media_type structure to compare
1685  * \param type The media type to compare
1686  * \param subtype The media subtype to compare
1687  * \retval 0 No match
1688  * \retval -1 Match
1689  */
1690 int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
1691
1692 /*!
1693  * \brief Send a security event notification for when an invalid endpoint is requested
1694  *
1695  * \param name Name of the endpoint requested
1696  * \param rdata Received message
1697  */
1698 void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
1699
1700 /*!
1701  * \brief Send a security event notification for when an ACL check fails
1702  *
1703  * \param endpoint Pointer to the endpoint in use
1704  * \param rdata Received message
1705  * \param name Name of the ACL
1706  */
1707 void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
1708
1709 /*!
1710  * \brief Send a security event notification for when a challenge response has failed
1711  *
1712  * \param endpoint Pointer to the endpoint in use
1713  * \param rdata Received message
1714  */
1715 void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1716
1717 /*!
1718  * \brief Send a security event notification for when authentication succeeds
1719  *
1720  * \param endpoint Pointer to the endpoint in use
1721  * \param rdata Received message
1722  */
1723 void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1724
1725 /*!
1726  * \brief Send a security event notification for when an authentication challenge is sent
1727  *
1728  * \param endpoint Pointer to the endpoint in use
1729  * \param rdata Received message
1730  * \param tdata Sent message
1731  */
1732 void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1733
1734 /*!
1735  * \brief Send a security event notification for when a request is not supported
1736  *
1737  * \param endpoint Pointer to the endpoint in use
1738  * \param rdata Received message
1739  * \param req_type the type of request
1740  */
1741 void ast_sip_report_req_no_support(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata,
1742                                    const char* req_type);
1743
1744 /*!
1745  * \brief Send a security event notification for when a memory limit is hit.
1746  *
1747  * \param endpoint Pointer to the endpoint in use
1748  * \param rdata Received message
1749  */
1750 void ast_sip_report_mem_limit(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1751
1752 int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
1753 int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
1754
1755 /*!
1756  * \brief Retrieves the value associated with the given key.
1757  *
1758  * \param ht the hash table/dictionary to search
1759  * \param key the key to find
1760  *
1761  * \retval the value associated with the key, NULL otherwise.
1762  */
1763 void *ast_sip_dict_get(void *ht, const char *key);
1764
1765 /*!
1766  * \brief Using the dictionary stored in mod_data array at a given id,
1767  *        retrieve the value associated with the given key.
1768  *
1769  * \param mod_data a module data array
1770  * \param id the mod_data array index
1771  * \param key the key to find
1772  *
1773  * \retval the value associated with the key, NULL otherwise.
1774  */
1775 #define ast_sip_mod_data_get(mod_data, id, key)         \
1776         ast_sip_dict_get(mod_data[id], key)
1777
1778 /*!
1779  * \brief Set the value for the given key.
1780  *
1781  * Note - if the hash table does not exist one is created first, the key/value
1782  * pair is set, and the hash table returned.
1783  *
1784  * \param pool the pool to allocate memory in
1785  * \param ht the hash table/dictionary in which to store the key/value pair
1786  * \param key the key to associate a value with
1787  * \param val the value to associate with a key
1788  *
1789  * \retval the given, or newly created, hash table.
1790  */
1791 void *ast_sip_dict_set(pj_pool_t* pool, void *ht,
1792                        const char *key, void *val);
1793
1794 /*!
1795  * \brief Utilizing a mod_data array for a given id, set the value
1796  *        associated with the given key.
1797  *
1798  * For a given structure's mod_data array set the element indexed by id to
1799  * be a dictionary containing the key/val pair.
1800  *
1801  * \param pool a memory allocation pool
1802  * \param mod_data a module data array
1803  * \param id the mod_data array index
1804  * \param key the key to find
1805  * \param val the value to associate with a key
1806  */
1807 #define ast_sip_mod_data_set(pool, mod_data, id, key, val)              \
1808         mod_data[id] = ast_sip_dict_set(pool, mod_data[id], key, val)
1809
1810 /*!
1811  * \brief For every contact on an AOR call the given 'on_contact' handler.
1812  *
1813  * \param aor the aor containing a list of contacts to iterate
1814  * \param on_contact callback on each contact on an AOR.  The object
1815  * received by the callback will be a ast_sip_contact_wrapper structure.
1816  * \param arg user data passed to handler
1817  * \retval 0 Success, non-zero on failure
1818  */
1819 int ast_sip_for_each_contact(const struct ast_sip_aor *aor,
1820                 ao2_callback_fn on_contact, void *arg);
1821
1822 /*!
1823  * \brief Handler used to convert a contact to a string.
1824  *
1825  * \param object the ast_sip_aor_contact_pair containing a list of contacts to iterate and the contact
1826  * \param arg user data passed to handler
1827  * \param flags
1828  * \retval 0 Success, non-zero on failure
1829  */
1830 int ast_sip_contact_to_str(void *object, void *arg, int flags);
1831
1832 /*!
1833  * \brief For every aor in the comma separated aors string call the
1834  *        given 'on_aor' handler.
1835  *
1836  * \param aors a comma separated list of aors
1837  * \param on_aor callback for each aor
1838  * \param arg user data passed to handler
1839  * \retval 0 Success, non-zero on failure
1840  */
1841 int ast_sip_for_each_aor(const char *aors, ao2_callback_fn on_aor, void *arg);
1842
1843 /*!
1844  * \brief For every auth in the array call the given 'on_auth' handler.
1845  *
1846  * \param array an array of auths
1847  * \param on_auth callback for each auth
1848  * \param arg user data passed to handler
1849  * \retval 0 Success, non-zero on failure
1850  */
1851 int ast_sip_for_each_auth(const struct ast_sip_auth_vector *array,
1852                           ao2_callback_fn on_auth, void *arg);
1853
1854 /*!
1855  * \brief Converts the given auth type to a string
1856  *
1857  * \param type the auth type to convert
1858  * \retval a string representative of the auth type
1859  */
1860 const char *ast_sip_auth_type_to_str(enum ast_sip_auth_type type);
1861
1862 /*!
1863  * \brief Converts an auths array to a string of comma separated values
1864  *
1865  * \param auths an auth array
1866  * \param buf the string buffer to write the object data
1867  * \retval 0 Success, non-zero on failure
1868  */
1869 int ast_sip_auths_to_str(const struct ast_sip_auth_vector *auths, char **buf);
1870
1871 /*!
1872  * \brief AMI variable container
1873  */
1874 struct ast_sip_ami {
1875         /*! Manager session */
1876         struct mansession *s;
1877         /*! Manager message */
1878         const struct message *m;
1879         /*! Manager Action ID */
1880         const char *action_id;
1881         /*! user specified argument data */
1882         void *arg;
1883         /*! count of objects */
1884         int count;
1885 };
1886
1887 /*!
1888  * \brief Creates a string to store AMI event data in.
1889  *
1890  * \param event the event to set
1891  * \param ami AMI session and message container
1892  * \retval an initialized ast_str or NULL on error.
1893  */
1894 struct ast_str *ast_sip_create_ami_event(const char *event,
1895                                          struct ast_sip_ami *ami);
1896
1897 /*!
1898  * \brief An entity responsible formatting endpoint information.
1899  */
1900 struct ast_sip_endpoint_formatter {
1901         /*!
1902          * \brief Callback used to format endpoint information over AMI.
1903          */
1904         int (*format_ami)(const struct ast_sip_endpoint *endpoint,
1905                           struct ast_sip_ami *ami);
1906         AST_RWLIST_ENTRY(ast_sip_endpoint_formatter) next;
1907 };
1908
1909 /*!
1910  * \brief Register an endpoint formatter.
1911  *
1912  * \param obj the formatter to register
1913  * \retval 0 Success
1914  * \retval -1 Failure
1915  */
1916 int ast_sip_register_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
1917
1918 /*!
1919  * \brief Unregister an endpoint formatter.
1920  *
1921  * \param obj the formatter to unregister
1922  */
1923 void ast_sip_unregister_endpoint_formatter(struct ast_sip_endpoint_formatter *obj);
1924
1925 /*!
1926  * \brief Converts a sorcery object to a string of object properties.
1927  *
1928  * \param obj the sorcery object to convert
1929  * \param str the string buffer to write the object data
1930  * \retval 0 Success, non-zero on failure
1931  */
1932 int ast_sip_sorcery_object_to_ami(const void *obj, struct ast_str **buf);
1933
1934 /*!
1935  * \brief Formats the endpoint and sends over AMI.
1936  *
1937  * \param endpoint the endpoint to format and send
1938  * \param endpoint ami AMI variable container
1939  * \param count the number of formatters operated on
1940  * \retval 0 Success, otherwise non-zero on error
1941  */
1942 int ast_sip_format_endpoint_ami(struct ast_sip_endpoint *endpoint,
1943                                 struct ast_sip_ami *ami, int *count);
1944
1945 /*!
1946  * \brief Format auth details for AMI.
1947  *
1948  * \param auths an auth array
1949  * \param ami ami variable container
1950  * \retval 0 Success, non-zero on failure
1951  */
1952 int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths,
1953                              struct ast_sip_ami *ami);
1954
1955 /*!
1956  * \brief Retrieve the endpoint snapshot for an endpoint
1957  *
1958  * \param endpoint The endpoint whose snapshot is to be retreieved.
1959  * \retval The endpoint snapshot
1960  */
1961 struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot(
1962         const struct ast_sip_endpoint *endpoint);
1963
1964 /*!
1965  * \brief Retrieve the device state for an endpoint.
1966  *
1967  * \param endpoint The endpoint whose state is to be retrieved.
1968  * \retval The device state.
1969  */
1970 const char *ast_sip_get_device_state(const struct ast_sip_endpoint *endpoint);
1971
1972 /*!
1973  * \brief For every channel snapshot on an endpoint snapshot call the given
1974  *        'on_channel_snapshot' handler.
1975  *
1976  * \param endpoint_snapshot snapshot of an endpoint
1977  * \param on_channel_snapshot callback for each channel snapshot
1978  * \param arg user data passed to handler
1979  * \retval 0 Success, non-zero on failure
1980  */
1981 int ast_sip_for_each_channel_snapshot(const struct ast_endpoint_snapshot *endpoint_snapshot,
1982                 ao2_callback_fn on_channel_snapshot,
1983                                       void *arg);
1984
1985 /*!
1986  * \brief For every channel snapshot on an endpoint all the given
1987  *        'on_channel_snapshot' handler.
1988  *
1989  * \param endpoint endpoint
1990  * \param on_channel_snapshot callback for each channel snapshot
1991  * \param arg user data passed to handler
1992  * \retval 0 Success, non-zero on failure
1993  */
1994 int ast_sip_for_each_channel(const struct ast_sip_endpoint *endpoint,
1995                 ao2_callback_fn on_channel_snapshot,
1996                                       void *arg);
1997
1998 enum ast_sip_supplement_priority {
1999         /*! Top priority. Supplements with this priority are those that need to run before any others */
2000         AST_SIP_SUPPLEMENT_PRIORITY_FIRST = 0,
2001         /*! Channel creation priority.
2002          * chan_pjsip creates a channel at this priority. If your supplement depends on being run before
2003          * or after channel creation, then set your priority to be lower or higher than this value.
2004          */
2005         AST_SIP_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
2006         /*! Lowest priority. Supplements with this priority should be run after all other supplements */
2007         AST_SIP_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
2008 };
2009
2010 /*!
2011  * \brief A supplement to SIP message processing
2012  *
2013  * These can be registered by any module in order to add
2014  * processing to incoming and outgoing SIP out of dialog
2015  * requests and responses
2016  */
2017 struct ast_sip_supplement {
2018         /*! Method on which to call the callbacks. If NULL, call on all methods */
2019         const char *method;
2020         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
2021         enum ast_sip_supplement_priority priority;
2022         /*!
2023          * \brief Called on incoming SIP request
2024          * This method can indicate a failure in processing in its return. If there
2025          * is a failure, it is required that this method sends a response to the request.
2026          * This method is always called from a SIP servant thread.
2027          *
2028          * \note
2029          * The following PJSIP methods will not work properly:
2030          * pjsip_rdata_get_dlg()
2031          * pjsip_rdata_get_tsx()
2032          * The reason is that the rdata passed into this function is a cloned rdata structure,
2033          * and its module data is not copied during the cloning operation.
2034          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2035          *
2036          * \note
2037          * There is no guarantee that a channel will be present on the session when this is called.
2038          */
2039         int (*incoming_request)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2040         /*!
2041          * \brief Called on an incoming SIP response
2042          * This method is always called from a SIP servant thread.
2043          *
2044          * \note
2045          * The following PJSIP methods will not work properly:
2046          * pjsip_rdata_get_dlg()
2047          * pjsip_rdata_get_tsx()
2048          * The reason is that the rdata passed into this function is a cloned rdata structure,
2049          * and its module data is not copied during the cloning operation.
2050          * If you need to get the dialog, you can get it via session->inv_session->dlg.
2051          *
2052          * \note
2053          * There is no guarantee that a channel will be present on the session when this is called.
2054          */
2055         void (*incoming_response)(struct ast_sip_endpoint *endpoint, struct pjsip_rx_data *rdata);
2056         /*!
2057          * \brief Called on an outgoing SIP request
2058          * This method is always called from a SIP servant thread.
2059          */
2060         void (*outgoing_request)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2061         /*!
2062          * \brief Called on an outgoing SIP response
2063          * This method is always called from a SIP servant thread.
2064          */
2065         void (*outgoing_response)(struct ast_sip_endpoint *endpoint, struct ast_sip_contact *contact, struct pjsip_tx_data *tdata);
2066         /*! Next item in the list */
2067         AST_LIST_ENTRY(ast_sip_supplement) next;
2068 };
2069
2070 /*!
2071  * \brief Register a supplement to SIP out of dialog processing
2072  *
2073  * This allows for someone to insert themselves in the processing of out
2074  * of dialog SIP requests and responses. This, for example could allow for
2075  * a module to set channel data based on headers in an incoming message.
2076  * Similarly, a module could reject an incoming request if desired.
2077  *
2078  * \param supplement The supplement to register
2079  * \retval 0 Success
2080  * \retval -1 Failure
2081  */
2082 int ast_sip_register_supplement(struct ast_sip_supplement *supplement);
2083
2084 /*!
2085  * \brief Unregister a an supplement to SIP out of dialog processing
2086  *
2087  * \param supplement The supplement to unregister
2088  */
2089 void ast_sip_unregister_supplement(struct ast_sip_supplement *supplement);
2090
2091 /*!
2092  * \brief Retrieve the system debug setting (yes|no|host).
2093  *
2094  * \note returned string needs to be de-allocated by caller.
2095  *
2096  * \retval the system debug setting.
2097  */
2098 char *ast_sip_get_debug(void);
2099
2100 /*!
2101  * \brief Retrieve the global regcontext setting.
2102  *
2103  * \since 13.8.0
2104  *
2105  * \note returned string needs to be de-allocated by caller.
2106  *
2107  * \retval the global regcontext setting
2108  */
2109 char *ast_sip_get_regcontext(void);
2110
2111 /*!
2112  * \brief Retrieve the global endpoint_identifier_order setting.
2113  *
2114  * Specifies the order by which endpoint identifiers should be regarded.
2115  *
2116  * \retval the global endpoint_identifier_order value
2117  */
2118 char *ast_sip_get_endpoint_identifier_order(void);
2119
2120 /*!
2121  * \brief Retrieve the global default from user.
2122  *
2123  * This is the value placed in outbound requests' From header if there
2124  * is no better option (such as an endpoint-configured from_user or
2125  * caller ID number).
2126  *
2127  * \param[out] from_user The default from user
2128  * \param size The buffer size of from_user
2129  * \return nothing
2130  */
2131 void ast_sip_get_default_from_user(char *from_user, size_t size);
2132
2133 /*! \brief Determines whether the res_pjsip module is loaded */
2134 #define CHECK_PJSIP_MODULE_LOADED()                             \
2135         do {                                                    \
2136                 if (!ast_module_check("res_pjsip.so")           \
2137                         || !ast_sip_get_pjsip_endpoint()) {     \
2138                         return AST_MODULE_LOAD_DECLINE;         \
2139                 }                                               \
2140         } while(0)
2141
2142 /*!
2143  * \brief Retrieve the system keep alive interval setting.
2144  *
2145  * \retval the keep alive interval.
2146  */
2147 unsigned int ast_sip_get_keep_alive_interval(void);
2148
2149 /*!
2150  * \brief Retrieve the system max initial qualify time.
2151  *
2152  * \retval the maximum initial qualify time.
2153  */
2154 unsigned int ast_sip_get_max_initial_qualify_time(void);
2155
2156 /*!
2157  * \brief translate ast_sip_contact_status_type to character string.
2158  *
2159  * \retval the character string equivalent.
2160  */
2161
2162 const char *ast_sip_get_contact_status_label(const enum ast_sip_contact_status_type status);
2163 const char *ast_sip_get_contact_short_status_label(const enum ast_sip_contact_status_type status);
2164
2165 /*!
2166  * \brief Set a request to use the next value in the list of resolved addresses.
2167  *
2168  * \param tdata the tx data from the original request
2169  * \retval 0 No more addresses to try
2170  * \retval 1 The request was successfully re-intialized
2171  */
2172 int ast_sip_failover_request(pjsip_tx_data *tdata);
2173
2174 /*
2175  * \brief Retrieve the local host address in IP form
2176  *
2177  * \param af The address family to retrieve
2178  * \param addr A place to store the local host address
2179  *
2180  * \retval 0 success
2181  * \retval -1 failure
2182  *
2183  * \since 13.6.0
2184  */
2185 int ast_sip_get_host_ip(int af, pj_sockaddr *addr);
2186
2187 /*!
2188  * \brief Retrieve the local host address in string form
2189  *
2190  * \param af The address family to retrieve
2191  *
2192  * \retval non-NULL success
2193  * \retval NULL failure
2194  *
2195  * \since 13.6.0
2196  *
2197  * \note An empty string may be returned if the address family is valid but no local address exists
2198  */
2199 const char *ast_sip_get_host_ip_string(int af);
2200
2201 /*!
2202  * \brief Return the size of the SIP threadpool's task queue
2203  * \since 13.7.0
2204  */
2205 long ast_sip_threadpool_queue_size(void);
2206
2207 /*!
2208  * \brief Retrieve transport state
2209  * \since 13.7.1
2210  *
2211  * @param transport_id
2212  * @returns transport_state
2213  *
2214  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2215  */
2216 struct ast_sip_transport_state *ast_sip_get_transport_state(const char *transport_id);
2217
2218 /*!
2219  * \brief Retrieves all transport states
2220  * \since 13.7.1
2221  *
2222  * @returns ao2_container
2223  *
2224  * \note ao2_cleanup(...) or ao2_ref(...,  -1) must be called on the returned object
2225  */
2226 struct ao2_container *ast_sip_get_transport_states(void);
2227
2228 /*!
2229  * \brief Sets pjsip_tpselector from ast_sip_transport
2230  * \since 13.8.0
2231  *
2232  * \param transport The transport to be used
2233  * \param selector The selector to be populated
2234  * \retval 0 success
2235  * \retval -1 failure
2236  */
2237 int ast_sip_set_tpselector_from_transport(const struct ast_sip_transport *transport, pjsip_tpselector *selector);
2238
2239 /*!
2240  * \brief Sets pjsip_tpselector from ast_sip_transport
2241  * \since 13.8.0
2242  *
2243  * \param transport_name The name of the transport to be used
2244  * \param selector The selector to be populated
2245  * \retval 0 success
2246  * \retval -1 failure
2247  */
2248 int ast_sip_set_tpselector_from_transport_name(const char *transport_name, pjsip_tpselector *selector);
2249
2250 #endif /* _RES_PJSIP_H */