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