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