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