xref: /freebsd/crypto/openssl/doc/man3/PKCS8_pkey_add1_attr.pod (revision 2e3507c25e42292b45a5482e116d278f5515d04d)
1=pod
2
3=head1 NAME
4
5PKCS8_pkey_get0_attrs, PKCS8_pkey_add1_attr, PKCS8_pkey_add1_attr_by_NID, PKCS8_pkey_add1_attr_by_OBJ - PKCS8 attribute functions
6
7=head1 SYNOPSIS
8
9 #include <openssl/x509.h>
10
11 const STACK_OF(X509_ATTRIBUTE) *
12 PKCS8_pkey_get0_attrs(const PKCS8_PRIV_KEY_INFO *p8);
13 int PKCS8_pkey_add1_attr(PKCS8_PRIV_KEY_INFO *p8, X509_ATTRIBUTE *attr);
14 int PKCS8_pkey_add1_attr_by_NID(PKCS8_PRIV_KEY_INFO *p8, int nid, int type,
15                                 const unsigned char *bytes, int len);
16 int PKCS8_pkey_add1_attr_by_OBJ(PKCS8_PRIV_KEY_INFO *p8, const ASN1_OBJECT *obj,
17                                int type, const unsigned char *bytes, int len);
18
19=head1 DESCRIPTION
20
21PKCS8_pkey_get0_attrs() returns a const STACK of X509_ATTRIBUTE present in
22the passed const PKCS8_PRIV_KEY_INFO structure B<p8>.
23
24PKCS8_pkey_add1_attr() adds a constructed X509_ATTRIBUTE B<attr> to the
25existing PKCS8_PRIV_KEY_INFO structure B<p8>.
26
27PKCS8_pkey_add1_attr_by_NID() and PKCS8_pkey_add1_attr_by_OBJ() construct a new
28X509_ATTRIBUTE from the passed arguments and add it to the existing
29PKCS8_PRIV_KEY_INFO structure B<p8>.
30
31=head1 RETURN VALUES
32
33PKCS8_pkey_add1_attr(), PKCS8_pkey_add1_attr_by_NID(), and
34PKCS8_pkey_add1_attr_by_OBJ() return 1 for success and 0 for failure.
35
36=head1 NOTES
37
38STACK of X509_ATTRIBUTE is present in many X509-related structures and some of
39them have the corresponding set of similar functions.
40
41=head1 SEE ALSO
42
43L<crypto(7)>
44
45=head1 COPYRIGHT
46
47Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
48
49Licensed under the Apache License 2.0 (the "License").  You may not use
50this file except in compliance with the License.  You can obtain a copy
51in the file LICENSE in the source distribution or at
52L<https://www.openssl.org/source/license.html>.
53
54=cut
55