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