mirror of
https://github.com/python/cpython.git
synced 2025-08-18 15:51:23 +00:00
1fcc0efdaa
replacing hashlib primitives (for the non-OpenSSL case) with verified implementations from HACL*. This is the first PR in the series, and focuses specifically on SHA2-256 and SHA2-224. This PR imports Hacl_Streaming_SHA2 into the Python tree. This is the HACL* implementation of SHA2, which combines a core implementation of SHA2 along with a layer of buffer management that allows updating the digest with any number of bytes. This supersedes the previous implementation in the tree. @franziskuskiefer was kind enough to benchmark the changes: in addition to being verified (thus providing significant safety and security improvements), this implementation also provides a sizeable performance boost! ``` --------------------------------------------------------------- Benchmark Time CPU Iterations --------------------------------------------------------------- Sha2_256_Streaming 3163 ns 3160 ns 219353 // this PR LibTomCrypt_Sha2_256 5057 ns 5056 ns 136234 // library used by Python currently ``` The changes in this PR are as follows: - import the subset of HACL* that covers SHA2-256/224 into `Modules/_hacl` - rewire sha256module.c to use the HACL* implementation Co-authored-by: Gregory P. Smith [Google LLC] <greg@krypto.org> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
136 lines
4.4 KiB
C
136 lines
4.4 KiB
C
/* MIT License
|
|
*
|
|
* Copyright (c) 2016-2022 INRIA, CMU and Microsoft Corporation
|
|
* Copyright (c) 2022-2023 HACL* Contributors
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*/
|
|
|
|
|
|
#ifndef __Hacl_Streaming_SHA2_H
|
|
#define __Hacl_Streaming_SHA2_H
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <string.h>
|
|
#include "python_hacl_namespaces.h"
|
|
#include "krml/FStar_UInt_8_16_32_64.h"
|
|
#include "krml/lowstar_endianness.h"
|
|
#include "krml/internal/target.h"
|
|
|
|
|
|
|
|
|
|
typedef struct Hacl_Streaming_SHA2_state_sha2_224_s
|
|
{
|
|
uint32_t *block_state;
|
|
uint8_t *buf;
|
|
uint64_t total_len;
|
|
}
|
|
Hacl_Streaming_SHA2_state_sha2_224;
|
|
|
|
typedef Hacl_Streaming_SHA2_state_sha2_224 Hacl_Streaming_SHA2_state_sha2_256;
|
|
|
|
/**
|
|
Allocate initial state for the SHA2_256 hash. The state is to be freed by
|
|
calling `free_256`.
|
|
*/
|
|
Hacl_Streaming_SHA2_state_sha2_224 *Hacl_Streaming_SHA2_create_in_256(void);
|
|
|
|
/**
|
|
Copies the state passed as argument into a newly allocated state (deep copy).
|
|
The state is to be freed by calling `free_256`. Cloning the state this way is
|
|
useful, for instance, if your control-flow diverges and you need to feed
|
|
more (different) data into the hash in each branch.
|
|
*/
|
|
Hacl_Streaming_SHA2_state_sha2_224
|
|
*Hacl_Streaming_SHA2_copy_256(Hacl_Streaming_SHA2_state_sha2_224 *s0);
|
|
|
|
/**
|
|
Reset an existing state to the initial hash state with empty data.
|
|
*/
|
|
void Hacl_Streaming_SHA2_init_256(Hacl_Streaming_SHA2_state_sha2_224 *s);
|
|
|
|
/**
|
|
Feed an arbitrary amount of data into the hash. This function returns 0 for
|
|
success, or 1 if the combined length of all of the data passed to `update_256`
|
|
(since the last call to `init_256`) exceeds 2^61-1 bytes.
|
|
|
|
This function is identical to the update function for SHA2_224.
|
|
*/
|
|
uint32_t
|
|
Hacl_Streaming_SHA2_update_256(
|
|
Hacl_Streaming_SHA2_state_sha2_224 *p,
|
|
uint8_t *input,
|
|
uint32_t input_len
|
|
);
|
|
|
|
/**
|
|
Write the resulting hash into `dst`, an array of 32 bytes. The state remains
|
|
valid after a call to `finish_256`, meaning the user may feed more data into
|
|
the hash via `update_256`. (The finish_256 function operates on an internal copy of
|
|
the state and therefore does not invalidate the client-held state `p`.)
|
|
*/
|
|
void Hacl_Streaming_SHA2_finish_256(Hacl_Streaming_SHA2_state_sha2_224 *p, uint8_t *dst);
|
|
|
|
/**
|
|
Free a state allocated with `create_in_256`.
|
|
|
|
This function is identical to the free function for SHA2_224.
|
|
*/
|
|
void Hacl_Streaming_SHA2_free_256(Hacl_Streaming_SHA2_state_sha2_224 *s);
|
|
|
|
/**
|
|
Hash `input`, of len `input_len`, into `dst`, an array of 32 bytes.
|
|
*/
|
|
void Hacl_Streaming_SHA2_sha256(uint8_t *input, uint32_t input_len, uint8_t *dst);
|
|
|
|
Hacl_Streaming_SHA2_state_sha2_224 *Hacl_Streaming_SHA2_create_in_224(void);
|
|
|
|
void Hacl_Streaming_SHA2_init_224(Hacl_Streaming_SHA2_state_sha2_224 *s);
|
|
|
|
uint32_t
|
|
Hacl_Streaming_SHA2_update_224(
|
|
Hacl_Streaming_SHA2_state_sha2_224 *p,
|
|
uint8_t *input,
|
|
uint32_t input_len
|
|
);
|
|
|
|
/**
|
|
Write the resulting hash into `dst`, an array of 28 bytes. The state remains
|
|
valid after a call to `finish_224`, meaning the user may feed more data into
|
|
the hash via `update_224`.
|
|
*/
|
|
void Hacl_Streaming_SHA2_finish_224(Hacl_Streaming_SHA2_state_sha2_224 *p, uint8_t *dst);
|
|
|
|
void Hacl_Streaming_SHA2_free_224(Hacl_Streaming_SHA2_state_sha2_224 *p);
|
|
|
|
/**
|
|
Hash `input`, of len `input_len`, into `dst`, an array of 28 bytes.
|
|
*/
|
|
void Hacl_Streaming_SHA2_sha224(uint8_t *input, uint32_t input_len, uint8_t *dst);
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#define __Hacl_Streaming_SHA2_H_DEFINED
|
|
#endif
|