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