Skip to content

Commit 70d80ef

Browse files
committed
Expand the XTS documentation
Explain that XTS does not support streaming, and that the IV value is the tweak. Reviewed-by: Tomas Mraz <[email protected]> Reviewed-by: Paul Dale <[email protected]> (Merged from openssl#11461)
1 parent 94468c7 commit 70d80ef

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/man3/EVP_aes_128_gcm.pod

+7
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,13 @@ In particular, XTS-AES-128 (B<EVP_aes_128_xts>) takes input of a 256-bit key to
160160
achieve AES 128-bit security, and XTS-AES-256 (B<EVP_aes_256_xts>) takes input
161161
of a 512-bit key to achieve AES 256-bit security.
162162

163+
The XTS implementation in OpenSSL does not support streaming. That is there must
164+
only be one L<EVP_EncryptUpdate(3)> call per L<EVP_EncryptInit_ex(3)> call (and
165+
similarly with the "Decrypt" functions).
166+
167+
The I<iv> parameter to L<EVP_EncryptInit_ex(3)> or L<EVP_DecryptInit_ex(3)> is
168+
the XTS "tweak" value.
169+
163170
=back
164171

165172
=head1 RETURN VALUES

0 commit comments

Comments
 (0)