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