$NetBSD: b2i_PVK_bio_ex.3,v 1.5 2026/04/08 17:06:50 christos Exp $ -*- mode: troff; coding: utf-8 -*- Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) Standard preamble: ========================================================================..
..
..
\*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.. ds C` ""
. ds C' ""
'br\}
. ds C`
. ds C'
'br\}
Escape single quotes in literal strings from groff's Unicode transform. If the F register is >0, we'll generate index entries on stderr for titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index entries marked with X<> in POD. Of course, you'll have to process the output yourself in some meaningful fashion. Avoid warning from groff about undefined register 'F'...
.nr rF 0
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
Required to disable full justification in groff 1.23.0. ======================================================================== Title "b2i_PVK_bio_ex 3" b2i_PVK_bio_ex 3 2026-04-07 3.5.6 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes way too many mistakes in technical documents..nh
NAME
b2i_PVK_bio, b2i_PVK_bio_ex, i2b_PVK_bio, i2b_PVK_bio_ex - Decode and encode
functions for reading and writing MSBLOB format private keys
SYNOPSIS
Header "SYNOPSIS" .Vb 1
#include <
openssl/
pem.h>
\&
EVP_PKEY *b2i_PVK_bio(BIO *in, pem_password_cb *cb, void *u);
EVP_PKEY *b2i_PVK_bio_ex(BIO *in, pem_password_cb *cb, void *u,
OSSL_LIB_CTX *libctx, const char *propq);
int i2b_PVK_bio(BIO *out, const EVP_PKEY *pk, int enclevel,
pem_password_cb *cb, void *u);
int i2b_PVK_bio_ex(BIO *out, const EVP_PKEY *pk, int enclevel,
pem_password_cb *cb, void *u,
OSSL_LIB_CTX *libctx, const char *propq);
.Ve
DESCRIPTION
Header "DESCRIPTION" \fBb2i_PVK_bio_ex() decodes a private key of MSBLOB format read from a
BIO. It
attempts to automatically determine the key type. If the key is encrypted then
\fIcb is called with the user data
u in order to obtain a password to decrypt
the key. The supplied library context
libctx and property query
string
propq are used in any decrypt operation.
\fBb2i_PVK_bio() does the same as b2i_PVK_bio_ex() except that the default
library context and property query string are used.
\fBi2b_PVK_bio_ex() encodes pk using MSBLOB format. If enclevel is 1 then
a password obtained via pem_password_cb is used to encrypt the private key.
If enclevel is 0 then no encryption is applied. The user data in u is
passed to the password callback. The supplied library context libctx and
property query string propq are used in any decrypt operation.
\fBi2b_PVK_bio() does the same as i2b_PVK_bio_ex() except that the default
library context and property query string are used.
"RETURN VALUES"
Header "RETURN VALUES" The
b2i_PVK_bio() and
b2i_PVK_bio_ex() functions return a valid
EVP_KEY
structure or
NULL if an error occurs. The error code can be obtained by calling
\fBERR_get_error\|(3).
\fBi2b_PVK_bio() and i2b_PVK_bio_ex() return the number of bytes successfully
encoded or a negative value if an error occurs. The error code can be obtained
by calling ERR_get_error\|(3).
"SEE ALSO"
Header "SEE ALSO" \fBcrypto\|(7),
\fBd2i_PKCS8PrivateKey_bio\|(3)
HISTORY
Header "HISTORY" \fBb2i_PVK_bio_ex() and
i2b_PVK_bio_ex() were added in OpenSSL 3.0.
COPYRIGHT
Header "COPYRIGHT" Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
<https://www.openssl.org/source/license.html>.