mbed TLS v2.12.0

sha256.h
Go to the documentation of this file.
1
9 /*
10 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
11 * SPDX-License-Identifier: Apache-2.0
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License"); you may
14 * not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
21 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 * This file is part of Mbed TLS (https://tls.mbed.org)
26 */
27 #ifndef MBEDTLS_SHA256_H
28 #define MBEDTLS_SHA256_H
29
30 #if !defined(MBEDTLS_CONFIG_FILE)
31 #include "config.h"
32 #else
33 #include MBEDTLS_CONFIG_FILE
34 #endif
35
36 #include <stddef.h>
37 #include <stdint.h>
38
39 #define MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED -0x0037
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 #if !defined(MBEDTLS_SHA256_ALT)
46 // Regular implementation
47 //
48
56 typedef struct
57 {
58 uint32_t total[2];
59 uint32_t state[8];
60 unsigned char buffer[64];
61 int is224;
63 }
64 mbedtls_sha256_context;
65
66 #else /* MBEDTLS_SHA256_ALT */
67 #include "sha256_alt.h"
68 #endif /* MBEDTLS_SHA256_ALT */
69
75 void mbedtls_sha256_init( mbedtls_sha256_context *ctx );
76
82 void mbedtls_sha256_free( mbedtls_sha256_context *ctx );
83
90 void mbedtls_sha256_clone( mbedtls_sha256_context *dst,
91 const mbedtls_sha256_context *src );
92
103 int mbedtls_sha256_starts_ret( mbedtls_sha256_context *ctx, int is224 );
104
115 int mbedtls_sha256_update_ret( mbedtls_sha256_context *ctx,
116 const unsigned char *input,
117 size_t ilen );
118
128 int mbedtls_sha256_finish_ret( mbedtls_sha256_context *ctx,
129 unsigned char output[32] );
130
141 int mbedtls_internal_sha256_process( mbedtls_sha256_context *ctx,
142 const unsigned char data[64] );
143
144 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
145 #if defined(MBEDTLS_DEPRECATED_WARNING)
146 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
147 #else
148 #define MBEDTLS_DEPRECATED
149 #endif
150
161 MBEDTLS_DEPRECATED void mbedtls_sha256_starts( mbedtls_sha256_context *ctx,
162 int is224 );
163
174 MBEDTLS_DEPRECATED void mbedtls_sha256_update( mbedtls_sha256_context *ctx,
175 const unsigned char *input,
176 size_t ilen );
177
187 MBEDTLS_DEPRECATED void mbedtls_sha256_finish( mbedtls_sha256_context *ctx,
188 unsigned char output[32] );
189
200 MBEDTLS_DEPRECATED void mbedtls_sha256_process( mbedtls_sha256_context *ctx,
201 const unsigned char data[64] );
202
203 #undef MBEDTLS_DEPRECATED
204 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
205
222 int mbedtls_sha256_ret( const unsigned char *input,
223 size_t ilen,
224 unsigned char output[32],
225 int is224 );
226
227 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
228 #if defined(MBEDTLS_DEPRECATED_WARNING)
229 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
230 #else
231 #define MBEDTLS_DEPRECATED
232 #endif
233
252 MBEDTLS_DEPRECATED void mbedtls_sha256( const unsigned char *input,
253 size_t ilen,
254 unsigned char output[32],
255 int is224 );
256
257 #undef MBEDTLS_DEPRECATED
258 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
259
266 int mbedtls_sha256_self_test( int verbose );
267
268 #ifdef __cplusplus
269 }
270 #endif
271
272 #endif /* mbedtls_sha256.h */
mbedtls_internal_sha256_process
int mbedtls_internal_sha256_process(mbedtls_sha256_context *ctx, const unsigned char data[64])
This function processes a single data block within the ongoing SHA-256 computation. This function is for internal use only.
mbedtls_sha256_finish
MBEDTLS_DEPRECATED void mbedtls_sha256_finish(mbedtls_sha256_context *ctx, unsigned char output[32])
This function finishes the SHA-256 operation, and writes the result to the output buffer...
mbedtls_sha256_init
void mbedtls_sha256_init(mbedtls_sha256_context *ctx)
This function initializes a SHA-256 context.
mbedtls_sha256_update_ret
int mbedtls_sha256_update_ret(mbedtls_sha256_context *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing SHA-256 checksum calculation. ...
mbedtls_sha256_free
void mbedtls_sha256_free(mbedtls_sha256_context *ctx)
This function clears a SHA-256 context.
mbedtls_sha256_starts_ret
int mbedtls_sha256_starts_ret(mbedtls_sha256_context *ctx, int is224)
This function starts a SHA-224 or SHA-256 checksum calculation.
config.h
Configuration options (set of defines)
mbedtls_sha256_finish_ret
int mbedtls_sha256_finish_ret(mbedtls_sha256_context *ctx, unsigned char output[32])
This function finishes the SHA-256 operation, and writes the result to the output buffer...
MBEDTLS_DEPRECATED
#define MBEDTLS_DEPRECATED
Definition: sha256.h:231
mbedtls_sha256_update
MBEDTLS_DEPRECATED void mbedtls_sha256_update(mbedtls_sha256_context *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing SHA-256 checksum calculation. ...
mbedtls_sha256_context::is224
int is224
Definition: sha256.h:61
mbedtls_sha256_context
The SHA-256 context structure.
Definition: sha256.h:56
mbedtls_sha256
MBEDTLS_DEPRECATED void mbedtls_sha256(const unsigned char *input, size_t ilen, unsigned char output[32], int is224)
This function calculates the SHA-224 or SHA-256 checksum of a buffer.
mbedtls_sha256_ret
int mbedtls_sha256_ret(const unsigned char *input, size_t ilen, unsigned char output[32], int is224)
This function calculates the SHA-224 or SHA-256 checksum of a buffer.
mbedtls_sha256_process
MBEDTLS_DEPRECATED void mbedtls_sha256_process(mbedtls_sha256_context *ctx, const unsigned char data[64])
This function processes a single data block within the ongoing SHA-256 computation. This function is for internal use only.
mbedtls_sha256_clone
void mbedtls_sha256_clone(mbedtls_sha256_context *dst, const mbedtls_sha256_context *src)
This function clones the state of a SHA-256 context.
mbedtls_sha256_starts
MBEDTLS_DEPRECATED void mbedtls_sha256_starts(mbedtls_sha256_context *ctx, int is224)
This function starts a SHA-224 or SHA-256 checksum calculation.
mbedtls_sha256_self_test
int mbedtls_sha256_self_test(int verbose)
The SHA-224 and SHA-256 checkup routine.