$NetBSD: openssl_rsa.3,v 1.7 2013/02/12 19:52:15 christos Exp $

Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20)

Standard preamble:
========================================================================
..

..

.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is turned on, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
. de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} . de IX .. .\}
Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "rsa 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
rsa - RSA public key cryptosystem libcrypto, -lcrypto Header "SYNOPSIS" .Vb 2 #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); \& int RSA_size(const 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_SSLeay(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_get_ex_new_index(long argl, char *argp, int (*new_func)(), int (*dup_func)(), void (*free_func)()); int RSA_set_ex_data(RSA *r,int idx,char *arg); char *RSA_get_ex_data(RSA *r, int idx); \& 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); .Ve Header "DESCRIPTION" These functions implement \s-1RSA\s0 public key encryption and signatures as defined in \s-1PKCS\s0 #1 v2.0 [\s-1RFC\s0 2437].

The \s-1RSA\s0 structure consists of several \s-1BIGNUM\s0 components. It can contain public as well as private \s-1RSA\s0 keys:

.Vb 10 struct { BIGNUM *n; // public modulus BIGNUM *e; // public exponent BIGNUM *d; // private exponent BIGNUM *p; // secret prime factor BIGNUM *q; // secret prime factor BIGNUM *dmp1; // d mod (p-1) BIGNUM *dmq1; // d mod (q-1) BIGNUM *iqmp; // q^-1 mod p // ... }; RSA .Ve

In public keys, the private exponent and the related secret values are \fB\s-1NULL\s0.

\fBp, q, dmp1, dmq1 and iqmp may be \s-1NULL\s0 in private keys, but the \s-1RSA\s0 operations are much faster when these values are available.

Note that \s-1RSA\s0 keys may use non-standard \s-1RSA_METHOD\s0 implementations, either directly or by the use of \s-1ENGINE\s0 modules. In some cases (eg. an \s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values will not be used by the implementation or may be used for alternative data storage. For this reason, applications should generally avoid using \s-1RSA\s0 structure elements directly and instead use \s-1API\s0 functions to query or modify keys.

Header "CONFORMING TO" \s-1SSL\s0, \s-1PKCS\s0 #1 v2.0 Header "PATENTS" \s-1RSA\s0 was covered by a \s-1US\s0 patent which expired in September 2000. Header "SEE ALSO" \fIopenssl_rsa\|(1), openssl_bn\|(3), openssl_dsa\|(3), openssl_dh\|(3), \fIopenssl_rand\|(3), engine\|(3), RSA_new\|(3), \fIRSA_public_encrypt\|(3), \fIRSA_sign\|(3), RSA_size\|(3), \fIRSA_generate_key\|(3), \fIRSA_check_key\|(3), \fIRSA_blinding_on\|(3), \fIRSA_set_method\|(3), RSA_print\|(3), \fIRSA_get_ex_new_index\|(3), \fIRSA_private_encrypt\|(3), \fIRSA_sign_ASN1_OCTET_STRING\|(3), \fIRSA_padding_add_PKCS1_type_1\|(3)