checksum_helper.h File Reference

#include "common/cryptohash.h"
#include "common/sha2.h"
#include "port/pg_crc32c.h"

Include dependency graph for checksum_helper.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
union	pg_checksum_raw_context
struct	pg_checksum_context

Macros
#define	PG_CHECKSUM_MAX_LENGTH   PG_SHA512_DIGEST_LENGTH

Typedefs
typedef enum pg_checksum_type	pg_checksum_type
typedef union pg_checksum_raw_context	pg_checksum_raw_context
typedef struct pg_checksum_context	pg_checksum_context

Enumerations
enum	pg_checksum_type {   CHECKSUM_TYPE_NONE , CHECKSUM_TYPE_CRC32C , CHECKSUM_TYPE_SHA224 , CHECKSUM_TYPE_SHA256 ,   CHECKSUM_TYPE_SHA384 , CHECKSUM_TYPE_SHA512 }

Functions
bool	pg_checksum_parse_type (char *name, pg_checksum_type *)
char *	pg_checksum_type_name (pg_checksum_type)
int	pg_checksum_init (pg_checksum_context *, pg_checksum_type)
int	pg_checksum_update (pg_checksum_context *, const uint8 *input, size_t len)
int	pg_checksum_final (pg_checksum_context *, uint8 *output)

Macro Definition Documentation

PG_CHECKSUM_MAX_LENGTH

#define PG_CHECKSUM_MAX_LENGTH   PG_SHA512_DIGEST_LENGTH

Definition at line 62 of file checksum_helper.h.

Typedef Documentation

pg_checksum_context

typedef struct pg_checksum_context pg_checksum_context

pg_checksum_raw_context

typedef union pg_checksum_raw_context pg_checksum_raw_context

pg_checksum_type

typedef enum pg_checksum_type pg_checksum_type

Enumeration Type Documentation

pg_checksum_type

enum pg_checksum_type

Enumerator
CHECKSUM_TYPE_NONE
CHECKSUM_TYPE_CRC32C
CHECKSUM_TYPE_SHA224
CHECKSUM_TYPE_SHA256
CHECKSUM_TYPE_SHA384
CHECKSUM_TYPE_SHA512

Definition at line 29 of file checksum_helper.h.

{
    CHECKSUM_TYPE_NONE,
    CHECKSUM_TYPE_CRC32C,
    CHECKSUM_TYPE_SHA224,
    CHECKSUM_TYPE_SHA256,
    CHECKSUM_TYPE_SHA384,
    CHECKSUM_TYPE_SHA512,
} pg_checksum_type;

Function Documentation

pg_checksum_final()

int pg_checksum_final	(	pg_checksum_context *	context,
		uint8 *	output
	)

Definition at line 176 of file checksum_helper.c.

{
    int         retval = 0;
 
    StaticAssertDecl(sizeof(pg_crc32c) <= PG_CHECKSUM_MAX_LENGTH,
                     "CRC-32C digest too big for PG_CHECKSUM_MAX_LENGTH");
    StaticAssertDecl(PG_SHA224_DIGEST_LENGTH <= PG_CHECKSUM_MAX_LENGTH,
                     "SHA224 digest too big for PG_CHECKSUM_MAX_LENGTH");
    StaticAssertDecl(PG_SHA256_DIGEST_LENGTH <= PG_CHECKSUM_MAX_LENGTH,
                     "SHA256 digest too big for PG_CHECKSUM_MAX_LENGTH");
    StaticAssertDecl(PG_SHA384_DIGEST_LENGTH <= PG_CHECKSUM_MAX_LENGTH,
                     "SHA384 digest too big for PG_CHECKSUM_MAX_LENGTH");
    StaticAssertDecl(PG_SHA512_DIGEST_LENGTH <= PG_CHECKSUM_MAX_LENGTH,
                     "SHA512 digest too big for PG_CHECKSUM_MAX_LENGTH");
 
    switch (context->type)
    {
        case CHECKSUM_TYPE_NONE:
            break;
        case CHECKSUM_TYPE_CRC32C:
            FIN_CRC32C(context->raw_context.c_crc32c);
            retval = sizeof(pg_crc32c);
            memcpy(output, &context->raw_context.c_crc32c, retval);
            break;
        case CHECKSUM_TYPE_SHA224:
            retval = PG_SHA224_DIGEST_LENGTH;
            if (pg_cryptohash_final(context->raw_context.c_sha2,
                                    output, retval) < 0)
                return -1;
            pg_cryptohash_free(context->raw_context.c_sha2);
            break;
        case CHECKSUM_TYPE_SHA256:
            retval = PG_SHA256_DIGEST_LENGTH;
            if (pg_cryptohash_final(context->raw_context.c_sha2,
                                    output, retval) < 0)
                return -1;
            pg_cryptohash_free(context->raw_context.c_sha2);
            break;
        case CHECKSUM_TYPE_SHA384:
            retval = PG_SHA384_DIGEST_LENGTH;
            if (pg_cryptohash_final(context->raw_context.c_sha2,
                                    output, retval) < 0)
                return -1;
            pg_cryptohash_free(context->raw_context.c_sha2);
            break;
        case CHECKSUM_TYPE_SHA512:
            retval = PG_SHA512_DIGEST_LENGTH;
            if (pg_cryptohash_final(context->raw_context.c_sha2,
                                    output, retval) < 0)
                return -1;
            pg_cryptohash_free(context->raw_context.c_sha2);
            break;
    }
 
    Assert(retval <= PG_CHECKSUM_MAX_LENGTH);
    return retval;
}

