doc/crypto/rsa.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 rsa - RSA public key cryptosystem
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/rsa.h>
  10  #include <openssl/engine.h>
  11
  12  RSA * RSA_new(void);
  13  void RSA_free(RSA *rsa);
  14
  15  int RSA_public_encrypt(int flen, unsigned char *from,
  16     unsigned char *to, RSA *rsa, int padding);
  17  int RSA_private_decrypt(int flen, unsigned char *from,
  18     unsigned char *to, RSA *rsa, int padding);
  19  int RSA_private_encrypt(int flen, unsigned char *from,
  20     unsigned char *to, RSA *rsa,int padding);
  21  int RSA_public_decrypt(int flen, unsigned char *from,
  22     unsigned char *to, RSA *rsa,int padding);
  23
  24  int RSA_sign(int type, unsigned char *m, unsigned int m_len,
  25     unsigned char *sigret, unsigned int *siglen, RSA *rsa);
  26  int RSA_verify(int type, unsigned char *m, unsigned int m_len,
  27     unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
  28
  29  RSA *RSA_generate_key(int num, unsigned long e,
  30     void (*callback)(int,int,void *), void *cb_arg);
  31
  32  int RSA_check_key(RSA *rsa);
  33
  34  int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
  35  void RSA_blinding_off(RSA *rsa);
  36
  37  void RSA_set_default_method(const RSA_METHOD *meth);
  38  const RSA_METHOD *RSA_get_default_method(void);
  39  int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
  40  const RSA_METHOD *RSA_get_method(const RSA *rsa);
  41  RSA_METHOD *RSA_PKCS1_OpenSSL(void);
  42  RSA_METHOD *RSA_null_method(void);
  43  int RSA_flags(const RSA *rsa);
  44  RSA *RSA_new_method(ENGINE *engine);
  45
  46  int RSA_print(BIO *bp, RSA *x, int offset);
  47  int RSA_print_fp(FILE *fp, RSA *x, int offset);
  48
  49  int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
  50     unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
  51     RSA *rsa);
  52  int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
  53     unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
  54     RSA *rsa);
  55
  56 =head1 DESCRIPTION
  57
  58 These functions implement RSA public key encryption and signatures
  59 as defined in PKCS #1 v2.0 [RFC 2437].
  60
  61 The B<RSA> structure consists of the BIGNUM components B<n>, B<e>,
  62 B<d>, B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp>, which represent public
  63 as well as private RSA keys.
  64
  65 In public keys, the private exponent B<d> and the related secret
  66 values B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp> are B<NULL>.
  67
  68 B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp> may be B<NULL> in private
  69 keys, but the RSA operations are much faster when these values are
  70 available.
  71
  72 Note that RSA keys may use non-standard B<RSA_METHOD> implementations,
  73 either directly or by the use of B<ENGINE> modules. In some cases (eg. an
  74 ENGINE providing support for hardware-embedded keys), these BIGNUM values
  75 will not be used by the implementation or may be used for alternative data
  76 storage. For this reason, applications should generally avoid using RSA
  77 structure elements directly and instead use API functions to query or
  78 modify keys.
  79
  80 =head1 CONFORMING TO
  81
  82 SSL, PKCS #1 v2.0
  83
  84 =head1 PATENTS
  85
  86 RSA was covered by a US patent which expired in September 2000.
  87
  88 =head1 SEE ALSO
  89
  90 L<rsa(1)>, L<bn(3)>, L<dsa(3)>, L<dh(3)>,
  91 L<rand(3)>, L<engine(3)>, L<RSA_new(3)>, L<RSA_set0_key(3)>
  92 L<RSA_public_encrypt(3)>,
  93 L<RSA_sign(3)>, L<RSA_size(3)>,
  94 L<RSA_generate_key(3)>,
  95 L<RSA_check_key(3)>,
  96 L<RSA_blinding_on(3)>,
  97 L<RSA_set_method(3)>, L<RSA_print(3)>,
  98 L<RSA_get_ex_new_index(3)>,
  99 L<RSA_private_encrypt(3)>,
 100 L<RSA_sign_ASN1_OCTET_STRING(3)>,
 101 L<RSA_padding_add_PKCS1_type_1(3)>
 102
 103 =head1 COPYRIGHT
 104
 105 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 106
 107 Licensed under the OpenSSL license (the "License").  You may not use
 108 this file except in compliance with the License.  You can obtain a copy
 109 in the file LICENSE in the source distribution or at
 110 L<https://www.openssl.org/source/license.html>.
 111
 112 =cut