Debian Codegraph @

upstream/debian-unstable/man3/X509_ACERT_get_attr.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 "X509_ACERT_GET_ATTR 3SSL"
58 .TH X509_ACERT_GET_ATTR 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 X509_ACERT_get_attr,
65 X509_ACERT_get_attr_by_NID,
66 X509_ACERT_get_attr_by_OBJ,
67 X509_ACERT_get_attr_count
68 \&\- Retrieve attributes from an X509_ACERT structure
69 .SH SYNOPSIS
70 .IX Header "SYNOPSIS"
71 .Vb 1
72 \& #include <openssl/x509_acert.h>
73 \&
74 \& X509_ATTRIBUTE *X509_ACERT_get_attr(const X509_ACERT *x, int loc);
75 \& int X509_ACERT_get_attr_by_NID(const X509_ACERT *x, int nid, int lastpos);
76 \& int X509_ACERT_get_attr_by_OBJ(const X509_ACERT *x, const ASN1_OBJECT *obj,
77 \& int lastpos);
78 \& int X509_ACERT_get_attr_count(const X509_ACERT *x);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 \&\fBX509_ACERT_get0_attr()\fR retrieves the \fIloc\fRth \fBX509_ATTRIBUTE\fR from an
83 \&\fBX509_ACERT\fR \fIx\fR. \fBX509_ACERT_get_attr_count()\fR returns the total number
84 of attributes in the \fBX509_ACERT\fR.
85 .PP
86 \&\fBX509_ACERT_get_attr_by_NID()\fR and \fBX509_ACERT_get_attr_by_OBJ()\fR retrieve the next
87 attribute location matching \fInid\fR or \fIobj\fR after \fIlastpos\fR. \fIlastpos\fR
88 should initially be set to \-1.
89 If there are no more entries \-1 is returned. If \fInid\fR is invalid
90 (doesn't correspond to a valid OID) then \-2 is returned.
91 .SH "RETURN VALUES"
92 .IX Header "RETURN VALUES"
93 \&\fBX509_ACERT_get0_attr()\fR return a \fBX509_ATTRIBUTE\fR from an attribute
94 certificate, or NULL if the specified attribute is not found.
95 .PP
96 \&\fBX509_ACERT_get_attr_by_NID()\fR and \fBX509_ACERT_get_attr_by_OBJ()\fR return
97 the location of the next attribute requested or \-1 if not found.
98 \&\fBX509_ACERT_get_attr_by_NID()\fR can also return \-2 if the supplied NID is invalid.
99 .PP
100 \&\fBX509_ACERT_get_attr_count()\fR returns the number of attributes in the given
101 attribute certificate.
102 .SH HISTORY
103 .IX Header "HISTORY"
104 \&\fBX509_ACERT_get0_attr()\fR, \fBX509_ACERT_get_attr_by_NID()\fR, \fBX509_ACERT_get_attr_by_OBJ()\fR and
105 \&\fBX509_ACERT_get_attr_count()\fR were added in OpenSSL 3.4.
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright 2023\-2024 The OpenSSL Project Authors. All Rights Reserved.
109 .PP
110 Licensed under the Apache License 2.0 (the "License"). You may not use
111 this file except in compliance with the License. You can obtain a copy
112 in the file LICENSE in the source distribution or at
113 <https://www.openssl.org/source/license.html>.