secure/lib/libcrypto/man/man3/RSA_check_key.3

   1 .\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.40)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 .    ds C`
  42 .    ds C'
  43 'br\}
  44 .\"
  45 .\" Escape single quotes in literal strings from groff's Unicode transform.
  46 .ie \n(.g .ds Aq \(aq
  47 .el       .ds Aq '
  48 .\"
  49 .\" If the F register is >0, we'll generate index entries on stderr for
  50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  52 .\" output yourself in some meaningful fashion.
  53 .\"
  54 .\" Avoid warning from groff about undefined register 'F'.
  55 .de IX
  56 ..
  57 .nr rF 0
  58 .if \n(.g .if rF .nr rF 1
  59 .if (\n(rF:(\n(.g==0)) \{\
  60 .    if \nF \{\
  61 .        de IX
  62 .        tm Index:\\$1\t\\n%\t"\\$2"
  63 ..
  64 .        if !\nF==2 \{\
  65 .            nr % 0
  66 .            nr F 2
  67 .        \}
  68 .    \}
  69 .\}
  70 .rr rF
  71 .\"
  72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  74 .    \" fudge factors for nroff and troff
  75 .if n \{\
  76 .    ds #H 0
  77 .    ds #V .8m
  78 .    ds #F .3m
  79 .    ds #[ \f1
  80 .    ds #] \fP
  81 .\}
  82 .if t \{\
  83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  84 .    ds #V .6m
  85 .    ds #F 0
  86 .    ds #[ \&
  87 .    ds #] \&
  88 .\}
  89 .    \" simple accents for nroff and troff
  90 .if n \{\
  91 .    ds ' \&
  92 .    ds ` \&
  93 .    ds ^ \&
  94 .    ds , \&
  95 .    ds ~ ~
  96 .    ds /
  97 .\}
  98 .if t \{\
  99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 105 .\}
 106 .    \" troff and (daisy-wheel) nroff accents
 107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 114 .ds ae a\h'-(\w'a'u*4/10)'e
 115 .ds Ae A\h'-(\w'A'u*4/10)'E
 116 .    \" corrections for vroff
 117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 119 .    \" for low resolution devices (crt and lpr)
 120 .if \n(.H>23 .if \n(.V>19 \
 121 \{\
 122 .    ds : e
 123 .    ds 8 ss
 124 .    ds o a
 125 .    ds d- d\h'-1'\(ga
 126 .    ds D- D\h'-1'\(hy
 127 .    ds th \o'bp'
 128 .    ds Th \o'LP'
 129 .    ds ae ae
 130 .    ds Ae AE
 131 .\}
 132 .rm #[ #] #H #V #F C
 133 .\" ========================================================================
 134 .\"
 135 .IX Title "RSA_CHECK_KEY 3"
 136 .TH RSA_CHECK_KEY 3 "2020-03-31" "1.1.1f" "OpenSSL"
 137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 138 .\" way too many mistakes in technical documents.
 139 .if n .ad l
 140 .nh
 141 .SH "NAME"
 142 RSA_check_key_ex, RSA_check_key \- validate private RSA keys
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 .Vb 1
 146 \& #include <openssl/rsa.h>
 147 \&
 148 \& int RSA_check_key_ex(RSA *rsa, BN_GENCB *cb);
 149 \&
 150 \& int RSA_check_key(RSA *rsa);
 151 .Ve
 152 .SH "DESCRIPTION"
 153 .IX Header "DESCRIPTION"
 154 \&\fBRSA_check_key_ex()\fR function validates \s-1RSA\s0 keys.
 155 It checks that \fBp\fR and \fBq\fR are
 156 in fact prime, and that \fBn = p*q\fR.
 157 .PP
 158 It does not work on \s-1RSA\s0 public keys that have only the modulus
 159 and public exponent elements populated.
 160 It also checks that \fBd*e = 1 mod (p\-1*q\-1)\fR,
 161 and that \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR are set correctly or are \fB\s-1NULL\s0\fR.
 162 It performs integrity checks on all
 163 the \s-1RSA\s0 key material, so the \s-1RSA\s0 key structure must contain all the private
 164 key data too.
 165 Therefore, it cannot be used with any arbitrary \s-1RSA\s0 key object,
 166 even if it is otherwise fit for regular \s-1RSA\s0 operation.
 167 .PP
 168 The \fBcb\fR parameter is a callback that will be invoked in the same
 169 manner as \fBBN_is_prime_ex\fR\|(3).
 170 .PP
 171 \&\fBRSA_check_key()\fR is equivalent to \fBRSA_check_key_ex()\fR with a \s-1NULL\s0 \fBcb\fR.
 172 .SH "RETURN VALUES"
 173 .IX Header "RETURN VALUES"
 174 \&\fBRSA_check_key_ex()\fR and \fBRSA_check_key()\fR
 175 return 1 if \fBrsa\fR is a valid \s-1RSA\s0 key, and 0 otherwise.
 176 They return \-1 if an error occurs while checking the key.
 177 .PP
 178 If the key is invalid or an error occurred, the reason code can be
 179 obtained using \fBERR_get_error\fR\|(3).
 180 .SH "NOTES"
 181 .IX Header "NOTES"
 182 Unlike most other \s-1RSA\s0 functions, this function does \fBnot\fR work
 183 transparently with any underlying \s-1ENGINE\s0 implementation because it uses the
 184 key data in the \s-1RSA\s0 structure directly. An \s-1ENGINE\s0 implementation can
 185 override the way key data is stored and handled, and can even provide
 186 support for \s-1HSM\s0 keys \- in which case the \s-1RSA\s0 structure may contain \fBno\fR
 187 key data at all! If the \s-1ENGINE\s0 in question is only being used for
 188 acceleration or analysis purposes, then in all likelihood the \s-1RSA\s0 key data
 189 is complete and untouched, but this can't be assumed in the general case.
 190 .SH "BUGS"
 191 .IX Header "BUGS"
 192 A method of verifying the \s-1RSA\s0 key using opaque \s-1RSA API\s0 functions might need
 193 to be considered. Right now \fBRSA_check_key()\fR simply uses the \s-1RSA\s0 structure
 194 elements directly, bypassing the \s-1RSA_METHOD\s0 table altogether (and
 195 completely violating encapsulation and object-orientation in the process).
 196 The best fix will probably be to introduce a \*(L"\fBcheck_key()\fR\*(R" handler to the
 197 \&\s-1RSA_METHOD\s0 function table so that alternative implementations can also
 198 provide their own verifiers.
 199 .SH "SEE ALSO"
 200 .IX Header "SEE ALSO"
 201 \&\fBBN_is_prime_ex\fR\|(3),
 202 \&\fBERR_get_error\fR\|(3)
 203 .SH "HISTORY"
 204 .IX Header "HISTORY"
 205 \&\fBRSA_check_key_ex()\fR appeared after OpenSSL 1.0.2.
 206 .SH "COPYRIGHT"
 207 .IX Header "COPYRIGHT"
 208 Copyright 2000\-2018 The OpenSSL Project Authors. All Rights Reserved.
 209 .PP
 210 Licensed under the OpenSSL license (the \*(L"License\*(R").  You may not use
 211 this file except in compliance with the License.  You can obtain a copy
 212 in the file \s-1LICENSE\s0 in the source distribution or at
 213 <https://www.openssl.org/source/license.html>.