1B2I_PVK_BIO_EX(3ossl)               OpenSSL              B2I_PVK_BIO_EX(3ossl)
2
3
4

NAME

6       b2i_PVK_bio, b2i_PVK_bio_ex, i2b_PVK_bio, i2b_PVK_bio_ex - Decode and
7       encode functions for reading and writing MSBLOB format private keys
8

SYNOPSIS

10        #include <openssl/pem.h>
11
12        EVP_PKEY *b2i_PVK_bio(BIO *in, pem_password_cb *cb, void *u);
13        EVP_PKEY *b2i_PVK_bio_ex(BIO *in, pem_password_cb *cb, void *u,
14                                 OSSL_LIB_CTX *libctx, const char *propq);
15        int i2b_PVK_bio(BIO *out, const EVP_PKEY *pk, int enclevel,
16                        pem_password_cb *cb, void *u);
17        int i2b_PVK_bio_ex(BIO *out, const EVP_PKEY *pk, int enclevel,
18                           pem_password_cb *cb, void *u,
19                           OSSL_LIB_CTX *libctx, const char *propq);
20

DESCRIPTION

22       b2i_PVK_bio_ex() decodes a private key of MSBLOB format read from a
23       BIO. It attempts to automatically determine the key type. If the key is
24       encrypted then cb is called with the user data u in order to obtain a
25       password to decrypt the key. The supplied library context libctx and
26       property query string propq are used in any decrypt operation.
27
28       b2i_PVK_bio() does the same as b2i_PVK_bio_ex() except that the default
29       library context and property query string are used.
30
31       i2b_PVK_bio_ex() encodes pk using MSBLOB format. If enclevel is 1 then
32       a password obtained via pem_password_cb is used to encrypt the private
33       key.  If enclevel is 0 then no encryption is applied. The user data in
34       u is passed to the password callback. The supplied library context
35       libctx and property query string propq are used in any decrypt
36       operation.
37
38       i2b_PVK_bio() does the same as i2b_PVK_bio_ex() except that the default
39       library context and property query string are used.
40

RETURN VALUES

42       The b2i_PVK_bio() and b2i_PVK_bio_ex() functions return a valid EVP_KEY
43       structure or NULL if an error occurs. The error code can be obtained by
44       calling ERR_get_error(3).
45
46       i2b_PVK_bio() and i2b_PVK_bio_ex() return the number of bytes
47       successfully encoded or a negative value if an error occurs. The error
48       code can be obtained by calling ERR_get_error(3).
49

SEE ALSO

51       crypto(7), d2i_PKCS8PrivateKey_bio(3)
52

HISTORY

54       b2i_PVK_bio_ex() and i2b_PVK_bio_ex() were added in OpenSSL 3.0.
55

57       Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
58
59       Licensed under the Apache License 2.0 (the "License").  You may not use
60       this file except in compliance with the License.  You can obtain a copy
61       in the file LICENSE in the source distribution or at
62       <https://www.openssl.org/source/license.html>.
63
64
65
663.0.5                             2022-11-01             B2I_PVK_BIO_EX(3ossl)
Impressum