mbed TLS v2.7.17
sha1.h
Go to the documentation of this file.
1 
10 /*
11  * Copyright The Mbed TLS Contributors
12  * SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later
13  *
14  * This file is provided under the Apache License 2.0, or the
15  * GNU General Public License v2.0 or later.
16  *
17  * **********
18  * Apache License 2.0:
19  *
20  * Licensed under the Apache License, Version 2.0 (the "License"); you may
21  * not use this file except in compliance with the License.
22  * You may obtain a copy of the License at
23  *
24  * http://www.apache.org/licenses/LICENSE-2.0
25  *
26  * Unless required by applicable law or agreed to in writing, software
27  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
28  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
29  * See the License for the specific language governing permissions and
30  * limitations under the License.
31  *
32  * **********
33  *
34  * **********
35  * GNU General Public License v2.0 or later:
36  *
37  * This program is free software; you can redistribute it and/or modify
38  * it under the terms of the GNU General Public License as published by
39  * the Free Software Foundation; either version 2 of the License, or
40  * (at your option) any later version.
41  *
42  * This program is distributed in the hope that it will be useful,
43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
45  * GNU General Public License for more details.
46  *
47  * You should have received a copy of the GNU General Public License along
48  * with this program; if not, write to the Free Software Foundation, Inc.,
49  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
50  *
51  * **********
52  */
53 #ifndef MBEDTLS_SHA1_H
54 #define MBEDTLS_SHA1_H
55 
56 #if !defined(MBEDTLS_CONFIG_FILE)
57 #include "config.h"
58 #else
59 #include MBEDTLS_CONFIG_FILE
60 #endif
61 
62 #include <stddef.h>
63 #include <stdint.h>
64 
65 #define MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED -0x0035
67 #if !defined(MBEDTLS_SHA1_ALT)
68 // Regular implementation
69 //
70 
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74 
83 typedef struct
84 {
85  uint32_t total[2];
86  uint32_t state[5];
87  unsigned char buffer[64];
88 }
90 
102 
114 
127  const mbedtls_sha1_context *src );
128 
142 
159  const unsigned char *input,
160  size_t ilen );
161 
177  unsigned char output[20] );
178 
193  const unsigned char data[64] );
194 
195 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
196 #if defined(MBEDTLS_DEPRECATED_WARNING)
197 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
198 #else
199 #define MBEDTLS_DEPRECATED
200 #endif
201 
214 
230  const unsigned char *input,
231  size_t ilen );
232 
247  unsigned char output[20] );
248 
263  const unsigned char data[64] );
264 
265 #undef MBEDTLS_DEPRECATED
266 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
267 
268 #ifdef __cplusplus
269 }
270 #endif
271 
272 #else /* MBEDTLS_SHA1_ALT */
273 #include "sha1_alt.h"
274 #endif /* MBEDTLS_SHA1_ALT */
275 
276 #ifdef __cplusplus
277 extern "C" {
278 #endif
279 
300 int mbedtls_sha1_ret( const unsigned char *input,
301  size_t ilen,
302  unsigned char output[20] );
303 
304 #if !defined(MBEDTLS_DEPRECATED_REMOVED)
305 #if defined(MBEDTLS_DEPRECATED_WARNING)
306 #define MBEDTLS_DEPRECATED __attribute__((deprecated))
307 #else
308 #define MBEDTLS_DEPRECATED
309 #endif
310 
324 MBEDTLS_DEPRECATED void mbedtls_sha1( const unsigned char *input,
325  size_t ilen,
326  unsigned char output[20] );
327 
328 #undef MBEDTLS_DEPRECATED
329 #endif /* !MBEDTLS_DEPRECATED_REMOVED */
330 
341 int mbedtls_sha1_self_test( int verbose );
342 
343 #ifdef __cplusplus
344 }
345 #endif
346 
347 #endif /* mbedtls_sha1.h */
void mbedtls_sha1_clone(mbedtls_sha1_context *dst, const mbedtls_sha1_context *src)
This function clones the state of a SHA-1 context.
int mbedtls_sha1_self_test(int verbose)
The SHA-1 checkup routine.
MBEDTLS_DEPRECATED void mbedtls_sha1_process(mbedtls_sha1_context *ctx, const unsigned char data[64])
SHA-1 process data block (internal use only)
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.
#define MBEDTLS_DEPRECATED
Definition: aes.h:387
void mbedtls_sha1_init(mbedtls_sha1_context *ctx)
This function initializes a SHA-1 context.
Configuration options (set of defines)
MBEDTLS_DEPRECATED void mbedtls_sha1_starts(mbedtls_sha1_context *ctx)
SHA-1 context setup.
int mbedtls_internal_sha1_process(mbedtls_sha1_context *ctx, const unsigned char data[64])
SHA-1 process data block (internal use only)
MBEDTLS_DEPRECATED void mbedtls_sha1_finish(mbedtls_sha1_context *ctx, unsigned char output[20])
SHA-1 final digest.
MBEDTLS_DEPRECATED void mbedtls_sha1(const unsigned char *input, size_t ilen, unsigned char output[20])
Output = SHA-1( input buffer )
void mbedtls_sha1_free(mbedtls_sha1_context *ctx)
This function clears a SHA-1 context.
The SHA-1 context structure.
Definition: sha1.h:83
MBEDTLS_DEPRECATED void mbedtls_sha1_update(mbedtls_sha1_context *ctx, const unsigned char *input, size_t ilen)
SHA-1 process buffer.
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.
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.
int mbedtls_sha1_starts_ret(mbedtls_sha1_context *ctx)
This function starts a SHA-1 checksum calculation.