EVP_KEM-RSA.7ossl 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118
  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_KEM-RSA 7ossl"
  58. .TH EVP_KEM-RSA 7ossl 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_KEM\-RSA
  65. \&\- EVP_KEM RSA keytype and algorithm support
  66. .SH DESCRIPTION
  67. .IX Header "DESCRIPTION"
  68. The \fBRSA\fR keytype and its parameters are described in \fBEVP_PKEY\-RSA\fR\|(7).
  69. See \fBEVP_PKEY_encapsulate\fR\|(3) and \fBEVP_PKEY_decapsulate\fR\|(3) for more info.
  70. .SS "RSA KEM parameters"
  71. .IX Subsection "RSA KEM parameters"
  72. .IP """operation"" (\fBOSSL_KEM_PARAM_OPERATION\fR) <UTF8 string>" 4
  73. .IX Item """operation"" (OSSL_KEM_PARAM_OPERATION) <UTF8 string>"
  74. The OpenSSL RSA Key Encapsulation Mechanism only currently supports the
  75. following operation
  76. .RS 4
  77. .IP """RSASVE""" 4
  78. .IX Item """RSASVE"""
  79. The encapsulate function simply generates a secret using random bytes and then
  80. encrypts the secret using the RSA public key (with no padding).
  81. The decapsulate function recovers the secret using the RSA private key.
  82. .RE
  83. .RS 4
  84. .Sp
  85. This can be set using \fBEVP_PKEY_CTX_set_kem_op()\fR.
  86. .RE
  87. .IP """fips-indicator"" (\fBOSSL_KEM_PARAM_FIPS_APPROVED_INDICATOR\fR) <integer>" 4
  88. .IX Item """fips-indicator"" (OSSL_KEM_PARAM_FIPS_APPROVED_INDICATOR) <integer>"
  89. .PD 0
  90. .IP """key-check"" (\fBOSSL_KEM_PARAM_FIPS_KEY_CHECK\fR) <integer>" 4
  91. .IX Item """key-check"" (OSSL_KEM_PARAM_FIPS_KEY_CHECK) <integer>"
  92. .PD
  93. These parameters are described in \fBprovider\-kem\fR\|(7).
  94. .SH "CONFORMING TO"
  95. .IX Header "CONFORMING TO"
  96. .IP SP800\-56Br2 4
  97. .IX Item "SP800-56Br2"
  98. Section 7.2.1.2 RSASVE Generate Operation (RSASVE.GENERATE).
  99. Section 7.2.1.3 RSASVE Recovery Operation (RSASVE.RECOVER).
  100. .SH "SEE ALSO"
  101. .IX Header "SEE ALSO"
  102. \&\fBEVP_PKEY_CTX_set_kem_op\fR\|(3),
  103. \&\fBEVP_PKEY_encapsulate\fR\|(3),
  104. \&\fBEVP_PKEY_decapsulate\fR\|(3)
  105. \&\fBEVP_KEYMGMT\fR\|(3),
  106. \&\fBEVP_PKEY\fR\|(3),
  107. \&\fBprovider\-keymgmt\fR\|(7)
  108. .SH HISTORY
  109. .IX Header "HISTORY"
  110. This functionality was added in OpenSSL 3.0.
  111. .SH COPYRIGHT
  112. .IX Header "COPYRIGHT"
  113. Copyright 2020\-2024 The OpenSSL Project Authors. All Rights Reserved.
  114. .PP
  115. Licensed under the Apache License 2.0 (the "License"). You may not use
  116. this file except in compliance with the License. You can obtain a copy
  117. in the file LICENSE in the source distribution or at
  118. <https://www.openssl.org/source/license.html>.