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