mbed TLS v2.7.17
sha256.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright The Mbed TLS Contributors
8  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
9  *
10  * This file is provided under the Apache License 2.0, or the
11  * GNU General Public License v2.0 or later.
12  *
13  * **********
14  * Apache License 2.0:
15  *
16  * Licensed under the Apache License, Version 2.0 (the "License"); you may
17  * not use this file except in compliance with the License.
18  * You may obtain a copy of the License at
19  *
20  * http://www.apache.org/licenses/LICENSE-2.0
21  *
22  * Unless required by applicable law or agreed to in writing, software
23  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
24  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
25  * See the License for the specific language governing permissions and
26  * limitations under the License.
27  *
28  * **********
29  *
30  * **********
31  * GNU General Public License v2.0 or later:
32  *
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License along
44  * with this program; if not, write to the Free Software Foundation, Inc.,
45  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
46  *
47  * **********
48  */
49 #ifndef MBEDTLS_SHA256_H
50 #define MBEDTLS_SHA256_H
51 
52 #if !defined(MBEDTLS_CONFIG_FILE)
53 #include "config.h"
54 #else
55 #include MBEDTLS_CONFIG_FILE
56 #endif
57 
58 #include <stddef.h>
59 #include <stdint.h>
60 
61 #define MBEDTLS_ERR_SHA256_HW_ACCEL_FAILED -0x0037
63 #if !defined(MBEDTLS_SHA256_ALT)
64 // Regular implementation
65 //
66 
67 #ifdef __cplusplus
68 extern "C" {
69 #endif
70 
78 typedef struct
79 {
80  uint32_t total[2];
81  uint32_t state[8];
82  unsigned char buffer[64];
83  int is224;
86 }
88 
95 
102 
110  const mbedtls_sha256_context *src );
111 
124 
136  const unsigned char *input,
137  size_t ilen );
138 
149  unsigned char output[32] );
150 
162  const unsigned char data[64] );
163 
164 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
165 #if defined(MBEDTLS_DEPRECATED_WARNING)
166 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
167 #else
168 #define MBEDTLS_DEPRECATED
169 #endif
170 
181  int is224 );
182 
194  const unsigned char *input,
195  size_t ilen );
196 
207  unsigned char output[32] );
208 
220  const unsigned char data[64] );
221 
222 #undef MBEDTLS_DEPRECATED
223 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
224 #ifdef __cplusplus
225 }
226 #endif
227 
228 #else /* MBEDTLS_SHA256_ALT */
229 #include "sha256_alt.h"
230 #endif /* MBEDTLS_SHA256_ALT */
231 
232 #ifdef __cplusplus
233 extern "C" {
234 #endif
235 
253 int mbedtls_sha256_ret( const unsigned char *input,
254  size_t ilen,
255  unsigned char output[32],
256  int is224 );
257 
258 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
259 #if defined(MBEDTLS_DEPRECATED_WARNING)
260 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
261 #else
262 #define MBEDTLS_DEPRECATED
263 #endif
264 
284 MBEDTLS_DEPRECATED void mbedtls_sha256( const unsigned char *input,
285  size_t ilen,
286  unsigned char output[32],
287  int is224 );
288 
289 #undef MBEDTLS_DEPRECATED
290 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
291 
297 int mbedtls_sha256_self_test( int verbose );
298 
299 #ifdef __cplusplus
300 }
301 #endif
302 
303 #endif /* mbedtls_sha256.h */
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_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...
void mbedtls_sha256_init(mbedtls_sha256_context *ctx)
This function initializes a SHA-256 context.
#define MBEDTLS_DEPRECATED
Definition: aes.h:387
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. ...
void mbedtls_sha256_free(mbedtls_sha256_context *ctx)
This function clears a SHA-256 context.
int mbedtls_sha256_starts_ret(mbedtls_sha256_context *ctx, int is224)
This function starts a SHA-224 or SHA-256 checksum calculation.
Configuration options (set of defines)
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 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. ...
The SHA-256 context structure.
Definition: sha256.h:78
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.
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_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.
void mbedtls_sha256_clone(mbedtls_sha256_context *dst, const mbedtls_sha256_context *src)
This function clones the state of a SHA-256 context.
MBEDTLS_DEPRECATED void mbedtls_sha256_starts(mbedtls_sha256_context *ctx, int is224)
This function starts a SHA-256 checksum calculation.
int mbedtls_sha256_self_test(int verbose)
The SHA-224 and SHA-256 checkup routine.