proxmark3/common/mbedtls/sha1.h

350 lines
12 KiB
C
Raw Normal View History

2018-11-08 00:05:02 +08:00
/**
* \file sha1.h
*
* \brief This file contains SHA-1 definitions and functions.
*
* The Secure Hash Algorithm 1 (SHA-1) cryptographic hash function is defined in
* <em>FIPS 180-4: Secure Hash Standard (SHS)</em>.
*
* \warning SHA-1 is considered a weak message digest and its use constitutes
* a security risk. We recommend considering stronger message
* digests instead.
*/
/*
2021-05-14 15:53:00 +08:00
* Copyright The Mbed TLS Contributors
* SPDX-License-Identifier: Apache-2.0
2018-11-08 00:05:02 +08:00
*
2021-05-14 15:53:00 +08:00
* Licensed under the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
2018-11-08 00:05:02 +08:00
*
2021-05-14 15:53:00 +08:00
* http://www.apache.org/licenses/LICENSE-2.0
2018-11-08 00:05:02 +08:00
*
2021-05-14 15:53:00 +08:00
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
2018-11-08 00:05:02 +08:00
*/
#ifndef MBEDTLS_SHA1_H
#define MBEDTLS_SHA1_H
#if !defined(MBEDTLS_CONFIG_FILE)
2021-05-14 15:53:00 +08:00
#include "mbedtls/config.h"
2018-11-08 00:05:02 +08:00
#else
#include MBEDTLS_CONFIG_FILE
#endif
#include <stddef.h>
#include <stdint.h>
2021-05-14 15:53:00 +08:00
/* MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED is deprecated and should not be used. */
2018-11-08 00:05:02 +08:00
#define MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED -0x0035 /**< SHA-1 hardware accelerator failed */
2021-05-14 15:53:00 +08:00
#define MBEDTLS_ERR_SHA1_BAD_INPUT_DATA -0x0073 /**< SHA-1 input data was malformed. */
2018-11-08 00:05:02 +08:00
#ifdef __cplusplus
extern "C" {
#endif
#if !defined(MBEDTLS_SHA1_ALT)
// Regular implementation
//
/**
* \brief The SHA-1 context structure.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
*/
2021-05-14 17:00:46 +08:00
typedef struct mbedtls_sha1_context {
2018-11-08 00:05:02 +08:00
uint32_t total[2]; /*!< The number of Bytes processed. */
uint32_t state[5]; /*!< The intermediate digest state. */
unsigned char buffer[64]; /*!< The data block being processed. */
}
mbedtls_sha1_context;
#else /* MBEDTLS_SHA1_ALT */
#include "sha1_alt.h"
#endif /* MBEDTLS_SHA1_ALT */
/**
* \brief This function initializes a SHA-1 context.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
* \param ctx The SHA-1 context to initialize.
2021-05-14 15:53:00 +08:00
* This must not be \c NULL.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
void mbedtls_sha1_init(mbedtls_sha1_context *ctx);
2018-11-08 00:05:02 +08:00
/**
* \brief This function clears a SHA-1 context.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context to clear. This may be \c NULL,
* in which case this function does nothing. If it is
* not \c NULL, it must point to an initialized
* SHA-1 context.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
void mbedtls_sha1_free(mbedtls_sha1_context *ctx);
2018-11-08 00:05:02 +08:00
/**
* \brief This function clones the state of a SHA-1 context.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
2021-05-14 15:53:00 +08:00
* \param dst The SHA-1 context to clone to. This must be initialized.
* \param src The SHA-1 context to clone from. This must be initialized.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
void mbedtls_sha1_clone(mbedtls_sha1_context *dst,
const mbedtls_sha1_context *src);
2018-11-08 00:05:02 +08:00
/**
* \brief This function starts a SHA-1 checksum calculation.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context to initialize. This must be initialized.
2018-11-08 00:05:02 +08:00
*
* \return \c 0 on success.
2021-05-14 15:53:00 +08:00
* \return A negative error code on failure.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
int mbedtls_sha1_starts_ret(mbedtls_sha1_context *ctx);
2018-11-08 00:05:02 +08:00
/**
* \brief This function feeds an input buffer into an ongoing SHA-1
* checksum calculation.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context. This must be initialized
* and have a hash operation started.
2018-11-08 00:05:02 +08:00
* \param input The buffer holding the input data.
2021-05-14 15:53:00 +08:00
* This must be a readable buffer of length \p ilen Bytes.
* \param ilen The length of the input data \p input in Bytes.
2018-11-08 00:05:02 +08:00
*
* \return \c 0 on success.
2021-05-14 15:53:00 +08:00
* \return A negative error code on failure.
2018-11-08 00:05:02 +08:00
*/
2021-05-14 17:00:46 +08:00
int mbedtls_sha1_update_ret(mbedtls_sha1_context *ctx,
const unsigned char *input,
size_t ilen);
2018-11-08 00:05:02 +08:00
/**
* \brief This function finishes the SHA-1 operation, and writes
* the result to the output buffer.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context to use. This must be initialized and
* have a hash operation started.
* \param output The SHA-1 checksum result. This must be a writable
* buffer of length \c 20 Bytes.
2018-11-08 00:05:02 +08:00
*
* \return \c 0 on success.
2021-05-14 15:53:00 +08:00
* \return A negative error code on failure.
2018-11-08 00:05:02 +08:00
*/
2021-05-14 17:00:46 +08:00
int mbedtls_sha1_finish_ret(mbedtls_sha1_context *ctx,
unsigned char output[20]);
2018-11-08 00:05:02 +08:00
/**
* \brief SHA-1 process data block (internal use only).
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context to use. This must be initialized.
* \param data The data block being processed. This must be a
* readable buffer of length \c 64 Bytes.
2018-11-08 00:05:02 +08:00
*
* \return \c 0 on success.
2021-05-14 15:53:00 +08:00
* \return A negative error code on failure.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
int mbedtls_internal_sha1_process(mbedtls_sha1_context *ctx,
const unsigned char data[64]);
2018-11-08 00:05:02 +08:00
#if !defined(MBEDTLS_DEPRECATED_REMOVED)
#if defined(MBEDTLS_DEPRECATED_WARNING)
#define MBEDTLS_DEPRECATED __attribute__((deprecated))
#else
#define MBEDTLS_DEPRECATED
#endif
/**
* \brief This function starts a SHA-1 checksum calculation.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
* \deprecated Superseded by mbedtls_sha1_starts_ret() in 2.7.0.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context to initialize. This must be initialized.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
MBEDTLS_DEPRECATED void mbedtls_sha1_starts(mbedtls_sha1_context *ctx);
2018-11-08 00:05:02 +08:00
/**
* \brief This function feeds an input buffer into an ongoing SHA-1
* checksum calculation.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
* \deprecated Superseded by mbedtls_sha1_update_ret() in 2.7.0.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context. This must be initialized and
* have a hash operation started.
2018-11-08 00:05:02 +08:00
* \param input The buffer holding the input data.
2021-05-14 15:53:00 +08:00
* This must be a readable buffer of length \p ilen Bytes.
* \param ilen The length of the input data \p input in Bytes.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
MBEDTLS_DEPRECATED void mbedtls_sha1_update(mbedtls_sha1_context *ctx,
const unsigned char *input,
size_t ilen);
2018-11-08 00:05:02 +08:00
/**
* \brief This function finishes the SHA-1 operation, and writes
* the result to the output buffer.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
* \deprecated Superseded by mbedtls_sha1_finish_ret() in 2.7.0.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context. This must be initialized and
* have a hash operation started.
2018-11-08 00:05:02 +08:00
* \param output The SHA-1 checksum result.
2021-05-14 15:53:00 +08:00
* This must be a writable buffer of length \c 20 Bytes.
2018-11-08 00:05:02 +08:00
*/
2021-05-14 17:00:46 +08:00
MBEDTLS_DEPRECATED void mbedtls_sha1_finish(mbedtls_sha1_context *ctx,
unsigned char output[20]);
2018-11-08 00:05:02 +08:00
/**
* \brief SHA-1 process data block (internal use only).
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
* \deprecated Superseded by mbedtls_internal_sha1_process() in 2.7.0.
*
2021-05-14 15:53:00 +08:00
* \param ctx The SHA-1 context. This must be initialized.
2018-11-08 00:05:02 +08:00
* \param data The data block being processed.
2021-05-14 15:53:00 +08:00
* This must be a readable buffer of length \c 64 bytes.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
MBEDTLS_DEPRECATED void mbedtls_sha1_process(mbedtls_sha1_context *ctx,
const unsigned char data[64]);
2018-11-08 00:05:02 +08:00
#undef MBEDTLS_DEPRECATED
#endif /* !MBEDTLS_DEPRECATED_REMOVED */
/**
* \brief This function calculates the SHA-1 checksum of a buffer.
*
* The function allocates the context, performs the
* calculation, and frees the context.
*
* The SHA-1 result is calculated as
* output = SHA-1(input buffer).
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
* \param input The buffer holding the input data.
2021-05-14 15:53:00 +08:00
* This must be a readable buffer of length \p ilen Bytes.
* \param ilen The length of the input data \p input in Bytes.
2018-11-08 00:05:02 +08:00
* \param output The SHA-1 checksum result.
2021-05-14 15:53:00 +08:00
* This must be a writable buffer of length \c 20 Bytes.
2018-11-08 00:05:02 +08:00
*
* \return \c 0 on success.
2021-05-14 15:53:00 +08:00
* \return A negative error code on failure.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
int mbedtls_sha1_ret(const unsigned char *input,
size_t ilen,
unsigned char output[20]);
2018-11-08 00:05:02 +08:00
#if !defined(MBEDTLS_DEPRECATED_REMOVED)
#if defined(MBEDTLS_DEPRECATED_WARNING)
#define MBEDTLS_DEPRECATED __attribute__((deprecated))
#else
#define MBEDTLS_DEPRECATED
#endif
/**
* \brief This function calculates the SHA-1 checksum of a buffer.
*
* The function allocates the context, performs the
* calculation, and frees the context.
*
* The SHA-1 result is calculated as
* output = SHA-1(input buffer).
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
* \deprecated Superseded by mbedtls_sha1_ret() in 2.7.0
*
* \param input The buffer holding the input data.
2021-05-14 15:53:00 +08:00
* This must be a readable buffer of length \p ilen Bytes.
* \param ilen The length of the input data \p input in Bytes.
* \param output The SHA-1 checksum result. This must be a writable
* buffer of size \c 20 Bytes.
2018-11-08 00:05:02 +08:00
*
*/
2021-05-14 17:00:46 +08:00
MBEDTLS_DEPRECATED void mbedtls_sha1(const unsigned char *input,
size_t ilen,
unsigned char output[20]);
2018-11-08 00:05:02 +08:00
#undef MBEDTLS_DEPRECATED
#endif /* !MBEDTLS_DEPRECATED_REMOVED */
2021-05-14 15:53:00 +08:00
#if defined(MBEDTLS_SELF_TEST)
2018-11-08 00:05:02 +08:00
/**
* \brief The SHA-1 checkup routine.
*
* \warning SHA-1 is considered a weak message digest and its use
* constitutes a security risk. We recommend considering
* stronger message digests instead.
*
* \return \c 0 on success.
* \return \c 1 on failure.
*
*/
2021-05-14 17:00:46 +08:00
int mbedtls_sha1_self_test(int verbose);
2021-05-14 15:53:00 +08:00
#endif /* MBEDTLS_SELF_TEST */
2018-11-08 00:05:02 +08:00
#ifdef __cplusplus
}
#endif
#endif /* mbedtls_sha1.h */