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