Hash size definitions for the PSA Crypto API. More...
Detailed Description
Hash size definitions for the PSA Crypto API.
Definition in file sizes.h.
Include dependency graph for sizes.h: This graph shows which files directly or indirectly include this file:Go to the source code of this file.
| #define | PSA_HASH_LENGTH(alg) |
| The size of the output of psa_hash_compute() and psa_hash_finish(), in bytes. | |
| #define | PSA_HASH_MAX_SIZE (64) |
| Maximum size of a hash supported by this implementation, in bytes. | |
| #define | PSA_HASH_MAX_BLOCK_SIZE 0 |
| Maximum size of a hash block supported by this implementation, in bytes. | |
| #define | PSA_HASH_SUSPEND_OUTPUT_SIZE(alg) |
| A sufficient hash suspend state buffer size for psa_hash_suspend(), in bytes. | |
| #define | PSA_HASH_SUSPEND_OUTPUT_MAX_SIZE /* implementation-defined value */ |
| A sufficient hash suspend state buffer size for psa_hash_suspend(), for any supported hash algorithms. | |
| #define | PSA_HASH_SUSPEND_ALGORITHM_FIELD_LENGTH ((size_t)4) |
| The size of the algorithm field that is part of the output of psa_hash_suspend(), in bytes. | |
| #define | PSA_HASH_SUSPEND_INPUT_LENGTH_FIELD_LENGTH(alg) |
| The size of the input-length field that is part of the output of psa_hash_suspend(), in bytes. | |
| #define | PSA_HASH_SUSPEND_HASH_STATE_FIELD_LENGTH(alg) |
| The size of the hash-state field that is part of the output of psa_hash_suspend(), in bytes. | |
| #define | PSA_HASH_BLOCK_LENGTH(alg) |
| The input block size of a hash algorithm, in bytes. | |
Macro Definition Documentation
◆ PSA_HASH_BLOCK_LENGTH
| #define PSA_HASH_BLOCK_LENGTH | ( | alg | ) |
The input block size of a hash algorithm, in bytes.
Hash algorithms process their input data in blocks. Hash operations will retain any partial blocks until they have enough input to fill the block or until the operation is finished.
This affects the output from psa_hash_suspend().
- Parameters
-
alg A hash algorithm: a value of type psa_algorithm_t such that PSA_ALG_IS_HASH( alg) is true.
- Returns
- The block size in bytes for the specified hash algorithm. If the hash algorithm is not recognized, return 0. An implementation can return either 0 or the correct size for a hash algorithm that it recognizes, but does not support.
◆ PSA_HASH_LENGTH
| #define PSA_HASH_LENGTH | ( | alg | ) |
The size of the output of psa_hash_compute() and psa_hash_finish(), in bytes.
This is also the hash length that psa_hash_compare() and psa_hash_verify() expect.
See also PSA_HASH_MAX_SIZE.
- Parameters
-
alg A hash algorithm or an HMAC algorithm: a value of type psa_algorithm_t such that (PSA_ALG_IS_HASH( alg) || PSA_ALG_IS_HMAC(alg)) is true.
- Returns
- The hash length for the specified hash algorithm. 0 if the hash algorithm is not recognized or not supported.
◆ PSA_HASH_MAX_BLOCK_SIZE
| #define PSA_HASH_MAX_BLOCK_SIZE 0 |
◆ PSA_HASH_MAX_SIZE
| #define PSA_HASH_MAX_SIZE (64) |
◆ PSA_HASH_SUSPEND_ALGORITHM_FIELD_LENGTH
| #define PSA_HASH_SUSPEND_ALGORITHM_FIELD_LENGTH ((size_t)4) |
The size of the algorithm field that is part of the output of psa_hash_suspend(), in bytes.
Applications can use this value to unpack the hash suspend state that is output by psa_hash_suspend().
◆ PSA_HASH_SUSPEND_HASH_STATE_FIELD_LENGTH
| #define PSA_HASH_SUSPEND_HASH_STATE_FIELD_LENGTH | ( | alg | ) |
The size of the hash-state field that is part of the output of psa_hash_suspend(), in bytes.
Applications can use this value to unpack the hash suspend state that is output by psa_hash_suspend().
- Parameters
-
alg A hash algorithm: a value of type psa_algorithm_t such that PSA_ALG_IS_HASH( alg) is true.
- Returns
- The size, in bytes, of the hash-state field of the hash suspend state for the specified hash algorithm. 0 if the hash algorithm is not recognized or not supported.
◆ PSA_HASH_SUSPEND_INPUT_LENGTH_FIELD_LENGTH
| #define PSA_HASH_SUSPEND_INPUT_LENGTH_FIELD_LENGTH | ( | alg | ) |
The size of the input-length field that is part of the output of psa_hash_suspend(), in bytes.
Applications can use this value to unpack the hash suspend state that is output by psa_hash_suspend().
- Parameters
-
alg A hash algorithm: a value of type psa_algorithm_t such that PSA_ALG_IS_HASH( alg) is true.
- Returns
- The size, in bytes, of the input-length field of the hash suspend state for the specified hash algorithm. 0 i f the hash algorithm is not recognized or not supported.
◆ PSA_HASH_SUSPEND_OUTPUT_MAX_SIZE
| #define PSA_HASH_SUSPEND_OUTPUT_MAX_SIZE /* implementation-defined value */ |
A sufficient hash suspend state buffer size for psa_hash_suspend(), for any supported hash algorithms.
If the size of the hash state buffer is at least this large, it is guaranteed that psa_hash_suspend() will not fail due to an insufficient buffer size.
See also PSA_HASH_SUSPEND_OUTPUT_SIZE().
◆ PSA_HASH_SUSPEND_OUTPUT_SIZE
| #define PSA_HASH_SUSPEND_OUTPUT_SIZE | ( | alg | ) |
A sufficient hash suspend state buffer size for psa_hash_suspend(), in bytes.
If the size of the hash state buffer is at least this large, it is guaranteed that psa_hash_suspend() will not fail due to an insufficient buffer size. The actual size of the output might be smaller in any given call.
See also PSA_HASH_SUSPEND_OUTPUT_MAX_SIZE.
- Parameters
-
alg A hash algorithm: a value of type psa_algorithm_t such that PSA_ALG_IS_HASH(alg) is true.
- Returns
- A sufficient output size for the algorithm. 0 if the hash algorithm is not recognized, or is not supported by psa_hash_suspend().
For a supported hash algorithm alg, the following expression is true:
