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