From d80bf693faaa8ad08ca76f52228837306d77bb32 Mon Sep 17 00:00:00 2001 From: Dmitry Belyavskiy Date: Mon, 20 Jan 2020 16:02:26 +0300 Subject: [PATCH] New functions for PKCS8 attributes management - documentation Reviewed-by: Tomas Mraz Reviewed-by: Shane Lontis (Merged from https://github.com/openssl/openssl/pull/10900) --- doc/man3/PKCS8_pkey_add1_attr.pod | 54 +++++++++++++++++++++++++++++++ util/missingcrypto.txt | 2 -- 2 files changed, 54 insertions(+), 2 deletions(-) create mode 100644 doc/man3/PKCS8_pkey_add1_attr.pod diff --git a/doc/man3/PKCS8_pkey_add1_attr.pod b/doc/man3/PKCS8_pkey_add1_attr.pod new file mode 100644 index 0000000000..340b56aafe --- /dev/null +++ b/doc/man3/PKCS8_pkey_add1_attr.pod @@ -0,0 +1,54 @@ +=pod + +=head1 NAME + +PKCS8_pkey_get0_attrs, PKCS8_pkey_add1_attr, PKCS8_pkey_add1_attr_by_NID, PKCS8_pkey_add1_attr_by_OBJ - PKCS8 attribute functions + +=head1 SYNOPSIS + + #include + + const STACK_OF(X509_ATTRIBUTE) * + PKCS8_pkey_get0_attrs(const PKCS8_PRIV_KEY_INFO *p8); + int PKCS8_pkey_add1_attr(PKCS8_PRIV_KEY_INFO *p8, X509_ATTRIBUTE *attr); + int PKCS8_pkey_add1_attr_by_NID(PKCS8_PRIV_KEY_INFO *p8, int nid, int type, + const unsigned char *bytes, int len); + int PKCS8_pkey_add1_attr_by_OBJ(PKCS8_PRIV_KEY_INFO *p8, const ASN1_OBJECT *obj, + int type, const unsigned char *bytes, int len); + +=head1 DESCRIPTION + +PKCS8_pkey_get0_attrs() returns a const STACK of X509_ATTRIBUTE present in +the passed const PKCS8_PRIV_KEY_INFO structure B. + +PKCS8_pkey_add1_attr() adds a constructed X509_ATTRIBUTE B to the +existing PKCS8_PRIV_KEY_INFO structure B. + +PKCS8_pkey_add1_attr_by_NID() and PKCS8_pkey_add1_attr_by_OBJ() construct a new +X509_ATTRIBUTE from the passed arguments and add it to the existing +PKCS8_PRIV_KEY_INFO structure B. + +=head1 RETURN VALUES + +PKCS8_pkey_add1_attr(), PKCS8_pkey_add1_attr_by_NID(), and +PKCS8_pkey_add1_attr_by_OBJ() return 1 for success and 0 for failure. + +=head1 NOTES + +STACK of X509_ATTRIBUTE is present in many X509-related structures and some of +them have the corresponding set of similar functions. + +=head1 SEE ALSO + +L + +=head1 COPYRIGHT + +Copyright 2020 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. + +=cut diff --git a/util/missingcrypto.txt b/util/missingcrypto.txt index 4f610c5815..05a8bbf18e 100644 --- a/util/missingcrypto.txt +++ b/util/missingcrypto.txt @@ -876,9 +876,7 @@ PKCS8_add_keyusage(3) PKCS8_decrypt(3) PKCS8_encrypt(3) PKCS8_get_attr(3) -PKCS8_pkey_add1_attr_by_NID(3) PKCS8_pkey_get0(3) -PKCS8_pkey_get0_attrs(3) PKCS8_pkey_set0(3) PKCS8_set0_pbe(3) PKEY_USAGE_PERIOD_it(3) -- 2.25.1