diff options
| author | Adam Langley <agl@google.com> | 2015-05-12 00:28:12 +0300 |
|---|---|---|
| committer | Adam Langley <agl@google.com> | 2015-05-12 02:18:43 +0300 |
| commit | 5aa8a8643851e309b48a1b5a5d91d2fd183eae52 (patch) | |
| tree | 5d052820af926d0cb6ce170ec0aee0875a0bec7c /include/openssl/aead.h | |
| parent | 9624b405a8f05a9e70ffae54096ee1fbf89c2688 (diff) | |
AEAD: allow _cleanup after failed _init.
This change makes it safe to call EVP_AEAD_CTX_cleanup after a failed
EVP_AEAD_CTX_init.
Change-Id: I608ed550e08d638cd7e941f5067edd3da4c850ab
Reviewed-on: https://boringssl-review.googlesource.com/4692
Reviewed-by: David Benjamin <davidben@chromium.org>
Reviewed-by: Adam Langley <agl@google.com>
Diffstat (limited to 'include/openssl/aead.h')
| -rw-r--r-- | include/openssl/aead.h | 9 |
1 files changed, 7 insertions, 2 deletions
diff --git a/include/openssl/aead.h b/include/openssl/aead.h index 0416bbe8..dc453e34 100644 --- a/include/openssl/aead.h +++ b/include/openssl/aead.h @@ -228,7 +228,10 @@ enum evp_aead_direction_t { * Authentication tags may be truncated by passing a size as |tag_len|. A * |tag_len| of zero indicates the default tag length and this is defined as * EVP_AEAD_DEFAULT_TAG_LENGTH for readability. - * Returns 1 on success. Otherwise returns 0 and pushes to the error stack. */ + * + * Returns 1 on success. Otherwise returns 0 and pushes to the error stack. In + * the error case, you do not need to call |EVP_AEAD_CTX_cleanup|, but it's + * harmless to do so. */ OPENSSL_EXPORT int EVP_AEAD_CTX_init(EVP_AEAD_CTX *ctx, const EVP_AEAD *aead, const uint8_t *key, size_t key_len, size_t tag_len, ENGINE *impl); @@ -240,7 +243,9 @@ OPENSSL_EXPORT int EVP_AEAD_CTX_init_with_direction( EVP_AEAD_CTX *ctx, const EVP_AEAD *aead, const uint8_t *key, size_t key_len, size_t tag_len, enum evp_aead_direction_t dir); -/* EVP_AEAD_CTX_cleanup frees any data allocated by |ctx|. */ +/* EVP_AEAD_CTX_cleanup frees any data allocated by |ctx|. It is a no-op to + * call |EVP_AEAD_CTX_cleanup| on a |EVP_AEAD_CTX| that has been |memset| to + * all zeros. */ OPENSSL_EXPORT void EVP_AEAD_CTX_cleanup(EVP_AEAD_CTX *ctx); /* EVP_AEAD_CTX_seal encrypts and authenticates |in_len| bytes from |in| and |