References Assert, CHECKSUM_TYPE_CRC32C, CHECKSUM_TYPE_NONE, CHECKSUM_TYPE_SHA224, CHECKSUM_TYPE_SHA256, CHECKSUM_TYPE_SHA384, CHECKSUM_TYPE_SHA512, context, FIN_CRC32C, output, PG_CHECKSUM_MAX_LENGTH, pg_cryptohash_final(), pg_cryptohash_free(), PG_SHA224_DIGEST_LENGTH, PG_SHA256_DIGEST_LENGTH, PG_SHA384_DIGEST_LENGTH, PG_SHA512_DIGEST_LENGTH, and StaticAssertDecl.

Referenced by AddFileToBackupManifest(), finalize_manifest(), process_directory_recursively(), reconstruct_from_incremental_file(), verify_file_checksum(), and write_backup_label().

pg_checksum_init()

int pg_checksum_init	(	pg_checksum_context *	context,
		pg_checksum_type	type
	)

Definition at line 83 of file checksum_helper.c.

{
    context->type = type;
 
    switch (type)
    {
        case CHECKSUM_TYPE_NONE:
            /* do nothing */
            break;
        case CHECKSUM_TYPE_CRC32C:
            INIT_CRC32C(context->raw_context.c_crc32c);
            break;
        case CHECKSUM_TYPE_SHA224:
            context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA224);
            if (context->raw_context.c_sha2 == NULL)
                return -1;
            if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
            {
                pg_cryptohash_free(context->raw_context.c_sha2);
                return -1;
            }
            break;
        case CHECKSUM_TYPE_SHA256:
            context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA256);
            if (context->raw_context.c_sha2 == NULL)
                return -1;
            if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
            {
                pg_cryptohash_free(context->raw_context.c_sha2);
                return -1;
            }
            break;
        case CHECKSUM_TYPE_SHA384:
            context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA384);
            if (context->raw_context.c_sha2 == NULL)
                return -1;
            if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
            {
                pg_cryptohash_free(context->raw_context.c_sha2);
                return -1;
            }
            break;
        case CHECKSUM_TYPE_SHA512:
            context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA512);
            if (context->raw_context.c_sha2 == NULL)
                return -1;
            if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
            {
                pg_cryptohash_free(context->raw_context.c_sha2);
                return -1;
            }
            break;
    }
 
    return 0;
}

References CHECKSUM_TYPE_CRC32C, CHECKSUM_TYPE_NONE, CHECKSUM_TYPE_SHA224, CHECKSUM_TYPE_SHA256, CHECKSUM_TYPE_SHA384, CHECKSUM_TYPE_SHA512, context, INIT_CRC32C, pg_cryptohash_create(), pg_cryptohash_free(), pg_cryptohash_init(), PG_SHA224, PG_SHA256, PG_SHA384, PG_SHA512, and type.

