1 /** 2 * \file sha512.h 3 * \brief This file contains SHA-384 and SHA-512 definitions and functions. 4 * 5 * The Secure Hash Algorithms 384 and 512 (SHA-384 and SHA-512) cryptographic 6 * hash functions are defined in <em>FIPS 180-4: Secure Hash Standard (SHS)</em>. 7 */ 8 /* 9 * Copyright The Mbed TLS Contributors 10 * SPDX-License-Identifier: Apache-2.0 11 * 12 * Licensed under the Apache License, Version 2.0 (the "License"); you may 13 * not use this file except in compliance with the License. 14 * You may obtain a copy of the License at 15 * 16 * http://www.apache.org/licenses/LICENSE-2.0 17 * 18 * Unless required by applicable law or agreed to in writing, software 19 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 20 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 21 * See the License for the specific language governing permissions and 22 * limitations under the License. 23 */ 24 #ifndef MBEDTLS_SHA512_H 25 #define MBEDTLS_SHA512_H 26 #include "mbedtls/private_access.h" 27 28 #include "mbedtls/build_info.h" 29 30 #include <stddef.h> 31 #include <stdint.h> 32 33 /** SHA-512 input data was malformed. */ 34 #define MBEDTLS_ERR_SHA512_BAD_INPUT_DATA -0x0075 35 36 #ifdef __cplusplus 37 extern "C" { 38 #endif 39 40 #if !defined(MBEDTLS_SHA512_ALT) 41 // Regular implementation 42 // 43 44 /** 45 * \brief The SHA-512 context structure. 46 * 47 * The structure is used both for SHA-384 and for SHA-512 48 * checksum calculations. The choice between these two is 49 * made in the call to mbedtls_sha512_starts(). 50 */ 51 typedef struct mbedtls_sha512_context { 52 uint64_t MBEDTLS_PRIVATE(total)[2]; /*!< The number of Bytes processed. */ 53 uint64_t MBEDTLS_PRIVATE(state)[8]; /*!< The intermediate digest state. */ 54 unsigned char MBEDTLS_PRIVATE(buffer)[128]; /*!< The data block being processed. */ 55 #if defined(MBEDTLS_SHA384_C) 56 int MBEDTLS_PRIVATE(is384); /*!< Determines which function to use: 57 0: Use SHA-512, or 1: Use SHA-384. */ 58 #endif 59 } 60 mbedtls_sha512_context; 61 62 #else /* MBEDTLS_SHA512_ALT */ 63 #include "sha512_alt.h" 64 #endif /* MBEDTLS_SHA512_ALT */ 65 66 /** 67 * \brief This function initializes a SHA-512 context. 68 * 69 * \param ctx The SHA-512 context to initialize. This must 70 * not be \c NULL. 71 */ 72 void mbedtls_sha512_init(mbedtls_sha512_context *ctx); 73 74 /** 75 * \brief This function clears a SHA-512 context. 76 * 77 * \param ctx The SHA-512 context to clear. This may be \c NULL, 78 * in which case this function does nothing. If it 79 * is not \c NULL, it must point to an initialized 80 * SHA-512 context. 81 */ 82 void mbedtls_sha512_free(mbedtls_sha512_context *ctx); 83 84 /** 85 * \brief This function clones the state of a SHA-512 context. 86 * 87 * \param dst The destination context. This must be initialized. 88 * \param src The context to clone. This must be initialized. 89 */ 90 void mbedtls_sha512_clone(mbedtls_sha512_context *dst, 91 const mbedtls_sha512_context *src); 92 93 /** 94 * \brief This function starts a SHA-384 or SHA-512 checksum 95 * calculation. 96 * 97 * \param ctx The SHA-512 context to use. This must be initialized. 98 * \param is384 Determines which function to use. This must be 99 * either \c 0 for SHA-512, or \c 1 for SHA-384. 100 * 101 * \note is384 must be defined accordingly to the enabled 102 * MBEDTLS_SHA384_C/MBEDTLS_SHA512_C symbols otherwise the 103 * function will return #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA. 104 * 105 * \return \c 0 on success. 106 * \return A negative error code on failure. 107 */ 108 int mbedtls_sha512_starts(mbedtls_sha512_context *ctx, int is384); 109 110 /** 111 * \brief This function feeds an input buffer into an ongoing 112 * SHA-512 checksum calculation. 113 * 114 * \param ctx The SHA-512 context. This must be initialized 115 * and have a hash operation started. 116 * \param input The buffer holding the input data. This must 117 * be a readable buffer of length \p ilen Bytes. 118 * \param ilen The length of the input data in Bytes. 119 * 120 * \return \c 0 on success. 121 * \return A negative error code on failure. 122 */ 123 int mbedtls_sha512_update(mbedtls_sha512_context *ctx, 124 const unsigned char *input, 125 size_t ilen); 126 127 /** 128 * \brief This function finishes the SHA-512 operation, and writes 129 * the result to the output buffer. 130 * 131 * \param ctx The SHA-512 context. This must be initialized 132 * and have a hash operation started. 133 * \param output The SHA-384 or SHA-512 checksum result. 134 * This must be a writable buffer of length \c 64 bytes 135 * for SHA-512, \c 48 bytes for SHA-384. 136 * 137 * \return \c 0 on success. 138 * \return A negative error code on failure. 139 */ 140 int mbedtls_sha512_finish(mbedtls_sha512_context *ctx, 141 unsigned char *output); 142 143 /** 144 * \brief This function processes a single data block within 145 * the ongoing SHA-512 computation. 146 * This function is for internal use only. 147 * 148 * \param ctx The SHA-512 context. This must be initialized. 149 * \param data The buffer holding one block of data. This 150 * must be a readable buffer of length \c 128 Bytes. 151 * 152 * \return \c 0 on success. 153 * \return A negative error code on failure. 154 */ 155 int mbedtls_internal_sha512_process(mbedtls_sha512_context *ctx, 156 const unsigned char data[128]); 157 158 /** 159 * \brief This function calculates the SHA-512 or SHA-384 160 * checksum of a buffer. 161 * 162 * The function allocates the context, performs the 163 * calculation, and frees the context. 164 * 165 * The SHA-512 result is calculated as 166 * output = SHA-512(input buffer). 167 * 168 * \param input The buffer holding the input data. This must be 169 * a readable buffer of length \p ilen Bytes. 170 * \param ilen The length of the input data in Bytes. 171 * \param output The SHA-384 or SHA-512 checksum result. 172 * This must be a writable buffer of length \c 64 bytes 173 * for SHA-512, \c 48 bytes for SHA-384. 174 * \param is384 Determines which function to use. This must be either 175 * \c 0 for SHA-512, or \c 1 for SHA-384. 176 * 177 * \note is384 must be defined accordingly with the supported 178 * symbols in the config file. If: 179 * - is384 is 0, but \c MBEDTLS_SHA384_C is not defined, or 180 * - is384 is 1, but \c MBEDTLS_SHA512_C is not defined 181 * then the function will return 182 * #MBEDTLS_ERR_SHA512_BAD_INPUT_DATA. 183 * 184 * \return \c 0 on success. 185 * \return A negative error code on failure. 186 */ 187 int mbedtls_sha512(const unsigned char *input, 188 size_t ilen, 189 unsigned char *output, 190 int is384); 191 192 #if defined(MBEDTLS_SELF_TEST) 193 194 #if defined(MBEDTLS_SHA384_C) 195 /** 196 * \brief The SHA-384 checkup routine. 197 * 198 * \return \c 0 on success. 199 * \return \c 1 on failure. 200 */ 201 int mbedtls_sha384_self_test(int verbose); 202 #endif /* MBEDTLS_SHA384_C */ 203 204 #if defined(MBEDTLS_SHA512_C) 205 /** 206 * \brief The SHA-512 checkup routine. 207 * 208 * \return \c 0 on success. 209 * \return \c 1 on failure. 210 */ 211 int mbedtls_sha512_self_test(int verbose); 212 #endif /* MBEDTLS_SHA512_C */ 213 214 #endif /* MBEDTLS_SELF_TEST */ 215 216 #ifdef __cplusplus 217 } 218 #endif 219 220 #endif /* mbedtls_sha512.h */ 221
