mirror of
https://github.com/openssl/openssl.git
synced 2025-01-18 13:44:20 +08:00
New functions for PKCS8 attributes management - documentation
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Shane Lontis <shane.lontis@oracle.com> (Merged from https://github.com/openssl/openssl/pull/10900)
This commit is contained in:
parent
408113c050
commit
d80bf693fa
54
doc/man3/PKCS8_pkey_add1_attr.pod
Normal file
54
doc/man3/PKCS8_pkey_add1_attr.pod
Normal file
@ -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 <openssl/x509.h>
|
||||
|
||||
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<p8>.
|
||||
|
||||
PKCS8_pkey_add1_attr() adds a constructed X509_ATTRIBUTE B<attr> to the
|
||||
existing PKCS8_PRIV_KEY_INFO structure B<p8>.
|
||||
|
||||
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<p8>.
|
||||
|
||||
=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<crypto(7)>
|
||||
|
||||
=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<https://www.openssl.org/source/license.html>.
|
||||
|
||||
=cut
|
@ -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)
|
||||
|
Loading…
Reference in New Issue
Block a user