2020-04-03 17:50:38 +02:00
|
|
|
/*-------------------------------------------------------------------------
|
|
|
|
*
|
|
|
|
* checksum_helper.h
|
|
|
|
* Compute a checksum of any of various types using common routines
|
|
|
|
*
|
2022-01-08 01:04:57 +01:00
|
|
|
* Portions Copyright (c) 2016-2022, PostgreSQL Global Development Group
|
2020-04-03 17:50:38 +02:00
|
|
|
*
|
|
|
|
* IDENTIFICATION
|
|
|
|
* src/include/common/checksum_helper.h
|
|
|
|
*
|
|
|
|
*-------------------------------------------------------------------------
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef CHECKSUM_HELPER_H
|
|
|
|
#define CHECKSUM_HELPER_H
|
|
|
|
|
Move SHA2 routines to a new generic API layer for crypto hashes
Two new routines to allocate a hash context and to free it are created,
as these become necessary for the goal behind this refactoring: switch
the all cryptohash implementations for OpenSSL to use EVP (for FIPS and
also because upstream does not recommend the use of low-level cryptohash
functions for 20 years). Note that OpenSSL hides the internals of
cryptohash contexts since 1.1.0, so it is necessary to leave the
allocation to OpenSSL itself, explaining the need for those two new
routines. This part is going to require more work to properly track
hash contexts with resource owners, but this not introduced here.
Still, this refactoring makes the move possible.
This reduces the number of routines for all SHA2 implementations from
twelve (SHA{224,256,386,512} with init, update and final calls) to five
(create, free, init, update and final calls) by incorporating the hash
type directly into the hash context data.
The new cryptohash routines are moved to a new file, called cryptohash.c
for the fallback implementations, with SHA2 specifics becoming a part
internal to src/common/. OpenSSL specifics are part of
cryptohash_openssl.c. This infrastructure is usable for more hash
types, like MD5 or HMAC.
Any code paths using the internal SHA2 routines are adapted to report
correctly errors, which are most of the changes of this commit. The
zones mostly impacted are checksum manifests, libpq and SCRAM.
Note that e21cbb4 was a first attempt to switch SHA2 to EVP, but it
lacked the refactoring needed for libpq, as done here.
This patch has been tested on Linux and Windows, with and without
OpenSSL, and down to 1.0.1, the oldest version supported on HEAD.
Author: Michael Paquier
Reviewed-by: Daniel Gustafsson
Discussion: https://postgr.es/m/20200924025314.GE7405@paquier.xyz
2020-12-02 02:37:20 +01:00
|
|
|
#include "common/cryptohash.h"
|
2020-04-03 17:50:38 +02:00
|
|
|
#include "common/sha2.h"
|
|
|
|
#include "port/pg_crc32c.h"
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Supported checksum types. It's not necessarily the case that code using
|
|
|
|
* these functions needs a cryptographically strong checksum; it may only
|
|
|
|
* need to detect accidental modification. That's why we include CRC-32C: it's
|
|
|
|
* much faster than any of the other algorithms. On the other hand, we omit
|
|
|
|
* MD5 here because any new that does need a cryptographically strong checksum
|
|
|
|
* should use something better.
|
|
|
|
*/
|
|
|
|
typedef enum pg_checksum_type
|
|
|
|
{
|
|
|
|
CHECKSUM_TYPE_NONE,
|
|
|
|
CHECKSUM_TYPE_CRC32C,
|
|
|
|
CHECKSUM_TYPE_SHA224,
|
|
|
|
CHECKSUM_TYPE_SHA256,
|
|
|
|
CHECKSUM_TYPE_SHA384,
|
|
|
|
CHECKSUM_TYPE_SHA512
|
|
|
|
} pg_checksum_type;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This is just a union of all applicable context types.
|
|
|
|
*/
|
|
|
|
typedef union pg_checksum_raw_context
|
|
|
|
{
|
|
|
|
pg_crc32c c_crc32c;
|
2021-01-08 02:37:03 +01:00
|
|
|
pg_cryptohash_ctx *c_sha2;
|
2020-04-03 17:50:38 +02:00
|
|
|
} pg_checksum_raw_context;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This structure provides a convenient way to pass the checksum type and the
|
|
|
|
* checksum context around together.
|
|
|
|
*/
|
|
|
|
typedef struct pg_checksum_context
|
|
|
|
{
|
|
|
|
pg_checksum_type type;
|
|
|
|
pg_checksum_raw_context raw_context;
|
|
|
|
} pg_checksum_context;
|
|
|
|
|
|
|
|
/*
|
|
|
|
* This is the longest possible output for any checksum algorithm supported
|
|
|
|
* by this file.
|
|
|
|
*/
|
|
|
|
#define PG_CHECKSUM_MAX_LENGTH PG_SHA512_DIGEST_LENGTH
|
|
|
|
|
|
|
|
extern bool pg_checksum_parse_type(char *name, pg_checksum_type *);
|
|
|
|
extern char *pg_checksum_type_name(pg_checksum_type);
|
|
|
|
|
Move SHA2 routines to a new generic API layer for crypto hashes
Two new routines to allocate a hash context and to free it are created,
as these become necessary for the goal behind this refactoring: switch
the all cryptohash implementations for OpenSSL to use EVP (for FIPS and
also because upstream does not recommend the use of low-level cryptohash
functions for 20 years). Note that OpenSSL hides the internals of
cryptohash contexts since 1.1.0, so it is necessary to leave the
allocation to OpenSSL itself, explaining the need for those two new
routines. This part is going to require more work to properly track
hash contexts with resource owners, but this not introduced here.
Still, this refactoring makes the move possible.
This reduces the number of routines for all SHA2 implementations from
twelve (SHA{224,256,386,512} with init, update and final calls) to five
(create, free, init, update and final calls) by incorporating the hash
type directly into the hash context data.
The new cryptohash routines are moved to a new file, called cryptohash.c
for the fallback implementations, with SHA2 specifics becoming a part
internal to src/common/. OpenSSL specifics are part of
cryptohash_openssl.c. This infrastructure is usable for more hash
types, like MD5 or HMAC.
Any code paths using the internal SHA2 routines are adapted to report
correctly errors, which are most of the changes of this commit. The
zones mostly impacted are checksum manifests, libpq and SCRAM.
Note that e21cbb4 was a first attempt to switch SHA2 to EVP, but it
lacked the refactoring needed for libpq, as done here.
This patch has been tested on Linux and Windows, with and without
OpenSSL, and down to 1.0.1, the oldest version supported on HEAD.
Author: Michael Paquier
Reviewed-by: Daniel Gustafsson
Discussion: https://postgr.es/m/20200924025314.GE7405@paquier.xyz
2020-12-02 02:37:20 +01:00
|
|
|
extern int pg_checksum_init(pg_checksum_context *, pg_checksum_type);
|
|
|
|
extern int pg_checksum_update(pg_checksum_context *, const uint8 *input,
|
2020-04-03 17:50:38 +02:00
|
|
|
size_t len);
|
|
|
|
extern int pg_checksum_final(pg_checksum_context *, uint8 *output);
|
|
|
|
|
|
|
|
#endif
|