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