123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302 |
- /**
- * \file sha256.h
- *
- * \brief The SHA-224 and SHA-256 cryptographic hash function.
- */
- /*
- * 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_SHA256_H
- #define MBEDTLS_SHA256_H
- #if !defined(MBEDTLS_CONFIG_FILE)
- #include "config.h"
- #else
- #include MBEDTLS_CONFIG_FILE
- #endif
- #include <stddef.h>
- #include <stdint.h>
- #define MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED -0x0037 /**< SHA-256 hardware accelerator failed */
- #if ( defined(__ARMCC_VERSION) || defined(_MSC_VER) ) && \
- !defined(inline) && !defined(__cplusplus)
- #define inline __inline
- #endif
- #if !defined(MBEDTLS_SHA256_ALT)
- // Regular implementation
- //
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**
- * \brief The SHA-256 context structure.
- *
- * The structure is used both for SHA-256 and for SHA-224
- * checksum calculations. The choice between these two is
- * made in the call to mbedtls_sha256_starts_ret().
- */
- typedef struct
- {
- uint32_t total[2]; /*!< The number of Bytes processed. */
- uint32_t state[8]; /*!< The intermediate digest state. */
- unsigned char buffer[64]; /*!< The data block being processed. */
- int is224; /*!< Determines which function to use.
- <ul><li>0: Use SHA-256.</li>
- <li>1: Use SHA-224.</li></ul> */
- }
- mbedtls_sha256_context;
- /**
- * \brief This function initializes a SHA-256 context.
- *
- * \param ctx The SHA-256 context to initialize.
- */
- void mbedtls_sha256_init( mbedtls_sha256_context *ctx );
- /**
- * \brief This function clears a SHA-256 context.
- *
- * \param ctx The SHA-256 context to clear.
- */
- void mbedtls_sha256_free( mbedtls_sha256_context *ctx );
- /**
- * \brief This function clones the state of a SHA-256 context.
- *
- * \param dst The destination context.
- * \param src The context to clone.
- */
- void mbedtls_sha256_clone( mbedtls_sha256_context *dst,
- const mbedtls_sha256_context *src );
- /**
- * \brief This function starts a SHA-224 or SHA-256 checksum
- * calculation.
- *
- * \param ctx The context to initialize.
- * \param is224 Determines which function to use.
- * <ul><li>0: Use SHA-256.</li>
- * <li>1: Use SHA-224.</li></ul>
- *
- * \return \c 0 on success.
- */
- int mbedtls_sha256_starts_ret( mbedtls_sha256_context *ctx, int is224 );
- /**
- * \brief This function feeds an input buffer into an ongoing
- * SHA-256 checksum calculation.
- *
- * \param ctx SHA-256 context
- * \param input buffer holding the data
- * \param ilen length of the input data
- *
- * \return \c 0 on success.
- */
- int mbedtls_sha256_update_ret( mbedtls_sha256_context *ctx,
- const unsigned char *input,
- size_t ilen );
- /**
- * \brief This function finishes the SHA-256 operation, and writes
- * the result to the output buffer.
- *
- * \param ctx The SHA-256 context.
- * \param output The SHA-224 or SHA-256 checksum result.
- *
- * \return \c 0 on success.
- */
- int mbedtls_sha256_finish_ret( mbedtls_sha256_context *ctx,
- unsigned char output[32] );
- /**
- * \brief This function processes a single data block within
- * the ongoing SHA-256 computation. This function is for
- * internal use only.
- *
- * \param ctx The SHA-256 context.
- * \param data The buffer holding one block of data.
- *
- * \return \c 0 on success.
- */
- int mbedtls_internal_sha256_process( mbedtls_sha256_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 This function starts a SHA-256 checksum calculation.
- *
- * \deprecated Superseded by mbedtls_sha256_starts_ret() in 2.7.0.
- *
- * \param ctx The SHA-256 context to initialize.
- * \param is224 Determines which function to use.
- * <ul><li>0: Use SHA-256.</li>
- * <li>1: Use SHA-224.</li></ul>
- */
- MBEDTLS_DEPRECATED static inline void mbedtls_sha256_starts(
- mbedtls_sha256_context *ctx,
- int is224 )
- {
- mbedtls_sha256_starts_ret( ctx, is224 );
- }
- /**
- * \brief This function feeds an input buffer into an ongoing
- * SHA-256 checksum calculation.
- *
- * \deprecated Superseded by mbedtls_sha256_update_ret() in 2.7.0.
- *
- * \param ctx The SHA-256 context to initialize.
- * \param input The buffer holding the data.
- * \param ilen The length of the input data.
- */
- MBEDTLS_DEPRECATED static inline void mbedtls_sha256_update(
- mbedtls_sha256_context *ctx,
- const unsigned char *input,
- size_t ilen )
- {
- mbedtls_sha256_update_ret( ctx, input, ilen );
- }
- /**
- * \brief This function finishes the SHA-256 operation, and writes
- * the result to the output buffer.
- *
- * \deprecated Superseded by mbedtls_sha256_finish_ret() in 2.7.0.
- *
- * \param ctx The SHA-256 context.
- * \param output The SHA-224or SHA-256 checksum result.
- */
- MBEDTLS_DEPRECATED static inline void mbedtls_sha256_finish(
- mbedtls_sha256_context *ctx,
- unsigned char output[32] )
- {
- mbedtls_sha256_finish_ret( ctx, output );
- }
- /**
- * \brief This function processes a single data block within
- * the ongoing SHA-256 computation. This function is for
- * internal use only.
- *
- * \deprecated Superseded by mbedtls_internal_sha256_process() in 2.7.0.
- *
- * \param ctx The SHA-256 context.
- * \param data The buffer holding one block of data.
- */
- MBEDTLS_DEPRECATED static inline void mbedtls_sha256_process(
- mbedtls_sha256_context *ctx,
- const unsigned char data[64] )
- {
- mbedtls_internal_sha256_process( ctx, data );
- }
- #undef MBEDTLS_DEPRECATED
- #endif /* !MBEDTLS_DEPRECATED_REMOVED */
- #ifdef __cplusplus
- }
- #endif
- #else /* MBEDTLS_SHA256_ALT */
- #include "sha256_alt.h"
- #endif /* MBEDTLS_SHA256_ALT */
- #ifdef __cplusplus
- extern "C" {
- #endif
- /**
- * \brief This function calculates the SHA-224 or SHA-256
- * checksum of a buffer.
- *
- * The function allocates the context, performs the
- * calculation, and frees the context.
- *
- * The SHA-256 result is calculated as
- * output = SHA-256(input buffer).
- *
- * \param input The buffer holding the input data.
- * \param ilen The length of the input data.
- * \param output The SHA-224 or SHA-256 checksum result.
- * \param is224 Determines which function to use.
- * <ul><li>0: Use SHA-256.</li>
- * <li>1: Use SHA-224.</li></ul>
- */
- int mbedtls_sha256_ret( const unsigned char *input,
- size_t ilen,
- unsigned char output[32],
- int is224 );
- #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-224 or SHA-256 checksum
- * of a buffer.
- *
- * The function allocates the context, performs the
- * calculation, and frees the context.
- *
- * The SHA-256 result is calculated as
- * output = SHA-256(input buffer).
- *
- * \deprecated Superseded by mbedtls_sha256_ret() in 2.7.0.
- *
- * \param input The buffer holding the data.
- * \param ilen The length of the input data.
- * \param output The SHA-224 or SHA-256 checksum result.
- * \param is224 Determines which function to use.
- * <ul><li>0: Use SHA-256.</li>
- * <li>1: Use SHA-224.</li></ul>
- */
- MBEDTLS_DEPRECATED static inline void mbedtls_sha256(
- const unsigned char *input,
- size_t ilen,
- unsigned char output[32],
- int is224 )
- {
- mbedtls_sha256_ret( input, ilen, output, is224 );
- }
- #undef MBEDTLS_DEPRECATED
- #endif /* !MBEDTLS_DEPRECATED_REMOVED */
- /**
- * \brief The SHA-224 and SHA-256 checkup routine.
- *
- * \return \c 0 on success, or \c 1 on failure.
- */
- int mbedtls_sha256_self_test( int verbose );
- #ifdef __cplusplus
- }
- #endif
- #endif /* mbedtls_sha256.h */
|