1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.28) 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'br\} 42.\" 43.\" Escape single quotes in literal strings from groff's Unicode transform. 44.ie \n(.g .ds Aq \(aq 45.el .ds Aq ' 46.\" 47.\" If the F register is turned on, we'll generate index entries on stderr for 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 49.\" entries marked with X<> in POD. Of course, you'll have to process the 50.\" output yourself in some meaningful fashion. 51.ie \nF \{\ 52. de IX 53. tm Index:\\$1\t\\n%\t"\\$2" 54.. 55. nr % 0 56. rr F 57.\} 58.el \{\ 59. de IX 60.. 61.\} 62.\" 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 66.if n \{\ 67. ds #H 0 68. ds #V .8m 69. ds #F .3m 70. ds #[ \f1 71. ds #] \fP 72.\} 73.if t \{\ 74. ds #H ((1u-(\\\\n(.fu%2u))*.13m) 75. ds #V .6m 76. ds #F 0 77. ds #[ \& 78. ds #] \& 79.\} 80. \" simple accents for nroff and troff 81.if n \{\ 82. ds ' \& 83. ds ` \& 84. ds ^ \& 85. ds , \& 86. ds ~ ~ 87. ds / 88.\} 89.if t \{\ 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' 96.\} 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 \ 112\{\ 113. ds : e 114. ds 8 ss 115. ds o a 116. ds d- d\h'-1'\(ga 117. ds D- D\h'-1'\(hy 118. ds th \o'bp' 119. ds Th \o'LP' 120. ds ae ae 121. ds Ae AE 122.\} 123.rm #[ #] #H #V #F C 124.\" ======================================================================== 125.\" 126.IX Title "RSA_check_key 3"
| 1.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.28) 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'br\} 42.\" 43.\" Escape single quotes in literal strings from groff's Unicode transform. 44.ie \n(.g .ds Aq \(aq 45.el .ds Aq ' 46.\" 47.\" If the F register is turned on, we'll generate index entries on stderr for 48.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index 49.\" entries marked with X<> in POD. Of course, you'll have to process the 50.\" output yourself in some meaningful fashion. 51.ie \nF \{\ 52. de IX 53. tm Index:\\$1\t\\n%\t"\\$2" 54.. 55. nr % 0 56. rr F 57.\} 58.el \{\ 59. de IX 60.. 61.\} 62.\" 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 66.if n \{\ 67. ds #H 0 68. ds #V .8m 69. ds #F .3m 70. ds #[ \f1 71. ds #] \fP 72.\} 73.if t \{\ 74. ds #H ((1u-(\\\\n(.fu%2u))*.13m) 75. ds #V .6m 76. ds #F 0 77. ds #[ \& 78. ds #] \& 79.\} 80. \" simple accents for nroff and troff 81.if n \{\ 82. ds ' \& 83. ds ` \& 84. ds ^ \& 85. ds , \& 86. ds ~ ~ 87. ds / 88.\} 89.if t \{\ 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' 96.\} 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 \ 112\{\ 113. ds : e 114. ds 8 ss 115. ds o a 116. ds d- d\h'-1'\(ga 117. ds D- D\h'-1'\(hy 118. ds th \o'bp' 119. ds Th \o'LP' 120. ds ae ae 121. ds Ae AE 122.\} 123.rm #[ #] #H #V #F C 124.\" ======================================================================== 125.\" 126.IX Title "RSA_check_key 3"
|
127.TH RSA_check_key 3 "2014-06-05" "1.0.1h" "OpenSSL"
| 127.TH RSA_check_key 3 "2014-08-06" "1.0.1i" "OpenSSL"
|
128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 129.\" way too many mistakes in technical documents. 130.if n .ad l 131.nh 132.SH "NAME" 133RSA_check_key \- validate private RSA keys 134.SH "SYNOPSIS" 135.IX Header "SYNOPSIS" 136.Vb 1 137\& #include <openssl/rsa.h> 138\& 139\& int RSA_check_key(RSA *rsa); 140.Ve 141.SH "DESCRIPTION" 142.IX Header "DESCRIPTION" 143This function validates \s-1RSA\s0 keys. It checks that \fBp\fR and \fBq\fR are 144in fact prime, and that \fBn = p*q\fR. 145.PP 146It also checks that \fBd*e = 1 mod (p\-1*q\-1)\fR, 147and that \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR are set correctly or are \fB\s-1NULL\s0\fR. 148.PP 149As such, this function can not be used with any arbitrary \s-1RSA\s0 key object, 150even if it is otherwise fit for regular \s-1RSA\s0 operation. See \fB\s-1NOTES\s0\fR for more 151information. 152.SH "RETURN VALUE" 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. 156.PP 157If the key is invalid or an error occurred, the reason code can be 158obtained using \fIERR_get_error\fR\|(3). 159.SH "NOTES" 160.IX Header "NOTES" 161This function does not work on \s-1RSA\s0 public keys that have only the modulus 162and public exponent elements populated. It performs integrity checks on all 163the \s-1RSA\s0 key material, so the \s-1RSA\s0 key structure must contain all the private 164key data too. 165.PP 166Unlike most other \s-1RSA\s0 functions, this function does \fBnot\fR work 167transparently with any underlying \s-1ENGINE\s0 implementation because it uses the 168key data in the \s-1RSA\s0 structure directly. An \s-1ENGINE\s0 implementation can 169override the way key data is stored and handled, and can even provide 170support for \s-1HSM\s0 keys \- in which case the \s-1RSA\s0 structure may contain \fBno\fR 171key data at all! If the \s-1ENGINE\s0 in question is only being used for 172acceleration or analysis purposes, then in all likelihood the \s-1RSA\s0 key data 173is complete and untouched, but this can't be assumed in the general case. 174.SH "BUGS" 175.IX Header "BUGS" 176A method of verifying the \s-1RSA\s0 key using opaque \s-1RSA\s0 \s-1API\s0 functions might need 177to be considered. Right now \fIRSA_check_key()\fR simply uses the \s-1RSA\s0 structure 178elements directly, bypassing the \s-1RSA_METHOD\s0 table altogether (and 179completely violating encapsulation and object-orientation in the process). 180The 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 182provide their own verifiers. 183.SH "SEE ALSO" 184.IX Header "SEE ALSO" 185\&\fIrsa\fR\|(3), \fIERR_get_error\fR\|(3) 186.SH "HISTORY" 187.IX Header "HISTORY" 188\&\fIRSA_check_key()\fR appeared in OpenSSL 0.9.4.
| 128.\" For nroff, turn off justification. Always turn off hyphenation; it makes 129.\" way too many mistakes in technical documents. 130.if n .ad l 131.nh 132.SH "NAME" 133RSA_check_key \- validate private RSA keys 134.SH "SYNOPSIS" 135.IX Header "SYNOPSIS" 136.Vb 1 137\& #include <openssl/rsa.h> 138\& 139\& int RSA_check_key(RSA *rsa); 140.Ve 141.SH "DESCRIPTION" 142.IX Header "DESCRIPTION" 143This function validates \s-1RSA\s0 keys. It checks that \fBp\fR and \fBq\fR are 144in fact prime, and that \fBn = p*q\fR. 145.PP 146It also checks that \fBd*e = 1 mod (p\-1*q\-1)\fR, 147and that \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR are set correctly or are \fB\s-1NULL\s0\fR. 148.PP 149As such, this function can not be used with any arbitrary \s-1RSA\s0 key object, 150even if it is otherwise fit for regular \s-1RSA\s0 operation. See \fB\s-1NOTES\s0\fR for more 151information. 152.SH "RETURN VALUE" 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. 156.PP 157If the key is invalid or an error occurred, the reason code can be 158obtained using \fIERR_get_error\fR\|(3). 159.SH "NOTES" 160.IX Header "NOTES" 161This function does not work on \s-1RSA\s0 public keys that have only the modulus 162and public exponent elements populated. It performs integrity checks on all 163the \s-1RSA\s0 key material, so the \s-1RSA\s0 key structure must contain all the private 164key data too. 165.PP 166Unlike most other \s-1RSA\s0 functions, this function does \fBnot\fR work 167transparently with any underlying \s-1ENGINE\s0 implementation because it uses the 168key data in the \s-1RSA\s0 structure directly. An \s-1ENGINE\s0 implementation can 169override the way key data is stored and handled, and can even provide 170support for \s-1HSM\s0 keys \- in which case the \s-1RSA\s0 structure may contain \fBno\fR 171key data at all! If the \s-1ENGINE\s0 in question is only being used for 172acceleration or analysis purposes, then in all likelihood the \s-1RSA\s0 key data 173is complete and untouched, but this can't be assumed in the general case. 174.SH "BUGS" 175.IX Header "BUGS" 176A method of verifying the \s-1RSA\s0 key using opaque \s-1RSA\s0 \s-1API\s0 functions might need 177to be considered. Right now \fIRSA_check_key()\fR simply uses the \s-1RSA\s0 structure 178elements directly, bypassing the \s-1RSA_METHOD\s0 table altogether (and 179completely violating encapsulation and object-orientation in the process). 180The 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 182provide their own verifiers. 183.SH "SEE ALSO" 184.IX Header "SEE ALSO" 185\&\fIrsa\fR\|(3), \fIERR_get_error\fR\|(3) 186.SH "HISTORY" 187.IX Header "HISTORY" 188\&\fIRSA_check_key()\fR appeared in OpenSSL 0.9.4.
|