blob: ee88fcf31fb011d505f7199a29cb6f95b85296fe [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
Simon Butcher5b331b92016-01-03 16:14:14 +00002 * \file sha512.h
Rose Zadik1a6275a2018-03-27 13:03:42 +01003 * \brief This file contains SHA-384 and SHA-512 definitions and functions.
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00004 *
Rose Zadik1a6275a2018-03-27 13:03:42 +01005 * 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>.
Darryl Greena40a1012018-01-05 15:33:17 +00007 */
8/*
Rose Zadik27ff1202018-01-26 11:01:31 +00009 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020010 * 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.
Paul Bakkerb96f1542010-07-18 20:36:00 +000023 *
Rose Zadik27ff1202018-01-26 11:01:31 +000024 * This file is part of Mbed TLS (https://tls.mbed.org)
Paul Bakker5121ce52009-01-03 21:22:43 +000025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#ifndef MBEDTLS_SHA512_H
27#define MBEDTLS_SHA512_H
Paul Bakker5121ce52009-01-03 21:22:43 +000028
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020029#if !defined(MBEDTLS_CONFIG_FILE)
Paul Bakker90995b52013-06-24 19:20:35 +020030#include "config.h"
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020031#else
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#include MBEDTLS_CONFIG_FILE
Manuel Pégourié-Gonnardcef4ad22014-04-29 12:39:06 +020033#endif
Paul Bakker90995b52013-06-24 19:20:35 +020034
Rich Evans00ab4702015-02-06 13:43:58 +000035#include <stddef.h>
Manuel Pégourié-Gonnardab229102015-04-15 11:53:16 +020036#include <stdint.h>
Paul Bakker5121ce52009-01-03 21:22:43 +000037
Gilles Peskinea381fe82018-01-23 18:16:11 +010038#define MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED -0x0039 /**< SHA-512 hardware accelerator failed */
39
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020040#if !defined(MBEDTLS_SHA512_ALT)
Paul Bakker90995b52013-06-24 19:20:35 +020041// Regular implementation
42//
43
Paul Bakker407a0da2013-06-27 14:29:21 +020044#ifdef __cplusplus
45extern "C" {
46#endif
47
Paul Bakker5121ce52009-01-03 21:22:43 +000048/**
Rose Zadik27ff1202018-01-26 11:01:31 +000049 * \brief The SHA-512 context structure.
50 *
51 * The structure is used both for SHA-384 and for SHA-512
52 * checksum calculations. The choice between these two is
53 * made in the call to mbedtls_sha512_starts_ret().
Paul Bakker5121ce52009-01-03 21:22:43 +000054 */
55typedef struct
56{
Rose Zadik27ff1202018-01-26 11:01:31 +000057 uint64_t total[2]; /*!< The number of Bytes processed. */
58 uint64_t state[8]; /*!< The intermediate digest state. */
59 unsigned char buffer[128]; /*!< The data block being processed. */
Rose Zadik1a6275a2018-03-27 13:03:42 +010060 int is384; /*!< Determines which function to use:
61 0: Use SHA-512, or 1: Use SHA-384. */
Paul Bakker5121ce52009-01-03 21:22:43 +000062}
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020063mbedtls_sha512_context;
Paul Bakker5121ce52009-01-03 21:22:43 +000064
Paul Bakker5121ce52009-01-03 21:22:43 +000065/**
Rose Zadik27ff1202018-01-26 11:01:31 +000066 * \brief This function initializes a SHA-512 context.
Paul Bakker5b4af392014-06-26 12:09:34 +020067 *
Rose Zadik27ff1202018-01-26 11:01:31 +000068 * \param ctx The SHA-512 context to initialize.
Paul Bakker5b4af392014-06-26 12:09:34 +020069 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020070void mbedtls_sha512_init( mbedtls_sha512_context *ctx );
Paul Bakker5b4af392014-06-26 12:09:34 +020071
72/**
Rose Zadik27ff1202018-01-26 11:01:31 +000073 * \brief This function clears a SHA-512 context.
Paul Bakker5b4af392014-06-26 12:09:34 +020074 *
Rose Zadik27ff1202018-01-26 11:01:31 +000075 * \param ctx The SHA-512 context to clear.
Paul Bakker5b4af392014-06-26 12:09:34 +020076 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020077void mbedtls_sha512_free( mbedtls_sha512_context *ctx );
Paul Bakker5b4af392014-06-26 12:09:34 +020078
79/**
Rose Zadik27ff1202018-01-26 11:01:31 +000080 * \brief This function clones the state of a SHA-512 context.
Manuel Pégourié-Gonnard16d412f2015-07-06 15:26:26 +020081 *
Rose Zadik27ff1202018-01-26 11:01:31 +000082 * \param dst The destination context.
83 * \param src The context to clone.
Manuel Pégourié-Gonnard16d412f2015-07-06 15:26:26 +020084 */
85void mbedtls_sha512_clone( mbedtls_sha512_context *dst,
86 const mbedtls_sha512_context *src );
87
88/**
Rose Zadik27ff1202018-01-26 11:01:31 +000089 * \brief This function starts a SHA-384 or SHA-512 checksum
90 * calculation.
Paul Bakker5121ce52009-01-03 21:22:43 +000091 *
Rose Zadik27ff1202018-01-26 11:01:31 +000092 * \param ctx The SHA-512 context to initialize.
Rose Zadik1a6275a2018-03-27 13:03:42 +010093 * \param is384 Determines which function to use:
94 * 0: Use SHA-512, or 1: Use SHA-384.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +010095 *
Rose Zadik27ff1202018-01-26 11:01:31 +000096 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +000097 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +010098int mbedtls_sha512_starts_ret( mbedtls_sha512_context *ctx, int is384 );
Paul Bakker5121ce52009-01-03 21:22:43 +000099
100/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000101 * \brief This function feeds an input buffer into an ongoing
102 * SHA-512 checksum calculation.
Paul Bakker5121ce52009-01-03 21:22:43 +0000103 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000104 * \param ctx The SHA-512 context.
105 * \param input The buffer holding the input data.
106 * \param ilen The length of the input data.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100107 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000108 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000109 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100110int mbedtls_sha512_update_ret( mbedtls_sha512_context *ctx,
Rose Zadik27ff1202018-01-26 11:01:31 +0000111 const unsigned char *input,
112 size_t ilen );
Paul Bakker5121ce52009-01-03 21:22:43 +0000113
114/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000115 * \brief This function finishes the SHA-512 operation, and writes
116 * the result to the output buffer. This function is for
117 * internal use only.
Paul Bakker5121ce52009-01-03 21:22:43 +0000118 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000119 * \param ctx The SHA-512 context.
120 * \param output The SHA-384 or SHA-512 checksum result.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100121 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000122 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000123 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100124int mbedtls_sha512_finish_ret( mbedtls_sha512_context *ctx,
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100125 unsigned char output[64] );
126
127/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000128 * \brief This function processes a single data block within
129 * the ongoing SHA-512 computation.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100130 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000131 * \param ctx The SHA-512 context.
132 * \param data The buffer holding one block of data.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100133 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000134 * \return \c 0 on success.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100135 */
Andres Amaya Garciacccfe082017-06-28 10:36:39 +0100136int mbedtls_internal_sha512_process( mbedtls_sha512_context *ctx,
137 const unsigned char data[128] );
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100138#if !defined(MBEDTLS_DEPRECATED_REMOVED)
139#if defined(MBEDTLS_DEPRECATED_WARNING)
140#define MBEDTLS_DEPRECATED __attribute__((deprecated))
141#else
142#define MBEDTLS_DEPRECATED
143#endif
144/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000145 * \brief This function starts a SHA-384 or SHA-512 checksum
146 * calculation.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100147 *
Gilles Peskine3e28d702018-01-22 12:18:59 +0100148 * \deprecated Superseded by mbedtls_sha512_starts_ret() in 2.7.0
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100149 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000150 * \param ctx The SHA-512 context to initialize.
Rose Zadik1a6275a2018-03-27 13:03:42 +0100151 * \param is384 Determines which function to use:
152 * 0: Use SHA-512, or 1: Use SHA-384.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100153 */
Jaeden Amero041039f2018-02-19 15:28:08 +0000154MBEDTLS_DEPRECATED void mbedtls_sha512_starts( mbedtls_sha512_context *ctx,
155 int is384 );
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100156
157/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000158 * \brief This function feeds an input buffer into an ongoing
159 * SHA-512 checksum calculation.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100160 *
Rose Zadik1a6275a2018-03-27 13:03:42 +0100161 * \deprecated Superseded by mbedtls_sha512_update_ret() in 2.7.0.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100162 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000163 * \param ctx The SHA-512 context.
164 * \param input The buffer holding the data.
165 * \param ilen The length of the input data.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100166 */
Jaeden Amero041039f2018-02-19 15:28:08 +0000167MBEDTLS_DEPRECATED void mbedtls_sha512_update( mbedtls_sha512_context *ctx,
168 const unsigned char *input,
169 size_t ilen );
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100170
171/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000172 * \brief This function finishes the SHA-512 operation, and writes
173 * the result to the output buffer.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100174 *
Rose Zadik1a6275a2018-03-27 13:03:42 +0100175 * \deprecated Superseded by mbedtls_sha512_finish_ret() in 2.7.0.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100176 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000177 * \param ctx The SHA-512 context.
178 * \param output The SHA-384 or SHA-512 checksum result.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100179 */
Jaeden Amero041039f2018-02-19 15:28:08 +0000180MBEDTLS_DEPRECATED void mbedtls_sha512_finish( mbedtls_sha512_context *ctx,
181 unsigned char output[64] );
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100182
183/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000184 * \brief This function processes a single data block within
185 * the ongoing SHA-512 computation. This function is for
186 * internal use only.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100187 *
Rose Zadik1a6275a2018-03-27 13:03:42 +0100188 * \deprecated Superseded by mbedtls_internal_sha512_process() in 2.7.0.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100189 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000190 * \param ctx The SHA-512 context.
191 * \param data The buffer holding one block of data.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100192 */
Jaeden Amero041039f2018-02-19 15:28:08 +0000193MBEDTLS_DEPRECATED void mbedtls_sha512_process(
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100194 mbedtls_sha512_context *ctx,
Jaeden Amero041039f2018-02-19 15:28:08 +0000195 const unsigned char data[128] );
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100196
197#undef MBEDTLS_DEPRECATED
198#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Paul Bakker5121ce52009-01-03 21:22:43 +0000199
Paul Bakker90995b52013-06-24 19:20:35 +0200200#ifdef __cplusplus
201}
202#endif
203
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200204#else /* MBEDTLS_SHA512_ALT */
Paul Bakkerd2681d82013-06-30 14:49:12 +0200205#include "sha512_alt.h"
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200206#endif /* MBEDTLS_SHA512_ALT */
Paul Bakker90995b52013-06-24 19:20:35 +0200207
208#ifdef __cplusplus
209extern "C" {
210#endif
211
Paul Bakker5121ce52009-01-03 21:22:43 +0000212/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000213 * \brief This function calculates the SHA-512 or SHA-384
214 * checksum of a buffer.
Paul Bakker5121ce52009-01-03 21:22:43 +0000215 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000216 * The function allocates the context, performs the
217 * calculation, and frees the context.
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100218 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000219 * The SHA-512 result is calculated as
220 * output = SHA-512(input buffer).
221 *
222 * \param input The buffer holding the input data.
223 * \param ilen The length of the input data.
224 * \param output The SHA-384 or SHA-512 checksum result.
Rose Zadik1a6275a2018-03-27 13:03:42 +0100225 * \param is384 Determines which function to use:
226 * 0: Use SHA-512, or 1: Use SHA-384.
Rose Zadik27ff1202018-01-26 11:01:31 +0000227 *
228 * \return \c 0 on success.
Paul Bakker5121ce52009-01-03 21:22:43 +0000229 */
Gilles Peskine9e4f77c2018-01-22 11:48:08 +0100230int mbedtls_sha512_ret( const unsigned char *input,
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100231 size_t ilen,
232 unsigned char output[64],
233 int is384 );
234
235#if !defined(MBEDTLS_DEPRECATED_REMOVED)
236#if defined(MBEDTLS_DEPRECATED_WARNING)
237#define MBEDTLS_DEPRECATED __attribute__((deprecated))
238#else
239#define MBEDTLS_DEPRECATED
240#endif
241/**
Rose Zadik27ff1202018-01-26 11:01:31 +0000242 * \brief This function calculates the SHA-512 or SHA-384
243 * checksum of a buffer.
244 *
245 * The function allocates the context, performs the
246 * calculation, and frees the context.
247 *
248 * The SHA-512 result is calculated as
249 * output = SHA-512(input buffer).
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100250 *
Gilles Peskine3e28d702018-01-22 12:18:59 +0100251 * \deprecated Superseded by mbedtls_sha512_ret() in 2.7.0
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100252 *
Rose Zadik27ff1202018-01-26 11:01:31 +0000253 * \param input The buffer holding the data.
254 * \param ilen The length of the input data.
255 * \param output The SHA-384 or SHA-512 checksum result.
Rose Zadik1a6275a2018-03-27 13:03:42 +0100256 * \param is384 Determines which function to use:
257 * 0: Use SHA-512, or 1: Use SHA-384.
Paul Bakker5121ce52009-01-03 21:22:43 +0000258 */
Jaeden Amero041039f2018-02-19 15:28:08 +0000259MBEDTLS_DEPRECATED void mbedtls_sha512( const unsigned char *input,
260 size_t ilen,
261 unsigned char output[64],
262 int is384 );
Andres Amaya Garcia614c6892017-05-02 12:07:26 +0100263
264#undef MBEDTLS_DEPRECATED
265#endif /* !MBEDTLS_DEPRECATED_REMOVED */
Rose Zadik27ff1202018-01-26 11:01:31 +0000266 /**
267 * \brief The SHA-384 or SHA-512 checkup routine.
Paul Bakker5121ce52009-01-03 21:22:43 +0000268 *
Rose Zadik1a6275a2018-03-27 13:03:42 +0100269 * \return \c 0 on success.
270 * \return \c 1 on failure.
Paul Bakker5121ce52009-01-03 21:22:43 +0000271 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200272int mbedtls_sha512_self_test( int verbose );
Paul Bakker5121ce52009-01-03 21:22:43 +0000273
Paul Bakker5121ce52009-01-03 21:22:43 +0000274#ifdef __cplusplus
275}
276#endif
277
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200278#endif /* mbedtls_sha512.h */