summaryrefslogtreecommitdiffstats
path: root/doc/man3/X509_ACERT_add_attr_nconf.pod
blob: a16d31c3f3698495890cba5f8be71aaf86bf8434 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
=pod

=head1 NAME

X509_ACERT_add_attr_nconf
- Add attributes to X509_ACERT from configuration section

=head1 SYNOPSIS

 #include <openssl/x509_acert.h>

 int X509_ACERT_add_attr_nconf(CONF *conf, const char *section,
                               X509_ACERT *acert);

=head1 DESCRIPTION

X509_ACERT_add_attr_nconf() adds one or more B<X509_ATTRIBUTE>s to the
existing B<X509_ACERT> structure I<acert>. The attributes are read
from a I<section> of the I<conf> object.

The give I<section> of the configuration should contain attribute
descriptions of the form:

  attribute_name = value

The format of B<value> will vary depending on the B<attribute_name>.
B<value> can either be a string value or an B<ASN1_TYPE>
object.

To encode an B<ASN1_TYPE> object, use the prefix "ASN1:" followed by
the object description that uses the same syntax as L<ASN1_generate_nconf(3)>.
For example:

 id-aca-group = ASN1:SEQUENCE:ietfattr

 [ietfattr]
 values = SEQUENCE:groups

 [groups]
 1.string = UTF8:mygroup1

=head1 RETURN VALUES

X509_ACERT_add_attr_nconf() returns 1 for success and 0 for failure.

=head1 SEE ALSO

L<ASN1_generate_nconf(3)>.

=head1 HISTORY

The function X509_ACERT_add_attr_nconf() was added in OpenSSL 3.4.

=head1 COPYRIGHT

Copyright 2023 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut