mbed TLS v2.16.12
sha512.h
Go to the documentation of this file.
1 
8 /*
9  * Copyright The Mbed TLS Contributors
10  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
11  *
12  * This file is provided under the Apache License 2.0, or the
13  * GNU General Public License v2.0 or later.
14  *
15  * **********
16  * Apache License 2.0:
17  *
18  * Licensed under the Apache License, Version 2.0 (the "License"); you may
19  * not use this file except in compliance with the License.
20  * You may obtain a copy of the License at
21  *
22  * http://www.apache.org/licenses/LICENSE-2.0
23  *
24  * Unless required by applicable law or agreed to in writing, software
25  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
26  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
27  * See the License for the specific language governing permissions and
28  * limitations under the License.
29  *
30  * **********
31  *
32  * **********
33  * GNU General Public License v2.0 or later:
34  *
35  * This program is free software; you can redistribute it and/or modify
36  * it under the terms of the GNU General Public License as published by
37  * the Free Software Foundation; either version 2 of the License, or
38  * (at your option) any later version.
39  *
40  * This program is distributed in the hope that it will be useful,
41  * but WITHOUT ANY WARRANTY; without even the implied warranty of
42  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43  * GNU General Public License for more details.
44  *
45  * You should have received a copy of the GNU General Public License along
46  * with this program; if not, write to the Free Software Foundation, Inc.,
47  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
48  *
49  * **********
50  */
51 #ifndef MBEDTLS_SHA512_H
52 #define MBEDTLS_SHA512_H
53 
54 #if !defined(MBEDTLS_CONFIG_FILE)
55 #include "config.h"
56 #else
57 #include MBEDTLS_CONFIG_FILE
58 #endif
59 
60 #include <stddef.h>
61 #include <stdint.h>
62 
63 /* MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED is deprecated and should not be used. */
65 #define MBEDTLS_ERR_SHA512_HW_ACCEL_FAILED -0x0039
66 
67 #define MBEDTLS_ERR_SHA512_BAD_INPUT_DATA -0x0075
68 
69 #ifdef __cplusplus
70 extern "C" {
71 #endif
72 
73 #if !defined(MBEDTLS_SHA512_ALT)
74 // Regular implementation
75 //
76 
84 typedef struct mbedtls_sha512_context
85 {
86  uint64_t total[2];
87  uint64_t state[8];
88  unsigned char buffer[128];
89  int is384;
91 }
93 
94 #else /* MBEDTLS_SHA512_ALT */
95 #include "sha512_alt.h"
96 #endif /* MBEDTLS_SHA512_ALT */
97 
105 
115 
123  const mbedtls_sha512_context *src );
124 
137 
152  const unsigned char *input,
153  size_t ilen );
154 
168  unsigned char output[64] );
169 
183  const unsigned char data[128] );
184 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
185 #if defined(MBEDTLS_DEPRECATED_WARNING)
186 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
187 #else
188 #define MBEDTLS_DEPRECATED
189 #endif
190 
201  int is384 );
202 
216  const unsigned char *input,
217  size_t ilen );
218 
231  unsigned char output[64] );
232 
246  const unsigned char data[128] );
247 
248 #undef MBEDTLS_DEPRECATED
249 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
250 
272 int mbedtls_sha512_ret( const unsigned char *input,
273  size_t ilen,
274  unsigned char output[64],
275  int is384 );
276 
277 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
278 #if defined(MBEDTLS_DEPRECATED_WARNING)
279 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
280 #else
281 #define MBEDTLS_DEPRECATED
282 #endif
283 
304 MBEDTLS_DEPRECATED void mbedtls_sha512( const unsigned char *input,
305  size_t ilen,
306  unsigned char output[64],
307  int is384 );
308 
309 #undef MBEDTLS_DEPRECATED
310 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
311 
312 #if defined(MBEDTLS_SELF_TEST)
313 
320 int mbedtls_sha512_self_test( int verbose );
321 #endif /* MBEDTLS_SELF_TEST */
322 
323 #ifdef __cplusplus
324 }
325 #endif
326 
327 #endif /* mbedtls_sha512.h */
#define MBEDTLS_DEPRECATED
Definition: sha512.h:281
void mbedtls_sha512_clone(mbedtls_sha512_context *dst, const mbedtls_sha512_context *src)
This function clones the state of a SHA-512 context.
void mbedtls_sha512_init(mbedtls_sha512_context *ctx)
This function initializes a SHA-512 context.
uint64_t total[2]
Definition: sha512.h:86
int mbedtls_sha512_finish_ret(mbedtls_sha512_context *ctx, unsigned char output[64])
This function finishes the SHA-512 operation, and writes the result to the output buffer...
MBEDTLS_DEPRECATED void mbedtls_sha512_update(mbedtls_sha512_context *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing SHA-512 checksum calculation. ...
struct mbedtls_sha512_context mbedtls_sha512_context
The SHA-512 context structure.
MBEDTLS_DEPRECATED void mbedtls_sha512(const unsigned char *input, size_t ilen, unsigned char output[64], int is384)
This function calculates the SHA-512 or SHA-384 checksum of a buffer.
Configuration options (set of defines)
The SHA-512 context structure.
Definition: sha512.h:84
int mbedtls_sha512_starts_ret(mbedtls_sha512_context *ctx, int is384)
This function starts a SHA-384 or SHA-512 checksum calculation.
unsigned char buffer[128]
Definition: sha512.h:88
int mbedtls_sha512_self_test(int verbose)
The SHA-384 or SHA-512 checkup routine.
MBEDTLS_DEPRECATED void mbedtls_sha512_finish(mbedtls_sha512_context *ctx, unsigned char output[64])
This function finishes the SHA-512 operation, and writes the result to the output buffer...
int mbedtls_internal_sha512_process(mbedtls_sha512_context *ctx, const unsigned char data[128])
This function processes a single data block within the ongoing SHA-512 computation. This function is for internal use only.
void mbedtls_sha512_free(mbedtls_sha512_context *ctx)
This function clears a SHA-512 context.
uint64_t state[8]
Definition: sha512.h:87
int mbedtls_sha512_ret(const unsigned char *input, size_t ilen, unsigned char output[64], int is384)
This function calculates the SHA-512 or SHA-384 checksum of a buffer.
MBEDTLS_DEPRECATED void mbedtls_sha512_starts(mbedtls_sha512_context *ctx, int is384)
This function starts a SHA-384 or SHA-512 checksum calculation.
int mbedtls_sha512_update_ret(mbedtls_sha512_context *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing SHA-512 checksum calculation. ...
MBEDTLS_DEPRECATED void mbedtls_sha512_process(mbedtls_sha512_context *ctx, const unsigned char data[128])
This function processes a single data block within the ongoing SHA-512 computation. This function is for internal use only.