doc/crypto/RSA_set_method.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 RSA_set_default_method, RSA_get_default_method, RSA_set_method,
   6 RSA_get_method, RSA_PKCS1_OpenSSL, RSA_null_method, RSA_flags,
   7 RSA_new_method - select RSA method
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/rsa.h>
  12
  13  void RSA_set_default_method(const RSA_METHOD *meth);
  14
  15  RSA_METHOD *RSA_get_default_method(void);
  16
  17  int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
  18
  19  RSA_METHOD *RSA_get_method(const RSA *rsa);
  20
  21  RSA_METHOD *RSA_PKCS1_OpenSSL(void);
  22
  23  RSA_METHOD *RSA_null_method(void);
  24
  25  int RSA_flags(const RSA *rsa);
  26
  27  RSA *RSA_new_method(ENGINE *engine);
  28
  29 =head1 DESCRIPTION
  30
  31 An B<RSA_METHOD> specifies the functions that OpenSSL uses for RSA
  32 operations. By modifying the method, alternative implementations such as
  33 hardware accelerators may be used. IMPORTANT: See the NOTES section for
  34 important information about how these RSA API functions are affected by the
  35 use of B<ENGINE> API calls.
  36
  37 Initially, the default RSA_METHOD is the OpenSSL internal implementation,
  38 as returned by RSA_PKCS1_OpenSSL().
  39
  40 RSA_set_default_method() makes B<meth> the default method for all RSA
  41 structures created later. B<NB>: This is true only whilst no ENGINE has
  42 been set as a default for RSA, so this function is no longer recommended.
  43
  44 RSA_get_default_method() returns a pointer to the current default
  45 RSA_METHOD. However, the meaningfulness of this result is dependent on
  46 whether the ENGINE API is being used, so this function is no longer
  47 recommended.
  48
  49 RSA_set_method() selects B<meth> to perform all operations using the key
  50 B<rsa>. This will replace the RSA_METHOD used by the RSA key and if the
  51 previous method was supplied by an ENGINE, the handle to that ENGINE will
  52 be released during the change. It is possible to have RSA keys that only
  53 work with certain RSA_METHOD implementations (eg. from an ENGINE module
  54 that supports embedded hardware-protected keys), and in such cases
  55 attempting to change the RSA_METHOD for the key can have unexpected
  56 results.
  57
  58 RSA_get_method() returns a pointer to the RSA_METHOD being used by B<rsa>.
  59 This method may or may not be supplied by an ENGINE implementation, but if
  60 it is, the return value can only be guaranteed to be valid as long as the
  61 RSA key itself is valid and does not have its implementation changed by
  62 RSA_set_method().
  63
  64 RSA_flags() returns the B<flags> that are set for B<rsa>'s current
  65 RSA_METHOD. See the BUGS section.
  66
  67 RSA_new_method() allocates and initializes an RSA structure so that
  68 B<engine> will be used for the RSA operations. If B<engine> is NULL, the
  69 default ENGINE for RSA operations is used, and if no default ENGINE is set,
  70 the RSA_METHOD controlled by RSA_set_default_method() is used.
  71
  72 RSA_flags() returns the B<flags> that are set for B<rsa>'s current method.
  73
  74 RSA_new_method() allocates and initializes an B<RSA> structure so that
  75 B<method> will be used for the RSA operations. If B<method> is B<NULL>,
  76 the default method is used.
  77
  78 =head1 THE RSA_METHOD STRUCTURE
  79
  80  typedef struct rsa_meth_st
  81  {
  82      /* name of the implementation */
  83         const char *name;
  84
  85      /* encrypt */
  86         int (*rsa_pub_enc)(int flen, unsigned char *from,
  87           unsigned char *to, RSA *rsa, int padding);
  88
  89      /* verify arbitrary data */
  90         int (*rsa_pub_dec)(int flen, unsigned char *from,
  91           unsigned char *to, RSA *rsa, int padding);
  92
  93      /* sign arbitrary data */
  94         int (*rsa_priv_enc)(int flen, unsigned char *from,
  95           unsigned char *to, RSA *rsa, int padding);
  96
  97      /* decrypt */
  98         int (*rsa_priv_dec)(int flen, unsigned char *from,
  99           unsigned char *to, RSA *rsa, int padding);
 100
 101      /* compute r0 = r0 ^ I mod rsa->n (May be NULL for some
 102                                         implementations) */
 103         int (*rsa_mod_exp)(BIGNUM *r0, BIGNUM *I, RSA *rsa);
 104
 105      /* compute r = a ^ p mod m (May be NULL for some implementations) */
 106         int (*bn_mod_exp)(BIGNUM *r, BIGNUM *a, const BIGNUM *p,
 107           const BIGNUM *m, BN_CTX *ctx, BN_MONT_CTX *m_ctx);
 108
 109      /* called at RSA_new */
 110         int (*init)(RSA *rsa);
 111
 112      /* called at RSA_free */
 113         int (*finish)(RSA *rsa);
 114
 115      /* RSA_FLAG_EXT_PKEY        - rsa_mod_exp is called for private key
 116       *                            operations, even if p,q,dmp1,dmq1,iqmp
 117       *                            are NULL
 118       * RSA_METHOD_FLAG_NO_CHECK - don't check pub/private match
 119       */
 120         int flags;
 121
 122         char *app_data; /* ?? */
 123
 124         int (*rsa_sign)(int type,
 125                 const unsigned char *m, unsigned int m_length,
 126                 unsigned char *sigret, unsigned int *siglen, const RSA *rsa);
 127         int (*rsa_verify)(int dtype,
 128                 const unsigned char *m, unsigned int m_length,
 129                 const unsigned char *sigbuf, unsigned int siglen,
 130                                                                 const RSA *rsa);
 131      /* keygen. If NULL builtin RSA key generation will be used */
 132         int (*rsa_keygen)(RSA *rsa, int bits, BIGNUM *e, BN_GENCB *cb);
 133
 134  } RSA_METHOD;
 135
 136 =head1 RETURN VALUES
 137
 138 RSA_PKCS1_OpenSSL(), RSA_PKCS1_null_method(), RSA_get_default_method()
 139 and RSA_get_method() return pointers to the respective RSA_METHODs.
 140
 141 RSA_set_default_method() returns no value.
 142
 143 RSA_set_method() returns a pointer to the old RSA_METHOD implementation
 144 that was replaced. However, this return value should probably be ignored
 145 because if it was supplied by an ENGINE, the pointer could be invalidated
 146 at any time if the ENGINE is unloaded (in fact it could be unloaded as a
 147 result of the RSA_set_method() function releasing its handle to the
 148 ENGINE). For this reason, the return type may be replaced with a B<void>
 149 declaration in a future release.
 150
 151 RSA_new_method() returns NULL and sets an error code that can be obtained
 152 by L<ERR_get_error(3)> if the allocation fails. Otherwise
 153 it returns a pointer to the newly allocated structure.
 154
 155 =head1 BUGS
 156
 157 The behaviour of RSA_flags() is a mis-feature that is left as-is for now
 158 to avoid creating compatibility problems. RSA functionality, such as the
 159 encryption functions, are controlled by the B<flags> value in the RSA key
 160 itself, not by the B<flags> value in the RSA_METHOD attached to the RSA key
 161 (which is what this function returns). If the flags element of an RSA key
 162 is changed, the changes will be honoured by RSA functionality but will not
 163 be reflected in the return value of the RSA_flags() function - in effect
 164 RSA_flags() behaves more like an RSA_default_flags() function (which does
 165 not currently exist).
 166
 167 =head1 SEE ALSO
 168
 169 L<RSA_new(3)>
 170
 171 =head1 COPYRIGHT
 172
 173 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 174
 175 Licensed under the OpenSSL license (the "License").  You may not use
 176 this file except in compliance with the License.  You can obtain a copy
 177 in the file LICENSE in the source distribution or at
 178 L<https://www.openssl.org/source/license.html>.
 179
 180 =cut