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