diff options
author | Richard Godbee <richard@godbee.net> | 2015-03-13 20:54:39 -0700 |
---|---|---|
committer | Dr. Stephen Henson <steve@openssl.org> | 2015-03-20 23:22:17 +0000 |
commit | 1062ecfc53622ff42edef5af63ace39c23dd3b49 (patch) | |
tree | 998b35481e4134e2b4c6e4405d90d5e1b491334c /crypto | |
parent | 3c381e54233be3d0dcbce7cc853c4767d979fe90 (diff) |
wrap128.c: Fix Doxygen comments
Reviewed-by: Stephen Henson <steve@openssl.org>
Reviewed-by: Emilia Käsper <emilia@openssl.org>
Diffstat (limited to 'crypto')
-rw-r--r-- | crypto/modes/wrap128.c | 39 |
1 files changed, 20 insertions, 19 deletions
diff --git a/crypto/modes/wrap128.c b/crypto/modes/wrap128.c index 73718ae59f..e1191e496e 100644 --- a/crypto/modes/wrap128.c +++ b/crypto/modes/wrap128.c @@ -81,9 +81,9 @@ static const unsigned char default_aiv[] = { * * @param[in] key Key value. * @param[in] iv IV value. Length = 8 bytes. NULL = use default_iv. - * @param[in] in Plain text as n 64-bit blocks, n >= 2. + * @param[in] in Plaintext as n 64-bit blocks, n >= 2. * @param[in] inlen Length of in. - * @param[out] out Cipher text. Minimal buffer length = (inlen + 8) bytes. + * @param[out] out Ciphertext. Minimal buffer length = (inlen + 8) bytes. * Input and output buffers can overlap if block function * supports that. * @param[in] block Block processing function. @@ -127,19 +127,19 @@ size_t CRYPTO_128_wrap(void *key, const unsigned char *iv, } /** Unwrapping according to RFC 3394 section 2.2.2 steps 1-2. - * IV check (step 3) is responsibility of the caller. + * The IV check (step 3) is responsibility of the caller. * * @param[in] key Key value. * @param[out] iv Unchecked IV value. Minimal buffer length = 8 bytes. - * @param[out] out Plain text without IV. + * @param[out] out Plaintext without IV. * Minimal buffer length = (inlen - 8) bytes. * Input and output buffers can overlap if block function * supports that. - * @param[in] in Ciphertext text as n 64-bit blocks + * @param[in] in Ciphertext as n 64-bit blocks. * @param[in] inlen Length of in. * @param[in] block Block processing function. * @return 0 if inlen is out of range [24, CRYPTO128_WRAP_MAX] - * or if inlen is not multiply of 8. + * or if inlen is not a multiple of 8. * Output length otherwise. */ static size_t crypto_128_unwrap_raw(void *key, unsigned char *iv, @@ -174,21 +174,22 @@ static size_t crypto_128_unwrap_raw(void *key, unsigned char *iv, return inlen; } -/** Unwrapping according to RFC 3394 section 2.2.2 including IV check. - * First block of plain text have to match supplied IV otherwise an error is - * returned. +/** Unwrapping according to RFC 3394 section 2.2.2, including the IV check. + * The first block of plaintext has to match the supplied IV, otherwise an + * error is returned. * * @param[in] key Key value. - * @param[out] iv Unchecked IV value. Minimal buffer length = 8 bytes. - * @param[out] out Plain text without IV. + * @param[out] iv IV value to match against. Length = 8 bytes. + * NULL = use default_iv. + * @param[out] out Plaintext without IV. * Minimal buffer length = (inlen - 8) bytes. * Input and output buffers can overlap if block function * supports that. - * @param[in] in Ciphertext text as n 64-bit blocks + * @param[in] in Ciphertext as n 64-bit blocks. * @param[in] inlen Length of in. * @param[in] block Block processing function. * @return 0 if inlen is out of range [24, CRYPTO128_WRAP_MAX] - * or if inlen is not multiply of 8 + * or if inlen is not a multiple of 8 * or if IV doesn't match expected value. * Output length otherwise. */ @@ -216,10 +217,10 @@ size_t CRYPTO_128_unwrap(void *key, const unsigned char *iv, * * @param[in] key Key value. * @param[in] icv (Non-standard) IV, 4 bytes. NULL = use default_aiv. - * @param[out] out Cipher text. Minimal buffer length = (inlen + 15) bytes. + * @param[out] out Ciphertext. Minimal buffer length = (inlen + 15) bytes. * Input and output buffers can overlap if block function * supports that. - * @param[in] in Plain text as n 64-bit blocks, n >= 2. + * @param[in] in Plaintext as n 64-bit blocks, n >= 2. * @param[in] inlen Length of in. * @param[in] block Block processing function. * @return 0 if inlen is out of range [1, CRYPTO128_WRAP_MAX]. @@ -282,14 +283,14 @@ size_t CRYPTO_128_wrap_pad(void *key, const unsigned char *icv, * * @param[in] key Key value. * @param[in] icv (Non-standard) IV, 4 bytes. NULL = use default_aiv. - * @param[out] out Plain text. Minimal buffer length = inlen bytes. + * @param[out] out Plaintext. Minimal buffer length = inlen bytes. * Input and output buffers can overlap if block function * supports that. - * @param[in] in Ciphertext text as n 64-bit blocks + * @param[in] in Ciphertext as n 64-bit blocks. * @param[in] inlen Length of in. * @param[in] block Block processing function. * @return 0 if inlen is out of range [16, CRYPTO128_WRAP_MAX], - * or if inlen is not multiply of 8 + * or if inlen is not a multiple of 8 * or if IV and message length indicator doesn't match. * Output length if unwrapping succeeded and IV matches. */ @@ -308,7 +309,7 @@ size_t CRYPTO_128_unwrap_pad(void *key, const unsigned char *icv, static unsigned char zeros[8] = { 0x0 }; size_t ret; - /* Section 4.2: Cipher text length has to be (n+1) 64-bit blocks. */ + /* Section 4.2: Ciphertext length has to be (n+1) 64-bit blocks. */ if ((inlen & 0x7) != 0 || inlen < 16 || inlen >= CRYPTO128_WRAP_MAX) return 0; |