Debian Codegraph @

upstream/debian-unstable/man3/X509_ACERT_add_attr_nconf.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_ADD_ATTR_NCONF 3SSL"
58 .TH X509_ACERT_ADD_ATTR_NCONF 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_add_attr_nconf
65 \&\- Add attributes to X509_ACERT from configuration section
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/x509_acert.h>
70 \&
71 \& int X509_ACERT_add_attr_nconf(CONF *conf, const char *section,
72 \& X509_ACERT *acert);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 \&\fBX509_ACERT_add_attr_nconf()\fR adds one or more \fBX509_ATTRIBUTE\fRs to the
77 existing \fBX509_ACERT\fR structure \fIacert\fR. The attributes are read
78 from a \fIsection\fR of the \fIconf\fR object.
79 .PP
80 The give \fIsection\fR of the configuration should contain attribute
81 descriptions of the form:
82 .PP
83 .Vb 1
84 \& attribute_name = value
85 .Ve
86 .PP
87 The format of \fBvalue\fR will vary depending on the \fBattribute_name\fR.
88 \&\fBvalue\fR can either be a string value or an \fBASN1_TYPE\fR
89 object.
90 .PP
91 To encode an \fBASN1_TYPE\fR object, use the prefix "ASN1:" followed by
92 the object description that uses the same syntax as \fBASN1_generate_nconf\fR\|(3).
93 For example:
94 .PP
95 .Vb 1
96 \& id\-aca\-group = ASN1:SEQUENCE:ietfattr
97 \&
98 \& [ietfattr]
99 \& values = SEQUENCE:groups
100 \&
101 \& [groups]
102 \& 1.string = UTF8:mygroup1
103 .Ve
104 .SH "RETURN VALUES"
105 .IX Header "RETURN VALUES"
106 \&\fBX509_ACERT_add_attr_nconf()\fR returns 1 for success and 0 for failure.
107 .SH "SEE ALSO"
108 .IX Header "SEE ALSO"
109 \&\fBASN1_generate_nconf\fR\|(3).
110 .SH HISTORY
111 .IX Header "HISTORY"
112 The function \fBX509_ACERT_add_attr_nconf()\fR was added in OpenSSL 3.4.
113 .SH COPYRIGHT
114 .IX Header "COPYRIGHT"
115 Copyright 2023\-2024 The OpenSSL Project Authors. All Rights Reserved.
116 .PP
117 Licensed under the Apache License 2.0 (the "License"). You may not use
118 this file except in compliance with the License. You can obtain a copy
119 in the file LICENSE in the source distribution or at
120 <https://www.openssl.org/source/license.html>.