Debian Codegraph @

upstream/debian-unstable/man3/OSSL_CRMF_MSG_set1_regCtrl_regToken.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_REGCTRL_REGTOKEN 3SSL"
58 .TH OSSL_CRMF_MSG_SET1_REGCTRL_REGTOKEN 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_regCtrl_regToken,
65 OSSL_CRMF_MSG_set1_regCtrl_regToken,
66 OSSL_CRMF_MSG_get0_regCtrl_authenticator,
67 OSSL_CRMF_MSG_set1_regCtrl_authenticator,
68 OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo,
69 OSSL_CRMF_MSG_set0_SinglePubInfo,
70 OSSL_CRMF_MSG_set_PKIPublicationInfo_action,
71 OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo,
72 OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo,
73 OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey,
74 OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey,
75 OSSL_CRMF_MSG_get0_regCtrl_oldCertID,
76 OSSL_CRMF_MSG_set1_regCtrl_oldCertID,
77 OSSL_CRMF_CERTID_gen
78 \&\- functions getting or setting CRMF Registration Controls
79 .SH SYNOPSIS
80 .IX Header "SYNOPSIS"
81 .Vb 1
82 \& #include <openssl/crmf.h>
83 \&
84 \& ASN1_UTF8STRING
85 \& *OSSL_CRMF_MSG_get0_regCtrl_regToken(const OSSL_CRMF_MSG *msg);
86 \& int OSSL_CRMF_MSG_set1_regCtrl_regToken(OSSL_CRMF_MSG *msg,
87 \& const ASN1_UTF8STRING *tok);
88 \& ASN1_UTF8STRING
89 \& *OSSL_CRMF_MSG_get0_regCtrl_authenticator(const OSSL_CRMF_MSG *msg);
90 \& int OSSL_CRMF_MSG_set1_regCtrl_authenticator(OSSL_CRMF_MSG *msg,
91 \& const ASN1_UTF8STRING *auth);
92 \& int OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo(
93 \& OSSL_CRMF_PKIPUBLICATIONINFO *pi,
94 \& OSSL_CRMF_SINGLEPUBINFO *spi);
95 \& int OSSL_CRMF_MSG_set0_SinglePubInfo(OSSL_CRMF_SINGLEPUBINFO *spi,
96 \& int method, GENERAL_NAME *nm);
97 \& int OSSL_CRMF_MSG_set_PKIPublicationInfo_action(
98 \& OSSL_CRMF_PKIPUBLICATIONINFO *pi, int action);
99 \& OSSL_CRMF_PKIPUBLICATIONINFO
100 \& *OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo(const OSSL_CRMF_MSG *msg);
101 \& int OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo(OSSL_CRMF_MSG *msg,
102 \& const OSSL_CRMF_PKIPUBLICATIONINFO *pi);
103 \& X509_PUBKEY
104 \& *OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey(const OSSL_CRMF_MSG *msg);
105 \& int OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey(OSSL_CRMF_MSG *msg,
106 \& const X509_PUBKEY *pubkey);
107 \& OSSL_CRMF_CERTID
108 \& *OSSL_CRMF_MSG_get0_regCtrl_oldCertID(const OSSL_CRMF_MSG *msg);
109 \& int OSSL_CRMF_MSG_set1_regCtrl_oldCertID(OSSL_CRMF_MSG *msg,
110 \& const OSSL_CRMF_CERTID *cid);
111 \& OSSL_CRMF_CERTID *OSSL_CRMF_CERTID_gen(const X509_NAME *issuer,
112 \& const ASN1_INTEGER *serial);
113 .Ve
114 .SH DESCRIPTION
115 .IX Header "DESCRIPTION"
116 Each of the \fBOSSL_CRMF_MSG_get0_regCtrl_X()\fR functions
117 returns the respective control X in the given \fImsg\fR, if present.
118 .PP
119 \&\fBOSSL_CRMF_MSG_set1_regCtrl_regToken()\fR sets the regToken control in the given
120 \&\fImsg\fR copying the given \fItok\fR as value. See RFC 4211, section 6.1.
121 .PP
122 \&\fBOSSL_CRMF_MSG_set1_regCtrl_authenticator()\fR sets the authenticator control in
123 the given \fImsg\fR copying the given \fIauth\fR as value. See RFC 4211, section 6.2.
124 .PP
125 \&\fBOSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo()\fR pushes the given \fIspi\fR
126 to \fIsi\fR. Consumes the \fIspi\fR pointer.
127 .PP
128 \&\fBOSSL_CRMF_MSG_set0_SinglePubInfo()\fR sets in the given SinglePubInfo \fIspi\fR
129 the \fImethod\fR and publication location, in the form of a GeneralName, \fInm\fR.
130 The publication location is optional, and therefore \fInm\fR may be NULL.
131 The function consumes the \fInm\fR pointer if present.
132 Available methods are:
133 # define OSSL_CRMF_PUB_METHOD_DONTCARE 0
134 # define OSSL_CRMF_PUB_METHOD_X500 1
135 # define OSSL_CRMF_PUB_METHOD_WEB 2
136 # define OSSL_CRMF_PUB_METHOD_LDAP 3
137 .PP
138 \&\fBOSSL_CRMF_MSG_set_PKIPublicationInfo_action()\fR sets the action in the given \fIpi\fR
139 using the given \fIaction\fR as value. See RFC 4211, section 6.3.
140 Available actions are:
141 # define OSSL_CRMF_PUB_ACTION_DONTPUBLISH 0
142 # define OSSL_CRMF_PUB_ACTION_PLEASEPUBLISH 1
143 .PP
144 \&\fBOSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo()\fR sets the pkiPublicationInfo
145 control in the given \fImsg\fR copying the given \fItok\fR as value. See RFC 4211,
146 section 6.3.
147 .PP
148 \&\fBOSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey()\fR sets the protocolEncrKey control in
149 the given \fImsg\fR copying the given \fIpubkey\fR as value. See RFC 4211 section 6.6.
150 .PP
151 \&\fBOSSL_CRMF_MSG_set1_regCtrl_oldCertID()\fR sets the \fBoldCertID\fR regToken control in
152 the given \fImsg\fR copying the given \fIcid\fR as value. See RFC 4211, section 6.5.
153 .PP
154 OSSL_CRMF_CERTID_gen produces an OSSL_CRMF_CERTID_gen structure copying the
155 given \fIissuer\fR name and \fIserial\fR number.
156 .SH "RETURN VALUES"
157 .IX Header "RETURN VALUES"
158 All OSSL_CRMF_MSG_get0_*() functions
159 return the respective pointer value or NULL if not present and on error.
160 .PP
161 All OSSL_CRMF_MSG_set1_*() functions return 1 on success, 0 on error.
162 .PP
163 \&\fBOSSL_CRMF_CERTID_gen()\fR returns a pointer to the resulting structure
164 or NULL on error.
165 .SH NOTES
166 .IX Header "NOTES"
167 A function \fBOSSL_CRMF_MSG_set1_regCtrl_pkiArchiveOptions()\fR for setting an
168 Archive Options Control is not yet implemented due to missing features to
169 create the needed OSSL_CRMF_PKIARCHIVEOPTINS content.
170 .SH "SEE ALSO"
171 .IX Header "SEE ALSO"
172 RFC 4211
173 .SH HISTORY
174 .IX Header "HISTORY"
175 The OpenSSL CRMF support was added in OpenSSL 3.0.
176 .SH COPYRIGHT
177 .IX Header "COPYRIGHT"
178 Copyright 2007\-2022 The OpenSSL Project Authors. All Rights Reserved.
179 .PP
180 Licensed under the Apache License 2.0 (the "License"). You may not use
181 this file except in compliance with the License. You can obtain a copy
182 in the file LICENSE in the source distribution or at
183 <https://www.openssl.org/source/license.html>.