secure/lib/libcrypto/man/rsa.3

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