diff options
| author | Peter Eisentraut | 2023-03-09 08:59:46 +0000 |
|---|---|---|
| committer | Peter Eisentraut | 2023-03-09 08:59:46 +0000 |
| commit | 36ea345f8fa616fd9b40576310e54145aa70c1a1 (patch) | |
| tree | f7bce78a325999071b42b73f519adaa92b81451a | |
| parent | 544b452a5a598dd14d7a38d15a778932e58d18b0 (diff) | |
Improve/correct comments
Change comments for pg_cryptohash_init(), pg_cryptohash_update(),
pg_cryptohash_final() in cryptohash.c to match cryptohash_openssl.c.
In particular, the claim that these functions were "designed" to never
fail was incorrect, since by design callers need to be prepared to
handle failures, for compatibility with the cryptohash_openssl.c
versions.
Reviewed-by: Daniel Gustafsson <[email protected]>
Discussion: https://www.postgresql.org/message-id/[email protected]
| -rw-r--r-- | src/common/cryptohash.c | 11 |
1 files changed, 3 insertions, 8 deletions
diff --git a/src/common/cryptohash.c b/src/common/cryptohash.c index b3da9a99bd..42dbed7226 100644 --- a/src/common/cryptohash.c +++ b/src/common/cryptohash.c @@ -94,8 +94,7 @@ pg_cryptohash_create(pg_cryptohash_type type) /* * pg_cryptohash_init * - * Initialize a hash context. Note that this implementation is designed - * to never fail, so this always returns 0. + * Initialize a hash context. Returns 0 on success, and -1 on failure. */ int pg_cryptohash_init(pg_cryptohash_ctx *ctx) @@ -131,9 +130,7 @@ pg_cryptohash_init(pg_cryptohash_ctx *ctx) /* * pg_cryptohash_update * - * Update a hash context. Note that this implementation is designed - * to never fail, so this always returns 0 except if the caller has - * given a NULL context. + * Update a hash context. Returns 0 on success, and -1 on failure. */ int pg_cryptohash_update(pg_cryptohash_ctx *ctx, const uint8 *data, size_t len) @@ -169,9 +166,7 @@ pg_cryptohash_update(pg_cryptohash_ctx *ctx, const uint8 *data, size_t len) /* * pg_cryptohash_final * - * Finalize a hash context. Note that this implementation is designed to - * never fail, so this always returns 0 except if the destination buffer - * is not large enough. + * Finalize a hash context. Returns 0 on success, and -1 on failure. */ int pg_cryptohash_final(pg_cryptohash_ctx *ctx, uint8 *dest, size_t len) |