xref: /freebsd/crypto/openssl/doc/man3/OSSL_CRMF_MSG_set1_regInfo_certReq.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1=pod
2
3=head1 NAME
4
5OSSL_CRMF_MSG_get0_regInfo_utf8Pairs,
6OSSL_CRMF_MSG_set1_regInfo_utf8Pairs,
7OSSL_CRMF_MSG_get0_regInfo_certReq,
8OSSL_CRMF_MSG_set1_regInfo_certReq
9- functions getting or setting CRMF Registration Info
10
11=head1 SYNOPSIS
12
13 #include <openssl/crmf.h>
14
15 ASN1_UTF8STRING
16     *OSSL_CRMF_MSG_get0_regInfo_utf8Pairs(const OSSL_CRMF_MSG *msg);
17 int OSSL_CRMF_MSG_set1_regInfo_utf8Pairs(OSSL_CRMF_MSG *msg,
18                                          const ASN1_UTF8STRING *utf8pairs);
19 OSSL_CRMF_CERTREQUEST
20     *OSSL_CRMF_MSG_get0_regInfo_certReq(const OSSL_CRMF_MSG *msg);
21 int OSSL_CRMF_MSG_set1_regInfo_certReq(OSSL_CRMF_MSG *msg,
22                                        const OSSL_CRMF_CERTREQUEST *cr);
23
24=head1 DESCRIPTION
25
26OSSL_CRMF_MSG_get0_regInfo_utf8Pairs() returns the first utf8Pairs regInfo
27in the given I<msg>, if present.
28
29OSSL_CRMF_MSG_set1_regInfo_utf8Pairs() adds a copy of the given I<utf8pairs>
30value as utf8Pairs regInfo to the given I<msg>. See RFC 4211 section 7.1.
31
32OSSL_CRMF_MSG_get0_regInfo_certReq() returns the first certReq regInfo
33in the given I<msg>, if present.
34
35OSSL_CRMF_MSG_set1_regInfo_certReq() adds a copy of the given I<cr> value
36as certReq regInfo to the given I<msg>. See RFC 4211 section 7.2.
37
38=head1 RETURN VALUES
39
40All get0_*() functions return the respective pointer value, NULL if not present.
41
42All set1_*() functions return 1 on success, 0 on error.
43
44=head1 NOTES
45
46Calling the set1_*() functions multiple times
47adds multiple instances of the respective
48control to the regInfo structure of the given I<msg>. While RFC 4211 expects
49multiple utf8Pairs in one regInfo structure, it does not allow multiple certReq.
50
51=head1 SEE ALSO
52
53RFC 4211
54
55=head1 HISTORY
56
57The OpenSSL CRMF support was added in OpenSSL 3.0.
58
59=head1 COPYRIGHT
60
61Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
62
63Licensed under the Apache License 2.0 (the "License").  You may not use
64this file except in compliance with the License.  You can obtain a copy
65in the file LICENSE in the source distribution or at
66L<https://www.openssl.org/source/license.html>.
67
68=cut
69