diff options
Diffstat (limited to 'src/lib/libcrypto/doc/rsa.pod')
-rw-r--r-- | src/lib/libcrypto/doc/rsa.pod | 123 |
1 files changed, 0 insertions, 123 deletions
diff --git a/src/lib/libcrypto/doc/rsa.pod b/src/lib/libcrypto/doc/rsa.pod deleted file mode 100644 index 45ac53ffc1..0000000000 --- a/src/lib/libcrypto/doc/rsa.pod +++ /dev/null | |||
@@ -1,123 +0,0 @@ | |||
1 | =pod | ||
2 | |||
3 | =head1 NAME | ||
4 | |||
5 | rsa - RSA public key cryptosystem | ||
6 | |||
7 | =head1 SYNOPSIS | ||
8 | |||
9 | #include <openssl/rsa.h> | ||
10 | #include <openssl/engine.h> | ||
11 | |||
12 | RSA * RSA_new(void); | ||
13 | void RSA_free(RSA *rsa); | ||
14 | |||
15 | int RSA_public_encrypt(int flen, unsigned char *from, | ||
16 | unsigned char *to, RSA *rsa, int padding); | ||
17 | int RSA_private_decrypt(int flen, unsigned char *from, | ||
18 | unsigned char *to, RSA *rsa, int padding); | ||
19 | int RSA_private_encrypt(int flen, unsigned char *from, | ||
20 | unsigned char *to, RSA *rsa,int padding); | ||
21 | int RSA_public_decrypt(int flen, unsigned char *from, | ||
22 | unsigned char *to, RSA *rsa,int padding); | ||
23 | |||
24 | int RSA_sign(int type, unsigned char *m, unsigned int m_len, | ||
25 | unsigned char *sigret, unsigned int *siglen, RSA *rsa); | ||
26 | int RSA_verify(int type, unsigned char *m, unsigned int m_len, | ||
27 | unsigned char *sigbuf, unsigned int siglen, RSA *rsa); | ||
28 | |||
29 | int RSA_size(const RSA *rsa); | ||
30 | |||
31 | RSA *RSA_generate_key(int num, unsigned long e, | ||
32 | void (*callback)(int,int,void *), void *cb_arg); | ||
33 | |||
34 | int RSA_check_key(RSA *rsa); | ||
35 | |||
36 | int RSA_blinding_on(RSA *rsa, BN_CTX *ctx); | ||
37 | void RSA_blinding_off(RSA *rsa); | ||
38 | |||
39 | void RSA_set_default_method(const RSA_METHOD *meth); | ||
40 | const RSA_METHOD *RSA_get_default_method(void); | ||
41 | int RSA_set_method(RSA *rsa, const RSA_METHOD *meth); | ||
42 | const RSA_METHOD *RSA_get_method(const RSA *rsa); | ||
43 | RSA_METHOD *RSA_PKCS1_SSLeay(void); | ||
44 | RSA_METHOD *RSA_null_method(void); | ||
45 | int RSA_flags(const RSA *rsa); | ||
46 | RSA *RSA_new_method(ENGINE *engine); | ||
47 | |||
48 | int RSA_print(BIO *bp, RSA *x, int offset); | ||
49 | int RSA_print_fp(FILE *fp, RSA *x, int offset); | ||
50 | |||
51 | int RSA_get_ex_new_index(long argl, char *argp, int (*new_func)(), | ||
52 | int (*dup_func)(), void (*free_func)()); | ||
53 | int RSA_set_ex_data(RSA *r,int idx,char *arg); | ||
54 | char *RSA_get_ex_data(RSA *r, int idx); | ||
55 | |||
56 | int RSA_sign_ASN1_OCTET_STRING(int dummy, unsigned char *m, | ||
57 | unsigned int m_len, unsigned char *sigret, unsigned int *siglen, | ||
58 | RSA *rsa); | ||
59 | int RSA_verify_ASN1_OCTET_STRING(int dummy, unsigned char *m, | ||
60 | unsigned int m_len, unsigned char *sigbuf, unsigned int siglen, | ||
61 | RSA *rsa); | ||
62 | |||
63 | =head1 DESCRIPTION | ||
64 | |||
65 | These functions implement RSA public key encryption and signatures | ||
66 | as defined in PKCS #1 v2.0 [RFC 2437]. | ||
67 | |||
68 | The B<RSA> structure consists of several BIGNUM components. It can | ||
69 | contain public as well as private RSA keys: | ||
70 | |||
71 | struct | ||
72 | { | ||
73 | BIGNUM *n; // public modulus | ||
74 | BIGNUM *e; // public exponent | ||
75 | BIGNUM *d; // private exponent | ||
76 | BIGNUM *p; // secret prime factor | ||
77 | BIGNUM *q; // secret prime factor | ||
78 | BIGNUM *dmp1; // d mod (p-1) | ||
79 | BIGNUM *dmq1; // d mod (q-1) | ||
80 | BIGNUM *iqmp; // q^-1 mod p | ||
81 | // ... | ||
82 | }; | ||
83 | RSA | ||
84 | |||
85 | In public keys, the private exponent and the related secret values are | ||
86 | B<NULL>. | ||
87 | |||
88 | B<p>, B<q>, B<dmp1>, B<dmq1> and B<iqmp> may be B<NULL> in private | ||
89 | keys, but the RSA operations are much faster when these values are | ||
90 | available. | ||
91 | |||
92 | Note that RSA keys may use non-standard B<RSA_METHOD> implementations, | ||
93 | either directly or by the use of B<ENGINE> modules. In some cases (eg. an | ||
94 | ENGINE providing support for hardware-embedded keys), these BIGNUM values | ||
95 | will not be used by the implementation or may be used for alternative data | ||
96 | storage. For this reason, applications should generally avoid using RSA | ||
97 | structure elements directly and instead use API functions to query or | ||
98 | modify keys. | ||
99 | |||
100 | =head1 CONFORMING TO | ||
101 | |||
102 | SSL, PKCS #1 v2.0 | ||
103 | |||
104 | =head1 PATENTS | ||
105 | |||
106 | RSA was covered by a US patent which expired in September 2000. | ||
107 | |||
108 | =head1 SEE ALSO | ||
109 | |||
110 | L<rsa(1)|rsa(1)>, L<bn(3)|bn(3)>, L<dsa(3)|dsa(3)>, L<dh(3)|dh(3)>, | ||
111 | L<rand(3)|rand(3)>, L<engine(3)|engine(3)>, L<RSA_new(3)|RSA_new(3)>, | ||
112 | L<RSA_public_encrypt(3)|RSA_public_encrypt(3)>, | ||
113 | L<RSA_sign(3)|RSA_sign(3)>, L<RSA_size(3)|RSA_size(3)>, | ||
114 | L<RSA_generate_key(3)|RSA_generate_key(3)>, | ||
115 | L<RSA_check_key(3)|RSA_check_key(3)>, | ||
116 | L<RSA_blinding_on(3)|RSA_blinding_on(3)>, | ||
117 | L<RSA_set_method(3)|RSA_set_method(3)>, L<RSA_print(3)|RSA_print(3)>, | ||
118 | L<RSA_get_ex_new_index(3)|RSA_get_ex_new_index(3)>, | ||
119 | L<RSA_private_encrypt(3)|RSA_private_encrypt(3)>, | ||
120 | L<RSA_sign_ASN1_OCTET_STRING(3)|RSA_sign_ASN1_OCTET_STRING(3)>, | ||
121 | L<RSA_padding_add_PKCS1_type_1(3)|RSA_padding_add_PKCS1_type_1(3)> | ||
122 | |||
123 | =cut | ||