d2i_PrivateKey.pod revision 306195 
1=pod
2
3=head1 NAME
4
5d2i_Private_key, d2i_AutoPrivateKey, i2d_PrivateKey - decode and encode
6functions for reading and saving EVP_PKEY structures.
7
8=head1 SYNOPSIS
9
10 #include <openssl/evp.h>
11
12 EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **a, const unsigned char **pp,
13                          long length);
14 EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **a, const unsigned char **pp,
15                              long length);
16 int i2d_PrivateKey(EVP_PKEY *a, unsigned char **pp);
17
18=head1 DESCRIPTION
19
20d2i_PrivateKey() decodes a private key using algorithm B<type>. It attempts to
21use any key specific format or PKCS#8 unencrypted PrivateKeyInfo format. The
22B<type> parameter should be a public key algorithm constant such as
23B<EVP_PKEY_RSA>. An error occurs if the decoded key does not match B<type>.
24
25d2i_AutoPrivateKey() is similar to d2i_PrivateKey() except it attempts to
26automatically detect the private key format.
27
28i2d_PrivateKey() encodes B<key>. It uses a key specific format or, if none is
29defined for that key type, PKCS#8 unencrypted PrivateKeyInfo format.
30
31These functions are similar to the d2i_X509() functions, and you should refer to
32that page for a detailed description (see L<d2i_X509(3)>).
33
34=head1 NOTES
35
36All these functions use DER format and unencrypted keys. Applications wishing
37to encrypt or decrypt private keys should use other functions such as
38d2i_PKC8PrivateKey() instead.
39
40If the B<*a> is not NULL when calling d2i_PrivateKey() or d2i_AutoPrivateKey()
41(i.e. an existing structure is being reused) and the key format is PKCS#8
42then B<*a> will be freed and replaced on a successful call.
43
44=head1 RETURN VALUES
45
46d2i_PrivateKey() and d2i_AutoPrivateKey() return a valid B<EVP_KEY> structure
47or B<NULL> if an error occurs. The error code can be obtained by calling
48L<ERR_get_error(3)>.
49
50i2d_PrivateKey() returns the number of bytes successfully encoded or a
51negative value if an error occurs. The error code can be obtained by calling
52L<ERR_get_error(3)>.
53
54=head1 SEE ALSO
55
56L<crypto(3)>,
57L<d2i_PKCS8PrivateKey(3)>
58
59=cut
60