xref: /freebsd/crypto/openssl/doc/man3/PKCS12_SAFEBAG_get0_attrs.pod (revision 4543ef516683042d46f3bd3bb8a4f3f746e00499)
1=pod
2
3=head1 NAME
4
5PKCS12_SAFEBAG_get0_attrs, PKCS12_get_attr_gen
6- Retrieve attributes from a PKCS#12 safeBag
7
8=head1 SYNOPSIS
9
10 #include <openssl/pkcs12.h>
11
12 const STACK_OF(X509_ATTRIBUTE) *PKCS12_SAFEBAG_get0_attrs(const PKCS12_SAFEBAG *bag);
13
14 ASN1_TYPE *PKCS12_get_attr_gen(const STACK_OF(X509_ATTRIBUTE) *attrs,
15                                int attr_nid);
16
17=head1 DESCRIPTION
18
19PKCS12_SAFEBAG_get0_attrs() retrieves the stack of B<X509_ATTRIBUTE>s from a
20PKCS#12 safeBag. I<bag> is the B<PKCS12_SAFEBAG> to retrieve the attributes from.
21
22PKCS12_get_attr_gen() retrieves an attribute by NID from a stack of
23B<X509_ATTRIBUTE>s. I<attr_nid> is the NID of the attribute to retrieve.
24
25=head1 RETURN VALUES
26
27PKCS12_SAFEBAG_get0_attrs() returns the stack of B<X509_ATTRIBUTE>s from a
28PKCS#12 safeBag, which could be empty.
29
30PKCS12_get_attr_gen() returns an B<ASN1_TYPE> object containing the attribute,
31or NULL if the attribute was either not present or an error occurred.
32
33PKCS12_get_attr_gen() does not allocate a new attribute. The returned attribute
34is still owned by the B<PKCS12_SAFEBAG> in which it resides.
35
36=head1 SEE ALSO
37
38L<PKCS12_get_friendlyname(3)>,
39L<PKCS12_add_friendlyname_asc(3)>
40
41=head1 COPYRIGHT
42
43Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
44
45Licensed under the Apache License 2.0 (the "License").  You may not use
46this file except in compliance with the License.  You can obtain a copy
47in the file LICENSE in the source distribution or at
48L<https://www.openssl.org/source/license.html>.
49
50=cut
51