diff options
author | Damian Hobson-Garcia <dhobsong@igel.co.jp> | 2023-06-30 23:12:38 +0200 |
---|---|---|
committer | Matt Caswell <matt@openssl.org> | 2024-04-24 15:05:35 +0200 |
commit | 62960b8710a39d58fe386a51dccbd35bd973220f (patch) | |
tree | bc6dfdf65b953011a67b10dd096d6cdd45fc3691 /doc | |
parent | Attribute certificate printing functions (diff) | |
download | openssl-62960b8710a39d58fe386a51dccbd35bd973220f.tar.xz openssl-62960b8710a39d58fe386a51dccbd35bd973220f.zip |
x509_acert: Add, remove and get attribute certificate attributes
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Neil Horman <nhorman@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/15857)
Diffstat (limited to 'doc')
-rw-r--r-- | doc/build.info | 12 | ||||
-rw-r--r-- | doc/man3/X509_ACERT_add1_attr.pod | 67 | ||||
-rw-r--r-- | doc/man3/X509_ACERT_get_attr.pod | 59 |
3 files changed, 138 insertions, 0 deletions
diff --git a/doc/build.info b/doc/build.info index 43bb3c8a1d..cc8bdef61d 100644 --- a/doc/build.info +++ b/doc/build.info @@ -2799,10 +2799,18 @@ DEPEND[html/man3/X509V3_set_ctx.html]=man3/X509V3_set_ctx.pod GENERATE[html/man3/X509V3_set_ctx.html]=man3/X509V3_set_ctx.pod DEPEND[man/man3/X509V3_set_ctx.3]=man3/X509V3_set_ctx.pod GENERATE[man/man3/X509V3_set_ctx.3]=man3/X509V3_set_ctx.pod +DEPEND[html/man3/X509_ACERT_add1_attr.html]=man3/X509_ACERT_add1_attr.pod +GENERATE[html/man3/X509_ACERT_add1_attr.html]=man3/X509_ACERT_add1_attr.pod +DEPEND[man/man3/X509_ACERT_add1_attr.3]=man3/X509_ACERT_add1_attr.pod +GENERATE[man/man3/X509_ACERT_add1_attr.3]=man3/X509_ACERT_add1_attr.pod DEPEND[html/man3/X509_ACERT_get0_holder_baseCertId.html]=man3/X509_ACERT_get0_holder_baseCertId.pod GENERATE[html/man3/X509_ACERT_get0_holder_baseCertId.html]=man3/X509_ACERT_get0_holder_baseCertId.pod DEPEND[man/man3/X509_ACERT_get0_holder_baseCertId.3]=man3/X509_ACERT_get0_holder_baseCertId.pod GENERATE[man/man3/X509_ACERT_get0_holder_baseCertId.3]=man3/X509_ACERT_get0_holder_baseCertId.pod +DEPEND[html/man3/X509_ACERT_get_attr.html]=man3/X509_ACERT_get_attr.pod +GENERATE[html/man3/X509_ACERT_get_attr.html]=man3/X509_ACERT_get_attr.pod +DEPEND[man/man3/X509_ACERT_get_attr.3]=man3/X509_ACERT_get_attr.pod +GENERATE[man/man3/X509_ACERT_get_attr.3]=man3/X509_ACERT_get_attr.pod DEPEND[html/man3/X509_ACERT_print_ex.html]=man3/X509_ACERT_print_ex.pod GENERATE[html/man3/X509_ACERT_print_ex.html]=man3/X509_ACERT_print_ex.pod DEPEND[man/man3/X509_ACERT_print_ex.3]=man3/X509_ACERT_print_ex.pod @@ -3639,7 +3647,9 @@ html/man3/UI_create_method.html \ html/man3/UI_new.html \ html/man3/X509V3_get_d2i.html \ html/man3/X509V3_set_ctx.html \ +html/man3/X509_ACERT_add1_attr.html \ html/man3/X509_ACERT_get0_holder_baseCertId.html \ +html/man3/X509_ACERT_get_attr.html \ html/man3/X509_ACERT_print_ex.html \ html/man3/X509_ALGOR_dup.html \ html/man3/X509_ATTRIBUTE.html \ @@ -4286,7 +4296,9 @@ man/man3/UI_create_method.3 \ man/man3/UI_new.3 \ man/man3/X509V3_get_d2i.3 \ man/man3/X509V3_set_ctx.3 \ +man/man3/X509_ACERT_add1_attr.3 \ man/man3/X509_ACERT_get0_holder_baseCertId.3 \ +man/man3/X509_ACERT_get_attr.3 \ man/man3/X509_ACERT_print_ex.3 \ man/man3/X509_ALGOR_dup.3 \ man/man3/X509_ATTRIBUTE.3 \ diff --git a/doc/man3/X509_ACERT_add1_attr.pod b/doc/man3/X509_ACERT_add1_attr.pod new file mode 100644 index 0000000000..ab6a256670 --- /dev/null +++ b/doc/man3/X509_ACERT_add1_attr.pod @@ -0,0 +1,67 @@ +=pod + +=head1 NAME + +X509_ACERT_add1_attr, +X509_ACERT_add1_attr_by_NID, +X509_ACERT_add1_attr_by_OBJ, +X509_ACERT_add1_attr_by_txt, +X509_ACERT_delete_attr +- X509_ACERT attribute functions + +=head1 SYNOPSIS + + #include <openssl/x509_acert.h> + + int X509_ACERT_add1_attr(X509_ACERT *x, X509_ATTRIBUTE *attr); + int X509_ACERT_add1_attr_by_NID(X509_ACERT *x, int nid, int type, + const void *bytes, int len); + int X509_ACERT_add1_attr_by_OBJ(X509_ACERT *x, const ASN1_OBJECT *obj, + int type, const void *bytes, int len); + int X509_ACERT_add1_attr_by_txt(X509_ACERT *x, const char *attrname, int type, + const unsigned char *bytes, int len); + X509_ATTRIBUTE *X509_ACERT_delete_attr(X509_ACERT *x, int loc); + +=head1 DESCRIPTION + +X509_ACERT_add1_attr() adds a constructed X509_ATTRIBUTE B<attr> to the +existing X509_ACERT structure B<x>. + +X509_ACERT_add1_attr_by_NID() and X509_ACERT_add1_attr_by_OBJ() +add an attribute of type I<nid> or I<obj> with a value of ASN1 +type I<type> constructed using I<len> bytes from I<bytes>. + +X509_ACERT_add1_attr_by_txt() adds an attribute of type I<attrname> with a value of +ASN1 type I<type> constructed using I<len> bytes from I<bytes>. + +X509_ACERT_delete_attr() will delete the I<loc>th attribute from I<x> and +return a pointer to it or NULL if there are fewer than I<loc> attributes +contained in I<x>. + +=head1 RETURN VALUES + +X509_ACERT_add1_attr(), X509_ACERT_add1_attr_by_NID(), and +X509_ACERT_add1_attr_by_OBJ() return 1 for success and 0 for failure. + +X509_ACERT_delete_attr() returns a B<X509_ATTRIBUTE> pointer on +success or NULL on failure. + +=head1 SEE ALSO + +L<X509_ACERT_get_attr_count(3)> + +=head1 HISTORY + +X509_ACERT_add1_attr(), X509_ACERT_add1_attr_by_NID(), X509_ACERT_add1_attr_by_OBJ(), +X509_ACERT_add1_attr_by_txt() and X509_ACERT_delete_attr() were added in OpenSSL 3.4. + +=head1 COPYRIGHT + +Copyright 2023 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 diff --git a/doc/man3/X509_ACERT_get_attr.pod b/doc/man3/X509_ACERT_get_attr.pod new file mode 100644 index 0000000000..b61cc2510b --- /dev/null +++ b/doc/man3/X509_ACERT_get_attr.pod @@ -0,0 +1,59 @@ +=pod + +=head1 NAME + +X509_ACERT_get_attr, +X509_ACERT_get_attr_by_NID, +X509_ACERT_get_attr_by_OBJ, +X509_ACERT_get_attr_count +- Retrieve attributes from an X509_ACERT structure + +=head1 SYNOPSIS + + #include <openssl/x509_acert.h> + + X509_ATTRIBUTE *X509_ACERT_get_attr(const X509_ACERT *x, int loc); + int X509_ACERT_get_attr_by_NID(const X509_ACERT *x, int nid, int lastpos); + int X509_ACERT_get_attr_by_OBJ(const X509_ACERT *x, const ASN1_OBJECT *obj, + int lastpos); + int X509_ACERT_get_attr_count(const X509_ACERT *x); + +=head1 DESCRIPTION + +X509_ACERT_get0_attr() retrieves the I<loc>th B<X509_ATTRIBUTE> from an +B<X509_ACERT> I<x>. X509_ACERT_get_attr_count() returns the total number +of attributes in the B<X509_ACERT>. + +X509_ACERT_get_attr_by_NID() and X509_ACERT_get_attr_by_OBJ() retrieve the next +attribute location matching I<nid> or I<obj> after I<lastpos>. I<lastpos> +should initially be set to -1. +If there are no more entries -1 is returned. If I<nid> is invalid +(doesn't correspond to a valid OID) then -2 is returned. + +=head1 RETURN VALUES + +X509_ACERT_get0_attr() return a B<X509_ATTRIBUTE> from an attribute +certificate, or NULL if the specified attribute is not found. + +X509_ACERT_get_attr_by_NID() and X509_ACERT_get_attr_by_OBJ() return +the location of the next attribute requested or -1 if not found. +X509_ACERT_get_attr_by_NID() can also return -2 if the supplied NID is invalid. + +X509_ACERT_get_attr_count() returns the number of attributes in the given +attribute certificate. + +=head1 HISTORY + +X509_ACERT_get0_attr(), X509_ACERT_get_attr_by_NID(), X509_ACERT_get_attr_by_OBJ() and +X509_ACERT_get_attr_count() were added in OpenSSL 3.4. + +=head1 COPYRIGHT + +Copyright 2023 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 |