diff options
| author | David Benjamin <davidben@chromium.org> | 2014-10-07 03:07:00 +0400 |
|---|---|---|
| committer | Adam Langley <agl@google.com> | 2014-10-07 03:51:31 +0400 |
| commit | 83e52bce3c42c6eeb9dc65315264c4e2c372b2e8 (patch) | |
| tree | 452b3d21849c164e255a0f4724271be219ef396c /include/openssl/sha.h | |
| parent | bce495c9f390dc17ab007e81d93f21258b3c3100 (diff) | |
HASH_UPDATE always succeeds.
Fill in some missing "and returns 1" documentation. Really they all do but some
of _Final functions have codepaths to guard against user error.
Change-Id: I16e12ec20ab59e3ba6deaa4cfd67574ed0a56652
Reviewed-on: https://boringssl-review.googlesource.com/1901
Reviewed-by: Adam Langley <agl@google.com>
Diffstat (limited to 'include/openssl/sha.h')
| -rw-r--r-- | include/openssl/sha.h | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/include/openssl/sha.h b/include/openssl/sha.h index bc10d382..9e71ec4c 100644 --- a/include/openssl/sha.h +++ b/include/openssl/sha.h @@ -116,7 +116,7 @@ struct sha_state_st { /* SHA224_Init initialises |sha| and returns 1. */ OPENSSL_EXPORT int SHA224_Init(SHA256_CTX *sha); -/* SHA224_Update adds |len| bytes from |data| to |sha|. */ +/* SHA224_Update adds |len| bytes from |data| to |sha| and returns 1. */ OPENSSL_EXPORT int SHA224_Update(SHA256_CTX *sha, const void *data, size_t len); /* SHA224_Final adds the final padding to |sha| and writes the resulting digest @@ -140,7 +140,7 @@ OPENSSL_EXPORT uint8_t *SHA224(const uint8_t *data, size_t len, uint8_t *out); /* SHA256_Init initialises |sha| and returns 1. */ OPENSSL_EXPORT int SHA256_Init(SHA256_CTX *sha); -/* SHA256_Update adds |len| bytes from |data| to |sha|. */ +/* SHA256_Update adds |len| bytes from |data| to |sha| and returns 1. */ OPENSSL_EXPORT int SHA256_Update(SHA256_CTX *sha, const void *data, size_t len); /* SHA256_Final adds the final padding to |sha| and writes the resulting digest @@ -175,7 +175,7 @@ struct sha256_state_st { /* SHA384_Init initialises |sha| and returns 1. */ OPENSSL_EXPORT int SHA384_Init(SHA512_CTX *sha); -/* SHA384_Update adds |len| bytes from |data| to |sha|. */ +/* SHA384_Update adds |len| bytes from |data| to |sha| and returns 1. */ OPENSSL_EXPORT int SHA384_Update(SHA512_CTX *sha, const void *data, size_t len); /* SHA384_Final adds the final padding to |sha| and writes the resulting digest @@ -203,7 +203,7 @@ OPENSSL_EXPORT void SHA384_Transform(SHA512_CTX *sha, const uint8_t *data); /* SHA512_Init initialises |sha| and returns 1. */ OPENSSL_EXPORT int SHA512_Init(SHA512_CTX *sha); -/* SHA512_Update adds |len| bytes from |data| to |sha|. */ +/* SHA512_Update adds |len| bytes from |data| to |sha| and returns 1. */ OPENSSL_EXPORT int SHA512_Update(SHA512_CTX *sha, const void *data, size_t len); /* SHA512_Final adds the final padding to |sha| and writes the resulting digest |