1=pod
2
3=head1 NAME
4
5PKCS12_SAFEBAG_get0_attr, PKCS12_SAFEBAG_get0_type,
6PKCS12_SAFEBAG_get_nid, PKCS12_SAFEBAG_get_bag_nid,
7PKCS12_SAFEBAG_get0_bag_obj, PKCS12_SAFEBAG_get0_bag_type,
8PKCS12_SAFEBAG_get1_cert_ex, PKCS12_SAFEBAG_get1_cert,
9PKCS12_SAFEBAG_get1_crl_ex, PKCS12_SAFEBAG_get1_crl,
10PKCS12_SAFEBAG_get0_safes, PKCS12_SAFEBAG_get0_p8inf,
11PKCS12_SAFEBAG_get0_pkcs8 - Get objects from a PKCS#12 safeBag
12
13=head1 SYNOPSIS
14
15 #include <openssl/pkcs12.h>
16
17 const ASN1_TYPE *PKCS12_SAFEBAG_get0_attr(const PKCS12_SAFEBAG *bag,
18                                           int attr_nid);
19 const ASN1_OBJECT *PKCS12_SAFEBAG_get0_type(const PKCS12_SAFEBAG *bag);
20 int PKCS12_SAFEBAG_get_nid(const PKCS12_SAFEBAG *bag);
21 int PKCS12_SAFEBAG_get_bag_nid(const PKCS12_SAFEBAG *bag);
22 const ASN1_TYPE *PKCS12_SAFEBAG_get0_bag_obj(const PKCS12_SAFEBAG *bag);
23 const ASN1_OBJECT *PKCS12_SAFEBAG_get0_bag_type(const PKCS12_SAFEBAG *bag);
24 X509_CRL *PKCS12_SAFEBAG_get1_cert_ex(const PKCS12_SAFEBAG *bag,
25                                       OSSL_LIB_CTX *libctx, const char *propq);
26 X509 *PKCS12_SAFEBAG_get1_cert(const PKCS12_SAFEBAG *bag);
27 X509_CRL *PKCS12_SAFEBAG_get1_crl_ex(const PKCS12_SAFEBAG *bag,
28                                      OSSL_LIB_CTX *libctx, const char *propq);
29 X509_CRL *PKCS12_SAFEBAG_get1_crl(const PKCS12_SAFEBAG *bag);
30 const STACK_OF(PKCS12_SAFEBAG) *PKCS12_SAFEBAG_get0_safes(const PKCS12_SAFEBAG *bag);
31 const PKCS8_PRIV_KEY_INFO *PKCS12_SAFEBAG_get0_p8inf(const PKCS12_SAFEBAG *bag);
32 const X509_SIG *PKCS12_SAFEBAG_get0_pkcs8(const PKCS12_SAFEBAG *bag);
33
34=head1 DESCRIPTION
35
36PKCS12_SAFEBAG_get0_attr() gets the attribute value corresponding to the B<attr_nid>.
37
38PKCS12_SAFEBAG_get0_type() gets the B<safeBag> type as an OID, whereas
39PKCS12_SAFEBAG_get_nid() gets the B<safeBag> type as an NID, which could be
40B<NID_certBag>, B<NID_crlBag>, B<NID_keyBag>, B<NID_secretBag>, B<NID_safeContentsBag>
41or B<NID_pkcs8ShroudedKeyBag>.
42
43PKCS12_SAFEBAG_get_bag_nid() gets the type of the object contained within the
44B<PKCS12_SAFEBAG>. This corresponds to the bag type for most bags, but can be
45arbitrary for B<secretBag>s. PKCS12_SAFEBAG_get0_bag_type() gets this type as an OID.
46
47PKCS12_SAFEBAG_get0_bag_obj() retrieves the object contained within the safeBag.
48
49PKCS12_SAFEBAG_get1_cert_ex() and PKCS12_SAFEBAG_get1_crl_ex() return new B<X509> or
50B<X509_CRL> objects from the item in the safeBag. I<libctx> and I<propq> are used when
51fetching algorithms, and may optionally be set to NULL.
52
53PKCS12_SAFEBAG_get1_cert() and PKCS12_SAFEBAG_get1_crl() are the same as
54PKCS12_SAFEBAG_get1_cert_ex() and PKCS12_SAFEBAG_get1_crl_ex() and set the I<libctx> and
55I<prop> to NULL. This will use the default library context.
56
57PKCS12_SAFEBAG_get0_p8inf() and PKCS12_SAFEBAG_get0_pkcs8() return the PKCS8 object
58from a PKCS8shroudedKeyBag or a keyBag.
59
60PKCS12_SAFEBAG_get0_safes() retrieves the set of B<safeBags> contained within a
61safeContentsBag.
62
63=head1 RETURN VALUES
64
65PKCS12_SAFEBAG_get_nid() and PKCS12_SAFEBAG_get_bag_nid() return the NID of the safeBag
66or bag object, or -1 if there is no corresponding NID.
67Other functions return a valid object of the specified type or NULL if an error occurred.
68
69=head1 SEE ALSO
70
71L<PKCS12_create(3)>,
72L<PKCS12_add_safe(3)>,
73L<PKCS12_add_safes(3)>
74
75=head1 HISTORY
76
77The functions PKCS12_SAFEBAG_get1_cert_ex() and PKCS12_SAFEBAG_get1_crl_ex() were
78added in OpenSSL 3.2.
79
80=head1 COPYRIGHT
81
82Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
83
84Licensed under the Apache License 2.0 (the "License").  You may not use
85this file except in compliance with the License.  You can obtain a copy
86in the file LICENSE in the source distribution or at
87L<https://www.openssl.org/source/license.html>.
88
89=cut
90