]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/man3/OSSL_CRMF_MSG_get0_tmpl.pod
Update copyright year
[thirdparty/openssl.git] / doc / man3 / OSSL_CRMF_MSG_get0_tmpl.pod
CommitLineData
2a3b52ea
DO
1=pod
2
3=head1 NAME
4
5OSSL_CRMF_MSG_get0_tmpl,
6OSSL_CRMF_CERTTEMPLATE_get0_serialNumber,
7OSSL_CRMF_CERTTEMPLATE_get0_issuer,
7960dbec
DDO
8OSSL_CRMF_CERTID_get0_serialNumber,
9OSSL_CRMF_CERTID_get0_issuer,
2a3b52ea
DO
10OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert,
11OSSL_CRMF_MSG_get_certReqId
12- functions reading from CRMF CertReqMsg structures
13
14=head1 SYNOPSIS
15
16 #include <openssl/crmf.h>
17
18 OSSL_CRMF_CERTTEMPLATE *OSSL_CRMF_MSG_get0_tmpl(const OSSL_CRMF_MSG *crm);
19 ASN1_INTEGER
20 *OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(OSSL_CRMF_CERTTEMPLATE *tmpl);
afe554c2 21 X509_NAME *OSSL_CRMF_CERTTEMPLATE_get0_issuer(OSSL_CRMF_CERTTEMPLATE *tmpl);
2a3b52ea 22
7960dbec 23 ASN1_INTEGER *OSSL_CRMF_CERTID_get0_serialNumber(const OSSL_CRMF_CERTID *cid);
8cc86b81 24 const X509_NAME *OSSL_CRMF_CERTID_get0_issuer(const OSSL_CRMF_CERTID *cid);
7960dbec 25
2a3b52ea
DO
26 X509 *OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(OSSL_CRMF_ENCRYPTEDVALUE *ecert,
27 EVP_PKEY *pkey);
28
29 int OSSL_CRMF_MSG_get_certReqId(OSSL_CRMF_MSG *crm);
30
31
32=head1 DESCRIPTION
33
34OSSL_CRMF_MSG_get0_tmpl() retrieves the certificate template of B<crm>.
35
36OSSL_CRMF_CERTTEMPLATE_get0_serialNumber() retrieves the serialNumber of the
37given certificate template B<tmpl>.
38
39OSSL_CRMF_CERTTEMPLATE_get0_issuer() retrieves the issuer name of the
40given certificate template B<tmpl>.
41
7960dbec
DDO
42OSSL_CRMF_CERTID_get0_serialNumber retrieves the serialNumber
43of the given CertId B<cid>.
44
45OSSL_CRMF_CERTID_get0_issuer retrieves the issuer name
46of the given CertId B<cid>, which must be of ASN.1 type GEN_DIRNAME.
47
2a3b52ea
DO
48OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert() decrypts the certificate in the given
49encryptedValue B<ecert>, using the private key B<pkey>.
50This is needed for the indirect PoP method as in RFC 4210 section 5.2.8.2.
51The function returns the decrypted certificate as a copy, leaving its ownership
52with the caller, who is responsible for freeing it.
53
54OSSL_CRMF_MSG_get_certReqId() retrieves the certReqId of B<crm>.
55
56
57=head1 RETURN VALUES
58
59OSSL_CRMF_MSG_get_certReqId() returns the certificate request ID as a
60non-negative integer or -1 on error.
61
62All other functions return a pointer with the intended result or NULL on error.
63
64=head1 SEE ALSO
65
66B<RFC 4211>
67
7960dbec
DDO
68=head1 HISTORY
69
70The OpenSSL CRMF support was added in OpenSSL 3.0.
71
2a3b52ea
DO
72=head1 COPYRIGHT
73
33388b44 74Copyright 2007-2020 The OpenSSL Project Authors. All Rights Reserved.
2a3b52ea 75
ce9b9964 76Licensed under the Apache License 2.0 (the "License"). You may not use
2a3b52ea
DO
77this file except in compliance with the License. You can obtain a copy
78in the file LICENSE in the source distribution or at
79L<https://www.openssl.org/source/license.html>.
80
81=cut