diff options
Diffstat (limited to 'src/lib/libcrypto/man/PEM_bytes_read_bio.3')
| -rw-r--r-- | src/lib/libcrypto/man/PEM_bytes_read_bio.3 | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/src/lib/libcrypto/man/PEM_bytes_read_bio.3 b/src/lib/libcrypto/man/PEM_bytes_read_bio.3 index d3a664ba74..d1148edfe0 100644 --- a/src/lib/libcrypto/man/PEM_bytes_read_bio.3 +++ b/src/lib/libcrypto/man/PEM_bytes_read_bio.3 | |||
| @@ -1,4 +1,4 @@ | |||
| 1 | .\" $OpenBSD: PEM_bytes_read_bio.3,v 1.4 2020/06/12 18:16:13 schwarze Exp $ | 1 | .\" $OpenBSD: PEM_bytes_read_bio.3,v 1.5 2020/06/15 14:13:14 schwarze Exp $ |
| 2 | .\" selective merge up to: | 2 | .\" selective merge up to: |
| 3 | .\" OpenSSL PEM_bytes_read_bio.pod 7671342e Feb 29 15:47:12 2016 -0600 | 3 | .\" OpenSSL PEM_bytes_read_bio.pod 7671342e Feb 29 15:47:12 2016 -0600 |
| 4 | .\" | 4 | .\" |
| @@ -65,7 +65,7 @@ | |||
| 65 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | 65 | .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED |
| 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. | 66 | .\" OF THE POSSIBILITY OF SUCH DAMAGE. |
| 67 | .\" | 67 | .\" |
| 68 | .Dd $Mdocdate: June 12 2020 $ | 68 | .Dd $Mdocdate: June 15 2020 $ |
| 69 | .Dt PEM_BYTES_READ_BIO 3 | 69 | .Dt PEM_BYTES_READ_BIO 3 |
| 70 | .Os | 70 | .Os |
| 71 | .Sh NAME | 71 | .Sh NAME |
| @@ -79,31 +79,31 @@ | |||
| 79 | .Fa "long *plen" | 79 | .Fa "long *plen" |
| 80 | .Fa "char **pnm" | 80 | .Fa "char **pnm" |
| 81 | .Fa "const char *name" | 81 | .Fa "const char *name" |
| 82 | .Fa "BIO *bp" | 82 | .Fa "BIO *in_bp" |
| 83 | .Fa "pem_password_cb *cb" | 83 | .Fa "pem_password_cb *cb" |
| 84 | .Fa "void *u" | 84 | .Fa "void *u" |
| 85 | .Fc | 85 | .Fc |
| 86 | .Sh DESCRIPTION | 86 | .Sh DESCRIPTION |
| 87 | .Fn PEM_bytes_read_bio | 87 | .Fn PEM_bytes_read_bio |
| 88 | reads PEM-formatted (RFC 1421) data from the BIO | 88 | reads and PEM decodes the first object of type |
| 89 | .Fa bp | ||
| 90 | for the data type given in | ||
| 91 | .Fa name | 89 | .Fa name |
| 92 | (RSA PRIVATE KEY, CERTIFICATE, etc.). | 90 | .Pq e.g. RSA PRIVATE KEY, CERTIFICATE, etc.\& |
| 91 | from | ||
| 92 | .Fa in_bp . | ||
| 93 | If multiple PEM-encoded data structures are present in the same stream, | 93 | If multiple PEM-encoded data structures are present in the same stream, |
| 94 | .Fn PEM_bytes_read_bio | 94 | it skips non-matching data types and continues reading. |
| 95 | will skip non-matching data types and continue reading. | 95 | Before reading each PEM object, lines not starting with |
| 96 | Non-PEM data present in the stream may cause an error. | 96 | .Qq "-----BEGIN " |
| 97 | are also skipped; see | ||
| 98 | .Xr PEM_read_bio 3 | ||
| 99 | for details of PEM parsing. | ||
| 97 | .Pp | 100 | .Pp |
| 98 | The PEM header may indicate that the following data is encrypted; if so, | 101 | The PEM header may indicate that the following data is encrypted; if so, |
| 99 | the data will be decrypted, waiting on user input to supply a passphrase | 102 | the data is decrypted, optionally using |
| 100 | if needed. | ||
| 101 | The password callback | ||
| 102 | .Fa cb | 103 | .Fa cb |
| 103 | and rock | 104 | and |
| 104 | .Fa u | 105 | .Fa u , |
| 105 | are used to obtain the decryption passphrase, if applicable. | 106 | as described in |
| 106 | For more details, see | ||
| 107 | .Xr pem_password_cb 3 . | 107 | .Xr pem_password_cb 3 . |
| 108 | .Pp | 108 | .Pp |
| 109 | Some data types have compatibility aliases, such as a file containing | 109 | Some data types have compatibility aliases, such as a file containing |
| @@ -175,6 +175,8 @@ Additional types of errors can result from | |||
| 175 | .Xr PEM_ASN1_read 3 , | 175 | .Xr PEM_ASN1_read 3 , |
| 176 | .Xr PEM_read 3 , | 176 | .Xr PEM_read 3 , |
| 177 | .Xr PEM_read_bio_PrivateKey 3 | 177 | .Xr PEM_read_bio_PrivateKey 3 |
| 178 | .Sh STANDARDS | ||
| 179 | RFC 1421: Privacy Enhancement for Internet Electronic Mail (PEM), Part I | ||
| 178 | .Sh HISTORY | 180 | .Sh HISTORY |
| 179 | .Fn PEM_bytes_read_bio | 181 | .Fn PEM_bytes_read_bio |
| 180 | first appeared in OpenSSL 0.9.7 and has been available since | 182 | first appeared in OpenSSL 0.9.7 and has been available since |
