EVP_rc4.3ossl 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  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_RC4 3ossl"
  58. .TH EVP_RC4 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_rc4,
  65. EVP_rc4_40,
  66. EVP_rc4_hmac_md5
  67. \&\- EVP RC4 stream cipher
  68. .SH SYNOPSIS
  69. .IX Header "SYNOPSIS"
  70. .Vb 1
  71. \& #include <openssl/evp.h>
  72. \&
  73. \& const EVP_CIPHER *EVP_rc4(void);
  74. \& const EVP_CIPHER *EVP_rc4_40(void);
  75. \& const EVP_CIPHER *EVP_rc4_hmac_md5(void);
  76. .Ve
  77. .SH DESCRIPTION
  78. .IX Header "DESCRIPTION"
  79. The RC4 stream cipher for EVP.
  80. .IP \fBEVP_rc4()\fR 4
  81. .IX Item "EVP_rc4()"
  82. RC4 stream cipher. This is a variable key length cipher with a default key
  83. length of 128 bits.
  84. .IP \fBEVP_rc4_40()\fR 4
  85. .IX Item "EVP_rc4_40()"
  86. RC4 stream cipher with 40 bit key length.
  87. .Sp
  88. WARNING: this function is obsolete. Its usage should be replaced with the
  89. \&\fBEVP_rc4()\fR and the \fBEVP_CIPHER_CTX_set_key_length()\fR functions.
  90. .IP \fBEVP_rc4_hmac_md5()\fR 4
  91. .IX Item "EVP_rc4_hmac_md5()"
  92. Authenticated encryption with the RC4 stream cipher with MD5 as HMAC.
  93. .Sp
  94. WARNING: this is not intended for usage outside of TLS and requires calling of
  95. some undocumented ctrl functions. These ciphers do not conform to the EVP AEAD
  96. interface.
  97. .SH NOTES
  98. .IX Header "NOTES"
  99. Developers should be aware of the negative performance implications of
  100. calling these functions multiple times and should consider using
  101. \&\fBEVP_CIPHER_fetch\fR\|(3) with \fBEVP_CIPHER\-RC4\fR\|(7) instead.
  102. See "Performance" in \fBcrypto\fR\|(7) for further information.
  103. .SH "RETURN VALUES"
  104. .IX Header "RETURN VALUES"
  105. These functions return an \fBEVP_CIPHER\fR structure that contains the
  106. implementation of the symmetric cipher. See \fBEVP_CIPHER_meth_new\fR\|(3) for
  107. details of the \fBEVP_CIPHER\fR structure.
  108. .SH "SEE ALSO"
  109. .IX Header "SEE ALSO"
  110. \&\fBevp\fR\|(7),
  111. \&\fBEVP_EncryptInit\fR\|(3),
  112. \&\fBEVP_CIPHER_meth_new\fR\|(3)
  113. .SH COPYRIGHT
  114. .IX Header "COPYRIGHT"
  115. Copyright 2017\-2023 The OpenSSL Project Authors. All Rights Reserved.
  116. .PP
  117. Licensed under the Apache License 2.0 (the "License"). You may not use
  118. this file except in compliance with the License. You can obtain a copy
  119. in the file LICENSE in the source distribution or at
  120. <https://www.openssl.org/source/license.html>.