mirror of
https://github.com/cuberite/polarssl.git
synced 2025-11-03 04:02:19 -05:00
b2aacec417
The cryptographic API should not be related to whether or not there is alternative implementation. The API should be same for regular implementation, and for alternative implementation, so it is defined outside of the XXX_ALT precompilation check in the cryptographic API header
315 lines
10 KiB
C
315 lines
10 KiB
C
/**
|
|
* \file sha1.h
|
|
*
|
|
* \brief The SHA-1 cryptographic hash function.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use constitutes
|
|
* a security risk. We recommend considering stronger message
|
|
* digests instead.
|
|
*/
|
|
/*
|
|
* Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* 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
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* 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.
|
|
*
|
|
* This file is part of Mbed TLS (https://tls.mbed.org)
|
|
*/
|
|
#ifndef MBEDTLS_SHA1_H
|
|
#define MBEDTLS_SHA1_H
|
|
|
|
#if !defined(MBEDTLS_CONFIG_FILE)
|
|
#include "config.h"
|
|
#else
|
|
#include MBEDTLS_CONFIG_FILE
|
|
#endif
|
|
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
#define MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED -0x0035 /**< SHA-1 hardware accelerator failed */
|
|
|
|
#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.
|
|
*
|
|
*/
|
|
typedef struct
|
|
{
|
|
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.
|
|
*
|
|
* \param ctx The SHA-1 context to initialize.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
void mbedtls_sha1_init( mbedtls_sha1_context *ctx );
|
|
|
|
/**
|
|
* \brief This function clears a SHA-1 context.
|
|
*
|
|
* \param ctx The SHA-1 context to clear.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
void mbedtls_sha1_free( mbedtls_sha1_context *ctx );
|
|
|
|
/**
|
|
* \brief This function clones the state of a SHA-1 context.
|
|
*
|
|
* \param dst The destination context.
|
|
* \param src The context to clone.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
void mbedtls_sha1_clone( mbedtls_sha1_context *dst,
|
|
const mbedtls_sha1_context *src );
|
|
|
|
/**
|
|
* \brief This function starts a SHA-1 checksum calculation.
|
|
*
|
|
* \param ctx The context to initialize.
|
|
*
|
|
* \return \c 0 if successful
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
int mbedtls_sha1_starts_ret( mbedtls_sha1_context *ctx );
|
|
|
|
/**
|
|
* \brief This function feeds an input buffer into an ongoing SHA-1
|
|
* checksum calculation.
|
|
*
|
|
* \param ctx The SHA-1 context.
|
|
* \param input The buffer holding the input data.
|
|
* \param ilen The length of the input data.
|
|
*
|
|
* \return \c 0 if successful
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
int mbedtls_sha1_update_ret( mbedtls_sha1_context *ctx,
|
|
const unsigned char *input,
|
|
size_t ilen );
|
|
|
|
/**
|
|
* \brief This function finishes the SHA-1 operation, and writes
|
|
* the result to the output buffer.
|
|
*
|
|
* \param ctx The SHA-1 context.
|
|
* \param output The SHA-1 checksum result.
|
|
*
|
|
* \return \c 0 if successful
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
int mbedtls_sha1_finish_ret( mbedtls_sha1_context *ctx,
|
|
unsigned char output[20] );
|
|
|
|
/**
|
|
* \brief SHA-1 process data block (internal use only)
|
|
*
|
|
* \param ctx SHA-1 context
|
|
* \param data The data block being processed.
|
|
*
|
|
* \return \c 0 if successful
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
int mbedtls_internal_sha1_process( mbedtls_sha1_context *ctx,
|
|
const unsigned char data[64] );
|
|
|
|
#if !defined(MBEDTLS_DEPRECATED_REMOVED)
|
|
#if defined(MBEDTLS_DEPRECATED_WARNING)
|
|
#define MBEDTLS_DEPRECATED __attribute__((deprecated))
|
|
#else
|
|
#define MBEDTLS_DEPRECATED
|
|
#endif
|
|
/**
|
|
* \brief SHA-1 context setup
|
|
*
|
|
* \deprecated Superseded by mbedtls_sha1_starts_ret() in 2.7.0
|
|
*
|
|
* \param ctx The SHA-1 context to be initialized.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
MBEDTLS_DEPRECATED void mbedtls_sha1_starts( mbedtls_sha1_context *ctx );
|
|
|
|
/**
|
|
* \brief SHA-1 process buffer
|
|
*
|
|
* \deprecated Superseded by mbedtls_sha1_update_ret() in 2.7.0
|
|
*
|
|
* \param ctx The SHA-1 context.
|
|
* \param input The buffer holding the input data.
|
|
* \param ilen The length of the input data.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
MBEDTLS_DEPRECATED void mbedtls_sha1_update( mbedtls_sha1_context *ctx,
|
|
const unsigned char *input,
|
|
size_t ilen );
|
|
|
|
/**
|
|
* \brief SHA-1 final digest
|
|
*
|
|
* \deprecated Superseded by mbedtls_sha1_finish_ret() in 2.7.0
|
|
*
|
|
* \param ctx The SHA-1 context.
|
|
* \param output The SHA-1 checksum result.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
MBEDTLS_DEPRECATED void mbedtls_sha1_finish( mbedtls_sha1_context *ctx,
|
|
unsigned char output[20] );
|
|
|
|
/**
|
|
* \brief SHA-1 process data block (internal use only)
|
|
*
|
|
* \deprecated Superseded by mbedtls_internal_sha1_process() in 2.7.0
|
|
*
|
|
* \param ctx The SHA-1 context.
|
|
* \param data The data block being processed.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
MBEDTLS_DEPRECATED void mbedtls_sha1_process( mbedtls_sha1_context *ctx,
|
|
const unsigned char data[64] );
|
|
|
|
#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).
|
|
*
|
|
* \param input The buffer holding the input data.
|
|
* \param ilen The length of the input data.
|
|
* \param output The SHA-1 checksum result.
|
|
*
|
|
* \return \c 0 if successful
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
int mbedtls_sha1_ret( const unsigned char *input,
|
|
size_t ilen,
|
|
unsigned char output[20] );
|
|
|
|
#if !defined(MBEDTLS_DEPRECATED_REMOVED)
|
|
#if defined(MBEDTLS_DEPRECATED_WARNING)
|
|
#define MBEDTLS_DEPRECATED __attribute__((deprecated))
|
|
#else
|
|
#define MBEDTLS_DEPRECATED
|
|
#endif
|
|
/**
|
|
* \brief Output = SHA-1( input buffer )
|
|
*
|
|
* \deprecated Superseded by mbedtls_sha1_ret() in 2.7.0
|
|
*
|
|
* \param input The buffer holding the input data.
|
|
* \param ilen The length of the input data.
|
|
* \param output The SHA-1 checksum result.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
MBEDTLS_DEPRECATED void mbedtls_sha1( const unsigned char *input,
|
|
size_t ilen,
|
|
unsigned char output[20] );
|
|
|
|
#undef MBEDTLS_DEPRECATED
|
|
#endif /* !MBEDTLS_DEPRECATED_REMOVED */
|
|
|
|
/**
|
|
* \brief The SHA-1 checkup routine.
|
|
*
|
|
* \return \c 0 on success, or \c 1 on failure.
|
|
*
|
|
* \warning SHA-1 is considered a weak message digest and its use
|
|
* constitutes a security risk. We recommend considering
|
|
* stronger message digests instead.
|
|
*
|
|
*/
|
|
int mbedtls_sha1_self_test( int verbose );
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* mbedtls_sha1.h */
|