Debian Codegraph @

upstream/debian-unstable/man3/OSSL_CRMF_MSG_set1_regInfo_certReq.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OSSL_CRMF_MSG_SET1_REGINFO_CERTREQ 3SSL"
58 .TH OSSL_CRMF_MSG_SET1_REGINFO_CERTREQ 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 OSSL_CRMF_MSG_get0_regInfo_utf8Pairs,
65 OSSL_CRMF_MSG_set1_regInfo_utf8Pairs,
66 OSSL_CRMF_MSG_get0_regInfo_certReq,
67 OSSL_CRMF_MSG_set1_regInfo_certReq
68 \&\- functions getting or setting CRMF Registration Info
69 .SH SYNOPSIS
70 .IX Header "SYNOPSIS"
71 .Vb 1
72 \& #include <openssl/crmf.h>
73 \&
74 \& ASN1_UTF8STRING
75 \& *OSSL_CRMF_MSG_get0_regInfo_utf8Pairs(const OSSL_CRMF_MSG *msg);
76 \& int OSSL_CRMF_MSG_set1_regInfo_utf8Pairs(OSSL_CRMF_MSG *msg,
77 \& const ASN1_UTF8STRING *utf8pairs);
78 \& OSSL_CRMF_CERTREQUEST
79 \& *OSSL_CRMF_MSG_get0_regInfo_certReq(const OSSL_CRMF_MSG *msg);
80 \& int OSSL_CRMF_MSG_set1_regInfo_certReq(OSSL_CRMF_MSG *msg,
81 \& const OSSL_CRMF_CERTREQUEST *cr);
82 .Ve
83 .SH DESCRIPTION
84 .IX Header "DESCRIPTION"
85 \&\fBOSSL_CRMF_MSG_get0_regInfo_utf8Pairs()\fR returns the first utf8Pairs regInfo
86 in the given \fImsg\fR, if present.
87 .PP
88 \&\fBOSSL_CRMF_MSG_set1_regInfo_utf8Pairs()\fR adds a copy of the given \fIutf8pairs\fR
89 value as utf8Pairs regInfo to the given \fImsg\fR. See RFC 4211 section 7.1.
90 .PP
91 \&\fBOSSL_CRMF_MSG_get0_regInfo_certReq()\fR returns the first certReq regInfo
92 in the given \fImsg\fR, if present.
93 .PP
94 \&\fBOSSL_CRMF_MSG_set1_regInfo_certReq()\fR adds a copy of the given \fIcr\fR value
95 as certReq regInfo to the given \fImsg\fR. See RFC 4211 section 7.2.
96 .SH "RETURN VALUES"
97 .IX Header "RETURN VALUES"
98 All get0_*() functions return the respective pointer value, NULL if not present.
99 .PP
100 All set1_*() functions return 1 on success, 0 on error.
101 .SH NOTES
102 .IX Header "NOTES"
103 Calling the set1_*() functions multiple times
104 adds multiple instances of the respective
105 control to the regInfo structure of the given \fImsg\fR. While RFC 4211 expects
106 multiple utf8Pairs in one regInfo structure, it does not allow multiple certReq.
107 .SH "SEE ALSO"
108 .IX Header "SEE ALSO"
109 RFC 4211
110 .SH HISTORY
111 .IX Header "HISTORY"
112 The OpenSSL CRMF support was added in OpenSSL 3.0.
113 .SH COPYRIGHT
114 .IX Header "COPYRIGHT"
115 Copyright 2007\-2021 The OpenSSL Project Authors. All Rights Reserved.
116 .PP
117 Licensed under the Apache License 2.0 (the "License"). You may not use
118 this file except in compliance with the License. You can obtain a copy
119 in the file LICENSE in the source distribution or at
120 <https://www.openssl.org/source/license.html>.