Added documentation for PEM_X509_INFO_read() and PEM_X509_INFO_read_bio()
authorAllan <allanchang96@gmail.com>
Mon, 20 Jun 2022 08:22:50 +0000 (01:22 -0700)
committerTomas Mraz <tomas@openssl.org>
Fri, 24 Jun 2022 07:51:20 +0000 (09:51 +0200)
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)

doc/man3/PEM_X509_INFO_read_bio_ex.pod
util/missingcrypto.txt

index 0c9b0ab6dfcdd3a1a0f5c4d096e8177962b18970..251775a3ade7a61e7e962634c11d85a6005b6e14 100644 (file)
@@ -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
index 4d2fd7f6b712ab28ce38cdbed5e13e5e3389f0df..9afa1b8c002173eb73b71a0d17ff525789079a4b 100644 (file)
@@ -841,8 +841,6 @@ PEM_ASN1_write_bio(3)
 PEM_SignFinal(3)
 PEM_SignInit(3)
 PEM_SignUpdate(3)
-PEM_X509_INFO_read(3)
-PEM_X509_INFO_read_bio(3)
 PEM_X509_INFO_write_bio(3)
 PEM_def_callback(3)
 PEM_dek_info(3)