1.\" $OpenBSD: d2i_PKCS8PrivateKey_bio.3,v 1.11 2019/06/07 19:28:52 schwarze Exp $ 2.\" full merge up to: OpenSSL 61f805c1 Jan 16 01:01:46 2018 +0800 3.\" 4.\" This file was written by Dr. Stephen Henson <steve@openssl.org>. 5.\" Copyright (c) 2002, 2016, 2017 The OpenSSL Project. All rights reserved. 6.\" 7.\" Redistribution and use in source and binary forms, with or without 8.\" modification, are permitted provided that the following conditions 9.\" are met: 10.\" 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" 3. All advertising materials mentioning features or use of this 20.\" software must display the following acknowledgment: 21.\" "This product includes software developed by the OpenSSL Project 22.\" for use in the OpenSSL Toolkit. (http://www.openssl.org/)" 23.\" 24.\" 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to 25.\" endorse or promote products derived from this software without 26.\" prior written permission. For written permission, please contact 27.\" openssl-core@openssl.org. 28.\" 29.\" 5. Products derived from this software may not be called "OpenSSL" 30.\" nor may "OpenSSL" appear in their names without prior written 31.\" permission of the OpenSSL Project. 32.\" 33.\" 6. Redistributions of any form whatsoever must retain the following 34.\" acknowledgment: 35.\" "This product includes software developed by the OpenSSL Project 36.\" for use in the OpenSSL Toolkit (http://www.openssl.org/)" 37.\" 38.\" THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY 39.\" EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 40.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 41.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR 42.\" ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 43.\" SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 44.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 45.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 46.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 47.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 48.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED 49.\" OF THE POSSIBILITY OF SUCH DAMAGE. 50.\" 51.Dd $Mdocdate: June 7 2019 $ 52.Dt D2I_PKCS8PRIVATEKEY_BIO 3 53.Os 54.Sh NAME 55.Nm d2i_PKCS8PrivateKey_bio , 56.Nm d2i_PKCS8PrivateKey_fp , 57.Nm i2d_PKCS8PrivateKey_bio , 58.Nm i2d_PKCS8PrivateKey_fp , 59.Nm i2d_PKCS8PrivateKey_nid_bio , 60.Nm i2d_PKCS8PrivateKey_nid_fp 61.Nd PKCS#8 format private key functions 62.Sh SYNOPSIS 63.In openssl/evp.h 64.Ft EVP_PKEY * 65.Fo d2i_PKCS8PrivateKey_bio 66.Fa "BIO *bp" 67.Fa "EVP_PKEY **x" 68.Fa "pem_password_cb *cb" 69.Fa "void *u" 70.Fc 71.Ft EVP_PKEY * 72.Fo d2i_PKCS8PrivateKey_fp 73.Fa "FILE *fp" 74.Fa "EVP_PKEY **x" 75.Fa "pem_password_cb *cb" 76.Fa "void *u" 77.Fc 78.Ft int 79.Fo i2d_PKCS8PrivateKey_bio 80.Fa "BIO *bp" 81.Fa "EVP_PKEY *x" 82.Fa "const EVP_CIPHER *enc" 83.Fa "char *kstr" 84.Fa "int klen" 85.Fa "pem_password_cb *cb" 86.Fa "void *u" 87.Fc 88.Ft int 89.Fo i2d_PKCS8PrivateKey_fp 90.Fa "FILE *fp" 91.Fa "EVP_PKEY *x" 92.Fa "const EVP_CIPHER *enc" 93.Fa "char *kstr" 94.Fa "int klen" 95.Fa "pem_password_cb *cb" 96.Fa "void *u" 97.Fc 98.Ft int 99.Fo i2d_PKCS8PrivateKey_nid_bio 100.Fa "BIO *bp" 101.Fa "EVP_PKEY *x" 102.Fa "int nid" 103.Fa "char *kstr" 104.Fa "int klen" 105.Fa "pem_password_cb *cb" 106.Fa "void *u" 107.Fc 108.Ft int 109.Fo i2d_PKCS8PrivateKey_nid_fp 110.Fa "FILE *fp" 111.Fa "EVP_PKEY *x" 112.Fa "int nid" 113.Fa "char *kstr" 114.Fa "int klen" 115.Fa "pem_password_cb *cb" 116.Fa "void *u" 117.Fc 118.Sh DESCRIPTION 119The PKCS#8 functions encode and decode private keys in PKCS#8 format 120using both PKCS#5 v1.5 and PKCS#5 v2.0 password based encryption 121algorithms. 122.Pp 123Other than the use of DER as opposed to PEM these functions are 124identical to the corresponding functions described in 125.Xr PEM_read_PrivateKey 3 . 126.Pp 127These functions are currently the only way to store encrypted private 128keys using DER format. 129.Pp 130Currently all the functions use 131.Vt BIO 132or 133.Vt FILE 134pointers. 135There are no functions which work directly on memory, 136though this can be readily worked around 137by converting the buffers to memory BIOs; 138see 139.Xr BIO_s_mem 3 140for details. 141.Sh RETURN VALUES 142.Fn d2i_PKCS8PrivateKey_bio 143and 144.Fn d2i_PKCS8PrivateKey_fp 145return a 146.Vt EVP_PKEY 147object or 148.Dv NULL 149if an error occurs. 150.Pp 151.Fn i2d_PKCS8PrivateKey_bio , 152.Fn i2d_PKCS8PrivateKey_fp , 153.Fn i2d_PKCS8PrivateKey_nid_bio , 154and 155.Fn i2d_PKCS8PrivateKey_nid_fp 156return 1 on success or 0 on error. 157.Sh SEE ALSO 158.Xr d2i_X509_SIG 3 , 159.Xr PEM_write_PKCS8PrivateKey 3 , 160.Xr PKCS8_PRIV_KEY_INFO_new 3 161.Sh HISTORY 162These functions first appeared in OpenSSL 0.9.5 163and have been available since 164.Ox 2.7 . 165.Sh CAVEATS 166Do not confuse these functions with 167.Xr i2d_PKCS8PrivateKeyInfo_bio 3 168and 169.Xr i2d_PKCS8PrivateKeyInfo_fp 3 , 170which write out private keys in 171.Sy unencrypted 172DER format. 173