sha1.h File Reference
The SHA-1 cryptographic hash function.
More...
#include "config.h"
#include <stddef.h>
#include <stdint.h>
Go to the source code of this file.
Data Structures |
struct | mbedtls_sha1_context |
| The SHA-1 context structure. More...
|
Defines |
#define | MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED -0x0035 |
#define | MBEDTLS_DEPRECATED |
#define | MBEDTLS_DEPRECATED |
Functions |
void | mbedtls_sha1_init (mbedtls_sha1_context *ctx) |
| This function initializes a SHA-1 context.
|
void | mbedtls_sha1_free (mbedtls_sha1_context *ctx) |
| This function clears a SHA-1 context.
|
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_starts_ret (mbedtls_sha1_context *ctx) |
| This function starts a SHA-1 checksum calculation.
|
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_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.
|
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_starts (mbedtls_sha1_context *ctx) |
| SHA-1 context setup.
|
MBEDTLS_DEPRECATED void | mbedtls_sha1_update (mbedtls_sha1_context *ctx, const unsigned char *input, size_t ilen) |
| SHA-1 process buffer.
|
MBEDTLS_DEPRECATED void | mbedtls_sha1_finish (mbedtls_sha1_context *ctx, unsigned char output[20]) |
| SHA-1 final digest.
|
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_ret (const unsigned char *input, size_t ilen, unsigned char output[20]) |
| This function calculates the SHA-1 checksum of a buffer.
|
MBEDTLS_DEPRECATED void | mbedtls_sha1 (const unsigned char *input, size_t ilen, unsigned char output[20]) |
| Output = SHA-1( input buffer ).
|
int | mbedtls_sha1_self_test (int verbose) |
| The SHA-1 checkup routine.
|
Detailed Description
The SHA-1 cryptographic hash function.
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
Definition in file sha1.h.
Define Documentation
#define MBEDTLS_DEPRECATED |
#define MBEDTLS_DEPRECATED |
#define MBEDTLS_ERR_SHA1_HW_ACCEL_FAILED -0x0035 |
SHA-1 hardware accelerator failed
Definition at line 67 of file sha1.h.
Function Documentation
SHA-1 process data block (internal use only).
- Parameters:
-
| ctx | SHA-1 context |
| data | The data block being processed. |
- Returns:
0
if successful
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
MBEDTLS_DEPRECATED void mbedtls_sha1 |
( |
const unsigned char * |
input, |
|
|
size_t |
ilen, |
|
|
unsigned char |
output[20] | |
|
) |
| | |
Output = SHA-1( input buffer ).
- Deprecated:
- Superseded by mbedtls_sha1_ret() in 2.7.0
- Parameters:
-
| input | The buffer holding the input data. |
| ilen | The length of the input data. |
| output | The SHA-1 checksum result. |
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
This function clones the state of a SHA-1 context.
- Parameters:
-
| dst | The destination context. |
| src | The context to clone. |
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
MBEDTLS_DEPRECATED void mbedtls_sha1_finish |
( |
mbedtls_sha1_context * |
ctx, |
|
|
unsigned char |
output[20] | |
|
) |
| | |
SHA-1 final digest.
- Deprecated:
- Superseded by mbedtls_sha1_finish_ret() in 2.7.0
- Parameters:
-
| ctx | The SHA-1 context. |
| output | The SHA-1 checksum result. |
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
This function finishes the SHA-1 operation, and writes the result to the output buffer.
- Parameters:
-
| ctx | The SHA-1 context. |
| output | The SHA-1 checksum result. |
- Returns:
0
if successful
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
This function clears a SHA-1 context.
- Parameters:
-
| ctx | The SHA-1 context to clear. |
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
This function initializes a SHA-1 context.
- Parameters:
-
| ctx | The SHA-1 context to initialize. |
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
MBEDTLS_DEPRECATED void mbedtls_sha1_process |
( |
mbedtls_sha1_context * |
ctx, |
|
|
const unsigned char |
data[64] | |
|
) |
| | |
SHA-1 process data block (internal use only).
- Deprecated:
- Superseded by mbedtls_internal_sha1_process() in 2.7.0
- Parameters:
-
| ctx | The SHA-1 context. |
| data | The data block being processed. |
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
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.
The function allocates the context, performs the calculation, and frees the context.
The SHA-1 result is calculated as output = SHA-1(input buffer).
- Parameters:
-
| input | The buffer holding the input data. |
| ilen | The length of the input data. |
| output | The SHA-1 checksum result. |
- Returns:
0
if successful
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
int mbedtls_sha1_self_test |
( |
int |
verbose |
) |
|
The SHA-1 checkup routine.
- Returns:
0
on success, or 1
on failure.
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
SHA-1 context setup.
- Deprecated:
- Superseded by mbedtls_sha1_starts_ret() in 2.7.0
- Parameters:
-
| ctx | The SHA-1 context to be initialized. |
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
This function starts a SHA-1 checksum calculation.
- Parameters:
-
| ctx | The context to initialize. |
- Returns:
0
if successful
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
MBEDTLS_DEPRECATED void mbedtls_sha1_update |
( |
mbedtls_sha1_context * |
ctx, |
|
|
const unsigned char * |
input, |
|
|
size_t |
ilen | |
|
) |
| | |
SHA-1 process buffer.
- Deprecated:
- Superseded by mbedtls_sha1_update_ret() in 2.7.0
- Parameters:
-
| ctx | The SHA-1 context. |
| input | The buffer holding the input data. |
| ilen | The length of the input data. |
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.
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.
- Parameters:
-
| ctx | The SHA-1 context. |
| input | The buffer holding the input data. |
| ilen | The length of the input data. |
- Returns:
0
if successful
- Warning:
- SHA-1 is considered a weak message digest and its use constitutes a security risk. We recommend considering stronger message digests instead.