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