EVP_CIPHER-AES.pod 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. =pod
  2. =head1 NAME
  3. EVP_CIPHER-AES - The AES EVP_CIPHER implementations
  4. =head1 DESCRIPTION
  5. Support for AES symmetric encryption using the B<EVP_CIPHER> API.
  6. =head2 Algorithm Names
  7. The following algorithms are available in the FIPS provider as well as the
  8. default provider:
  9. =over 4
  10. =item "AES-128-CBC", "AES-192-CBC" and "AES-256-CBC"
  11. =item "AES-128-CBC-CTS", "AES-192-CBC-CTS" and "AES-256-CBC-CTS"
  12. =item "AES-128-CFB", "AES-192-CFB", "AES-256-CFB",
  13. "AES-128-CFB1", "AES-192-CFB1", "AES-256-CFB1",
  14. "AES-128-CFB8", "AES-192-CFB8" and "AES-256-CFB8"
  15. =item "AES-128-CTR", "AES-192-CTR" and "AES-256-CTR"
  16. =item "AES-128-ECB", "AES-192-ECB" and "AES-256-ECB"
  17. =item "AES-192-OFB", "AES-128-OFB" and "AES-256-OFB"
  18. =item "AES-128-XTS" and "AES-256-XTS"
  19. =item "AES-128-CCM", "AES-192-CCM" and "AES-256-CCM"
  20. =item "AES-128-GCM", "AES-192-GCM" and "AES-256-GCM"
  21. =item "AES-128-WRAP", "AES-192-WRAP", "AES-256-WRAP",
  22. "AES-128-WRAP-PAD", "AES-192-WRAP-PAD", "AES-256-WRAP-PAD",
  23. "AES-128-WRAP-INV", "AES-192-WRAP-INV", "AES-256-WRAP-INV",
  24. "AES-128-WRAP-PAD-INV", "AES-192-WRAP-PAD-INV" and "AES-256-WRAP-PAD-INV"
  25. =item "AES-128-CBC-HMAC-SHA1", "AES-256-CBC-HMAC-SHA1",
  26. "AES-128-CBC-HMAC-SHA256" and "AES-256-CBC-HMAC-SHA256"
  27. =back
  28. The following algorithms are available in the default provider, but not the
  29. FIPS provider:
  30. =over 4
  31. =item "AES-128-OCB", "AES-192-OCB" and "AES-256-OCB"
  32. =item "AES-128-SIV", "AES-192-SIV" and "AES-256-SIV"
  33. =item "AES-128-GCM-SIV", "AES-192-GCM-SIV" and "AES-256-GCM-SIV"
  34. =back
  35. =head2 Parameters
  36. This implementation supports the parameters described in
  37. L<EVP_EncryptInit(3)/PARAMETERS>.
  38. =head1 NOTES
  39. The AES-SIV and AES-WRAP mode implementations do not support streaming. That
  40. means to obtain correct results there can be only one L<EVP_EncryptUpdate(3)>
  41. or L<EVP_DecryptUpdate(3)> call after the initialization of the context.
  42. The AES-XTS implementations allow streaming to be performed, but each
  43. L<EVP_EncryptUpdate(3)> or L<EVP_DecryptUpdate(3)> call requires each input
  44. to be a multiple of the blocksize. Only the final EVP_EncryptUpdate() or
  45. EVP_DecryptUpdate() call can optionally have an input that is not a multiple
  46. of the blocksize but is larger than one block. In that case ciphertext
  47. stealing (CTS) is used to fill the block.
  48. =head1 SEE ALSO
  49. L<provider-cipher(7)>, L<OSSL_PROVIDER-FIPS(7)>, L<OSSL_PROVIDER-default(7)>
  50. =head1 HISTORY
  51. The GCM-SIV mode ciphers were added in OpenSSL version 3.2.
  52. =head1 COPYRIGHT
  53. Copyright 2021-2023 The OpenSSL Project Authors. All Rights Reserved.
  54. Licensed under the Apache License 2.0 (the "License"). You may not use
  55. this file except in compliance with the License. You can obtain a copy
  56. in the file LICENSE in the source distribution or at
  57. L<https://www.openssl.org/source/license.html>.
  58. =cut