1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
4 .\" ========================================================================
5 .de Sh \" Subsection heading
13 .de Sp \" Vertical space (when we can't use .PP)
17 .de Vb \" Begin verbatim text
22 .de Ve \" End verbatim text
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
61 . tm Index:\\$1\t\\n%\t"\\$2"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
88 . \" simple accents for nroff and troff
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
132 .\" ========================================================================
134 .IX Title "RSA_check_key 3"
135 .TH RSA_check_key 3 "2009-04-11" "0.9.8k" "OpenSSL"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
141 RSA_check_key \- validate private RSA keys
143 .IX Header "SYNOPSIS"
145 \& #include <openssl/rsa.h>
147 \& int RSA_check_key(RSA *rsa);
150 .IX Header "DESCRIPTION"
151 This function validates \s-1RSA\s0 keys. It checks that \fBp\fR and \fBq\fR are
152 in fact prime, and that \fBn = p*q\fR.
154 It also checks that \fBd*e = 1 mod (p\-1*q\-1)\fR,
155 and that \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR are set correctly or are \fB\s-1NULL\s0\fR.
157 As such, this function can not be used with any arbitrary \s-1RSA\s0 key object,
158 even if it is otherwise fit for regular \s-1RSA\s0 operation. See \fB\s-1NOTES\s0\fR for more
161 .IX Header "RETURN VALUE"
162 \&\fIRSA_check_key()\fR returns 1 if \fBrsa\fR is a valid \s-1RSA\s0 key, and 0 otherwise.
163 \&\-1 is returned if an error occurs while checking the key.
165 If the key is invalid or an error occurred, the reason code can be
166 obtained using \fIERR_get_error\fR\|(3).
169 This function does not work on \s-1RSA\s0 public keys that have only the modulus
170 and public exponent elements populated. It performs integrity checks on all
171 the \s-1RSA\s0 key material, so the \s-1RSA\s0 key structure must contain all the private
174 Unlike most other \s-1RSA\s0 functions, this function does \fBnot\fR work
175 transparently with any underlying \s-1ENGINE\s0 implementation because it uses the
176 key data in the \s-1RSA\s0 structure directly. An \s-1ENGINE\s0 implementation can
177 override the way key data is stored and handled, and can even provide
178 support for \s-1HSM\s0 keys \- in which case the \s-1RSA\s0 structure may contain \fBno\fR
179 key data at all! If the \s-1ENGINE\s0 in question is only being used for
180 acceleration or analysis purposes, then in all likelihood the \s-1RSA\s0 key data
181 is complete and untouched, but this can't be assumed in the general case.
184 A method of verifying the \s-1RSA\s0 key using opaque \s-1RSA\s0 \s-1API\s0 functions might need
185 to be considered. Right now \fIRSA_check_key()\fR simply uses the \s-1RSA\s0 structure
186 elements directly, bypassing the \s-1RSA_METHOD\s0 table altogether (and
187 completely violating encapsulation and object-orientation in the process).
188 The best fix will probably be to introduce a \*(L"\fIcheck_key()\fR\*(R" handler to the
189 \&\s-1RSA_METHOD\s0 function table so that alternative implementations can also
190 provide their own verifiers.
192 .IX Header "SEE ALSO"
193 \&\fIrsa\fR\|(3), \fIERR_get_error\fR\|(3)
196 \&\fIRSA_check_key()\fR appeared in OpenSSL 0.9.4.