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