EVP_rc5_32_12_16_cbc.pod 2.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. =pod
  2. =head1 NAME
  3. EVP_rc5_32_12_16_cbc,
  4. EVP_rc5_32_12_16_cfb,
  5. EVP_rc5_32_12_16_cfb64,
  6. EVP_rc5_32_12_16_ecb,
  7. EVP_rc5_32_12_16_ofb
  8. - EVP RC5 cipher
  9. =head1 SYNOPSIS
  10. #include <openssl/evp.h>
  11. const EVP_CIPHER *EVP_rc5_32_12_16_cbc(void);
  12. const EVP_CIPHER *EVP_rc5_32_12_16_cfb(void);
  13. const EVP_CIPHER *EVP_rc5_32_12_16_cfb64(void);
  14. const EVP_CIPHER *EVP_rc5_32_12_16_ecb(void);
  15. const EVP_CIPHER *EVP_rc5_32_12_16_ofb(void);
  16. =head1 DESCRIPTION
  17. The RC5 encryption algorithm for EVP.
  18. =over 4
  19. =item EVP_rc5_32_12_16_cbc(),
  20. EVP_rc5_32_12_16_cfb(),
  21. EVP_rc5_32_12_16_cfb64(),
  22. EVP_rc5_32_12_16_ecb(),
  23. EVP_rc5_32_12_16_ofb()
  24. RC5 encryption algorithm in CBC, CFB, ECB and OFB modes respectively. This is a
  25. variable key length cipher with an additional "number of rounds" parameter. By
  26. default the key length is set to 128 bits and 12 rounds. Alternative key lengths
  27. can be set using L<EVP_CIPHER_CTX_set_key_length(3)>. The maximum key length is
  28. 2040 bits.
  29. The following rc5 specific I<ctrl>s are supported (see
  30. L<EVP_CIPHER_CTX_ctrl(3)>).
  31. =over 4
  32. =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_SET_RC5_ROUNDS, rounds, NULL)
  33. Sets the number of rounds to B<rounds>. This must be one of RC5_8_ROUNDS,
  34. RC5_12_ROUNDS or RC5_16_ROUNDS.
  35. =item EVP_CIPHER_CTX_ctrl(ctx, EVP_CTRL_GET_RC5_ROUNDS, 0, &rounds)
  36. Stores the number of rounds currently configured in B<*rounds> where B<*rounds>
  37. is an int.
  38. =back
  39. =back
  40. =head1 NOTES
  41. Developers should be aware of the negative performance implications of
  42. calling these functions multiple times and should consider using
  43. L<EVP_CIPHER_fetch(3)> with L<EVP_CIPHER-RC5(7)> instead.
  44. See L<crypto(7)/Performance> for further information.
  45. =head1 RETURN VALUES
  46. These functions return an B<EVP_CIPHER> structure that contains the
  47. implementation of the symmetric cipher. See L<EVP_CIPHER_meth_new(3)> for
  48. details of the B<EVP_CIPHER> structure.
  49. =head1 SEE ALSO
  50. L<evp(7)>,
  51. L<EVP_EncryptInit(3)>,
  52. L<EVP_CIPHER_meth_new(3)>
  53. =head1 COPYRIGHT
  54. Copyright 2017-2023 The OpenSSL Project Authors. All Rights Reserved.
  55. Licensed under the Apache License 2.0 (the "License"). You may not use
  56. this file except in compliance with the License. You can obtain a copy
  57. in the file LICENSE in the source distribution or at
  58. L<https://www.openssl.org/source/license.html>.
  59. =cut