Branch data Line data Source code
1 : : /*-------------------------------------------------------------------------
2 : : *
3 : : * checksum_helper.c
4 : : * Compute a checksum of any of various types using common routines
5 : : *
6 : : * Portions Copyright (c) 2016-2026, 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 : : */
27 : : bool
28 : 0 : pg_checksum_parse_type(char *name, pg_checksum_type *type)
29 : : {
30 : 0 : pg_checksum_type result_type = CHECKSUM_TYPE_NONE;
31 : 0 : bool result = true;
32 : :
33 [ # # ]: 0 : if (pg_strcasecmp(name, "none") == 0)
34 : 0 : result_type = CHECKSUM_TYPE_NONE;
35 [ # # ]: 0 : else if (pg_strcasecmp(name, "crc32c") == 0)
36 : 0 : result_type = CHECKSUM_TYPE_CRC32C;
37 [ # # ]: 0 : else if (pg_strcasecmp(name, "sha224") == 0)
38 : 0 : result_type = CHECKSUM_TYPE_SHA224;
39 [ # # ]: 0 : else if (pg_strcasecmp(name, "sha256") == 0)
40 : 0 : result_type = CHECKSUM_TYPE_SHA256;
41 [ # # ]: 0 : else if (pg_strcasecmp(name, "sha384") == 0)
42 : 0 : result_type = CHECKSUM_TYPE_SHA384;
43 [ # # ]: 0 : else if (pg_strcasecmp(name, "sha512") == 0)
44 : 0 : result_type = CHECKSUM_TYPE_SHA512;
45 : : else
46 : 0 : result = false;
47 : :
48 : 0 : *type = result_type;
49 : 0 : return result;
50 : 0 : }
51 : :
52 : : /*
53 : : * Get the canonical human-readable name corresponding to a checksum type.
54 : : */
55 : : char *
56 : 0 : pg_checksum_type_name(pg_checksum_type type)
57 : : {
58 [ # # # # : 0 : switch (type)
# # # ]
59 : : {
60 : : case CHECKSUM_TYPE_NONE:
61 : 0 : return "NONE";
62 : : case CHECKSUM_TYPE_CRC32C:
63 : 0 : return "CRC32C";
64 : : case CHECKSUM_TYPE_SHA224:
65 : 0 : return "SHA224";
66 : : case CHECKSUM_TYPE_SHA256:
67 : 0 : return "SHA256";
68 : : case CHECKSUM_TYPE_SHA384:
69 : 0 : return "SHA384";
70 : : case CHECKSUM_TYPE_SHA512:
71 : 0 : return "SHA512";
72 : : }
73 : :
74 : 0 : Assert(false);
75 : 0 : return "???";
76 : 0 : }
77 : :
78 : : /*
79 : : * Initialize a checksum context for checksums of the given type.
80 : : * Returns 0 for a success, -1 for a failure.
81 : : */
82 : : int
83 : 0 : pg_checksum_init(pg_checksum_context *context, pg_checksum_type type)
84 : : {
85 : 0 : context->type = type;
86 : :
87 [ # # # # : 0 : switch (type)
# # ]
88 : : {
89 : : case CHECKSUM_TYPE_NONE:
90 : : /* do nothing */
91 : : break;
92 : : case CHECKSUM_TYPE_CRC32C:
93 : 0 : INIT_CRC32C(context->raw_context.c_crc32c);
94 : 0 : break;
95 : : case CHECKSUM_TYPE_SHA224:
96 : 0 : context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA224);
97 [ # # ]: 0 : if (context->raw_context.c_sha2 == NULL)
98 : 0 : return -1;
99 [ # # ]: 0 : if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
100 : : {
101 : 0 : pg_cryptohash_free(context->raw_context.c_sha2);
102 : 0 : return -1;
103 : : }
104 : 0 : break;
105 : : case CHECKSUM_TYPE_SHA256:
106 : 0 : context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA256);
107 [ # # ]: 0 : if (context->raw_context.c_sha2 == NULL)
108 : 0 : return -1;
109 [ # # ]: 0 : if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
110 : : {
111 : 0 : pg_cryptohash_free(context->raw_context.c_sha2);
112 : 0 : return -1;
113 : : }
114 : 0 : break;
115 : : case CHECKSUM_TYPE_SHA384:
116 : 0 : context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA384);
117 [ # # ]: 0 : if (context->raw_context.c_sha2 == NULL)
118 : 0 : return -1;
119 [ # # ]: 0 : if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
120 : : {
121 : 0 : pg_cryptohash_free(context->raw_context.c_sha2);
122 : 0 : return -1;
123 : : }
124 : 0 : break;
125 : : case CHECKSUM_TYPE_SHA512:
126 : 0 : context->raw_context.c_sha2 = pg_cryptohash_create(PG_SHA512);
127 [ # # ]: 0 : if (context->raw_context.c_sha2 == NULL)
128 : 0 : return -1;
129 [ # # ]: 0 : if (pg_cryptohash_init(context->raw_context.c_sha2) < 0)
130 : : {
131 : 0 : pg_cryptohash_free(context->raw_context.c_sha2);
132 : 0 : return -1;
133 : : }
134 : 0 : break;
135 : : }
136 : :
137 : 0 : return 0;
138 : 0 : }
139 : :
140 : : /*
141 : : * Update a checksum context with new data.
142 : : * Returns 0 for a success, -1 for a failure.
143 : : */
144 : : int
145 : 0 : pg_checksum_update(pg_checksum_context *context, const uint8 *input,
146 : : size_t len)
147 : : {
148 [ # # # ]: 0 : switch (context->type)
149 : : {
150 : : case CHECKSUM_TYPE_NONE:
151 : : /* do nothing */
152 : : break;
153 : : case CHECKSUM_TYPE_CRC32C:
154 : 0 : COMP_CRC32C(context->raw_context.c_crc32c, input, len);
155 : 0 : break;
156 : : case CHECKSUM_TYPE_SHA224:
157 : : case CHECKSUM_TYPE_SHA256:
158 : : case CHECKSUM_TYPE_SHA384:
159 : : case CHECKSUM_TYPE_SHA512:
160 [ # # ]: 0 : if (pg_cryptohash_update(context->raw_context.c_sha2, input, len) < 0)
161 : 0 : return -1;
162 : 0 : break;
163 : : }
164 : :
165 : 0 : return 0;
166 : 0 : }
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 : : */
175 : : int
176 : 0 : pg_checksum_final(pg_checksum_context *context, uint8 *output)
177 : : {
178 : 0 : 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 [ # # # # : 0 : switch (context->type)
# # ]
192 : : {
193 : : case CHECKSUM_TYPE_NONE:
194 : : break;
195 : : case CHECKSUM_TYPE_CRC32C:
196 : 0 : FIN_CRC32C(context->raw_context.c_crc32c);
197 : 0 : retval = sizeof(pg_crc32c);
198 : 0 : memcpy(output, &context->raw_context.c_crc32c, retval);
199 : 0 : break;
200 : : case CHECKSUM_TYPE_SHA224:
201 : 0 : retval = PG_SHA224_DIGEST_LENGTH;
202 : 0 : if (pg_cryptohash_final(context->raw_context.c_sha2,
203 [ # # # # ]: 0 : output, retval) < 0)
204 : 0 : return -1;
205 : 0 : pg_cryptohash_free(context->raw_context.c_sha2);
206 : 0 : break;
207 : : case CHECKSUM_TYPE_SHA256:
208 : 0 : retval = PG_SHA256_DIGEST_LENGTH;
209 : 0 : if (pg_cryptohash_final(context->raw_context.c_sha2,
210 [ # # # # ]: 0 : output, retval) < 0)
211 : 0 : return -1;
212 : 0 : pg_cryptohash_free(context->raw_context.c_sha2);
213 : 0 : break;
214 : : case CHECKSUM_TYPE_SHA384:
215 : 0 : retval = PG_SHA384_DIGEST_LENGTH;
216 : 0 : if (pg_cryptohash_final(context->raw_context.c_sha2,
217 [ # # # # ]: 0 : output, retval) < 0)
218 : 0 : return -1;
219 : 0 : pg_cryptohash_free(context->raw_context.c_sha2);
220 : 0 : break;
221 : : case CHECKSUM_TYPE_SHA512:
222 : 0 : retval = PG_SHA512_DIGEST_LENGTH;
223 : 0 : if (pg_cryptohash_final(context->raw_context.c_sha2,
224 [ # # # # ]: 0 : output, retval) < 0)
225 : 0 : return -1;
226 : 0 : pg_cryptohash_free(context->raw_context.c_sha2);
227 : 0 : break;
228 : : }
229 : :
230 [ # # ]: 0 : Assert(retval <= PG_CHECKSUM_MAX_LENGTH);
231 : 0 : return retval;
232 : 0 : }
|
