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