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