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