xref: /freebsd/crypto/openssl/doc/man3/X509_ACERT_add_attr_nconf.pod (revision e7be843b4a162e68651d3911f0357ed464915629)
1*e7be843bSPierre Pronchery=pod
2*e7be843bSPierre Pronchery
3*e7be843bSPierre Pronchery=head1 NAME
4*e7be843bSPierre Pronchery
5*e7be843bSPierre ProncheryX509_ACERT_add_attr_nconf
6*e7be843bSPierre Pronchery- Add attributes to X509_ACERT from configuration section
7*e7be843bSPierre Pronchery
8*e7be843bSPierre Pronchery=head1 SYNOPSIS
9*e7be843bSPierre Pronchery
10*e7be843bSPierre Pronchery #include <openssl/x509_acert.h>
11*e7be843bSPierre Pronchery
12*e7be843bSPierre Pronchery int X509_ACERT_add_attr_nconf(CONF *conf, const char *section,
13*e7be843bSPierre Pronchery                               X509_ACERT *acert);
14*e7be843bSPierre Pronchery
15*e7be843bSPierre Pronchery=head1 DESCRIPTION
16*e7be843bSPierre Pronchery
17*e7be843bSPierre ProncheryX509_ACERT_add_attr_nconf() adds one or more B<X509_ATTRIBUTE>s to the
18*e7be843bSPierre Proncheryexisting B<X509_ACERT> structure I<acert>. The attributes are read
19*e7be843bSPierre Proncheryfrom a I<section> of the I<conf> object.
20*e7be843bSPierre Pronchery
21*e7be843bSPierre ProncheryThe give I<section> of the configuration should contain attribute
22*e7be843bSPierre Proncherydescriptions of the form:
23*e7be843bSPierre Pronchery
24*e7be843bSPierre Pronchery  attribute_name = value
25*e7be843bSPierre Pronchery
26*e7be843bSPierre ProncheryThe format of B<value> will vary depending on the B<attribute_name>.
27*e7be843bSPierre ProncheryB<value> can either be a string value or an B<ASN1_TYPE>
28*e7be843bSPierre Proncheryobject.
29*e7be843bSPierre Pronchery
30*e7be843bSPierre ProncheryTo encode an B<ASN1_TYPE> object, use the prefix "ASN1:" followed by
31*e7be843bSPierre Proncherythe object description that uses the same syntax as L<ASN1_generate_nconf(3)>.
32*e7be843bSPierre ProncheryFor example:
33*e7be843bSPierre Pronchery
34*e7be843bSPierre Pronchery id-aca-group = ASN1:SEQUENCE:ietfattr
35*e7be843bSPierre Pronchery
36*e7be843bSPierre Pronchery [ietfattr]
37*e7be843bSPierre Pronchery values = SEQUENCE:groups
38*e7be843bSPierre Pronchery
39*e7be843bSPierre Pronchery [groups]
40*e7be843bSPierre Pronchery 1.string = UTF8:mygroup1
41*e7be843bSPierre Pronchery
42*e7be843bSPierre Pronchery=head1 RETURN VALUES
43*e7be843bSPierre Pronchery
44*e7be843bSPierre ProncheryX509_ACERT_add_attr_nconf() returns 1 for success and 0 for failure.
45*e7be843bSPierre Pronchery
46*e7be843bSPierre Pronchery=head1 SEE ALSO
47*e7be843bSPierre Pronchery
48*e7be843bSPierre ProncheryL<ASN1_generate_nconf(3)>.
49*e7be843bSPierre Pronchery
50*e7be843bSPierre Pronchery=head1 HISTORY
51*e7be843bSPierre Pronchery
52*e7be843bSPierre ProncheryThe function X509_ACERT_add_attr_nconf() was added in OpenSSL 3.4.
53*e7be843bSPierre Pronchery
54*e7be843bSPierre Pronchery=head1 COPYRIGHT
55*e7be843bSPierre Pronchery
56*e7be843bSPierre ProncheryCopyright 2023-2024 The OpenSSL Project Authors. All Rights Reserved.
57*e7be843bSPierre Pronchery
58*e7be843bSPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
59*e7be843bSPierre Proncherythis file except in compliance with the License.  You can obtain a copy
60*e7be843bSPierre Proncheryin the file LICENSE in the source distribution or at
61*e7be843bSPierre ProncheryL<https://www.openssl.org/source/license.html>.
62*e7be843bSPierre Pronchery
63*e7be843bSPierre Pronchery=cut
64