secure/lib/libcrypto/man/rsa.3

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