asterisk/res/res_stir_shaken/curl.h
Ben Ford 0724b767a3 AST-2022-002 - res_stir_shaken/curl: Add ACL checks for Identity header.
Adds a new configuration option, stir_shaken_profile, in pjsip.conf that
can be specified on a per endpoint basis. This option will reference a
stir_shaken_profile that can be configured in stir_shaken.conf. The type
of this option must be 'profile'. The stir_shaken option can be
specified on this object with the same values as before (attest, verify,
on), but it cannot be off since having the profile itself implies wanting
STIR/SHAKEN support. You can also specify an ACL from acl.conf (along
with permit and deny lines in the object itself) that will be used to
limit what interfaces Asterisk will attempt to retrieve information from
when reading the Identity header.

ASTERISK-29476

Change-Id: I87fa61f78a9ea0cd42530691a30da3c781842406
2022-04-14 16:58:17 -05:00

79 lines
2.1 KiB
C

/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2020, Sangoma Technologies Corporation
*
* Ben Ford <bford@sangoma.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
#ifndef _STIR_SHAKEN_CURL_H
#define _STIR_SHAKEN_CURL_H
struct ast_acl_list;
/* Forward declaration for CURL callback data */
struct curl_cb_data;
/*!
* \brief Allocate memory for a curl_cb_data struct
*
* \note This will need to be freed by the consumer using curl_cb_data_free
*
* \retval NULL on failure
* \retval curl_cb_struct on success
*/
struct curl_cb_data *curl_cb_data_create(void);
/*!
* \brief Free a curl_cb_data struct
*
* \param data The curl_cb_data struct to free
*/
void curl_cb_data_free(struct curl_cb_data *data);
/*!
* \brief Get the cache_control field from a curl_cb_data struct
*
* \param data The curl_cb_data
*
* \retval cache_control on success
* \retval NULL otherwise
*/
char *curl_cb_data_get_cache_control(const struct curl_cb_data *data);
/*!
* \brief Get the expires field from a curl_cb_data struct
*
* \param data The curl_cb_data
*
* \retval expires on success
* \retval NULL otherwise
*/
char *curl_cb_data_get_expires(const struct curl_cb_data *data);
/*!
* \brief CURL the public key from the provided URL to the specified path
*
* \note The returned string will need to be freed by the caller
*
* \param public_cert_url The public cert URL
* \param path The path to download the file to
* \param data The curl_cb_data
* \param acl The ACL to use for cURL (if not NULL)
*
* \retval NULL on failure
* \retval full path filename on success
*/
char *curl_public_key(const char *public_cert_url, const char *path, struct curl_cb_data *data, const struct ast_acl_list *acl);
#endif /* _STIR_SHAKEN_CURL_H */