crypto/external/bsd/openssl/lib/libcrypto/man/openssl_rsa.3

   1 .\"     $NetBSD: openssl_rsa.3,v 1.14 2015/06/12 17:01:15 christos Exp $
   2 .\"
   3 .\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
   4 .\"
   5 .\" Standard preamble:
   6 .\" ========================================================================
   7 .de Sp \" Vertical space (when we can't use .PP)
   8 .if t .sp .5v
   9 .if n .sp
  10 ..
  11 .de Vb \" Begin verbatim text
  12 .ft CW
  13 .nf
  14 .ne \\$1
  15 ..
  16 .de Ve \" End verbatim text
  17 .ft R
  18 .fi
  19 ..
  20 .\" Set up some character translations and predefined strings.  \*(-- will
  21 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  22 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  23 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  24 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  25 .\" nothing in troff, for use with C<>.
  26 .tr \(*W-
  27 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  28 .ie n \{\
  29 .    ds -- \(*W-
  30 .    ds PI pi
  31 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  32 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  33 .    ds L" ""
  34 .    ds R" ""
  35 .    ds C` ""
  36 .    ds C' ""
  37 'br\}
  38 .el\{\
  39 .    ds -- \|\(em\|
  40 .    ds PI \(*p
  41 .    ds L" ``
  42 .    ds R" ''
  43 .    ds C`
  44 .    ds C'
  45 'br\}
  46 .\"
  47 .\" Escape single quotes in literal strings from groff's Unicode transform.
  48 .ie \n(.g .ds Aq \(aq
  49 .el       .ds Aq '
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .\"
  56 .\" Avoid warning from groff about undefined register 'F'.
  57 .de IX
  58 ..
  59 .nr rF 0
  60 .if \n(.g .if rF .nr rF 1
  61 .if (\n(rF:(\n(.g==0)) \{
  62 .    if \nF \{
  63 .        de IX
  64 .        tm Index:\\$1\t\\n%\t"\\$2"
  65 ..
  66 .        if !\nF==2 \{
  67 .            nr % 0
  68 .            nr F 2
  69 .        \}
  70 .    \}
  71 .\}
  72 .rr rF
  73 .\"
  74 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  75 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  76 .    \" fudge factors for nroff and troff
  77 .if n \{\
  78 .    ds #H 0
  79 .    ds #V .8m
  80 .    ds #F .3m
  81 .    ds #[ \f1
  82 .    ds #] \fP
  83 .\}
  84 .if t \{\
  85 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  86 .    ds #V .6m
  87 .    ds #F 0
  88 .    ds #[ \&
  89 .    ds #] \&
  90 .\}
  91 .    \" simple accents for nroff and troff
  92 .if n \{\
  93 .    ds ' \&
  94 .    ds ` \&
  95 .    ds ^ \&
  96 .    ds , \&
  97 .    ds ~ ~
  98 .    ds /
  99 .\}
 100 .if t \{\
 101 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 102 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 103 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 104 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 105 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 106 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 107 .\}
 108 .    \" troff and (daisy-wheel) nroff accents
 109 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 110 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 111 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 112 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 113 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 114 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 115 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 116 .ds ae a\h'-(\w'a'u*4/10)'e
 117 .ds Ae A\h'-(\w'A'u*4/10)'E
 118 .    \" corrections for vroff
 119 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 120 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 121 .    \" for low resolution devices (crt and lpr)
 122 .if \n(.H>23 .if \n(.V>19 \
 123 \{\
 124 .    ds : e
 125 .    ds 8 ss
 126 .    ds o a
 127 .    ds d- d\h'-1'\(ga
 128 .    ds D- D\h'-1'\(hy
 129 .    ds th \o'bp'
 130 .    ds Th \o'LP'
 131 .    ds ae ae
 132 .    ds Ae AE
 133 .\}
 134 .rm #[ #] #H #V #F C
 135 .\" ========================================================================
 136 .\"
 137 .IX Title "rsa 3"
 138 .TH rsa 3 "2009-07-19" "1.0.1n" "OpenSSL"
 139 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 140 .\" way too many mistakes in technical documents.
 141 .if n .ad l
 142 .nh
 143 .SH "NAME"
 144 rsa \- RSA public key cryptosystem
 145 .SH "LIBRARY"
 146 libcrypto, -lcrypto
 147 .SH "SYNOPSIS"
 148 .IX Header "SYNOPSIS"
 149 .Vb 2
 150 \& #include <openssl/rsa.h>
 151 \& #include <openssl/engine.h>
 152 \&
 153 \& RSA * RSA_new(void);
 154 \& void RSA_free(RSA *rsa);
 155 \&
 156 \& int RSA_public_encrypt(int flen, unsigned char *from,
 157 \&    unsigned char *to, RSA *rsa, int padding);
 158 \& int RSA_private_decrypt(int flen, unsigned char *from,
 159 \&    unsigned char *to, RSA *rsa, int padding);
 160 \& int RSA_private_encrypt(int flen, unsigned char *from,
 161 \&    unsigned char *to, RSA *rsa,int padding);
 162 \& int RSA_public_decrypt(int flen, unsigned char *from,
 163 \&    unsigned char *to, RSA *rsa,int padding);
 164 \&
 165 \& int RSA_sign(int type, unsigned char *m, unsigned int m_len,
 166 \&    unsigned char *sigret, unsigned int *siglen, RSA *rsa);
 167 \& int RSA_verify(int type, unsigned char *m, unsigned int m_len,
 168 \&    unsigned char *sigbuf, unsigned int siglen, RSA *rsa);
 169 \&
 170 \& int RSA_size(const RSA *rsa);
 171 \&
 172 \& RSA *RSA_generate_key(int num, unsigned long e,
 173 \&    void (*callback)(int,int,void *), void *cb_arg);
 174 \&
 175 \& int RSA_check_key(RSA *rsa);
 176 \&
 177 \& int RSA_blinding_on(RSA *rsa, BN_CTX *ctx);
 178 \& void RSA_blinding_off(RSA *rsa);
 179 \&
 180 \& void RSA_set_default_method(const RSA_METHOD *meth);
 181 \& const RSA_METHOD *RSA_get_default_method(void);
 182 \& int RSA_set_method(RSA *rsa, const RSA_METHOD *meth);
 183 \& const RSA_METHOD *RSA_get_method(const RSA *rsa);
 184 \& RSA_METHOD *RSA_PKCS1_SSLeay(void);
 185 \& RSA_METHOD *RSA_null_method(void);
 186 \& int RSA_flags(const RSA *rsa);
 187 \& RSA *RSA_new_method(ENGINE *engine);
 188 \&
 189 \& int RSA_print(BIO *bp, RSA *x, int offset);
 190 \& int RSA_print_fp(FILE *fp, RSA *x, int offset);
 191 \&
 192 \& int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(),
 193 \&    int (*dup_func)(), void (*free_func)());
 194 \& int RSA_set_ex_data(RSA *r,int idx,char *arg);
 195 \& char *RSA_get_ex_data(RSA *r, int idx);
 196 \&
 197 \& int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m,
 198 \&    unsigned int m_len, unsigned char *sigret, unsigned int *siglen,
 199 \&    RSA *rsa);
 200 \& int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m,
 201 \&    unsigned int m_len, unsigned char *sigbuf, unsigned int siglen,
 202 \&    RSA *rsa);
 203 .Ve
 204 .SH "DESCRIPTION"
 205 .IX Header "DESCRIPTION"
 206 These functions implement \s-1RSA\s0 public key encryption and signatures
 207 as defined in \s-1PKCS\s0 #1 v2.0 [\s-1RFC 2437\s0].
 208 .PP
 209 The \fB\s-1RSA\s0\fR structure consists of several \s-1BIGNUM\s0 components. It can
 210 contain public as well as private \s-1RSA\s0 keys:
 211 .PP
 212 .Vb 10
 213 \& struct
 214 \&        {
 215 \&        BIGNUM *n;              // public modulus
 216 \&        BIGNUM *e;              // public exponent
 217 \&        BIGNUM *d;              // private exponent
 218 \&        BIGNUM *p;              // secret prime factor
 219 \&        BIGNUM *q;              // secret prime factor
 220 \&        BIGNUM *dmp1;           // d mod (p\-1)
 221 \&        BIGNUM *dmq1;           // d mod (q\-1)
 222 \&        BIGNUM *iqmp;           // q^\-1 mod p
 223 \&        // ...
 224 \&        };
 225 \& RSA
 226 .Ve
 227 .PP
 228 In public keys, the private exponent and the related secret values are
 229 \&\fB\s-1NULL\s0\fR.
 230 .PP
 231 \&\fBp\fR, \fBq\fR, \fBdmp1\fR, \fBdmq1\fR and \fBiqmp\fR may be \fB\s-1NULL\s0\fR in private
 232 keys, but the \s-1RSA\s0 operations are much faster when these values are
 233 available.
 234 .PP
 235 Note that \s-1RSA\s0 keys may use non-standard \fB\s-1RSA_METHOD\s0\fR implementations,
 236 either directly or by the use of \fB\s-1ENGINE\s0\fR modules. In some cases (eg. an
 237 \&\s-1ENGINE\s0 providing support for hardware-embedded keys), these \s-1BIGNUM\s0 values
 238 will not be used by the implementation or may be used for alternative data
 239 storage. For this reason, applications should generally avoid using \s-1RSA\s0
 240 structure elements directly and instead use \s-1API\s0 functions to query or
 241 modify keys.
 242 .SH "CONFORMING TO"
 243 .IX Header "CONFORMING TO"
 244 \&\s-1SSL, PKCS\s0 #1 v2.0
 245 .SH "PATENTS"
 246 .IX Header "PATENTS"
 247 \&\s-1RSA\s0 was covered by a \s-1US\s0 patent which expired in September 2000.
 248 .SH "SEE ALSO"
 249 .IX Header "SEE ALSO"
 250 \&\fIopenssl_rsa\fR\|(1), \fIopenssl_bn\fR\|(3), \fIopenssl_dsa\fR\|(3), \fIopenssl_dh\fR\|(3),
 251 \&\fIopenssl_rand\fR\|(3), \fIengine\fR\|(3), \fIRSA_new\fR\|(3),
 252 \&\fIRSA_public_encrypt\fR\|(3),
 253 \&\fIRSA_sign\fR\|(3), \fIRSA_size\fR\|(3),
 254 \&\fIRSA_generate_key\fR\|(3),
 255 \&\fIRSA_check_key\fR\|(3),
 256 \&\fIRSA_blinding_on\fR\|(3),
 257 \&\fIRSA_set_method\fR\|(3), \fIRSA_print\fR\|(3),
 258 \&\fIRSA_get_ex_new_index\fR\|(3),
 259 \&\fIRSA_private_encrypt\fR\|(3),
 260 \&\fIRSA_sign_ASN1_OCTET_STRING\fR\|(3),
 261 \&\fIRSA_padding_add_PKCS1_type_1\fR\|(3)