secure/lib/libcrypto/man/RSA_set_method.3

   1 .\" Automatically generated by Pod::Man version 1.15
   2 .\" Wed Feb 19 16:42:59 2003
   3 .\"
   4 .\" Standard preamble:
   5 .\" ======================================================================
   6 .de Sh \" Subsection heading
   7 .br
   8 .if t .Sp
   9 .ne 5
  10 .PP
  11 \fB\\$1\fR
  12 .PP
  13 ..
  14 .de Sp \" Vertical space (when we can't use .PP)
  15 .if t .sp .5v
  16 .if n .sp
  17 ..
  18 .de Ip \" List item
  19 .br
  20 .ie \\n(.$>=3 .ne \\$3
  21 .el .ne 3
  22 .IP "\\$1" \\$2
  23 ..
  24 .de Vb \" Begin verbatim text
  25 .ft CW
  26 .nf
  27 .ne \\$1
  28 ..
  29 .de Ve \" End verbatim text
  30 .ft R
  31
  32 .fi
  33 ..
  34 .\" Set up some character translations and predefined strings.  \*(-- will
  35 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  36 .\" double quote, and \*(R" will give a right double quote.  | will give a
  37 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
  38 .\" to do unbreakable dashes and therefore won't be available.  \*(C` and
  39 .\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
  40 .tr \(*W-|\(bv\*(Tr
  41 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  42 .ie n \{\
  43 .    ds -- \(*W-
  44 .    ds PI pi
  45 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  46 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  47 .    ds L" ""
  48 .    ds R" ""
  49 .    ds C` ""
  50 .    ds C' ""
  51 'br\}
  52 .el\{\
  53 .    ds -- \|\(em\|
  54 .    ds PI \(*p
  55 .    ds L" ``
  56 .    ds R" ''
  57 'br\}
  58 .\"
  59 .\" If the F register is turned on, we'll generate index entries on stderr
  60 .\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  61 .\" index entries marked with X<> in POD.  Of course, you'll have to process
  62 .\" the output yourself in some meaningful fashion.
  63 .if \nF \{\
  64 .    de IX
  65 .    tm Index:\\$1\t\\n%\t"\\$2"
  66 ..
  67 .    nr % 0
  68 .    rr F
  69 .\}
  70 .\"
  71 .\" For nroff, turn off justification.  Always turn off hyphenation; it
  72 .\" makes way too many mistakes in technical documents.
  73 .hy 0
  74 .if n .na
  75 .\"
  76 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  77 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  78 .bd B 3
  79 .    \" fudge factors for nroff and troff
  80 .if n \{\
  81 .    ds #H 0
  82 .    ds #V .8m
  83 .    ds #F .3m
  84 .    ds #[ \f1
  85 .    ds #] \fP
  86 .\}
  87 .if t \{\
  88 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  89 .    ds #V .6m
  90 .    ds #F 0
  91 .    ds #[ \&
  92 .    ds #] \&
  93 .\}
  94 .    \" simple accents for nroff and troff
  95 .if n \{\
  96 .    ds ' \&
  97 .    ds ` \&
  98 .    ds ^ \&
  99 .    ds , \&
 100 .    ds ~ ~
 101 .    ds /
 102 .\}
 103 .if t \{\
 104 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 105 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 106 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 107 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 108 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 109 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 110 .\}
 111 .    \" troff and (daisy-wheel) nroff accents
 112 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 113 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 114 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 115 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 116 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 117 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 118 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 119 .ds ae a\h'-(\w'a'u*4/10)'e
 120 .ds Ae A\h'-(\w'A'u*4/10)'E
 121 .    \" corrections for vroff
 122 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 123 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 124 .    \" for low resolution devices (crt and lpr)
 125 .if \n(.H>23 .if \n(.V>19 \
 126 \{\
 127 .    ds : e
 128 .    ds 8 ss
 129 .    ds o a
 130 .    ds d- d\h'-1'\(ga
 131 .    ds D- D\h'-1'\(hy
 132 .    ds th \o'bp'
 133 .    ds Th \o'LP'
 134 .    ds ae ae
 135 .    ds Ae AE
 136 .\}
 137 .rm #[ #] #H #V #F C
 138 .\" ======================================================================
 139 .\"
 140 .IX Title "RSA_set_method 3"
 141 .TH RSA_set_method 3 "0.9.7a" "2003-02-19" "OpenSSL"
 142 .UC
 143 .SH "NAME"
 144 RSA_set_default_method, RSA_get_default_method, RSA_set_method,
 145 RSA_get_method, RSA_PKCS1_SSLeay, RSA_null_method, RSA_flags,
 146 RSA_new_method \- select \s-1RSA\s0 method
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 .Vb 1
 150 \& #include <openssl/rsa.h>
 151 .Ve
 152 .Vb 1
 153 \& void RSA_set_default_method(const RSA_METHOD *meth);
 154 .Ve
 155 .Vb 1
 156 \& RSA_METHOD *RSA_get_default_method(void);
 157 .Ve
 158 .Vb 1
 159 \& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
 160 .Ve
 161 .Vb 1
 162 \& RSA_METHOD *RSA_get_method(const RSA *rsa);
 163 .Ve
 164 .Vb 1
 165 \& RSA_METHOD *RSA_PKCS1_SSLeay(void);
 166 .Ve
 167 .Vb 1
 168 \& RSA_METHOD *RSA_null_method(void);
 169 .Ve
 170 .Vb 1
 171 \& int RSA_flags(const RSA *rsa);
 172 .Ve
 173 .Vb 1
 174 \& RSA *RSA_new_method(RSA_METHOD *method);
 175 .Ve
 176 .SH "DESCRIPTION"
 177 .IX Header "DESCRIPTION"
 178 An \fB\s-1RSA_METHOD\s0\fR specifies the functions that OpenSSL uses for \s-1RSA\s0
 179 operations. By modifying the method, alternative implementations such as
 180 hardware accelerators may be used. \s-1IMPORTANT:\s0 See the \s-1NOTES\s0 section for
 181 important information about how these \s-1RSA\s0 \s-1API\s0 functions are affected by the
 182 use of \fB\s-1ENGINE\s0\fR \s-1API\s0 calls.
 183 .PP
 184 Initially, the default \s-1RSA_METHOD\s0 is the OpenSSL internal implementation,
 185 as returned by \fIRSA_PKCS1_SSLeay()\fR.
 186 .PP
 187 \&\fIRSA_set_default_method()\fR makes \fBmeth\fR the default method for all \s-1RSA\s0
 188 structures created later. \fB\s-1NB\s0\fR: This is true only whilst no \s-1ENGINE\s0 has
 189 been set as a default for \s-1RSA\s0, so this function is no longer recommended.
 190 .PP
 191 \&\fIRSA_get_default_method()\fR returns a pointer to the current default
 192 \&\s-1RSA_METHOD\s0. However, the meaningfulness of this result is dependant on
 193 whether the \s-1ENGINE\s0 \s-1API\s0 is being used, so this function is no longer
 194 recommended.
 195 .PP
 196 \&\fIRSA_set_method()\fR selects \fBmeth\fR to perform all operations using the key
 197 \&\fBrsa\fR. This will replace the \s-1RSA_METHOD\s0 used by the \s-1RSA\s0 key and if the
 198 previous method was supplied by an \s-1ENGINE\s0, the handle to that \s-1ENGINE\s0 will
 199 be released during the change. It is possible to have \s-1RSA\s0 keys that only
 200 work with certain \s-1RSA_METHOD\s0 implementations (eg. from an \s-1ENGINE\s0 module
 201 that supports embedded hardware-protected keys), and in such cases
 202 attempting to change the \s-1RSA_METHOD\s0 for the key can have unexpected
 203 results.
 204 .PP
 205 \&\fIRSA_get_method()\fR returns a pointer to the \s-1RSA_METHOD\s0 being used by \fBrsa\fR.
 206 This method may or may not be supplied by an \s-1ENGINE\s0 implementation, but if
 207 it is, the return value can only be guaranteed to be valid as long as the
 208 \&\s-1RSA\s0 key itself is valid and does not have its implementation changed by
 209 \&\fIRSA_set_method()\fR.
 210 .PP
 211 \&\fIRSA_flags()\fR returns the \fBflags\fR that are set for \fBrsa\fR's current
 212 \&\s-1RSA_METHOD\s0. See the \s-1BUGS\s0 section.
 213 .PP
 214 \&\fIRSA_new_method()\fR allocates and initializes an \s-1RSA\s0 structure so that
 215 \&\fBengine\fR will be used for the \s-1RSA\s0 operations. If \fBengine\fR is \s-1NULL\s0, the
 216 default \s-1ENGINE\s0 for \s-1RSA\s0 operations is used, and if no default \s-1ENGINE\s0 is set,
 217 the \s-1RSA_METHOD\s0 controlled by \fIRSA_set_default_method()\fR is used.
 218 .PP
 219 \&\fIRSA_flags()\fR returns the \fBflags\fR that are set for \fBrsa\fR's current method.
 220 .PP
 221 \&\fIRSA_new_method()\fR allocates and initializes an \fB\s-1RSA\s0\fR structure so that
 222 \&\fBmethod\fR will be used for the \s-1RSA\s0 operations. If \fBmethod\fR is \fB\s-1NULL\s0\fR,
 223 the default method is used.
 224 .SH "THE RSA_METHOD STRUCTURE"
 225 .IX Header "THE RSA_METHOD STRUCTURE"
 226 .Vb 4
 227 \& typedef struct rsa_meth_st
 228 \& {
 229 \&     /* name of the implementation */
 230 \&        const char *name;
 231 .Ve
 232 .Vb 3
 233 \&     /* encrypt */
 234 \&        int (*rsa_pub_enc)(int flen, unsigned char *from,
 235 \&          unsigned char *to, RSA *rsa, int padding);
 236 .Ve
 237 .Vb 3
 238 \&     /* verify arbitrary data */
 239 \&        int (*rsa_pub_dec)(int flen, unsigned char *from,
 240 \&          unsigned char *to, RSA *rsa, int padding);
 241 .Ve
 242 .Vb 3
 243 \&     /* sign arbitrary data */
 244 \&        int (*rsa_priv_enc)(int flen, unsigned char *from,
 245 \&          unsigned char *to, RSA *rsa, int padding);
 246 .Ve
 247 .Vb 3
 248 \&     /* decrypt */
 249 \&        int (*rsa_priv_dec)(int flen, unsigned char *from,
 250 \&          unsigned char *to, RSA *rsa, int padding);
 251 .Ve
 252 .Vb 3
 253 \&     /* compute r0 = r0 ^ I mod rsa->n (May be NULL for some
 254 \&                                        implementations) */
 255 \&        int (*rsa_mod_exp)(BIGNUM *r0, BIGNUM *I, RSA *rsa);
 256 .Ve
 257 .Vb 3
 258 \&     /* compute r = a ^ p mod m (May be NULL for some implementations) */
 259 \&        int (*bn_mod_exp)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
 260 \&          const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 261 .Ve
 262 .Vb 2
 263 \&     /* called at RSA_new */
 264 \&        int (*init)(RSA *rsa);
 265 .Ve
 266 .Vb 2
 267 \&     /* called at RSA_free */
 268 \&        int (*finish)(RSA *rsa);
 269 .Ve
 270 .Vb 7
 271 \&     /* RSA_FLAG_EXT_PKEY        - rsa_mod_exp is called for private key
 272 \&      *                            operations, even if p,q,dmp1,dmq1,iqmp
 273 \&      *                            are NULL
 274 \&      * RSA_FLAG_SIGN_VER        - enable rsa_sign and rsa_verify
 275 \&      * RSA_METHOD_FLAG_NO_CHECK - don't check pub/private match
 276 \&      */
 277 \&        int flags;
 278 .Ve
 279 .Vb 1
 280 \&        char *app_data; /* ?? */
 281 .Ve
 282 .Vb 5
 283 \&     /* sign. For backward compatibility, this is used only
 284 \&      * if (flags & RSA_FLAG_SIGN_VER)
 285 \&      */
 286 \&        int (*rsa_sign)(int type, unsigned char *m, unsigned int m_len,
 287 \&           unsigned char *sigret, unsigned int *siglen, RSA *rsa);
 288 .Ve
 289 .Vb 5
 290 \&     /* verify. For backward compatibility, this is used only
 291 \&      * if (flags & RSA_FLAG_SIGN_VER)
 292 \&      */
 293 \&        int (*rsa_verify)(int type, unsigned char *m, unsigned int m_len,
 294 \&           unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
 295 .Ve
 296 .Vb 1
 297 \& } RSA_METHOD;
 298 .Ve
 299 .SH "RETURN VALUES"
 300 .IX Header "RETURN VALUES"
 301 \&\fIRSA_PKCS1_SSLeay()\fR, \fIRSA_PKCS1_null_method()\fR, \fIRSA_get_default_method()\fR
 302 and \fIRSA_get_method()\fR return pointers to the respective RSA_METHODs.
 303 .PP
 304 \&\fIRSA_set_default_method()\fR returns no value.
 305 .PP
 306 \&\fIRSA_set_method()\fR returns a pointer to the old \s-1RSA_METHOD\s0 implementation
 307 that was replaced. However, this return value should probably be ignored
 308 because if it was supplied by an \s-1ENGINE\s0, the pointer could be invalidated
 309 at any time if the \s-1ENGINE\s0 is unloaded (in fact it could be unloaded as a
 310 result of the \fIRSA_set_method()\fR function releasing its handle to the
 311 \&\s-1ENGINE\s0). For this reason, the return type may be replaced with a \fBvoid\fR
 312 declaration in a future release.
 313 .PP
 314 \&\fIRSA_new_method()\fR returns \s-1NULL\s0 and sets an error code that can be obtained
 315 by ERR_get_error(3) if the allocation fails. Otherwise
 316 it returns a pointer to the newly allocated structure.
 317 .SH "NOTES"
 318 .IX Header "NOTES"
 319 As of version 0.9.7, \s-1RSA_METHOD\s0 implementations are grouped together with
 320 other algorithmic APIs (eg. \s-1DSA_METHOD\s0, \s-1EVP_CIPHER\s0, etc) into \fB\s-1ENGINE\s0\fR
 321 modules. If a default \s-1ENGINE\s0 is specified for \s-1RSA\s0 functionality using an
 322 \&\s-1ENGINE\s0 \s-1API\s0 function, that will override any \s-1RSA\s0 defaults set using the \s-1RSA\s0
 323 \&\s-1API\s0 (ie.  \fIRSA_set_default_method()\fR). For this reason, the \s-1ENGINE\s0 \s-1API\s0 is the
 324 recommended way to control default implementations for use in \s-1RSA\s0 and other
 325 cryptographic algorithms.
 326 .SH "BUGS"
 327 .IX Header "BUGS"
 328 The behaviour of \fIRSA_flags()\fR is a mis-feature that is left as-is for now
 329 to avoid creating compatibility problems. \s-1RSA\s0 functionality, such as the
 330 encryption functions, are controlled by the \fBflags\fR value in the \s-1RSA\s0 key
 331 itself, not by the \fBflags\fR value in the \s-1RSA_METHOD\s0 attached to the \s-1RSA\s0 key
 332 (which is what this function returns). If the flags element of an \s-1RSA\s0 key
 333 is changed, the changes will be honoured by \s-1RSA\s0 functionality but will not
 334 be reflected in the return value of the \fIRSA_flags()\fR function \- in effect
 335 \&\fIRSA_flags()\fR behaves more like an \fIRSA_default_flags()\fR function (which does
 336 not currently exist).
 337 .SH "SEE ALSO"
 338 .IX Header "SEE ALSO"
 339 rsa(3), RSA_new(3)
 340 .SH "HISTORY"
 341 .IX Header "HISTORY"
 342 \&\fIRSA_new_method()\fR and \fIRSA_set_default_method()\fR appeared in SSLeay 0.8.
 343 \&\fIRSA_get_default_method()\fR, \fIRSA_set_method()\fR and \fIRSA_get_method()\fR as
 344 well as the rsa_sign and rsa_verify components of \s-1RSA_METHOD\s0 were
 345 added in OpenSSL 0.9.4.
 346 .PP
 347 \&\fIRSA_set_default_openssl_method()\fR and \fIRSA_get_default_openssl_method()\fR
 348 replaced \fIRSA_set_default_method()\fR and \fIRSA_get_default_method()\fR
 349 respectively, and \fIRSA_set_method()\fR and \fIRSA_new_method()\fR were altered to use
 350 \&\fB\s-1ENGINE\s0\fRs rather than \fB\s-1RSA_METHOD\s0\fRs during development of the engine
 351 version of OpenSSL 0.9.6. For 0.9.7, the handling of defaults in the \s-1ENGINE\s0
 352 \&\s-1API\s0 was restructured so that this change was reversed, and behaviour of the
 353 other functions resembled more closely the previous behaviour. The
 354 behaviour of defaults in the \s-1ENGINE\s0 \s-1API\s0 now transparently overrides the
 355 behaviour of defaults in the \s-1RSA\s0 \s-1API\s0 without requiring changing these
 356 function prototypes.