RT1665,2300: Crypto doc cleanups
[openssl.git] / doc / crypto / d2i_RSAPublicKey.pod
1 =pod
2
3 =head1 NAME
4
5 d2i_RSAPublicKey, i2d_RSAPublicKey, d2i_RSAPrivateKey, i2d_RSAPrivateKey,
6 d2i_RSA_PUBKEY, i2d_RSA_PUBKEY, i2d_Netscape_RSA,
7 d2i_Netscape_RSA - RSA public and private key encoding functions.
8
9 =head1 SYNOPSIS
10
11  #include <openssl/rsa.h>
12  #include <openssl/x509.h>
13
14  RSA * d2i_RSAPublicKey(RSA **a, const unsigned char **pp, long length);
15
16  int i2d_RSAPublicKey(RSA *a, unsigned char **pp);
17
18  RSA * d2i_RSA_PUBKEY(RSA **a, const unsigned char **pp, long length);
19
20  int i2d_RSA_PUBKEY(RSA *a, unsigned char **pp);
21
22  RSA * d2i_RSAPrivateKey(RSA **a, const unsigned char **pp, long length);
23
24  int i2d_RSAPrivateKey(RSA *a, unsigned char **pp);
25
26  int i2d_Netscape_RSA(RSA *a, unsigned char **pp, int (*cb)());
27
28  RSA * d2i_Netscape_RSA(RSA **a, const unsigned char **pp, long length, int (*cb)());
29
30 =head1 DESCRIPTION
31
32 d2i_RSAPublicKey() and i2d_RSAPublicKey() decode and encode a PKCS#1 RSAPublicKey
33 structure.
34
35 d2i_RSA_PUBKEY() and i2d_RSA_PUBKEY() decode and encode an RSA public key using
36 a SubjectPublicKeyInfo (certificate public key) structure.
37
38 d2i_RSAPrivateKey(), i2d_RSAPrivateKey() decode and encode a PKCS#1 RSAPrivateKey
39 structure.
40
41 d2i_Netscape_RSA(), i2d_Netscape_RSA() decode and encode an RSA private key in
42 NET format.
43
44 The usage of all of these functions is similar to the d2i_X509() and
45 i2d_X509() described in the L<d2i_X509(3)|d2i_X509(3)> manual page.
46
47 =head1 NOTES
48
49 The B<RSA> structure passed to the private key encoding functions should have
50 all the PKCS#1 private key components present.
51
52 The data encoded by the private key functions is unencrypted and therefore 
53 offers no private key security. 
54
55 The NET format functions are present to provide compatibility with certain very
56 old software. This format has some severe security weaknesses and should be
57 avoided if possible.
58
59 =head1 SEE ALSO
60
61 L<d2i_X509(3)|d2i_X509(3)>
62
63 =head1 HISTORY
64
65 TBA
66
67 =cut