1D2I_PRIVATEKEY(3)                   OpenSSL                  D2I_PRIVATEKEY(3)
2
3
4

NAME

6       d2i_PrivateKey, d2i_PublicKey, d2i_AutoPrivateKey, i2d_PrivateKey,
7       i2d_PublicKey, d2i_PrivateKey_bio, d2i_PrivateKey_fp - decode and
8       encode functions for reading and saving EVP_PKEY structures
9

SYNOPSIS

11        #include <openssl/evp.h>
12
13        EVP_PKEY *d2i_PrivateKey(int type, EVP_PKEY **a, const unsigned char **pp,
14                                 long length);
15        EVP_PKEY *d2i_PublicKey(int type, EVP_PKEY **a, const unsigned char **pp,
16                                long length);
17        EVP_PKEY *d2i_AutoPrivateKey(EVP_PKEY **a, const unsigned char **pp,
18                                     long length);
19        int i2d_PrivateKey(EVP_PKEY *a, unsigned char **pp);
20        int i2d_PublicKey(EVP_PKEY *a, unsigned char **pp);
21
22        EVP_PKEY *d2i_PrivateKey_bio(BIO *bp, EVP_PKEY **a);
23        EVP_PKEY *d2i_PrivateKey_fp(FILE *fp, EVP_PKEY **a)
24

DESCRIPTION

26       d2i_PrivateKey() decodes a private key using algorithm type. It
27       attempts to use any key specific format or PKCS#8 unencrypted
28       PrivateKeyInfo format. The type parameter should be a public key
29       algorithm constant such as EVP_PKEY_RSA. An error occurs if the decoded
30       key does not match type.  d2i_PublicKey() does the same for public
31       keys.
32
33       d2i_AutoPrivateKey() is similar to d2i_PrivateKey() except it attempts
34       to automatically detect the private key format.
35
36       i2d_PrivateKey() encodes key. It uses a key specific format or, if none
37       is defined for that key type, PKCS#8 unencrypted PrivateKeyInfo format.
38       i2d_PublicKey() does the same for public keys.
39
40       These functions are similar to the d2i_X509() functions; see
41       d2i_X509(3).
42

NOTES

44       All the functions that operate on data in memory update the data
45       pointer *pp after a successful operation, just like the other d2i and
46       i2d functions; see d2i_X509(3).
47
48       All these functions use DER format and unencrypted keys. Applications
49       wishing to encrypt or decrypt private keys should use other functions
50       such as d2i_PKCS8PrivateKey() instead.
51
52       If the *a is not NULL when calling d2i_PrivateKey() or
53       d2i_AutoPrivateKey() (i.e. an existing structure is being reused) and
54       the key format is PKCS#8 then *a will be freed and replaced on a
55       successful call.
56
57       To decode a key with type EVP_PKEY_EC, d2i_PublicKey() requires *a to
58       be a non-NULL EVP_PKEY structure assigned an EC_KEY structure
59       referencing the proper EC_GROUP.
60

RETURN VALUES

62       The d2i_PrivateKey(), d2i_AutoPrivateKey(), d2i_PrivateKey_bio(),
63       d2i_PrivateKey_fp(), and d2i_PublicKey() functions return a valid
64       EVP_KEY structure or NULL if an error occurs. The error code can be
65       obtained by calling ERR_get_error(3).
66
67       i2d_PrivateKey() and i2d_PublicKey() return the number of bytes
68       successfully encoded or a negative value if an error occurs. The error
69       code can be obtained by calling ERR_get_error(3).
70

SEE ALSO

72       crypto(7), d2i_PKCS8PrivateKey_bio(3)
73

75       Copyright 2017-2021 The OpenSSL Project Authors. All Rights Reserved.
76
77       Licensed under the OpenSSL license (the "License").  You may not use
78       this file except in compliance with the License.  You can obtain a copy
79       in the file LICENSE in the source distribution or at
80       <https://www.openssl.org/source/license.html>.
81
82
83
841.1.1q                            2023-02-06                 D2I_PRIVATEKEY(3)
Impressum