Certificate Management Protocol (CMP, RFC 4210) extension to OpenSSL
[openssl.git] / doc / man3 / OSSL_CRMF_MSG_set1_regInfo_certReq.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_CRMF_MSG_set1_regInfo_utf8Pairs,
6 OSSL_CRMF_MSG_set1_regInfo_certReq
7 - functions setting CRMF Registration Info
8
9 =head1 SYNOPSIS
10
11  #include <openssl/crmf.h>
12
13  int OSSL_CRMF_MSG_set1_regInfo_utf8Pairs(OSSL_CRMF_MSG *msg,
14                                           const ASN1_UTF8STRING *utf8pairs);
15  int OSSL_CRMF_MSG_set1_regInfo_certReq(OSSL_CRMF_MSG *msg,
16                                         const OSSL_CRMF_CERTREQUEST *cr);
17
18 =head1 DESCRIPTION
19
20 OSSL_CRMF_MSG_set1_regInfo_utf8Pairs() adds a copy of the given B<utf8pairs>
21 value as utf8Pairs regInfo to the given B<msg>. See RFC 4211 section 7.1.
22
23 OSSL_CRMF_MSG_set1_regInfo_certReq() adds a copy of the given B<cr> value
24 as certReq regInfo to the given B<msg>. See RFC 4211 section 7.2.
25
26 =head1 RETURN VALUES
27
28 All functions return 1 on success, 0 on error.
29
30 =head1 NOTES
31
32 Calling these functions multiple times adds multiple instances of the respective
33 control to the regInfo structure of the given B<msg>. While RFC 4211 expects
34 multiple utf8Pairs in one regInfo structure, it does not allow multiple certReq.
35
36 =head1 SEE ALSO
37
38 RFC 4211
39
40 =head1 COPYRIGHT
41
42 Copyright 2007-2018 The OpenSSL Project Authors. All Rights Reserved.
43
44 Licensed under the OpenSSL license (the "License").  You may not use
45 this file except in compliance with the License.  You can obtain a copy
46 in the file LICENSE in the source distribution or at
47 L<https://www.openssl.org/source/license.html>.
48
49 =cut