The large GULP->PJSIP renaming effort.
[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_SIP_H
20 #define _RES_SIP_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 /*!
320  * \brief Session timers options
321  */
322 struct ast_sip_timer_options {
323         /*! Minimum session expiration period, in seconds */
324         unsigned int min_se;
325         /*! Session expiration period, in seconds */
326         unsigned int sess_expires;
327 };
328
329 /*!
330  * \brief Endpoint configuration for SIP extensions.
331  *
332  * SIP extensions, in this case refers to features
333  * indicated in Supported or Required headers.
334  */
335 struct ast_sip_endpoint_extensions {
336         /*! Enabled SIP extensions */
337         unsigned int flags;
338         /*! Timer options */
339         struct ast_sip_timer_options timer;
340 };
341
342 /*!
343  * \brief Endpoint configuration for unsolicited MWI
344  */
345 struct ast_sip_mwi_configuration {
346         AST_DECLARE_STRING_FIELDS(
347                 /*! Configured voicemail boxes for this endpoint. Used for MWI */
348                 AST_STRING_FIELD(mailboxes);
349                 /*! Username to use when sending MWI NOTIFYs to this endpoint */
350                 AST_STRING_FIELD(fromuser);
351         );
352         /* Should mailbox states be combined into a single notification? */
353         unsigned int aggregate;
354 };
355
356 /*!
357  * \brief Endpoint subscription configuration
358  */
359 struct ast_sip_endpoint_subscription_configuration {
360         /*! Indicates if endpoint is allowed to initiate subscriptions */
361         unsigned int allow;
362         /*! The minimum allowed expiration for subscriptions from endpoint */
363         unsigned int minexpiry;
364         /*! Message waiting configuration */
365         struct ast_sip_mwi_configuration mwi;
366 };
367
368 /*!
369  * \brief NAT configuration options for endpoints
370  */
371 struct ast_sip_endpoint_nat_configuration {
372         /*! Whether to force using the source IP address/port for sending responses */
373         unsigned int force_rport;
374         /*! Whether to rewrite the Contact header with the source IP address/port or not */
375         unsigned int rewrite_contact;
376 };
377
378 /*!
379  * \brief Party identification options for endpoints
380  *
381  * This includes caller ID, connected line, and redirecting-related options
382  */
383 struct ast_sip_endpoint_id_configuration {
384         struct ast_party_id self;
385         /*! Do we accept identification information from this endpoint */
386         unsigned int trust_inbound;
387         /*! Do we send private identification information to this endpoint? */
388         unsigned int trust_outbound;
389         /*! Do we send P-Asserted-Identity headers to this endpoint? */
390         unsigned int send_pai;
391         /*! Do we send Remote-Party-ID headers to this endpoint? */
392         unsigned int send_rpid;
393         /*! Do we add Diversion headers to applicable outgoing requests/responses? */
394         unsigned int send_diversion;
395         /*! When performing connected line update, which method should be used */
396         enum ast_sip_session_refresh_method refresh_method;
397 };
398
399 /*!
400  * \brief Call pickup configuration options for endpoints
401  */
402 struct ast_sip_endpoint_pickup_configuration {
403         /*! Call group */
404         ast_group_t callgroup;
405         /*! Pickup group */
406         ast_group_t pickupgroup;
407         /*! Named call group */
408         struct ast_namedgroups *named_callgroups;
409         /*! Named pickup group */
410         struct ast_namedgroups *named_pickupgroups;
411 };
412
413 /*!
414  * \brief Configuration for one-touch INFO recording
415  */
416 struct ast_sip_info_recording_configuration {
417         AST_DECLARE_STRING_FIELDS(
418                 /*! Feature to enact when one-touch recording INFO with Record: On is received */
419                 AST_STRING_FIELD(onfeature);
420                 /*! Feature to enact when one-touch recording INFO with Record: Off is received */
421                 AST_STRING_FIELD(offfeature);
422         );
423         /*! Is one-touch recording permitted? */
424         unsigned int enabled;
425 };
426
427 /*!
428  * \brief Endpoint configuration options for INFO packages
429  */
430 struct ast_sip_endpoint_info_configuration {
431         /*! Configuration for one-touch recording */
432         struct ast_sip_info_recording_configuration recording;
433 };
434
435 /*!
436  * \brief RTP configuration for SIP endpoints
437  */
438 struct ast_sip_media_rtp_configuration {
439         AST_DECLARE_STRING_FIELDS(
440                 /*! Configured RTP engine for this endpoint. */
441                 AST_STRING_FIELD(engine);
442         );
443         /*! Whether IPv6 RTP is enabled or not */
444         unsigned int ipv6;
445         /*! Whether symmetric RTP is enabled or not */
446         unsigned int symmetric;
447         /*! Whether ICE support is enabled or not */
448         unsigned int ice_support;
449         /*! Whether to use the "ptime" attribute received from the endpoint or not */
450         unsigned int use_ptime;
451         /*! Do we use AVPF exclusively for this endpoint? */
452         unsigned int use_avpf;
453         /*! \brief DTLS-SRTP configuration information */
454         struct ast_rtp_dtls_cfg dtls_cfg;
455         /*! Should SRTP use a 32 byte tag instead of an 80 byte tag? */
456         unsigned int srtp_tag_32;
457         /*! Do we use media encryption? what type? */
458         enum ast_sip_session_media_encryption encryption;
459 };
460
461 /*!
462  * \brief Direct media options for SIP endpoints
463  */
464 struct ast_sip_direct_media_configuration {
465         /*! Boolean indicating if direct_media is permissible */
466         unsigned int enabled;
467         /*! When using direct media, which method should be used */
468         enum ast_sip_session_refresh_method method;
469         /*! Take steps to mitigate glare for direct media */
470         enum ast_sip_direct_media_glare_mitigation glare_mitigation;
471         /*! Do not attempt direct media session refreshes if a media NAT is detected */
472         unsigned int disable_on_nat;
473 };
474
475 struct ast_sip_t38_configuration {
476         /*! Whether T.38 UDPTL support is enabled or not */
477         unsigned int enabled;
478         /*! Error correction setting for T.38 UDPTL */
479         enum ast_t38_ec_modes error_correction;
480         /*! Explicit T.38 max datagram value, may be 0 to indicate the remote side can be trusted */
481         unsigned int maxdatagram;
482         /*! Whether NAT Support is enabled for T.38 UDPTL sessions or not */
483         unsigned int nat;
484         /*! Whether to use IPv6 for UDPTL or not */
485         unsigned int ipv6;
486 };
487
488 /*!
489  * \brief Media configuration for SIP endpoints
490  */
491 struct ast_sip_endpoint_media_configuration {
492         AST_DECLARE_STRING_FIELDS(
493                 /*! Optional external media address to use in SDP */
494                 AST_STRING_FIELD(external_address);
495                 /*! SDP origin username */
496                 AST_STRING_FIELD(sdpowner);
497                 /*! SDP session name */
498                 AST_STRING_FIELD(sdpsession);
499         );
500         /*! RTP media configuration */
501         struct ast_sip_media_rtp_configuration rtp;
502         /*! Direct media options */
503         struct ast_sip_direct_media_configuration direct_media;
504         /*! T.38 (FoIP) options */
505         struct ast_sip_t38_configuration t38;
506         /*! Codec preferences */
507         struct ast_codec_pref prefs;
508         /*! Configured codecs */
509         struct ast_format_cap *codecs;
510         /*! DSCP TOS bits for audio streams */
511         unsigned int tos_audio;
512         /*! Priority for audio streams */
513         unsigned int cos_audio;
514         /*! DSCP TOS bits for video streams */
515         unsigned int tos_video;
516         /*! Priority for video streams */
517         unsigned int cos_video;
518 };
519
520 /*!
521  * \brief An entity with which Asterisk communicates
522  */
523 struct ast_sip_endpoint {
524         SORCERY_OBJECT(details);
525         AST_DECLARE_STRING_FIELDS(
526                 /*! Context to send incoming calls to */
527                 AST_STRING_FIELD(context);
528                 /*! Name of an explicit transport to use */
529                 AST_STRING_FIELD(transport);
530                 /*! Outbound proxy to use */
531                 AST_STRING_FIELD(outbound_proxy);
532                 /*! Explicit AORs to dial if none are specified */
533                 AST_STRING_FIELD(aors);
534                 /*! Musiconhold class to suggest that the other side use when placing on hold */
535                 AST_STRING_FIELD(mohsuggest);
536                 /*! Configured tone zone for this endpoint. */
537                 AST_STRING_FIELD(zone);
538                 /*! Configured language for this endpoint. */
539                 AST_STRING_FIELD(language);
540                 /*! Default username to place in From header */
541                 AST_STRING_FIELD(fromuser);
542                 /*! Domain to place in From header */
543                 AST_STRING_FIELD(fromdomain);
544         );
545         /*! Configuration for extensions */
546         struct ast_sip_endpoint_extensions extensions;
547         /*! Configuration relating to media */
548         struct ast_sip_endpoint_media_configuration media;
549         /*! SUBSCRIBE/NOTIFY configuration options */
550         struct ast_sip_endpoint_subscription_configuration subscription;
551         /*! NAT configuration */
552         struct ast_sip_endpoint_nat_configuration nat;
553         /*! Party identification options */
554         struct ast_sip_endpoint_id_configuration id;
555         /*! Configuration options for INFO packages */
556         struct ast_sip_endpoint_info_configuration info;
557         /*! Call pickup configuration */
558         struct ast_sip_endpoint_pickup_configuration pickup;
559         /*! Inbound authentication credentials */
560         struct ast_sip_auth_array inbound_auths;
561         /*! Outbound authentication credentials */
562         struct ast_sip_auth_array outbound_auths;
563         /*! DTMF mode to use with this endpoint */
564         enum ast_sip_dtmf_mode dtmf;
565         /*! Method(s) by which the endpoint should be identified. */
566         enum ast_sip_endpoint_identifier_type ident_method;
567         /*! Boolean indicating if ringing should be sent as inband progress */
568         unsigned int inband_progress;
569         /*! Pointer to the persistent Asterisk endpoint */
570         struct ast_endpoint *persistent;
571         /*! The number of channels at which busy device state is returned */
572         unsigned int devicestate_busy_at;
573         /*! Whether fax detection is enabled or not (CNG tone detection) */
574         unsigned int faxdetect;
575         /*! Determines if transfers (using REFER) are allowed by this endpoint */
576         unsigned int allowtransfer;
577 };
578
579 /*!
580  * \brief Initialize an auth array with the configured values.
581  *
582  * \param array Array to initialize
583  * \param auth_names Comma-separated list of names to set in the array
584  * \retval 0 Success
585  * \retval non-zero Failure
586  */
587 int ast_sip_auth_array_init(struct ast_sip_auth_array *array, const char *auth_names);
588
589 /*!
590  * \brief Free contents of an auth array.
591  *
592  * \param array Array whose contents are to be freed
593  */
594 void ast_sip_auth_array_destroy(struct ast_sip_auth_array *array);
595
596 /*!
597  * \brief Possible returns from ast_sip_check_authentication
598  */
599 enum ast_sip_check_auth_result {
600     /*! Authentication needs to be challenged */
601     AST_SIP_AUTHENTICATION_CHALLENGE,
602     /*! Authentication succeeded */
603     AST_SIP_AUTHENTICATION_SUCCESS,
604     /*! Authentication failed */
605     AST_SIP_AUTHENTICATION_FAILED,
606     /*! Authentication encountered some internal error */
607     AST_SIP_AUTHENTICATION_ERROR,
608 };
609
610 /*!
611  * \brief An interchangeable way of handling digest authentication for SIP.
612  *
613  * An authenticator is responsible for filling in the callbacks provided below. Each is called from a publicly available
614  * function in res_sip. The authenticator can use configuration or other local policy to determine whether authentication
615  * should take place and what credentials should be used when challenging and authenticating a request.
616  */
617 struct ast_sip_authenticator {
618     /*!
619      * \brief Check if a request requires authentication
620      * See ast_sip_requires_authentication for more details
621      */
622     int (*requires_authentication)(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
623         /*!
624          * \brief Check that an incoming request passes authentication.
625          *
626          * The tdata parameter is useful for adding information such as digest challenges.
627          *
628          * \param endpoint The endpoint sending the incoming request
629          * \param rdata The incoming request
630          * \param tdata Tentative outgoing request.
631          */
632         enum ast_sip_check_auth_result (*check_authentication)(struct ast_sip_endpoint *endpoint,
633                         pjsip_rx_data *rdata, pjsip_tx_data *tdata);
634 };
635
636 /*!
637  * \brief an interchangeable way of responding to authentication challenges
638  *
639  * An outbound authenticator takes incoming challenges and formulates a new SIP request with
640  * credentials.
641  */
642 struct ast_sip_outbound_authenticator {
643         /*!
644          * \brief Create a new request with authentication credentials
645          *
646          * \param auths An array of IDs of auth sorcery objects
647          * \param challenge The SIP response with authentication challenge(s)
648          * \param tsx The transaction in which the challenge was received
649          * \param new_request The new SIP request with challenge response(s)
650          * \retval 0 Successfully created new request
651          * \retval -1 Failed to create a new request
652          */
653         int (*create_request_with_auth)(const struct ast_sip_auth_array *auths, struct pjsip_rx_data *challenge,
654                         struct pjsip_transaction *tsx, struct pjsip_tx_data **new_request);
655 };
656
657 /*!
658  * \brief An entity responsible for identifying the source of a SIP message
659  */
660 struct ast_sip_endpoint_identifier {
661     /*!
662      * \brief Callback used to identify the source of a message.
663      * See ast_sip_identify_endpoint for more details
664      */
665     struct ast_sip_endpoint *(*identify_endpoint)(pjsip_rx_data *rdata);
666 };
667
668 #define SIP_SORCERY_SECURITY_TYPE "security"
669
670 /*!
671  * \brief SIP security details and configuration.
672  */
673 struct ast_sip_security {
674         SORCERY_OBJECT(details);
675         struct ast_acl_list *acl;
676         struct ast_acl_list *contact_acl;
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 Initialize security support on a sorcery instance
977  *
978  * \param sorcery The sorcery instance
979  *
980  * \retval -1 failure
981  * \retval 0 success
982  */
983 int ast_sip_initialize_sorcery_security(struct ast_sorcery *sorcery);
984
985 /*!
986  * \brief Callback called when an outbound request with authentication credentials is to be sent in dialog
987  *
988  * This callback will have the created request on it. The callback's purpose is to do any extra
989  * housekeeping that needs to be done as well as to send the request out.
990  *
991  * This callback is only necessary if working with a PJSIP API that sits between the application
992  * and the dialog layer.
993  *
994  * \param dlg The dialog to which the request belongs
995  * \param tdata The created request to be sent out
996  * \param user_data Data supplied with the callback
997  *
998  * \retval 0 Success
999  * \retval -1 Failure
1000  */
1001 typedef int (*ast_sip_dialog_outbound_auth_cb)(pjsip_dialog *dlg, pjsip_tx_data *tdata, void *user_data);
1002
1003 /*!
1004  * \brief Set up outbound authentication on a SIP dialog
1005  *
1006  * This sets up the infrastructure so that all requests associated with a created dialog
1007  * can be re-sent with authentication credentials if the original request is challenged.
1008  *
1009  * \param dlg The dialog on which requests will be authenticated
1010  * \param endpoint The endpoint whom this dialog pertains to
1011  * \param cb Callback to call to send requests with authentication
1012  * \param user_data Data to be provided to the callback when it is called
1013  *
1014  * \retval 0 Success
1015  * \retval -1 Failure
1016  */
1017 int ast_sip_dialog_setup_outbound_authentication(pjsip_dialog *dlg, const struct ast_sip_endpoint *endpoint,
1018                 ast_sip_dialog_outbound_auth_cb cb, void *user_data);
1019
1020 /*!
1021  * \brief Initialize the distributor module
1022  *
1023  * The distributor module is responsible for taking an incoming
1024  * SIP message and placing it into the threadpool. Once in the threadpool,
1025  * the distributor will perform endpoint lookups and authentication, and
1026  * then distribute the message up the stack to any further modules.
1027  *
1028  * \retval -1 Failure
1029  * \retval 0 Success
1030  */
1031 int ast_sip_initialize_distributor(void);
1032
1033 /*!
1034  * \brief Destruct the distributor module.
1035  *
1036  * Unregisters pjsip modules and cleans up any allocated resources.
1037  */
1038 void ast_sip_destroy_distributor(void);
1039
1040 /*!
1041  * \brief Retrieves a reference to the artificial auth.
1042  *
1043  * \retval The artificial auth
1044  */
1045 struct ast_sip_auth *ast_sip_get_artificial_auth(void);
1046
1047 /*!
1048  * \brief Retrieves a reference to the artificial endpoint.
1049  *
1050  * \retval The artificial endpoint
1051  */
1052 struct ast_sip_endpoint *ast_sip_get_artificial_endpoint(void);
1053
1054 /*!
1055  * \page Threading model for SIP
1056  *
1057  * There are three major types of threads that SIP will have to deal with:
1058  * \li Asterisk threads
1059  * \li PJSIP threads
1060  * \li SIP threadpool threads (a.k.a. "servants")
1061  *
1062  * \par Asterisk Threads
1063  *
1064  * Asterisk threads are those that originate from outside of SIP but within
1065  * Asterisk. The most common of these threads are PBX (channel) threads and
1066  * the autoservice thread. Most interaction with these threads will be through
1067  * channel technology callbacks. Within these threads, it is fine to handle
1068  * Asterisk data from outside of SIP, but any handling of SIP data should be
1069  * left to servants, \b especially if you wish to call into PJSIP for anything.
1070  * Asterisk threads are not registered with PJLIB, so attempting to call into
1071  * PJSIP will cause an assertion to be triggered, thus causing the program to
1072  * crash.
1073  *
1074  * \par PJSIP Threads
1075  *
1076  * PJSIP threads are those that originate from handling of PJSIP events, such
1077  * as an incoming SIP request or response, or a transaction timeout. The role
1078  * of these threads is to process information as quickly as possible so that
1079  * the next item on the SIP socket(s) can be serviced. On incoming messages,
1080  * Asterisk automatically will push the request to a servant thread. When your
1081  * module callback is called, processing will already be in a servant. However,
1082  * for other PSJIP events, such as transaction state changes due to timer
1083  * expirations, your module will be called into from a PJSIP thread. If you
1084  * are called into from a PJSIP thread, then you should push whatever processing
1085  * is needed to a servant as soon as possible. You can discern if you are currently
1086  * in a SIP servant thread using the \ref ast_sip_thread_is_servant function.
1087  *
1088  * \par Servants
1089  *
1090  * Servants are where the bulk of SIP work should be performed. These threads
1091  * exist in order to do the work that Asterisk threads and PJSIP threads hand
1092  * off to them. Servant threads register themselves with PJLIB, meaning that
1093  * they are capable of calling PJSIP and PJLIB functions if they wish.
1094  *
1095  * \par Serializer
1096  *
1097  * Tasks are handed off to servant threads using the API call \ref ast_sip_push_task.
1098  * The first parameter of this call is a serializer. If this pointer
1099  * is NULL, then the work will be handed off to whatever servant can currently handle
1100  * the task. If this pointer is non-NULL, then the task will not be executed until
1101  * previous tasks pushed with the same serializer have completed. For more information
1102  * on serializers and the benefits they provide, see \ref ast_threadpool_serializer
1103  *
1104  * \note
1105  *
1106  * Do not make assumptions about individual threads based on a corresponding serializer.
1107  * In other words, just because several tasks use the same serializer when being pushed
1108  * to servants, it does not mean that the same thread is necessarily going to execute those
1109  * tasks, even though they are all guaranteed to be executed in sequence.
1110  */
1111
1112 /*!
1113  * \brief Create a new serializer for SIP tasks
1114  *
1115  * See \ref ast_threadpool_serializer for more information on serializers.
1116  * SIP creates serializers so that tasks operating on similar data will run
1117  * in sequence.
1118  *
1119  * \retval NULL Failure
1120  * \retval non-NULL Newly-created serializer
1121  */
1122 struct ast_taskprocessor *ast_sip_create_serializer(void);
1123
1124 /*!
1125  * \brief Set a serializer on a SIP dialog so requests and responses are automatically serialized
1126  *
1127  * Passing a NULL serializer is a way to remove a serializer from a dialog.
1128  *
1129  * \param dlg The SIP dialog itself
1130  * \param serializer The serializer to use
1131  */
1132 void ast_sip_dialog_set_serializer(pjsip_dialog *dlg, struct ast_taskprocessor *serializer);
1133
1134 /*!
1135  * \brief Set an endpoint on a SIP dialog so in-dialog requests do not undergo endpoint lookup.
1136  *
1137  * \param dlg The SIP dialog itself
1138  * \param endpoint The endpoint that this dialog is communicating with
1139  */
1140 void ast_sip_dialog_set_endpoint(pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1141
1142 /*!
1143  * \brief Get the endpoint associated with this dialog
1144  *
1145  * This function increases the refcount of the endpoint by one. Release
1146  * the reference once you are finished with the endpoint.
1147  *
1148  * \param dlg The SIP dialog from which to retrieve the endpoint
1149  * \retval NULL No endpoint associated with this dialog
1150  * \retval non-NULL The endpoint.
1151  */
1152 struct ast_sip_endpoint *ast_sip_dialog_get_endpoint(pjsip_dialog *dlg);
1153
1154 /*!
1155  * \brief Pushes a task to SIP servants
1156  *
1157  * This uses the serializer provided to determine how to push the task.
1158  * If the serializer is NULL, then the task will be pushed to the
1159  * servants directly. If the serializer is non-NULL, then the task will be
1160  * queued behind other tasks associated with the same serializer.
1161  *
1162  * \param serializer The serializer to which the task belongs. Can be NULL
1163  * \param sip_task The task to execute
1164  * \param task_data The parameter to pass to the task when it executes
1165  * \retval 0 Success
1166  * \retval -1 Failure
1167  */
1168 int ast_sip_push_task(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1169
1170 /*!
1171  * \brief Push a task to SIP servants and wait for it to complete
1172  *
1173  * Like \ref ast_sip_push_task except that it blocks until the task completes.
1174  *
1175  * \warning \b Never use this function in a SIP servant thread. This can potentially
1176  * cause a deadlock. If you are in a SIP servant thread, just call your function
1177  * in-line.
1178  *
1179  * \param serializer The SIP serializer to which the task belongs. May be NULL.
1180  * \param sip_task The task to execute
1181  * \param task_data The parameter to pass to the task when it executes
1182  * \retval 0 Success
1183  * \retval -1 Failure
1184  */
1185 int ast_sip_push_task_synchronous(struct ast_taskprocessor *serializer, int (*sip_task)(void *), void *task_data);
1186
1187 /*!
1188  * \brief Determine if the current thread is a SIP servant thread
1189  *
1190  * \retval 0 This is not a SIP servant thread
1191  * \retval 1 This is a SIP servant thread
1192  */
1193 int ast_sip_thread_is_servant(void);
1194
1195 /*!
1196  * \brief SIP body description
1197  *
1198  * This contains a type and subtype that will be added as
1199  * the "Content-Type" for the message as well as the body
1200  * text.
1201  */
1202 struct ast_sip_body {
1203         /*! Type of the body, such as "application" */
1204         const char *type;
1205         /*! Subtype of the body, such as "sdp" */
1206         const char *subtype;
1207         /*! The text to go in the body */
1208         const char *body_text;
1209 };
1210
1211 /*!
1212  * \brief General purpose method for creating a dialog with an endpoint
1213  *
1214  * \param endpoint A pointer to the endpoint
1215  * \param aor_name Optional name of the AOR to target, may even be an explicit SIP URI
1216  * \param request_user Optional user to place into the target URI
1217  *
1218  * \retval non-NULL success
1219  * \retval NULL failure
1220  */
1221  pjsip_dialog *ast_sip_create_dialog(const struct ast_sip_endpoint *endpoint, const char *aor_name, const char *request_user);
1222
1223 /*!
1224  * \brief General purpose method for creating a SIP request
1225  *
1226  * Its typical use would be to create one-off requests such as an out of dialog
1227  * SIP MESSAGE.
1228  *
1229  * The request can either be in- or out-of-dialog. If in-dialog, the
1230  * dlg parameter MUST be present. If out-of-dialog the endpoint parameter
1231  * MUST be present. If both are present, then we will assume that the message
1232  * is to be sent in-dialog.
1233  *
1234  * The uri parameter can be specified if the request should be sent to an explicit
1235  * URI rather than one configured on the endpoint.
1236  *
1237  * \param method The method of the SIP request to send
1238  * \param dlg Optional. If specified, the dialog on which to request the message.
1239  * \param endpoint Optional. If specified, the request will be created out-of-dialog
1240  * to the endpoint.
1241  * \param uri Optional. If specified, the request will be sent to this URI rather
1242  * this value.
1243  * than one configured for the endpoint.
1244  * \param[out] tdata The newly-created request
1245  * \retval 0 Success
1246  * \retval -1 Failure
1247  */
1248 int ast_sip_create_request(const char *method, struct pjsip_dialog *dlg,
1249                 struct ast_sip_endpoint *endpoint, const char *uri,
1250                 pjsip_tx_data **tdata);
1251
1252 /*!
1253  * \brief General purpose method for sending a SIP request
1254  *
1255  * This is a companion function for \ref ast_sip_create_request. The request
1256  * created there can be passed to this function, though any request may be
1257  * passed in.
1258  *
1259  * This will automatically set up handling outbound authentication challenges if
1260  * they arrive.
1261  *
1262  * \param tdata The request to send
1263  * \param dlg Optional. If specified, the dialog on which the request should be sent
1264  * \param endpoint Optional. If specified, the request is sent out-of-dialog to the endpoint.
1265  * \retval 0 Success
1266  * \retval -1 Failure
1267  */
1268 int ast_sip_send_request(pjsip_tx_data *tdata, struct pjsip_dialog *dlg, struct ast_sip_endpoint *endpoint);
1269
1270 /*!
1271  * \brief Determine if an incoming request requires authentication
1272  *
1273  * This calls into the registered authenticator's requires_authentication callback
1274  * in order to determine if the request requires authentication.
1275  *
1276  * If there is no registered authenticator, then authentication will be assumed
1277  * not to be required.
1278  *
1279  * \param endpoint The endpoint from which the request originates
1280  * \param rdata The incoming SIP request
1281  * \retval non-zero The request requires authentication
1282  * \retval 0 The request does not require authentication
1283  */
1284 int ast_sip_requires_authentication(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1285
1286 /*!
1287  * \brief Method to determine authentication status of an incoming request
1288  *
1289  * This will call into a registered authenticator. The registered authenticator will
1290  * do what is necessary to determine whether the incoming request passes authentication.
1291  * A tentative response is passed into this function so that if, say, a digest authentication
1292  * challenge should be sent in the ensuing response, it can be added to the response.
1293  *
1294  * \param endpoint The endpoint from the request was sent
1295  * \param rdata The request to potentially authenticate
1296  * \param tdata Tentative response to the request
1297  * \return The result of checking authentication.
1298  */
1299 enum ast_sip_check_auth_result ast_sip_check_authentication(struct ast_sip_endpoint *endpoint,
1300                 pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1301
1302 /*!
1303  * \brief Create a response to an authentication challenge
1304  *
1305  * This will call into an outbound authenticator's create_request_with_auth callback
1306  * to create a new request with authentication credentials. See the create_request_with_auth
1307  * callback in the \ref ast_sip_outbound_authenticator structure for details about
1308  * the parameters and return values.
1309  */
1310 int ast_sip_create_request_with_auth(const struct ast_sip_auth_array *auths, pjsip_rx_data *challenge,
1311                 pjsip_transaction *tsx, pjsip_tx_data **new_request);
1312
1313 /*!
1314  * \brief Determine the endpoint that has sent a SIP message
1315  *
1316  * This will call into each of the registered endpoint identifiers'
1317  * identify_endpoint() callbacks until one returns a non-NULL endpoint.
1318  * This will return an ao2 object. Its reference count will need to be
1319  * decremented when completed using the endpoint.
1320  *
1321  * \param rdata The inbound SIP message to use when identifying the endpoint.
1322  * \retval NULL No matching endpoint
1323  * \retval non-NULL The matching endpoint
1324  */
1325 struct ast_sip_endpoint *ast_sip_identify_endpoint(pjsip_rx_data *rdata);
1326
1327 /*!
1328  * \brief Add a header to an outbound SIP message
1329  *
1330  * \param tdata The message to add the header to
1331  * \param name The header name
1332  * \param value The header value
1333  * \retval 0 Success
1334  * \retval -1 Failure
1335  */
1336 int ast_sip_add_header(pjsip_tx_data *tdata, const char *name, const char *value);
1337
1338 /*!
1339  * \brief Add a body to an outbound SIP message
1340  *
1341  * If this is called multiple times, the latest body will replace the current
1342  * body.
1343  *
1344  * \param tdata The message to add the body to
1345  * \param body The message body to add
1346  * \retval 0 Success
1347  * \retval -1 Failure
1348  */
1349 int ast_sip_add_body(pjsip_tx_data *tdata, const struct ast_sip_body *body);
1350
1351 /*!
1352  * \brief Add a multipart body to an outbound SIP message
1353  *
1354  * This will treat each part of the input array as part of a multipart body and
1355  * add each part to the SIP message.
1356  *
1357  * \param tdata The message to add the body to
1358  * \param bodies The parts of the body to add
1359  * \retval 0 Success
1360  * \retval -1 Failure
1361  */
1362 int ast_sip_add_body_multipart(pjsip_tx_data *tdata, const struct ast_sip_body *bodies[], int num_bodies);
1363
1364 /*!
1365  * \brief Append body data to a SIP message
1366  *
1367  * This acts mostly the same as ast_sip_add_body, except that rather than replacing
1368  * a body if it currently exists, it appends data to an existing body.
1369  *
1370  * \param tdata The message to append the body to
1371  * \param body The string to append to the end of the current body
1372  * \retval 0 Success
1373  * \retval -1 Failure
1374  */
1375 int ast_sip_append_body(pjsip_tx_data *tdata, const char *body_text);
1376
1377 /*!
1378  * \brief Copy a pj_str_t into a standard character buffer.
1379  *
1380  * pj_str_t is not NULL-terminated. Any place that expects a NULL-
1381  * terminated string needs to have the pj_str_t copied into a separate
1382  * buffer.
1383  *
1384  * This method copies the pj_str_t contents into the destination buffer
1385  * and NULL-terminates the buffer.
1386  *
1387  * \param dest The destination buffer
1388  * \param src The pj_str_t to copy
1389  * \param size The size of the destination buffer.
1390  */
1391 void ast_copy_pj_str(char *dest, const pj_str_t *src, size_t size);
1392
1393 /*!
1394  * \brief Get the looked-up endpoint on an out-of dialog request or response
1395  *
1396  * The function may ONLY be called on out-of-dialog requests or responses. For
1397  * in-dialog requests and responses, it is required that the user of the dialog
1398  * has the looked-up endpoint stored locally.
1399  *
1400  * This function should never return NULL if the message is out-of-dialog. It will
1401  * always return NULL if the message is in-dialog.
1402  *
1403  * This function will increase the reference count of the returned endpoint by one.
1404  * Release your reference using the ao2_ref function when finished.
1405  *
1406  * \param rdata Out-of-dialog request or response
1407  * \return The looked up endpoint
1408  */
1409 struct ast_sip_endpoint *ast_pjsip_rdata_get_endpoint(pjsip_rx_data *rdata);
1410
1411 /*!
1412  * \brief Retrieve any endpoints available to sorcery.
1413  *
1414  * \retval Endpoints available to sorcery, NULL if no endpoints found.
1415  */
1416 struct ao2_container *ast_sip_get_endpoints(void);
1417
1418 /*!
1419  * \brief Retrieve relevant SIP auth structures from sorcery
1420  *
1421  * \param auths Array of sorcery IDs of auth credentials to retrieve
1422  * \param[out] out The retrieved auths are stored here
1423  */
1424 int ast_sip_retrieve_auths(const struct ast_sip_auth_array *auths, struct ast_sip_auth **out);
1425
1426 /*!
1427  * \brief Clean up retrieved auth structures from memory
1428  *
1429  * Call this function once you have completed operating on auths
1430  * retrieved from \ref ast_sip_retrieve_auths
1431  *
1432  * \param auths An array of auth structures to clean up
1433  * \param num_auths The number of auths in the array
1434  */
1435 void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths);
1436
1437 /*!
1438  * \brief Checks if the given content type matches type/subtype.
1439  *
1440  * Compares the pjsip_media_type with the passed type and subtype and
1441  * returns the result of that comparison.  The media type parameters are
1442  * ignored.
1443  *
1444  * \param content_type The pjsip_media_type structure to compare
1445  * \param type The media type to compare
1446  * \param subtype The media subtype to compare
1447  * \retval 0 No match
1448  * \retval -1 Match
1449  */
1450 int ast_sip_is_content_type(pjsip_media_type *content_type, char *type, char *subtype);
1451
1452 /*!
1453  * \brief Send a security event notification for when an invalid endpoint is requested
1454  *
1455  * \param name Name of the endpoint requested
1456  * \param rdata Received message
1457  */
1458 void ast_sip_report_invalid_endpoint(const char *name, pjsip_rx_data *rdata);
1459
1460 /*!
1461  * \brief Send a security event notification for when an ACL check fails
1462  *
1463  * \param endpoint Pointer to the endpoint in use
1464  * \param rdata Received message
1465  * \param name Name of the ACL
1466  */
1467 void ast_sip_report_failed_acl(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, const char *name);
1468
1469 /*!
1470  * \brief Send a security event notification for when a challenge response has failed
1471  *
1472  * \param endpoint Pointer to the endpoint in use
1473  * \param rdata Received message
1474  */
1475 void ast_sip_report_auth_failed_challenge_response(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1476
1477 /*!
1478  * \brief Send a security event notification for when authentication succeeds
1479  *
1480  * \param endpoint Pointer to the endpoint in use
1481  * \param rdata Received message
1482  */
1483 void ast_sip_report_auth_success(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata);
1484
1485 /*!
1486  * \brief Send a security event notification for when an authentication challenge is sent
1487  *
1488  * \param endpoint Pointer to the endpoint in use
1489  * \param rdata Received message
1490  * \param tdata Sent message
1491  */
1492 void ast_sip_report_auth_challenge_sent(struct ast_sip_endpoint *endpoint, pjsip_rx_data *rdata, pjsip_tx_data *tdata);
1493
1494 void ast_sip_initialize_global_headers(void);
1495 void ast_sip_destroy_global_headers(void);
1496
1497 int ast_sip_add_global_request_header(const char *name, const char *value, int replace);
1498 int ast_sip_add_global_response_header(const char *name, const char *value, int replace);
1499
1500 int ast_sip_initialize_sorcery_global(struct ast_sorcery *sorcery);
1501
1502 #endif /* _RES_SIP_H */