1OSSL_CRMF_MSG_SET1_REGCTRL_REGTOKEN(3OOopSseSsnLlS_)SCLRMF_MSG_SET1_REGCTRL_REGTOKEN(3ossl)
2
3
4

NAME

6       OSSL_CRMF_MSG_get0_regCtrl_regToken,
7       OSSL_CRMF_MSG_set1_regCtrl_regToken,
8       OSSL_CRMF_MSG_get0_regCtrl_authenticator,
9       OSSL_CRMF_MSG_set1_regCtrl_authenticator,
10       OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo,
11       OSSL_CRMF_MSG_set0_SinglePubInfo,
12       OSSL_CRMF_MSG_set_PKIPublicationInfo_action,
13       OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo,
14       OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo,
15       OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey,
16       OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey,
17       OSSL_CRMF_MSG_get0_regCtrl_oldCertID,
18       OSSL_CRMF_MSG_set1_regCtrl_oldCertID, OSSL_CRMF_CERTID_gen - functions
19       getting or setting CRMF Registration Controls
20

SYNOPSIS

22        #include <openssl/crmf.h>
23
24        ASN1_UTF8STRING
25           *OSSL_CRMF_MSG_get0_regCtrl_regToken(const OSSL_CRMF_MSG *msg);
26        int OSSL_CRMF_MSG_set1_regCtrl_regToken(OSSL_CRMF_MSG *msg,
27                                                const ASN1_UTF8STRING *tok);
28        ASN1_UTF8STRING
29           *OSSL_CRMF_MSG_get0_regCtrl_authenticator(const OSSL_CRMF_MSG *msg);
30        int OSSL_CRMF_MSG_set1_regCtrl_authenticator(OSSL_CRMF_MSG *msg,
31                                                     const ASN1_UTF8STRING *auth);
32        int OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo(
33                                         OSSL_CRMF_PKIPUBLICATIONINFO *pi,
34                                         OSSL_CRMF_SINGLEPUBINFO *spi);
35        int OSSL_CRMF_MSG_set0_SinglePubInfo(OSSL_CRMF_SINGLEPUBINFO *spi,
36                                             int method, GENERAL_NAME *nm);
37        int OSSL_CRMF_MSG_set_PKIPublicationInfo_action(
38                                         OSSL_CRMF_PKIPUBLICATIONINFO *pi, int action);
39        OSSL_CRMF_PKIPUBLICATIONINFO
40           *OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo(const OSSL_CRMF_MSG *msg);
41        int OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo(OSSL_CRMF_MSG *msg,
42                                               const OSSL_CRMF_PKIPUBLICATIONINFO *pi);
43        X509_PUBKEY
44           *OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey(const OSSL_CRMF_MSG *msg);
45        int OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey(OSSL_CRMF_MSG *msg,
46                                                       const X509_PUBKEY *pubkey);
47        OSSL_CRMF_CERTID
48           *OSSL_CRMF_MSG_get0_regCtrl_oldCertID(const OSSL_CRMF_MSG *msg);
49        int OSSL_CRMF_MSG_set1_regCtrl_oldCertID(OSSL_CRMF_MSG *msg,
50                                                 const OSSL_CRMF_CERTID *cid);
51        OSSL_CRMF_CERTID *OSSL_CRMF_CERTID_gen(const X509_NAME *issuer,
52                                               const ASN1_INTEGER *serial);
53

DESCRIPTION

55       Each of the OSSL_CRMF_MSG_get0_regCtrl_X() functions returns the
56       respective control X in the given msg, if present.
57
58       OSSL_CRMF_MSG_set1_regCtrl_regToken() sets the regToken control in the
59       given msg copying the given tok as value. See RFC 4211, section 6.1.
60
61       OSSL_CRMF_MSG_set1_regCtrl_authenticator() sets the authenticator
62       control in the given msg copying the given auth as value. See RFC 4211,
63       section 6.2.
64
65       OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo() pushes the given
66       spi to si. Consumes the spi pointer.
67
68       OSSL_CRMF_MSG_set0_SinglePubInfo() sets in the given SinglePubInfo spi
69       the method and publication location, in the form of a GeneralName, nm.
70       The publication location is optional, and therefore nm may be NULL.
71       The function consumes the nm pointer if present.  Available methods
72       are:
73        # define OSSL_CRMF_PUB_METHOD_DONTCARE 0
74        # define OSSL_CRMF_PUB_METHOD_X500     1
75        # define OSSL_CRMF_PUB_METHOD_WEB      2
76        # define OSSL_CRMF_PUB_METHOD_LDAP     3
77
78       OSSL_CRMF_MSG_set_PKIPublicationInfo_action() sets the action in the
79       given pi using the given action as value. See RFC 4211, section 6.3.
80       Available actions are:
81        # define OSSL_CRMF_PUB_ACTION_DONTPUBLISH   0
82        # define OSSL_CRMF_PUB_ACTION_PLEASEPUBLISH 1
83
84       OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo() sets the
85       pkiPublicationInfo control in the given msg copying the given tok as
86       value. See RFC 4211, section 6.3.
87
88       OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey() sets the protocolEncrKey
89       control in the given msg copying the given pubkey as value. See RFC
90       4211 section 6.6.
91
92       OSSL_CRMF_MSG_set1_regCtrl_oldCertID() sets the oldCertID regToken
93       control in the given msg copying the given cid as value. See RFC 4211,
94       section 6.5.
95
96       OSSL_CRMF_CERTID_gen produces an OSSL_CRMF_CERTID_gen structure copying
97       the given issuer name and serial number.
98

RETURN VALUES

100       All OSSL_CRMF_MSG_get0_*() functions return the respective pointer
101       value or NULL if not present and on error.
102
103       All OSSL_CRMF_MSG_set1_*() functions return 1 on success, 0 on error.
104
105       OSSL_CRMF_CERTID_gen() returns a pointer to the resulting structure or
106       NULL on error.
107

NOTES

109       A function OSSL_CRMF_MSG_set1_regCtrl_pkiArchiveOptions() for setting
110       an Archive Options Control is not yet implemented due to missing
111       features to create the needed OSSL_CRMF_PKIARCHIVEOPTINS content.
112

SEE ALSO

114       RFC 4211
115

HISTORY

117       The OpenSSL CRMF support was added in OpenSSL 3.0.
118
120       Copyright 2007-2022 The OpenSSL Project Authors. All Rights Reserved.
121
122       Licensed under the Apache License 2.0 (the "License").  You may not use
123       this file except in compliance with the License.  You can obtain a copy
124       in the file LICENSE in the source distribution or at
125       <https://www.openssl.org/source/license.html>.
126
127
128
1293.0.5                             202O2S-S0L7_-C0R5MF_MSG_SET1_REGCTRL_REGTOKEN(3ossl)
Impressum