Debian Codegraph @

upstream/debian-unstable/man3/PKCS12_SAFEBAG_get0_attrs.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "PKCS12_SAFEBAG_GET0_ATTRS 3SSL"
58 .TH PKCS12_SAFEBAG_GET0_ATTRS 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 PKCS12_SAFEBAG_get0_attrs, PKCS12_get_attr_gen
65 \&\- Retrieve attributes from a PKCS#12 safeBag
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/pkcs12.h>
70 \&
71 \& const STACK_OF(X509_ATTRIBUTE) *PKCS12_SAFEBAG_get0_attrs(const PKCS12_SAFEBAG *bag);
72 \&
73 \& ASN1_TYPE *PKCS12_get_attr_gen(const STACK_OF(X509_ATTRIBUTE) *attrs,
74 \& int attr_nid);
75 .Ve
76 .SH DESCRIPTION
77 .IX Header "DESCRIPTION"
78 \&\fBPKCS12_SAFEBAG_get0_attrs()\fR retrieves the stack of \fBX509_ATTRIBUTE\fRs from a
79 PKCS#12 safeBag. \fIbag\fR is the \fBPKCS12_SAFEBAG\fR to retrieve the attributes from.
80 .PP
81 \&\fBPKCS12_get_attr_gen()\fR retrieves an attribute by NID from a stack of
82 \&\fBX509_ATTRIBUTE\fRs. \fIattr_nid\fR is the NID of the attribute to retrieve.
83 .SH "RETURN VALUES"
84 .IX Header "RETURN VALUES"
85 \&\fBPKCS12_SAFEBAG_get0_attrs()\fR returns the stack of \fBX509_ATTRIBUTE\fRs from a
86 PKCS#12 safeBag, which could be empty.
87 .PP
88 \&\fBPKCS12_get_attr_gen()\fR returns an \fBASN1_TYPE\fR object containing the attribute,
89 or NULL if the attribute was either not present or an error occurred.
90 .PP
91 \&\fBPKCS12_get_attr_gen()\fR does not allocate a new attribute. The returned attribute
92 is still owned by the \fBPKCS12_SAFEBAG\fR in which it resides.
93 .SH "SEE ALSO"
94 .IX Header "SEE ALSO"
95 \&\fBPKCS12_get_friendlyname\fR\|(3),
96 \&\fBPKCS12_add_friendlyname_asc\fR\|(3)
97 .SH COPYRIGHT
98 .IX Header "COPYRIGHT"
99 Copyright 2019\-2020 The OpenSSL Project Authors. All Rights Reserved.
100 .PP
101 Licensed under the Apache License 2.0 (the "License"). You may not use
102 this file except in compliance with the License. You can obtain a copy
103 in the file LICENSE in the source distribution or at
104 <https://www.openssl.org/source/license.html>.