5 OSSL_CRMF_MSG_get0_regCtrl_regToken,
6 OSSL_CRMF_MSG_set1_regCtrl_regToken,
7 OSSL_CRMF_MSG_get0_regCtrl_authenticator,
8 OSSL_CRMF_MSG_set1_regCtrl_authenticator,
9 OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo,
10 OSSL_CRMF_MSG_set0_SinglePubInfo,
11 OSSL_CRMF_MSG_set_PKIPublicationInfo_action,
12 OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo,
13 OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo,
14 OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey,
15 OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey,
16 OSSL_CRMF_MSG_get0_regCtrl_oldCertID,
17 OSSL_CRMF_MSG_set1_regCtrl_oldCertID,
19 - functions getting or setting CRMF Registration Controls
23 #include <openssl/crmf.h>
26 *OSSL_CRMF_MSG_get0_regCtrl_regToken(const OSSL_CRMF_MSG *msg);
27 int OSSL_CRMF_MSG_set1_regCtrl_regToken(OSSL_CRMF_MSG *msg,
28 const ASN1_UTF8STRING *tok);
30 *OSSL_CRMF_MSG_get0_regCtrl_authenticator(const OSSL_CRMF_MSG *msg);
31 int OSSL_CRMF_MSG_set1_regCtrl_authenticator(OSSL_CRMF_MSG *msg,
32 const ASN1_UTF8STRING *auth);
33 int OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo(
34 OSSL_CRMF_PKIPUBLICATIONINFO *pi,
35 OSSL_CRMF_SINGLEPUBINFO *spi);
36 int OSSL_CRMF_MSG_set0_SinglePubInfo(OSSL_CRMF_SINGLEPUBINFO *spi,
37 int method, GENERAL_NAME *nm);
38 int OSSL_CRMF_MSG_set_PKIPublicationInfo_action(
39 OSSL_CRMF_PKIPUBLICATIONINFO *pi, int action);
40 OSSL_CRMF_PKIPUBLICATIONINFO
41 *OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo(const OSSL_CRMF_MSG *msg);
42 int OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo(OSSL_CRMF_MSG *msg,
43 const OSSL_CRMF_PKIPUBLICATIONINFO *pi);
45 *OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey(const OSSL_CRMF_MSG *msg);
46 int OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey(OSSL_CRMF_MSG *msg,
47 const X509_PUBKEY *pubkey);
49 *OSSL_CRMF_MSG_get0_regCtrl_oldCertID(const OSSL_CRMF_MSG *msg);
50 int OSSL_CRMF_MSG_set1_regCtrl_oldCertID(OSSL_CRMF_MSG *msg,
51 const OSSL_CRMF_CERTID *cid);
52 OSSL_CRMF_CERTID *OSSL_CRMF_CERTID_gen(const X509_NAME *issuer,
53 const ASN1_INTEGER *serial);
57 Each of the OSSL_CRMF_MSG_get0_regCtrl_X() functions
58 returns the respective control X in the given I<msg>, if present.
60 OSSL_CRMF_MSG_set1_regCtrl_regToken() sets the regToken control in the given
61 I<msg> copying the given I<tok> as value. See RFC 4211, section 6.1.
63 OSSL_CRMF_MSG_set1_regCtrl_authenticator() sets the authenticator control in
64 the given I<msg> copying the given I<auth> as value. See RFC 4211, section 6.2.
66 OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo() pushes the given I<spi>
67 to I<si>. Consumes the I<spi> pointer.
69 OSSL_CRMF_MSG_set0_SinglePubInfo() sets in the given SinglePubInfo I<spi>
70 the I<method> and publication location, in the form of a GeneralName, I<nm>.
71 The publication location is optional, and therefore I<nm> may be NULL.
72 The function consumes the I<nm> pointer if present.
73 Available methods are:
74 # define OSSL_CRMF_PUB_METHOD_DONTCARE 0
75 # define OSSL_CRMF_PUB_METHOD_X500 1
76 # define OSSL_CRMF_PUB_METHOD_WEB 2
77 # define OSSL_CRMF_PUB_METHOD_LDAP 3
79 OSSL_CRMF_MSG_set_PKIPublicationInfo_action() sets the action in the given I<pi>
80 using the given I<action> as value. See RFC 4211, section 6.3.
81 Available actions are:
82 # define OSSL_CRMF_PUB_ACTION_DONTPUBLISH 0
83 # define OSSL_CRMF_PUB_ACTION_PLEASEPUBLISH 1
85 OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo() sets the pkiPublicationInfo
86 control in the given I<msg> copying the given I<tok> as value. See RFC 4211,
89 OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey() sets the protocolEncrKey control in
90 the given I<msg> copying the given I<pubkey> as value. See RFC 4211 section 6.6.
92 OSSL_CRMF_MSG_set1_regCtrl_oldCertID() sets the oldCertID control in the given
93 I<msg> copying the given I<cid> as value. See RFC 4211, section 6.5.
95 OSSL_CRMF_CERTID_gen produces an OSSL_CRMF_CERTID_gen structure copying the
96 given I<issuer> name and I<serial> number.
100 All OSSL_CRMF_MSG_get0_*() functions
101 return the respective pointer value or NULL if not present and on error.
103 All OSSL_CRMF_MSG_set1_*() functions return 1 on success, 0 on error.
105 OSSL_CRMF_CERTID_gen() returns a pointer to the resulting structure
110 A function OSSL_CRMF_MSG_set1_regCtrl_pkiArchiveOptions() for setting an
111 Archive Options Control is not yet implemented due to missing features to
112 create the needed OSSL_CRMF_PKIARCHIVEOPTINS content.
120 The OpenSSL CRMF support was added in OpenSSL 3.0.
124 Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
126 Licensed under the Apache License 2.0 (the "License"). You may not use
127 this file except in compliance with the License. You can obtain a copy
128 in the file LICENSE in the source distribution or at
129 L<https://www.openssl.org/source/license.html>.