05ea606a25
Fix some code examples, trailing whitespace Fix TBA sections in verify, remove others. Remove empty sections Use Mixed Case not ALL CAPS in head2 Enhance doc-nits script. Remove extra =cut line Reviewed-by: Richard Levitte <levitte@openssl.org>
112 lines
3.6 KiB
Text
112 lines
3.6 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
rsa - RSA public key cryptosystem
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/rsa.h>
|
|
#include <openssl/engine.h>
|
|
|
|
RSA * RSA_new(void);
|
|
void RSA_free(RSA *rsa);
|
|
|
|
int RSA_public_encrypt(int flen, unsigned char *from,
|
|
unsigned char *to, RSA *rsa, int padding);
|
|
int RSA_private_decrypt(int flen, unsigned char *from,
|
|
unsigned char *to, RSA *rsa, int padding);
|
|
int RSA_private_encrypt(int flen, unsigned char *from,
|
|
unsigned char *to, RSA *rsa,int padding);
|
|
int RSA_public_decrypt(int flen, unsigned char *from,
|
|
unsigned char *to, RSA *rsa,int padding);
|
|
|
|
int RSA_sign(int type, unsigned char *m, unsigned int m_len,
|
|
unsigned char *sigret, unsigned int *siglen, RSA *rsa);
|
|
int RSA_verify(int type, unsigned char *m, unsigned int m_len,
|
|
unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
|
|
|
|
RSA *RSA_generate_key(int num, unsigned long e,
|
|
void (*callback)(int,int,void *), void *cb_arg);
|
|
|
|
int RSA_check_key(RSA *rsa);
|
|
|
|
int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
|
|
void RSA_blinding_off(RSA *rsa);
|
|
|
|
void RSA_set_default_method(const RSA_METHOD *meth);
|
|
const RSA_METHOD *RSA_get_default_method(void);
|
|
int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
|
|
const RSA_METHOD *RSA_get_method(const RSA *rsa);
|
|
RSA_METHOD *RSA_PKCS1_OpenSSL(void);
|
|
RSA_METHOD *RSA_null_method(void);
|
|
int RSA_flags(const RSA *rsa);
|
|
RSA *RSA_new_method(ENGINE *engine);
|
|
|
|
int RSA_print(BIO *bp, RSA *x, int offset);
|
|
int RSA_print_fp(FILE *fp, RSA *x, int offset);
|
|
|
|
int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
|
|
unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
|
|
RSA *rsa);
|
|
int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
|
|
unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
|
|
RSA *rsa);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
These functions implement RSA public key encryption and signatures
|
|
as defined in PKCS #1 v2.0 [RFC 2437].
|
|
|
|
The B<RSA> structure consists of the BIGNUM components B<n>, B<e>,
|
|
B<d>, B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp>, which represent public
|
|
as well as private RSA keys.
|
|
|
|
In public keys, the private exponent B<d> and the related secret
|
|
values B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp> are B<NULL>.
|
|
|
|
B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp> may be B<NULL> in private
|
|
keys, but the RSA operations are much faster when these values are
|
|
available.
|
|
|
|
Note that RSA keys may use non-standard B<RSA_METHOD> implementations,
|
|
either directly or by the use of B<ENGINE> modules. In some cases (eg. an
|
|
ENGINE providing support for hardware-embedded keys), these BIGNUM values
|
|
will not be used by the implementation or may be used for alternative data
|
|
storage. For this reason, applications should generally avoid using RSA
|
|
structure elements directly and instead use API functions to query or
|
|
modify keys.
|
|
|
|
=head1 CONFORMING TO
|
|
|
|
SSL, PKCS #1 v2.0
|
|
|
|
=head1 PATENTS
|
|
|
|
RSA was covered by a US patent which expired in September 2000.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<rsa(1)>, L<bn(3)>, L<dsa(3)>, L<dh(3)>,
|
|
L<rand(3)>, L<engine(3)>, L<RSA_new(3)>, L<RSA_set0_key(3)>
|
|
L<RSA_public_encrypt(3)>,
|
|
L<RSA_sign(3)>, L<RSA_size(3)>,
|
|
L<RSA_generate_key(3)>,
|
|
L<RSA_check_key(3)>,
|
|
L<RSA_blinding_on(3)>,
|
|
L<RSA_set_method(3)>, L<RSA_print(3)>,
|
|
L<RSA_get_ex_new_index(3)>,
|
|
L<RSA_private_encrypt(3)>,
|
|
L<RSA_sign_ASN1_OCTET_STRING(3)>,
|
|
L<RSA_padding_add_PKCS1_type_1(3)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the OpenSSL license (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|