EVP_rc2_cbc.3ossl 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124
  1. .\" -*- mode: troff; coding: utf-8 -*-
  2. .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
  3. .\"
  4. .\" Standard preamble:
  5. .\" ========================================================================
  6. .de Sp \" Vertical space (when we can't use .PP)
  7. .if t .sp .5v
  8. .if n .sp
  9. ..
  10. .de Vb \" Begin verbatim text
  11. .ft CW
  12. .nf
  13. .ne \\$1
  14. ..
  15. .de Ve \" End verbatim text
  16. .ft R
  17. .fi
  18. ..
  19. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
  20. .ie n \{\
  21. . ds C` ""
  22. . ds C' ""
  23. 'br\}
  24. .el\{\
  25. . ds C`
  26. . ds C'
  27. 'br\}
  28. .\"
  29. .\" Escape single quotes in literal strings from groff's Unicode transform.
  30. .ie \n(.g .ds Aq \(aq
  31. .el .ds Aq '
  32. .\"
  33. .\" If the F register is >0, we'll generate index entries on stderr for
  34. .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  35. .\" entries marked with X<> in POD. Of course, you'll have to process the
  36. .\" output yourself in some meaningful fashion.
  37. .\"
  38. .\" Avoid warning from groff about undefined register 'F'.
  39. .de IX
  40. ..
  41. .nr rF 0
  42. .if \n(.g .if rF .nr rF 1
  43. .if (\n(rF:(\n(.g==0)) \{\
  44. . if \nF \{\
  45. . de IX
  46. . tm Index:\\$1\t\\n%\t"\\$2"
  47. ..
  48. . if !\nF==2 \{\
  49. . nr % 0
  50. . nr F 2
  51. . \}
  52. . \}
  53. .\}
  54. .rr rF
  55. .\" ========================================================================
  56. .\"
  57. .IX Title "EVP_RC2_CBC 3ossl"
  58. .TH EVP_RC2_CBC 3ossl 2025-01-17 3.4.0 OpenSSL
  59. .\" For nroff, turn off justification. Always turn off hyphenation; it makes
  60. .\" way too many mistakes in technical documents.
  61. .if n .ad l
  62. .nh
  63. .SH NAME
  64. EVP_rc2_cbc,
  65. EVP_rc2_cfb,
  66. EVP_rc2_cfb64,
  67. EVP_rc2_ecb,
  68. EVP_rc2_ofb,
  69. EVP_rc2_40_cbc,
  70. EVP_rc2_64_cbc
  71. \&\- EVP RC2 cipher
  72. .SH SYNOPSIS
  73. .IX Header "SYNOPSIS"
  74. .Vb 1
  75. \& #include <openssl/evp.h>
  76. \&
  77. \& const EVP_CIPHER *EVP_rc2_cbc(void);
  78. \& const EVP_CIPHER *EVP_rc2_cfb(void);
  79. \& const EVP_CIPHER *EVP_rc2_cfb64(void);
  80. \& const EVP_CIPHER *EVP_rc2_ecb(void);
  81. \& const EVP_CIPHER *EVP_rc2_ofb(void);
  82. \& const EVP_CIPHER *EVP_rc2_40_cbc(void);
  83. \& const EVP_CIPHER *EVP_rc2_64_cbc(void);
  84. .Ve
  85. .SH DESCRIPTION
  86. .IX Header "DESCRIPTION"
  87. The RC2 encryption algorithm for EVP.
  88. .IP "\fBEVP_rc2_cbc()\fR, \fBEVP_rc2_cfb()\fR, \fBEVP_rc2_cfb64()\fR, \fBEVP_rc2_ecb()\fR, \fBEVP_rc2_ofb()\fR" 4
  89. .IX Item "EVP_rc2_cbc(), EVP_rc2_cfb(), EVP_rc2_cfb64(), EVP_rc2_ecb(), EVP_rc2_ofb()"
  90. RC2 encryption algorithm in CBC, CFB, ECB and OFB modes respectively. This is a
  91. variable key length cipher with an additional parameter called "effective key
  92. bits" or "effective key length". By default both are set to 128 bits.
  93. .IP "\fBEVP_rc2_40_cbc()\fR, \fBEVP_rc2_64_cbc()\fR" 4
  94. .IX Item "EVP_rc2_40_cbc(), EVP_rc2_64_cbc()"
  95. RC2 algorithm in CBC mode with a default key length and effective key length of
  96. 40 and 64 bits.
  97. .Sp
  98. WARNING: these functions are obsolete. Their usage should be replaced with the
  99. \&\fBEVP_rc2_cbc()\fR, \fBEVP_CIPHER_CTX_set_key_length()\fR and \fBEVP_CIPHER_CTX_ctrl()\fR
  100. functions to set the key length and effective key length.
  101. .SH NOTES
  102. .IX Header "NOTES"
  103. Developers should be aware of the negative performance implications of
  104. calling these functions multiple times and should consider using
  105. \&\fBEVP_CIPHER_fetch\fR\|(3) with \fBEVP_CIPHER\-RC2\fR\|(7) instead.
  106. See "Performance" in \fBcrypto\fR\|(7) for further information.
  107. .SH "RETURN VALUES"
  108. .IX Header "RETURN VALUES"
  109. These functions return an \fBEVP_CIPHER\fR structure that contains the
  110. implementation of the symmetric cipher. See \fBEVP_CIPHER_meth_new\fR\|(3) for
  111. details of the \fBEVP_CIPHER\fR structure.
  112. .SH "SEE ALSO"
  113. .IX Header "SEE ALSO"
  114. \&\fBevp\fR\|(7),
  115. \&\fBEVP_EncryptInit\fR\|(3),
  116. \&\fBEVP_CIPHER_meth_new\fR\|(3)
  117. .SH COPYRIGHT
  118. .IX Header "COPYRIGHT"
  119. Copyright 2017\-2023 The OpenSSL Project Authors. All Rights Reserved.
  120. .PP
  121. Licensed under the Apache License 2.0 (the "License"). You may not use
  122. this file except in compliance with the License. You can obtain a copy
  123. in the file LICENSE in the source distribution or at
  124. <https://www.openssl.org/source/license.html>.