1 .\" Automatically generated by Pod::Man 2.12 (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 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
57 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
126 .IX Title "RSA_check_key 3"
127 .TH RSA_check_key 3 "2007-10-24" "0.9.8g" "OpenSSL"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 RSA_check_key \- validate private RSA keys
135 .IX Header "SYNOPSIS"
137 \& #include <openssl/rsa.h>
139 \& int RSA_check_key(RSA *rsa);
142 .IX Header "DESCRIPTION"
143 This function validates \s-1RSA\s0 keys. It checks that \fBp\fR and \fBq\fR are
144 in fact prime, and that \fBn = p*q\fR.
146 It also checks that \fBd*e = 1 mod (p\-1*q\-1)\fR,
147 and that \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR are set correctly or are \fB\s-1NULL\s0\fR.
149 As such, this function can not be used with any arbitrary \s-1RSA\s0 key object,
150 even if it is otherwise fit for regular \s-1RSA\s0 operation. See \fB\s-1NOTES\s0\fR for more
153 .IX Header "RETURN VALUE"
154 \&\fIRSA_check_key()\fR returns 1 if \fBrsa\fR is a valid \s-1RSA\s0 key, and 0 otherwise.
155 \&\-1 is returned if an error occurs while checking the key.
157 If the key is invalid or an error occurred, the reason code can be
158 obtained using \fIERR_get_error\fR\|(3).
161 This function does not work on \s-1RSA\s0 public keys that have only the modulus
162 and public exponent elements populated. 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
166 Unlike most other \s-1RSA\s0 functions, this function does \fBnot\fR work
167 transparently with any underlying \s-1ENGINE\s0 implementation because it uses the
168 key data in the \s-1RSA\s0 structure directly. An \s-1ENGINE\s0 implementation can
169 override the way key data is stored and handled, and can even provide
170 support for \s-1HSM\s0 keys \- in which case the \s-1RSA\s0 structure may contain \fBno\fR
171 key data at all! If the \s-1ENGINE\s0 in question is only being used for
172 acceleration or analysis purposes, then in all likelihood the \s-1RSA\s0 key data
173 is complete and untouched, but this can't be assumed in the general case.
176 A method of verifying the \s-1RSA\s0 key using opaque \s-1RSA\s0 \s-1API\s0 functions might need
177 to be considered. Right now \fIRSA_check_key()\fR simply uses the \s-1RSA\s0 structure
178 elements directly, bypassing the \s-1RSA_METHOD\s0 table altogether (and
179 completely violating encapsulation and object-orientation in the process).
180 The best fix will probably be to introduce a \*(L"\fIcheck_key()\fR\*(R" handler to the
181 \&\s-1RSA_METHOD\s0 function table so that alternative implementations can also
182 provide their own verifiers.
184 .IX Header "SEE ALSO"
185 \&\fIrsa\fR\|(3), \fIERR_get_error\fR\|(3)
188 \&\fIRSA_check_key()\fR appeared in OpenSSL 0.9.4.