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