1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35
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. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, 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 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85 . \" simple accents for nroff and troff
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
129 .\" ========================================================================
131 .IX Title "RSA_check_key 3"
132 .TH RSA_check_key 3 "2007-03-15" "0.9.8e" "OpenSSL"
134 RSA_check_key \- validate private RSA keys
136 .IX Header "SYNOPSIS"
138 \& #include <openssl/rsa.h>
142 \& int RSA_check_key(RSA *rsa);
145 .IX Header "DESCRIPTION"
146 This function validates \s-1RSA\s0 keys. It checks that \fBp\fR and \fBq\fR are
147 in fact prime, and that \fBn = p*q\fR.
149 It also checks that \fBd*e = 1 mod (p\-1*q\-1)\fR,
150 and that \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR are set correctly or are \fB\s-1NULL\s0\fR.
152 As such, this function can not be used with any arbitrary \s-1RSA\s0 key object,
153 even if it is otherwise fit for regular \s-1RSA\s0 operation. See \fB\s-1NOTES\s0\fR for more
156 .IX Header "RETURN VALUE"
157 \&\fIRSA_check_key()\fR returns 1 if \fBrsa\fR is a valid \s-1RSA\s0 key, and 0 otherwise.
158 \&\-1 is returned if an error occurs while checking the key.
160 If the key is invalid or an error occurred, the reason code can be
161 obtained using \fIERR_get_error\fR\|(3).
164 This function does not work on \s-1RSA\s0 public keys that have only the modulus
165 and public exponent elements populated. It performs integrity checks on all
166 the \s-1RSA\s0 key material, so the \s-1RSA\s0 key structure must contain all the private
169 Unlike most other \s-1RSA\s0 functions, this function does \fBnot\fR work
170 transparently with any underlying \s-1ENGINE\s0 implementation because it uses the
171 key data in the \s-1RSA\s0 structure directly. An \s-1ENGINE\s0 implementation can
172 override the way key data is stored and handled, and can even provide
173 support for \s-1HSM\s0 keys \- in which case the \s-1RSA\s0 structure may contain \fBno\fR
174 key data at all! If the \s-1ENGINE\s0 in question is only being used for
175 acceleration or analysis purposes, then in all likelihood the \s-1RSA\s0 key data
176 is complete and untouched, but this can't be assumed in the general case.
179 A method of verifying the \s-1RSA\s0 key using opaque \s-1RSA\s0 \s-1API\s0 functions might need
180 to be considered. Right now \fIRSA_check_key()\fR simply uses the \s-1RSA\s0 structure
181 elements directly, bypassing the \s-1RSA_METHOD\s0 table altogether (and
182 completely violating encapsulation and object-orientation in the process).
183 The best fix will probably be to introduce a \*(L"\fIcheck_key()\fR\*(R" handler to the
184 \&\s-1RSA_METHOD\s0 function table so that alternative implementations can also
185 provide their own verifiers.
187 .IX Header "SEE ALSO"
188 \&\fIrsa\fR\|(3), \fIERR_get_error\fR\|(3)
191 \&\fIRSA_check_key()\fR appeared in OpenSSL 0.9.4.