Referenced by create_manifest_writer(), process_directory_recursively(), reconstruct_from_incremental_file(), sendFile(), sendFileWithContent(), verify_file_checksum(), and write_backup_label().

pg_checksum_parse_type()

bool pg_checksum_parse_type	(	char *	name,
		pg_checksum_type *	type
	)

Definition at line 28 of file checksum_helper.c.

{
    pg_checksum_type result_type = CHECKSUM_TYPE_NONE;
    bool        result = true;
 
    if (pg_strcasecmp(name, "none") == 0)
        result_type = CHECKSUM_TYPE_NONE;
    else if (pg_strcasecmp(name, "crc32c") == 0)
        result_type = CHECKSUM_TYPE_CRC32C;
    else if (pg_strcasecmp(name, "sha224") == 0)
        result_type = CHECKSUM_TYPE_SHA224;
    else if (pg_strcasecmp(name, "sha256") == 0)
        result_type = CHECKSUM_TYPE_SHA256;
    else if (pg_strcasecmp(name, "sha384") == 0)
        result_type = CHECKSUM_TYPE_SHA384;
    else if (pg_strcasecmp(name, "sha512") == 0)
        result_type = CHECKSUM_TYPE_SHA512;
    else
        result = false;
 
    *type = result_type;
    return result;
}

References CHECKSUM_TYPE_CRC32C, CHECKSUM_TYPE_NONE, CHECKSUM_TYPE_SHA224, CHECKSUM_TYPE_SHA256, CHECKSUM_TYPE_SHA384, CHECKSUM_TYPE_SHA512, name, pg_strcasecmp(), and type.

Referenced by json_manifest_finalize_file(), main(), and parse_basebackup_options().

pg_checksum_type_name()

char* pg_checksum_type_name

(

pg_checksum_type

type

)

Definition at line 56 of file checksum_helper.c.

{
    switch (type)
    {
        case CHECKSUM_TYPE_NONE:
            return "NONE";
        case CHECKSUM_TYPE_CRC32C:
            return "CRC32C";
        case CHECKSUM_TYPE_SHA224:
            return "SHA224";
        case CHECKSUM_TYPE_SHA256:
            return "SHA256";
        case CHECKSUM_TYPE_SHA384:
            return "SHA384";
        case CHECKSUM_TYPE_SHA512:
            return "SHA512";
    }
 
    Assert(false);
    return "???";
}

References Assert, CHECKSUM_TYPE_CRC32C, CHECKSUM_TYPE_NONE, CHECKSUM_TYPE_SHA224, CHECKSUM_TYPE_SHA256, CHECKSUM_TYPE_SHA384, CHECKSUM_TYPE_SHA512, and type.

Referenced by add_file_to_manifest(), AddFileToBackupManifest(), copy_file(), and write_reconstructed_file().

pg_checksum_update()

int pg_checksum_update	(	pg_checksum_context *	context,
		const uint8 *	input,
		size_t	len
	)

Definition at line 145 of file checksum_helper.c.

{
    switch (context->type)
    {
        case CHECKSUM_TYPE_NONE:
            /* do nothing */
            break;
        case CHECKSUM_TYPE_CRC32C:
            COMP_CRC32C(context->raw_context.c_crc32c, input, len);
            break;
        case CHECKSUM_TYPE_SHA224:
        case CHECKSUM_TYPE_SHA256:
        case CHECKSUM_TYPE_SHA384:
        case CHECKSUM_TYPE_SHA512:
            if (pg_cryptohash_update(context->raw_context.c_sha2, input, len) < 0)
                return -1;
            break;
    }
 
    return 0;
}

References CHECKSUM_TYPE_CRC32C, CHECKSUM_TYPE_NONE, CHECKSUM_TYPE_SHA224, CHECKSUM_TYPE_SHA256, CHECKSUM_TYPE_SHA384, CHECKSUM_TYPE_SHA512, COMP_CRC32C, context, input, len, and pg_cryptohash_update().

Referenced by checksum_file(), copy_file_blocks(), flush_manifest(), push_to_sink(), sendFile(), sendFileWithContent(), verify_file_checksum(), write_backup_label(), write_block(), and write_reconstructed_file().