diff options
| author | Allan <allanchang96@gmail.com> | 2022-06-20 01:22:50 -0700 |
|---|---|---|
| committer | Tomas Mraz <tomas@openssl.org> | 2022-06-24 09:51:20 +0200 |
| commit | 413e0dbeeee984180b04ed6b45dd913ac8f536bc (patch) | |
| tree | f84ab3e94b6758714a1354df5a2f765cc8c08314 /doc | |
| parent | 20f50e0f42cd5fec0b719865e0e45064221e10c2 (diff) | |
Added documentation for PEM_X509_INFO_read() and PEM_X509_INFO_read_bio()
Fixes #18342
Fixes <propq> to I<propq>
Updated copyright year
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18623)
(cherry picked from commit 9454423bf1eac4c75e70ff4fd67456e4cfb05a92)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/PEM_X509_INFO_read_bio_ex.pod | 22 |
1 files changed, 17 insertions, 5 deletions
diff --git a/doc/man3/PEM_X509_INFO_read_bio_ex.pod b/doc/man3/PEM_X509_INFO_read_bio_ex.pod index 0c9b0ab6df..251775a3ad 100644 --- a/doc/man3/PEM_X509_INFO_read_bio_ex.pod +++ b/doc/man3/PEM_X509_INFO_read_bio_ex.pod @@ -2,7 +2,7 @@ =head1 NAME -PEM_X509_INFO_read_bio_ex, PEM_X509_INFO_read_ex +PEM_X509_INFO_read_ex, PEM_X509_INFO_read, PEM_X509_INFO_read_bio_ex, PEM_X509_INFO_read_bio - read PEM-encoded data structures into one or more B<X509_INFO> objects =head1 SYNOPSIS @@ -13,19 +13,30 @@ PEM_X509_INFO_read_bio_ex, PEM_X509_INFO_read_ex pem_password_cb *cb, void *u, OSSL_LIB_CTX *libctx, const char *propq); - + STACK_OF(X509_INFO) *PEM_X509_INFO_read(FILE *fp, STACK_OF(X509_INFO) *sk, + pem_password_cb *cb, void *u); STACK_OF(X509_INFO) *PEM_X509_INFO_read_bio_ex(BIO *bio, STACK_OF(X509_INFO) *sk, pem_password_cb *cb, void *u, OSSL_LIB_CTX *libctx, const char *propq); + STACK_OF(X509_INFO) *PEM_X509_INFO_read_bio(BIO *bp, STACK_OF(X509_INFO) *sk, + pem_password_cb *cb, void *u); =head1 DESCRIPTION PEM_X509_INFO_read_ex() loads the B<X509_INFO> objects from a file I<fp>. +PEM_X509_INFO_read() is similar to PEM_X509_INFO_read_ex() +but uses the default (NULL) library context I<libctx> +and empty property query I<propq>. + PEM_X509_INFO_read_bio_ex() loads the B<X509_INFO> objects using a bio I<bp>. +PEM_X509_INFO_read_bio() is similar to PEM_X509_INFO_read_bio_ex() +but uses the default (NULL) library context I<libctx> +and empty property query I<propq>. + Each of the loaded B<X509_INFO> objects can contain a CRL, a certificate, and/or a private key. The elements are read sequentially, and as far as they are of different type than @@ -40,12 +51,13 @@ The optional I<cb> and I<u> parameters can be used for providing a pass phrase needed for decrypting encrypted PEM structures (normally only private keys). See L<PEM_read_bio_PrivateKey(3)> and L<passphrase-encoding(7)> for details. -The library context I<libctx> and property query <propq> are used for fetching +The library context I<libctx> and property query I<propq> are used for fetching algorithms from providers. =head1 RETURN VALUES -PEM_X509_INFO_read_ex() and PEM_X509_INFO_read_bio_ex() return +PEM_X509_INFO_read_ex(), PEM_X509_INFO_read(), +PEM_X509_INFO_read_bio_ex() and PEM_X509_INFO_read_bio() return a stack of B<X509_INFO> objects or NULL on failure. =head1 SEE ALSO @@ -61,7 +73,7 @@ PEM_X509_INFO_read_bio_ex() were added in OpenSSL 3.0. =head1 COPYRIGHT -Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2020-2022 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 |