1.\" $OpenBSD: PEM_bytes_read_bio.3,v 1.2 2018/03/22 21:08:22 schwarze Exp $ 2.\" OpenSSL PEM_bytes_read_bio.pod 7671342e Feb 29 15:47:12 2016 -0600 3.\" 4.\" This file was written by Benjamin Kaduk <bkaduk at akamai dot com>. 5.\" Copyright (c) 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: March 22 2018 $ 52.Dt PEM_BYTES_READ_BIO 3 53.Os 54.Sh NAME 55.Nm PEM_bytes_read_bio 56.Nd read a PEM-encoded data structure from a BIO 57.Sh SYNOPSIS 58.In openssl/pem.h 59.Ft int 60.Fo PEM_bytes_read_bio 61.Fa "unsigned char **pdata" 62.Fa "long *plen" 63.Fa "char **pnm" 64.Fa "const char *name" 65.Fa "BIO *bp" 66.Fa "pem_password_cb *cb" 67.Fa "void *u" 68.Fc 69.Sh DESCRIPTION 70.Fn PEM_bytes_read_bio 71reads PEM-formatted (RFC 1421) data from the BIO 72.Fa bp 73for the data type given in 74.Fa name 75(RSA PRIVATE KEY, CERTIFICATE, etc.). 76If multiple PEM-encoded data structures are present in the same stream, 77.Fn PEM_bytes_read_bio 78will skip non-matching data types and continue reading. 79Non-PEM data present in the stream may cause an error. 80.Pp 81The PEM header may indicate that the following data is encrypted; if so, 82the data will be decrypted, waiting on user input to supply a passphrase 83if needed. 84The password callback 85.Fa cb 86and rock 87.Fa u 88are used to obtain the decryption passphrase, if applicable. 89.Pp 90Some data types have compatibility aliases, such as a file containing 91X509 CERTIFICATE matching a request for the deprecated type CERTIFICATE. 92The actual type indicated by the file is returned in 93.Em *pnm 94if 95.Fa pnm 96is 97.Pf non- Dv NULL . 98The caller must free the storage pointed to by 99.Em *pnm . 100.Pp 101The returned data is the DER-encoded form of the requested type, in 102.Em *pdata 103with length 104.Em *plen . 105The caller must free the storage pointed to by 106.Em *pdata . 107.Sh RETURN VALUES 108.Fn PEM_bytes_read_bio 109returns 1 for success or 0 for failure. 110.Sh SEE ALSO 111.Xr PEM_read 3 , 112.Xr PEM_read_bio_PrivateKey 3 113.Sh HISTORY 114.Fn PEM_bytes_read_bio 115first appeared in OpenSSL 0.9.7 and has been available since 116.Ox 3.2 . 117