mirror of
https://github.com/asterisk/asterisk.git
synced 2025-11-08 02:48:29 +00:00
181edcc3a3
Why do we need a refactor?
The original stir/shaken implementation was started over 3 years ago
when little was understood about practical implementation. The
result was an implementation that wouldn't actually interoperate
with any other stir-shaken implementations.
There were also a number of stir-shaken features and RFC
requirements that were never implemented such as TNAuthList
certificate validation, sending Reason headers in SIP responses
when verification failed but we wished to continue the call, and
the ability to send Media Key(mky) grants in the Identity header
when the call involved DTLS.
Finally, there were some performance concerns around outgoing
calls and selection of the correct certificate and private key.
The configuration was keyed by an arbitrary name which meant that
for every outgoing call, we had to scan the entire list of
configured TNs to find the correct cert to use. With only a few
TNs configured, this wasn't an issue but if you have a thousand,
it could be.
What's changed?
* Configuration objects have been refactored to be clearer about
their uses and to fix issues.
* The "general" object was renamed to "verification" since it
contains parameters specific to the incoming verification
process. It also never handled ca_path and crl_path
correctly.
* A new "attestation" object was added that controls the
outgoing attestation process. It sets default certificates,
keys, etc.
* The "certificate" object was renamed to "tn" and had it's key
change to telephone number since outgoing call attestation
needs to look up certificates by telephone number.
* The "profile" object had more parameters added to it that can
override default parameters specified in the "attestation"
and "verification" objects.
* The "store" object was removed altogther as it was never
implemented.
* We now use libjwt to create outgoing Identity headers and to
parse and validate signatures on incoming Identiy headers. Our
previous custom implementation was much of the source of the
interoperability issues.
* General code cleanup and refactor.
* Moved things to better places.
* Separated some of the complex functions to smaller ones.
* Using context objects rather than passing tons of parameters
in function calls.
* Removed some complexity and unneeded encapsuation from the
config objects.
Resolves: #351
Resolves: #46
UserNote: Asterisk's stir-shaken feature has been refactored to
correct interoperability, RFC compliance, and performance issues.
See https://docs.asterisk.org/Deployment/STIR-SHAKEN for more
information.
UpgradeNote: The stir-shaken refactor is a breaking change but since
it's not working now we don't think it matters. The
stir_shaken.conf file has changed significantly which means that
existing ones WILL need to be changed. The stir_shaken.conf.sample
file in configs/samples/ has quite a bit more information. This is
also an ABI breaking change since some of the existing objects
needed to be changed or removed, and new ones added. Additionally,
if res_stir_shaken is enabled in menuselect, you'll need to either
have the development package for libjwt v1.15.3 installed or use
the --with-libjwt-bundled option with ./configure.
259 lines
8.0 KiB
C
259 lines
8.0 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2020, Sangoma Technologies Corporation
|
|
*
|
|
* Kevin Harwell <kharwell@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 _RES_STIR_SHAKEN_H
|
|
#define _RES_STIR_SHAKEN_H
|
|
|
|
#include "asterisk/sorcery.h"
|
|
|
|
enum ast_stir_shaken_vs_response_code {
|
|
AST_STIR_SHAKEN_VS_SUCCESS = 0,
|
|
AST_STIR_SHAKEN_VS_DISABLED,
|
|
AST_STIR_SHAKEN_VS_INVALID_ARGUMENTS,
|
|
AST_STIR_SHAKEN_VS_INTERNAL_ERROR,
|
|
AST_STIR_SHAKEN_VS_NO_IDENTITY_HDR,
|
|
AST_STIR_SHAKEN_VS_NO_DATE_HDR,
|
|
AST_STIR_SHAKEN_VS_DATE_HDR_PARSE_FAILURE,
|
|
AST_STIR_SHAKEN_VS_DATE_HDR_EXPIRED,
|
|
AST_STIR_SHAKEN_VS_NO_JWT_HDR,
|
|
AST_STIR_SHAKEN_VS_INVALID_OR_NO_X5U,
|
|
AST_STIR_SHAKEN_VS_CERT_CACHE_MISS,
|
|
AST_STIR_SHAKEN_VS_CERT_CACHE_INVALID,
|
|
AST_STIR_SHAKEN_VS_CERT_CACHE_EXPIRED,
|
|
AST_STIR_SHAKEN_VS_CERT_RETRIEVAL_FAILURE,
|
|
AST_STIR_SHAKEN_VS_CERT_CONTENTS_INVALID,
|
|
AST_STIR_SHAKEN_VS_CERT_NOT_TRUSTED,
|
|
AST_STIR_SHAKEN_VS_CERT_DATE_INVALID,
|
|
AST_STIR_SHAKEN_VS_CERT_NO_TN_AUTH_EXT,
|
|
AST_STIR_SHAKEN_VS_CERT_NO_SPC_IN_TN_AUTH_EXT,
|
|
AST_STIR_SHAKEN_VS_NO_RAW_KEY,
|
|
AST_STIR_SHAKEN_VS_SIGNATURE_VALIDATION,
|
|
AST_STIR_SHAKEN_VS_NO_IAT,
|
|
AST_STIR_SHAKEN_VS_IAT_EXPIRED,
|
|
AST_STIR_SHAKEN_VS_INVALID_OR_NO_PPT,
|
|
AST_STIR_SHAKEN_VS_INVALID_OR_NO_ALG,
|
|
AST_STIR_SHAKEN_VS_INVALID_OR_NO_TYP,
|
|
AST_STIR_SHAKEN_VS_INVALID_OR_NO_GRANTS,
|
|
AST_STIR_SHAKEN_VS_INVALID_OR_NO_ATTEST,
|
|
AST_STIR_SHAKEN_VS_NO_ORIGID,
|
|
AST_STIR_SHAKEN_VS_NO_ORIG_TN,
|
|
AST_STIR_SHAKEN_VS_CID_ORIG_TN_MISMATCH,
|
|
AST_STIR_SHAKEN_VS_NO_DEST_TN,
|
|
AST_STIR_SHAKEN_VS_INVALID_HEADER,
|
|
AST_STIR_SHAKEN_VS_INVALID_GRANT,
|
|
AST_STIR_SHAKEN_VS_RESPONSE_CODE_MAX
|
|
};
|
|
|
|
enum ast_stir_shaken_as_response_code {
|
|
AST_STIR_SHAKEN_AS_SUCCESS = 0,
|
|
AST_STIR_SHAKEN_AS_DISABLED,
|
|
AST_STIR_SHAKEN_AS_INVALID_ARGUMENTS,
|
|
AST_STIR_SHAKEN_AS_MISSING_PARAMETERS,
|
|
AST_STIR_SHAKEN_AS_INTERNAL_ERROR,
|
|
AST_STIR_SHAKEN_AS_NO_TN_FOR_CALLERID,
|
|
AST_STIR_SHAKEN_AS_NO_PRIVATE_KEY_AVAIL,
|
|
AST_STIR_SHAKEN_AS_NO_PUBLIC_CERT_URL_AVAIL,
|
|
AST_STIR_SHAKEN_AS_NO_ATTEST_LEVEL,
|
|
AST_STIR_SHAKEN_AS_IDENTITY_HDR_EXISTS,
|
|
AST_STIR_SHAKEN_AS_NO_TO_HDR,
|
|
AST_STIR_SHAKEN_AS_TO_HDR_BAD_URI,
|
|
AST_STIR_SHAKEN_AS_SIGN_ENCODE_FAILURE,
|
|
AST_STIR_SHAKEN_AS_RESPONSE_CODE_MAX
|
|
};
|
|
|
|
enum stir_shaken_failure_action_enum {
|
|
/*! Unknown value */
|
|
stir_shaken_failure_action_UNKNOWN = -1,
|
|
/*! Continue and let dialplan decide action */
|
|
stir_shaken_failure_action_CONTINUE = 0,
|
|
/*! Reject request with respone codes defined in RFC8224 */
|
|
stir_shaken_failure_action_REJECT_REQUEST,
|
|
/*! Continue but return a Reason header in next provisional response */
|
|
stir_shaken_failure_action_CONTINUE_RETURN_REASON,
|
|
/*! Not set in config */
|
|
stir_shaken_failure_action_NOT_SET,
|
|
};
|
|
|
|
struct ast_stir_shaken_as_ctx;
|
|
|
|
/*!
|
|
* \brief Create Attestation Service Context
|
|
*
|
|
* \param caller_id The caller_id for the outgoing call
|
|
* \param dest_tn Canonicalized destination tn
|
|
* \param chan The outgoing channel
|
|
* \param profile_name The profile name on the endpoint
|
|
* May be NULL.
|
|
* \param tag Identifying string to output in log and trace messages.
|
|
* \param ctxout Receives a pointer to the newly created context
|
|
* The caller must release with ao2_ref or ao2_cleanup.
|
|
|
|
* \retval AST_STIR_SHAKEN_AS_SUCCESS if successful.
|
|
* \retval AST_STIR_SHAKEN_AS_DISABLED if attestation is disabled
|
|
* by the endpoint itself, the profile or globally.
|
|
* \retval Other AST_STIR_SHAKEN_AS errors.
|
|
*/
|
|
enum ast_stir_shaken_as_response_code
|
|
ast_stir_shaken_as_ctx_create(const char *caller_id,
|
|
const char *dest_tn, struct ast_channel *chan,
|
|
const char *profile_name,
|
|
const char *tag, struct ast_stir_shaken_as_ctx **ctxout);
|
|
|
|
/*!
|
|
* \brief Indicates if the AS context needs DTLS fingerprints
|
|
*
|
|
* \param ctx AS Context
|
|
*
|
|
* \retval 0 Not needed
|
|
* \retval 1 Needed
|
|
*/
|
|
int ast_stir_shaken_as_ctx_wants_fingerprints(struct ast_stir_shaken_as_ctx *ctx);
|
|
|
|
/*!
|
|
* \brief Add DTLS fingerprints to AS context
|
|
*
|
|
* \param ctx AS context
|
|
* \param alg Fingerprint algorithm ("sha-1" or "sha-256")
|
|
* \param fingerprint Fingerprint
|
|
*
|
|
* \retval AST_STIR_SHAKEN_AS_SUCCESS if successful
|
|
* \retval Other AST_STIR_SHAKEN_AS errors.
|
|
*/
|
|
enum ast_stir_shaken_as_response_code ast_stir_shaken_as_ctx_add_fingerprint(
|
|
struct ast_stir_shaken_as_ctx *ctx, const char *alg, const char *fingerprint);
|
|
|
|
/*!
|
|
* \brief Attest and return Identity header value
|
|
*
|
|
* \param ctx AS Context
|
|
* \param header Pointer to buffer to receive the header value
|
|
* Must be freed with ast_free when done
|
|
*
|
|
* \retval AST_STIR_SHAKEN_AS_SUCCESS if successful
|
|
* \retval Other AST_STIR_SHAKEN_AS errors.
|
|
*/
|
|
enum ast_stir_shaken_as_response_code ast_stir_shaken_attest(
|
|
struct ast_stir_shaken_as_ctx *ctx, char **header);
|
|
|
|
|
|
struct ast_stir_shaken_vs_ctx;
|
|
|
|
/*!
|
|
* \brief Create Verification Service context
|
|
*
|
|
* \param caller_id Incoming caller id
|
|
* \param chan Incoming channel
|
|
* \param profile_name The profile name on the endpoint
|
|
* May be NULL.
|
|
* \param endpoint_behavior Behavior associated to the specific
|
|
* endpoint
|
|
* \param tag Identifying string to output in log and trace messages.
|
|
* \param ctxout Receives a pointer to the newly created context
|
|
* The caller must release with ao2_ref or ao2_cleanup.
|
|
*
|
|
* \retval AST_STIR_SHAKEN_VS_SUCCESS if successful.
|
|
* \retval AST_STIR_SHAKEN_VS_DISABLED if verification is disabled
|
|
* by the endpoint itself, the profile or globally.
|
|
* \retval Other AST_STIR_SHAKEN_VS errors.
|
|
*/
|
|
enum ast_stir_shaken_vs_response_code
|
|
ast_stir_shaken_vs_ctx_create(const char *caller_id,
|
|
struct ast_channel *chan, const char *profile_name,
|
|
const char *tag, struct ast_stir_shaken_vs_ctx **ctxout);
|
|
|
|
/*!
|
|
* \brief Sets response code on VS context
|
|
*
|
|
* \param ctx VS context
|
|
* \param vs_rc ast_stir_shaken_vs_response_code to set
|
|
*/
|
|
void ast_stir_shaken_vs_ctx_set_response_code(
|
|
struct ast_stir_shaken_vs_ctx *ctx,
|
|
enum ast_stir_shaken_vs_response_code vs_rc);
|
|
|
|
/*!
|
|
* \brief Add the received Identity header value to the VS context
|
|
*
|
|
* \param ctx VS context
|
|
* \param identity_hdr Identity header value
|
|
*
|
|
* \retval AST_STIR_SHAKEN_VS_SUCCESS if successful
|
|
* \retval Other AST_STIR_SHAKEN_VS errors.
|
|
*/
|
|
enum ast_stir_shaken_vs_response_code
|
|
ast_stir_shaken_vs_ctx_add_identity_hdr(struct ast_stir_shaken_vs_ctx * ctx,
|
|
const char *identity_hdr);
|
|
|
|
/*!
|
|
* \brief Add the received Date header value to the VS context
|
|
*
|
|
* \param ctx VS context
|
|
* \param date_hdr Date header value
|
|
*
|
|
* \retval AST_STIR_SHAKEN_VS_SUCCESS if successful
|
|
* \retval Other AST_STIR_SHAKEN_VS errors.
|
|
*/
|
|
enum ast_stir_shaken_vs_response_code
|
|
ast_stir_shaken_vs_ctx_add_date_hdr(struct ast_stir_shaken_vs_ctx * ctx,
|
|
const char *date_hdr);
|
|
|
|
/*!
|
|
* \brief Get failure_action from context
|
|
*
|
|
* \param ctx VS context
|
|
*
|
|
* \retval ast_stir_shaken_failure_action
|
|
*/
|
|
enum stir_shaken_failure_action_enum
|
|
ast_stir_shaken_vs_get_failure_action(
|
|
struct ast_stir_shaken_vs_ctx *ctx);
|
|
|
|
/*!
|
|
* \brief Get use_rfc9410_responses from context
|
|
*
|
|
* \param ctx VS context
|
|
*
|
|
* \retval 1 if true
|
|
* \retval 0 if false
|
|
*/
|
|
int ast_stir_shaken_vs_get_use_rfc9410_responses(
|
|
struct ast_stir_shaken_vs_ctx *ctx);
|
|
|
|
/*!
|
|
* \brief Add a STIR/SHAKEN verification result to a channel
|
|
*
|
|
* \param ctx VS context
|
|
*
|
|
* \retval -1 on failure
|
|
* \retval 0 on success
|
|
*/
|
|
int ast_stir_shaken_add_result_to_channel(
|
|
struct ast_stir_shaken_vs_ctx *ctx);
|
|
|
|
/*!
|
|
* \brief Perform incoming call verification
|
|
*
|
|
* \param ctx VS context
|
|
*
|
|
* \retval AST_STIR_SHAKEN_AS_SUCCESS if successful
|
|
* \retval Other AST_STIR_SHAKEN_AS errors.
|
|
*/
|
|
enum ast_stir_shaken_vs_response_code
|
|
ast_stir_shaken_vs_verify(struct ast_stir_shaken_vs_ctx * ctx);
|
|
|
|
#endif /* _RES_STIR_SHAKEN_H */
|