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