add missing doc of X509_REQ_get_extensions() and X509_REQ_add_extensions{,_nid}()
authorDr. David von Oheimb <David.von.Oheimb@siemens.com>
Mon, 1 Aug 2022 14:35:42 +0000 (16:35 +0200)
committerTomas Mraz <tomas@openssl.org>
Fri, 5 Jan 2024 11:41:15 +0000 (12:41 +0100)
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: David von Oheimb <david.von.oheimb@siemens.com>
(cherry picked from commit 47dc828c6b652feb9cef5b0e4186d010986f197c)

Reviewed-by: Tom Cosgrove <tom.cosgrove@arm.com>
(Merged from https://github.com/openssl/openssl/pull/23190)

doc/build.info
doc/man3/X509_REQ_get_extensions.pod [new file with mode: 0644]
util/missingcrypto.txt

index e3ec1fe46b10ea4b4cceff2ad9904e4fea6d2d10..0279e2390a32422007d9989364f708a2ef8fd631 100644 (file)
@@ -2715,6 +2715,10 @@ DEPEND[html/man3/X509_REQ_get_attr.html]=man3/X509_REQ_get_attr.pod
 GENERATE[html/man3/X509_REQ_get_attr.html]=man3/X509_REQ_get_attr.pod
 DEPEND[man/man3/X509_REQ_get_attr.3]=man3/X509_REQ_get_attr.pod
 GENERATE[man/man3/X509_REQ_get_attr.3]=man3/X509_REQ_get_attr.pod
+DEPEND[html/man3/X509_REQ_get_extensions.html]=man3/X509_REQ_get_extensions.pod
+GENERATE[html/man3/X509_REQ_get_extensions.html]=man3/X509_REQ_get_extensions.pod
+DEPEND[man/man3/X509_REQ_get_extensions.3]=man3/X509_REQ_get_extensions.pod
+GENERATE[man/man3/X509_REQ_get_extensions.3]=man3/X509_REQ_get_extensions.pod
 DEPEND[html/man3/X509_SIG_get0.html]=man3/X509_SIG_get0.pod
 GENERATE[html/man3/X509_SIG_get0.html]=man3/X509_SIG_get0.pod
 DEPEND[man/man3/X509_SIG_get0.3]=man3/X509_SIG_get0.pod
@@ -3458,6 +3462,7 @@ html/man3/X509_NAME_get_index_by_NID.html \
 html/man3/X509_NAME_print_ex.html \
 html/man3/X509_PUBKEY_new.html \
 html/man3/X509_REQ_get_attr.html \
+html/man3/X509_REQ_get_extensions.html \
 html/man3/X509_SIG_get0.html \
 html/man3/X509_STORE_CTX_get_error.html \
 html/man3/X509_STORE_CTX_new.html \
@@ -4065,6 +4070,7 @@ man/man3/X509_NAME_get_index_by_NID.3 \
 man/man3/X509_NAME_print_ex.3 \
 man/man3/X509_PUBKEY_new.3 \
 man/man3/X509_REQ_get_attr.3 \
+man/man3/X509_REQ_get_extensions.3 \
 man/man3/X509_SIG_get0.3 \
 man/man3/X509_STORE_CTX_get_error.3 \
 man/man3/X509_STORE_CTX_new.3 \
diff --git a/doc/man3/X509_REQ_get_extensions.pod b/doc/man3/X509_REQ_get_extensions.pod
new file mode 100644 (file)
index 0000000..7a3932c
--- /dev/null
@@ -0,0 +1,50 @@
+=pod
+
+=head1 NAME
+
+X509_REQ_get_extensions,
+X509_REQ_add_extensions, X509_REQ_add_extensions_nid
+- handle X.509 extension attributes of a CSR
+
+=head1 SYNOPSIS
+
+ #include <openssl/x509.h>
+
+ STACK_OF(X509_EXTENSION) *X509_REQ_get_extensions(X509_REQ *req);
+ int X509_REQ_add_extensions(X509_REQ *req, const STACK_OF(X509_EXTENSION) *exts);
+ int X509_REQ_add_extensions_nid(X509_REQ *req,
+                                 const STACK_OF(X509_EXTENSION) *exts, int nid);
+
+=head1 DESCRIPTION
+
+X509_REQ_get_extensions() returns the first list of X.509 extensions
+found in the attributes of I<req>.
+The returned list is empty if there are no such extensions in I<req>.
+The caller is responsible for freeing the list obtained.
+
+X509_REQ_add_extensions() adds to I<req> a list of X.509 extensions I<exts>,
+which must not be NULL, using the default B<NID_ext_req>.
+This function must not be called more than once on the same I<req>.
+
+X509_REQ_add_extensions_nid() is like X509_REQ_add_extensions()
+except that I<nid> is used to identify the extensions attribute.
+This function must not be called more than once with the same I<req> and I<nid>.
+
+=head1 RETURN VALUES
+
+X509_REQ_get_extensions() returns a pointer to B<STACK_OF(X509_EXTENSION)>
+or NULL on error.
+
+X509_REQ_add_extensions() and X509_REQ_add_extensions_nid()
+return 1 on success, 0 on error.
+
+=head1 COPYRIGHT
+
+Copyright 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
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
+
+=cut
index 9d9cd871f1a7715db231f17fb1166353e18098ca..b59bcd0dcc63b3eb7ca03e8643dfae7e60e390f4 100644 (file)
@@ -1160,7 +1160,6 @@ X509_REQ_delete_attr(3)
 X509_REQ_extension_nid(3)
 X509_REQ_get1_email(3)
 X509_REQ_get_extension_nids(3)
-X509_REQ_get_extensions(3)
 X509_REQ_it(3)
 X509_REQ_print(3)
 X509_REQ_print_ex(3)