mbed TLS v2.12.0

sha1.h
Go to the documentation of this file.
1
13 /*
14 * Copyright (C) 2006-2018, Arm Limited (or its affiliates), All Rights Reserved
15 * SPDX-License-Identifier: Apache-2.0
16 *
17 * Licensed under the Apache License, Version 2.0 (the "License"); you may
18 * not use this file except in compliance with the License.
19 * You may obtain a copy of the License at
20 *
21 * http://www.apache.org/licenses/LICENSE-2.0
22 *
23 * Unless required by applicable law or agreed to in writing, software
24 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
25 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
26 * See the License for the specific language governing permissions and
27 * limitations under the License.
28 *
29 * This file is part of Mbed TLS (https://tls.mbed.org)
30 */
31 #ifndef MBEDTLS_SHA1_H
32 #define MBEDTLS_SHA1_H
33
34 #if !defined(MBEDTLS_CONFIG_FILE)
35 #include "config.h"
36 #else
37 #include MBEDTLS_CONFIG_FILE
38 #endif
39
40 #include <stddef.h>
41 #include <stdint.h>
42
43 #define MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED -0x0035
45 #ifdef __cplusplus
46 extern "C" {
47 #endif
48
49 #if !defined(MBEDTLS_SHA1_ALT)
50 // Regular implementation
51 //
52
61 typedef struct
62 {
63 uint32_t total[2];
64 uint32_t state[5];
65 unsigned char buffer[64];
66 }
67 mbedtls_sha1_context;
68
69 #else /* MBEDTLS_SHA1_ALT */
70 #include "sha1_alt.h"
71 #endif /* MBEDTLS_SHA1_ALT */
72
83 void mbedtls_sha1_init( mbedtls_sha1_context *ctx );
84
95 void mbedtls_sha1_free( mbedtls_sha1_context *ctx );
96
108 void mbedtls_sha1_clone( mbedtls_sha1_context *dst,
109 const mbedtls_sha1_context *src );
110
123 int mbedtls_sha1_starts_ret( mbedtls_sha1_context *ctx );
124
139 int mbedtls_sha1_update_ret( mbedtls_sha1_context *ctx,
140 const unsigned char *input,
141 size_t ilen );
142
156 int mbedtls_sha1_finish_ret( mbedtls_sha1_context *ctx,
157 unsigned char output[20] );
158
172 int mbedtls_internal_sha1_process( mbedtls_sha1_context *ctx,
173 const unsigned char data[64] );
174
175 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
176 #if defined(MBEDTLS_DEPRECATED_WARNING)
177 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
178 #else
179 #define MBEDTLS_DEPRECATED
180 #endif
181
193 MBEDTLS_DEPRECATED void mbedtls_sha1_starts( mbedtls_sha1_context *ctx );
194
210 MBEDTLS_DEPRECATED void mbedtls_sha1_update( mbedtls_sha1_context *ctx,
211 const unsigned char *input,
212 size_t ilen );
213
228 MBEDTLS_DEPRECATED void mbedtls_sha1_finish( mbedtls_sha1_context *ctx,
229 unsigned char output[20] );
230
244 MBEDTLS_DEPRECATED void mbedtls_sha1_process( mbedtls_sha1_context *ctx,
245 const unsigned char data[64] );
246
247 #undef MBEDTLS_DEPRECATED
248 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
249
270 int mbedtls_sha1_ret( const unsigned char *input,
271 size_t ilen,
272 unsigned char output[20] );
273
274 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
275 #if defined(MBEDTLS_DEPRECATED_WARNING)
276 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
277 #else
278 #define MBEDTLS_DEPRECATED
279 #endif
280
300 MBEDTLS_DEPRECATED void mbedtls_sha1( const unsigned char *input,
301 size_t ilen,
302 unsigned char output[20] );
303
304 #undef MBEDTLS_DEPRECATED
305 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
306
318 int mbedtls_sha1_self_test( int verbose );
319
320 #ifdef __cplusplus
321 }
322 #endif
323
324 #endif /* mbedtls_sha1.h */
mbedtls_sha1_clone
void mbedtls_sha1_clone(mbedtls_sha1_context *dst, const mbedtls_sha1_context *src)
This function clones the state of a SHA-1 context.
mbedtls_sha1_self_test
int mbedtls_sha1_self_test(int verbose)
The SHA-1 checkup routine.
mbedtls_sha1_process
MBEDTLS_DEPRECATED void mbedtls_sha1_process(mbedtls_sha1_context *ctx, const unsigned char data[64])
SHA-1 process data block (internal use only).
mbedtls_sha1_finish_ret
int mbedtls_sha1_finish_ret(mbedtls_sha1_context *ctx, unsigned char output[20])
This function finishes the SHA-1 operation, and writes the result to the output buffer.
MBEDTLS_DEPRECATED
#define MBEDTLS_DEPRECATED
Definition: sha1.h:278
mbedtls_sha1_init
void mbedtls_sha1_init(mbedtls_sha1_context *ctx)
This function initializes a SHA-1 context.
config.h
Configuration options (set of defines)
mbedtls_sha1_starts
MBEDTLS_DEPRECATED void mbedtls_sha1_starts(mbedtls_sha1_context *ctx)
This function starts a SHA-1 checksum calculation.
mbedtls_internal_sha1_process
int mbedtls_internal_sha1_process(mbedtls_sha1_context *ctx, const unsigned char data[64])
SHA-1 process data block (internal use only).
mbedtls_sha1_finish
MBEDTLS_DEPRECATED void mbedtls_sha1_finish(mbedtls_sha1_context *ctx, unsigned char output[20])
This function finishes the SHA-1 operation, and writes the result to the output buffer.
mbedtls_sha1
MBEDTLS_DEPRECATED void mbedtls_sha1(const unsigned char *input, size_t ilen, unsigned char output[20])
This function calculates the SHA-1 checksum of a buffer.
mbedtls_sha1_free
void mbedtls_sha1_free(mbedtls_sha1_context *ctx)
This function clears a SHA-1 context.
mbedtls_sha1_context
The SHA-1 context structure.
Definition: sha1.h:61
mbedtls_sha1_update
MBEDTLS_DEPRECATED void mbedtls_sha1_update(mbedtls_sha1_context *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing SHA-1 checksum calculation.
mbedtls_sha1_update_ret
int mbedtls_sha1_update_ret(mbedtls_sha1_context *ctx, const unsigned char *input, size_t ilen)
This function feeds an input buffer into an ongoing SHA-1 checksum calculation.
mbedtls_sha1_ret
int mbedtls_sha1_ret(const unsigned char *input, size_t ilen, unsigned char output[20])
This function calculates the SHA-1 checksum of a buffer.
mbedtls_sha1_starts_ret
int mbedtls_sha1_starts_ret(mbedtls_sha1_context *ctx)
This function starts a SHA-1 checksum calculation.