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