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