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