mirror of
https://github.com/openssl/openssl.git
synced 2024-12-27 06:21:43 +08:00
c8c923454b
Also update and complete related documentation. Reviewed-by: Tomas Mraz <tomas@openssl.org> Reviewed-by: Paul Dale <pauli@openssl.org> Reviewed-by: David von Oheimb <david.von.oheimb@siemens.com> (Merged from https://github.com/openssl/openssl/pull/17726)
132 lines
5.2 KiB
Plaintext
132 lines
5.2 KiB
Plaintext
=pod
|
|
|
|
=head1 NAME
|
|
|
|
OSSL_CRMF_MSG_get0_regCtrl_regToken,
|
|
OSSL_CRMF_MSG_set1_regCtrl_regToken,
|
|
OSSL_CRMF_MSG_get0_regCtrl_authenticator,
|
|
OSSL_CRMF_MSG_set1_regCtrl_authenticator,
|
|
OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo,
|
|
OSSL_CRMF_MSG_set0_SinglePubInfo,
|
|
OSSL_CRMF_MSG_set_PKIPublicationInfo_action,
|
|
OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo,
|
|
OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo,
|
|
OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey,
|
|
OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey,
|
|
OSSL_CRMF_MSG_get0_regCtrl_oldCertID,
|
|
OSSL_CRMF_MSG_set1_regCtrl_oldCertID,
|
|
OSSL_CRMF_CERTID_gen
|
|
- functions getting or setting CRMF Registration Controls
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/crmf.h>
|
|
|
|
ASN1_UTF8STRING
|
|
*OSSL_CRMF_MSG_get0_regCtrl_regToken(const OSSL_CRMF_MSG *msg);
|
|
int OSSL_CRMF_MSG_set1_regCtrl_regToken(OSSL_CRMF_MSG *msg,
|
|
const ASN1_UTF8STRING *tok);
|
|
ASN1_UTF8STRING
|
|
*OSSL_CRMF_MSG_get0_regCtrl_authenticator(const OSSL_CRMF_MSG *msg);
|
|
int OSSL_CRMF_MSG_set1_regCtrl_authenticator(OSSL_CRMF_MSG *msg,
|
|
const ASN1_UTF8STRING *auth);
|
|
int OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo(
|
|
OSSL_CRMF_PKIPUBLICATIONINFO *pi,
|
|
OSSL_CRMF_SINGLEPUBINFO *spi);
|
|
int OSSL_CRMF_MSG_set0_SinglePubInfo(OSSL_CRMF_SINGLEPUBINFO *spi,
|
|
int method, GENERAL_NAME *nm);
|
|
int OSSL_CRMF_MSG_set_PKIPublicationInfo_action(
|
|
OSSL_CRMF_PKIPUBLICATIONINFO *pi, int action);
|
|
OSSL_CRMF_PKIPUBLICATIONINFO
|
|
*OSSL_CRMF_MSG_get0_regCtrl_pkiPublicationInfo(const OSSL_CRMF_MSG *msg);
|
|
int OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo(OSSL_CRMF_MSG *msg,
|
|
const OSSL_CRMF_PKIPUBLICATIONINFO *pi);
|
|
X509_PUBKEY
|
|
*OSSL_CRMF_MSG_get0_regCtrl_protocolEncrKey(const OSSL_CRMF_MSG *msg);
|
|
int OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey(OSSL_CRMF_MSG *msg,
|
|
const X509_PUBKEY *pubkey);
|
|
OSSL_CRMF_CERTID
|
|
*OSSL_CRMF_MSG_get0_regCtrl_oldCertID(const OSSL_CRMF_MSG *msg);
|
|
int OSSL_CRMF_MSG_set1_regCtrl_oldCertID(OSSL_CRMF_MSG *msg,
|
|
const OSSL_CRMF_CERTID *cid);
|
|
OSSL_CRMF_CERTID *OSSL_CRMF_CERTID_gen(const X509_NAME *issuer,
|
|
const ASN1_INTEGER *serial);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Each of the OSSL_CRMF_MSG_get0_regCtrl_X() functions
|
|
returns the respective control X in the given I<msg>, if present.
|
|
|
|
OSSL_CRMF_MSG_set1_regCtrl_regToken() sets the regToken control in the given
|
|
I<msg> copying the given I<tok> as value. See RFC 4211, section 6.1.
|
|
|
|
OSSL_CRMF_MSG_set1_regCtrl_authenticator() sets the authenticator control in
|
|
the given I<msg> copying the given I<auth> as value. See RFC 4211, section 6.2.
|
|
|
|
OSSL_CRMF_MSG_PKIPublicationInfo_push0_SinglePubInfo() pushes the given I<spi>
|
|
to I<si>. Consumes the I<spi> pointer.
|
|
|
|
OSSL_CRMF_MSG_set0_SinglePubInfo() sets in the given SinglePubInfo I<spi>
|
|
the I<method> and publication location, in the form of a GeneralName, I<nm>.
|
|
The publication location is optional, and therefore I<nm> may be NULL.
|
|
The function consumes the I<nm> pointer if present.
|
|
Available methods are:
|
|
# define OSSL_CRMF_PUB_METHOD_DONTCARE 0
|
|
# define OSSL_CRMF_PUB_METHOD_X500 1
|
|
# define OSSL_CRMF_PUB_METHOD_WEB 2
|
|
# define OSSL_CRMF_PUB_METHOD_LDAP 3
|
|
|
|
OSSL_CRMF_MSG_set_PKIPublicationInfo_action() sets the action in the given I<pi>
|
|
using the given I<action> as value. See RFC 4211, section 6.3.
|
|
Available actions are:
|
|
# define OSSL_CRMF_PUB_ACTION_DONTPUBLISH 0
|
|
# define OSSL_CRMF_PUB_ACTION_PLEASEPUBLISH 1
|
|
|
|
OSSL_CRMF_MSG_set1_regCtrl_pkiPublicationInfo() sets the pkiPublicationInfo
|
|
control in the given I<msg> copying the given I<tok> as value. See RFC 4211,
|
|
section 6.3.
|
|
|
|
OSSL_CRMF_MSG_set1_regCtrl_protocolEncrKey() sets the protocolEncrKey control in
|
|
the given I<msg> copying the given I<pubkey> as value. See RFC 4211 section 6.6.
|
|
|
|
OSSL_CRMF_MSG_set1_regCtrl_oldCertID() sets the B<oldCertID> regToken control in
|
|
the given I<msg> copying the given I<cid> as value. See RFC 4211, section 6.5.
|
|
|
|
OSSL_CRMF_CERTID_gen produces an OSSL_CRMF_CERTID_gen structure copying the
|
|
given I<issuer> name and I<serial> number.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
All OSSL_CRMF_MSG_get0_*() functions
|
|
return the respective pointer value or NULL if not present and on error.
|
|
|
|
All OSSL_CRMF_MSG_set1_*() functions return 1 on success, 0 on error.
|
|
|
|
OSSL_CRMF_CERTID_gen() returns a pointer to the resulting structure
|
|
or NULL on error.
|
|
|
|
=head1 NOTES
|
|
|
|
A function OSSL_CRMF_MSG_set1_regCtrl_pkiArchiveOptions() for setting an
|
|
Archive Options Control is not yet implemented due to missing features to
|
|
create the needed OSSL_CRMF_PKIARCHIVEOPTINS content.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
RFC 4211
|
|
|
|
=head1 HISTORY
|
|
|
|
The OpenSSL CRMF support was added in OpenSSL 3.0.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|