PostgreSQL Source Code git master
checksum_helper.c
Go to the documentation of this file.
1/*-------------------------------------------------------------------------
2 *
3 * checksum_helper.c
4 * Compute a checksum of any of various types using common routines
5 *
6 * Portions Copyright (c) 2016-2025, PostgreSQL Global Development Group
7 *
8 * IDENTIFICATION
9 * src/common/checksum_helper.c
10 *
11 *-------------------------------------------------------------------------
12 */
13
14#ifndef FRONTEND
15#include "postgres.h"
16#else
17#include "postgres_fe.h"
18#endif
19
20#include "common/checksum_helper.h"
21
22/*
23 * If 'name' is a recognized checksum type, set *type to the corresponding
24 * constant and return true. Otherwise, set *type to CHECKSUM_TYPE_NONE and
25 * return false.
26 */
27bool
28pg_checksum_parse_type(char *name, pg_checksum_type *type)
29{
30 pg_checksum_type result_type = CHECKSUM_TYPE_NONE;
31 bool result = true;
32
33 if (pg_strcasecmp(name, "none") == 0)
34 result_type = CHECKSUM_TYPE_NONE;
35 else if (pg_strcasecmp(name, "crc32c") == 0)
36 result_type = CHECKSUM_TYPE_CRC32C;
37 else if (pg_strcasecmp(name, "sha224") == 0)
38 result_type = CHECKSUM_TYPE_SHA224;
39 else if (pg_strcasecmp(name, "sha256") == 0)
40 result_type = CHECKSUM_TYPE_SHA256;
41 else if (pg_strcasecmp(name, "sha384") == 0)
42 result_type = CHECKSUM_TYPE_SHA384;
43 else if (pg_strcasecmp(name, "sha512") == 0)
44 result_type = CHECKSUM_TYPE_SHA512;
45 else
46 result = false;
47
48 *type = result_type;
49 return result;
50}
51
52/*
53 * Get the canonical human-readable name corresponding to a checksum type.
54 */
55char *
56pg_checksum_type_name(pg_checksum_type type)
57{
58 switch (type)
59 {
60 case CHECKSUM_TYPE_NONE:
61 return "NONE";
62 case CHECKSUM_TYPE_CRC32C:
63 return "CRC32C";
64 case CHECKSUM_TYPE_SHA224:
65 return "SHA224";
66 case CHECKSUM_TYPE_SHA256:
67 return "SHA256";
68 case CHECKSUM_TYPE_SHA384:
69 return "SHA384";
70 case CHECKSUM_TYPE_SHA512:
71 return "SHA512";
72 }
73
74 Assert(false);
75 return "???";
76}
77
78/*
79 * Initialize a checksum context for checksums of the given type.
80 * Returns 0 for a success, -1 for a failure.
81 */
82int
83pg_checksum_init(pg_checksum_context *context, pg_checksum_type type)
84{
85 context->type = type;
86
87 switch (type)
88 {
89 case CHECKSUM_TYPE_NONE:
90 /* do nothing */
91 break;
92 case CHECKSUM_TYPE_CRC32C:
93 INIT_CRC32C(context->raw_context.c_crc32c);
94 break;
95 case CHECKSUM_TYPE_SHA224:
96 context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA224);
97 if (context->raw_context.c_sha2 == NULL)
98 return -1;
99 if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
100 {
101 pg_cryptohash_free(context->raw_context.c_sha2);
102 return -1;
103 }
104 break;
105 case CHECKSUM_TYPE_SHA256:
106 context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA256);
107 if (context->raw_context.c_sha2 == NULL)
108 return -1;
109 if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
110 {
111 pg_cryptohash_free(context->raw_context.c_sha2);
112 return -1;
113 }
114 break;
115 case CHECKSUM_TYPE_SHA384:
116 context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA384);
117 if (context->raw_context.c_sha2 == NULL)
118 return -1;
119 if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
120 {
121 pg_cryptohash_free(context->raw_context.c_sha2);
122 return -1;
123 }
124 break;
125 case CHECKSUM_TYPE_SHA512:
126 context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA512);
127 if (context->raw_context.c_sha2 == NULL)
128 return -1;
129 if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
130 {
131 pg_cryptohash_free(context->raw_context.c_sha2);
132 return -1;
133 }
134 break;
135 }
136
137 return 0;
138}
139
140/*
141 * Update a checksum context with new data.
142 * Returns 0 for a success, -1 for a failure.
143 */
144int
145pg_checksum_update(pg_checksum_context *context, const uint8 *input,
146 size_t len)
147{
148 switch (context->type)
149 {
150 case CHECKSUM_TYPE_NONE:
151 /* do nothing */
152 break;
153 case CHECKSUM_TYPE_CRC32C:
154 COMP_CRC32C(context->raw_context.c_crc32c, input, len);
155 break;
156 case CHECKSUM_TYPE_SHA224:
157 case CHECKSUM_TYPE_SHA256:
158 case CHECKSUM_TYPE_SHA384:
159 case CHECKSUM_TYPE_SHA512:
160 if (pg_cryptohash_update(context->raw_context.c_sha2, input, len) < 0)
161 return -1;
162 break;
163 }
164
165 return 0;
166}
167
168/*
169 * Finalize a checksum computation and write the result to an output buffer.
170 *
171 * The caller must ensure that the buffer is at least PG_CHECKSUM_MAX_LENGTH
172 * bytes in length. The return value is the number of bytes actually written,
173 * or -1 for a failure.
174 */
175int
176pg_checksum_final(pg_checksum_context *context, uint8 *output)
177{
178 int retval = 0;
179
180 StaticAssertDecl(sizeof(pg_crc32c) <= PG_CHECKSUM_MAX_LENGTH,
181 "CRC-32C digest too big for PG_CHECKSUM_MAX_LENGTH");
182 StaticAssertDecl(PG_SHA224_DIGEST_LENGTH <= PG_CHECKSUM_MAX_LENGTH,
183 "SHA224 digest too big for PG_CHECKSUM_MAX_LENGTH");
184 StaticAssertDecl(PG_SHA256_DIGEST_LENGTH <= PG_CHECKSUM_MAX_LENGTH,
185 "SHA256 digest too big for PG_CHECKSUM_MAX_LENGTH");
186 StaticAssertDecl(PG_SHA384_DIGEST_LENGTH <= PG_CHECKSUM_MAX_LENGTH,
187 "SHA384 digest too big for PG_CHECKSUM_MAX_LENGTH");
188 StaticAssertDecl(PG_SHA512_DIGEST_LENGTH <= PG_CHECKSUM_MAX_LENGTH,
189 "SHA512 digest too big for PG_CHECKSUM_MAX_LENGTH");
190
191 switch (context->type)
192 {
193 case CHECKSUM_TYPE_NONE:
194 break;
195 case CHECKSUM_TYPE_CRC32C:
196 FIN_CRC32C(context->raw_context.c_crc32c);
197 retval = sizeof(pg_crc32c);
198 memcpy(output, &context->raw_context.c_crc32c, retval);
199 break;
200 case CHECKSUM_TYPE_SHA224:
201 retval = PG_SHA224_DIGEST_LENGTH;
202 if (pg_cryptohash_final(context->raw_context.c_sha2,
203 output, retval) < 0)
204 return -1;
205 pg_cryptohash_free(context->raw_context.c_sha2);
206 break;
207 case CHECKSUM_TYPE_SHA256:
208 retval = PG_SHA256_DIGEST_LENGTH;
209 if (pg_cryptohash_final(context->raw_context.c_sha2,
210 output, retval) < 0)
211 return -1;
212 pg_cryptohash_free(context->raw_context.c_sha2);
213 break;
214 case CHECKSUM_TYPE_SHA384:
215 retval = PG_SHA384_DIGEST_LENGTH;
216 if (pg_cryptohash_final(context->raw_context.c_sha2,
217 output, retval) < 0)
218 return -1;
219 pg_cryptohash_free(context->raw_context.c_sha2);
220 break;
221 case CHECKSUM_TYPE_SHA512:
222 retval = PG_SHA512_DIGEST_LENGTH;
223 if (pg_cryptohash_final(context->raw_context.c_sha2,
224 output, retval) < 0)
225 return -1;
226 pg_cryptohash_free(context->raw_context.c_sha2);
227 break;
228 }
229
230 Assert(retval <= PG_CHECKSUM_MAX_LENGTH);
231 return retval;
232}
uint8
uint8_t uint8
Definition: c.h:500
StaticAssertDecl
#define StaticAssertDecl(condition, errmessage)
Definition: c.h:907
pg_checksum_parse_type
bool pg_checksum_parse_type(char *name, pg_checksum_type *type)
Definition: checksum_helper.c:28
pg_checksum_final
int pg_checksum_final(pg_checksum_context *context, uint8 *output)
Definition: checksum_helper.c:176
pg_checksum_type_name
char * pg_checksum_type_name(pg_checksum_type type)
Definition: checksum_helper.c:56
pg_checksum_update
int pg_checksum_update(pg_checksum_context *context, const uint8 *input, size_t len)
Definition: checksum_helper.c:145
pg_checksum_init
int pg_checksum_init(pg_checksum_context *context, pg_checksum_type type)
Definition: checksum_helper.c:83
checksum_helper.h
PG_CHECKSUM_MAX_LENGTH
#define PG_CHECKSUM_MAX_LENGTH
Definition: checksum_helper.h:62
pg_checksum_type
pg_checksum_type
Definition: checksum_helper.h:30
CHECKSUM_TYPE_SHA384
@ CHECKSUM_TYPE_SHA384
Definition: checksum_helper.h:35
CHECKSUM_TYPE_SHA256
@ CHECKSUM_TYPE_SHA256
Definition: checksum_helper.h:34
CHECKSUM_TYPE_SHA224
@ CHECKSUM_TYPE_SHA224
Definition: checksum_helper.h:33
CHECKSUM_TYPE_NONE
@ CHECKSUM_TYPE_NONE
Definition: checksum_helper.h:31
CHECKSUM_TYPE_CRC32C
@ CHECKSUM_TYPE_CRC32C
Definition: checksum_helper.h:32
CHECKSUM_TYPE_SHA512
@ CHECKSUM_TYPE_SHA512
Definition: checksum_helper.h:36
pg_cryptohash_update
int pg_cryptohash_update(pg_cryptohash_ctx *ctx, const uint8 *data, size_t len)
Definition: cryptohash.c:136
pg_cryptohash_create
pg_cryptohash_ctx * pg_cryptohash_create(pg_cryptohash_type type)
Definition: cryptohash.c:74
pg_cryptohash_init
int pg_cryptohash_init(pg_cryptohash_ctx *ctx)
Definition: cryptohash.c:100
pg_cryptohash_free
void pg_cryptohash_free(pg_cryptohash_ctx *ctx)
Definition: cryptohash.c:238
pg_cryptohash_final
int pg_cryptohash_final(pg_cryptohash_ctx *ctx, uint8 *dest, size_t len)
Definition: cryptohash.c:172
PG_SHA512
@ PG_SHA512
Definition: cryptohash.h:26
PG_SHA224
@ PG_SHA224
Definition: cryptohash.h:23
PG_SHA384
@ PG_SHA384
Definition: cryptohash.h:25
PG_SHA256
@ PG_SHA256
Definition: cryptohash.h:24
Assert
Assert(PointerIsAligned(start, uint64))
input
FILE * input
output
FILE * output
Definition: pg_test_timing.c:182
pg_crc32c
uint32 pg_crc32c
Definition: pg_crc32c.h:38
COMP_CRC32C
#define COMP_CRC32C(crc, data, len)
Definition: pg_crc32c.h:98
INIT_CRC32C
#define INIT_CRC32C(crc)
Definition: pg_crc32c.h:41
FIN_CRC32C
#define FIN_CRC32C(crc)
Definition: pg_crc32c.h:103
len
const void size_t len
Definition: pg_crc32c_sse42.c:25
pg_strcasecmp
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
postgres_fe.h
PG_SHA256_DIGEST_LENGTH
#define PG_SHA256_DIGEST_LENGTH
Definition: sha2.h:23
PG_SHA384_DIGEST_LENGTH
#define PG_SHA384_DIGEST_LENGTH
Definition: sha2.h:26
PG_SHA512_DIGEST_LENGTH
#define PG_SHA512_DIGEST_LENGTH
Definition: sha2.h:29
PG_SHA224_DIGEST_LENGTH
#define PG_SHA224_DIGEST_LENGTH
Definition: sha2.h:20
pg_checksum_context
Definition: checksum_helper.h:53
pg_checksum_context::type
pg_checksum_type type
Definition: checksum_helper.h:54
pg_checksum_context::raw_context
pg_checksum_raw_context raw_context
Definition: checksum_helper.h:55
pg_checksum_raw_context::c_sha2
pg_cryptohash_ctx * c_sha2
Definition: checksum_helper.h:45
pg_checksum_raw_context::c_crc32c
pg_crc32c c_crc32c
Definition: checksum_helper.h:44
type
const char * type
Definition: wait_event_funcs.c:27
name
const char * name
Definition: wait_event_funcs.c:28