]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/man3/OSSL_CRMF_MSG_get0_tmpl.pod
Certificate Management Protocol (CMP, RFC 4210) extension to OpenSSL
[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,
8OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert,
9OSSL_CRMF_MSG_get_certReqId
10- functions reading from CRMF CertReqMsg structures
11
12=head1 SYNOPSIS
13
14 #include <openssl/crmf.h>
15
16 OSSL_CRMF_CERTTEMPLATE *OSSL_CRMF_MSG_get0_tmpl(const OSSL_CRMF_MSG *crm);
17 ASN1_INTEGER
18 *OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(OSSL_CRMF_CERTTEMPLATE *tmpl);
19 X509_NAME *OSSL_CRMF_CERTTEMPLATE_get0_issuer(OSSL_CRMF_CERTTEMPLATE *tmpl);
20
21 X509 *OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(OSSL_CRMF_ENCRYPTEDVALUE *ecert,
22 EVP_PKEY *pkey);
23
24 int OSSL_CRMF_MSG_get_certReqId(OSSL_CRMF_MSG *crm);
25
26
27=head1 DESCRIPTION
28
29OSSL_CRMF_MSG_get0_tmpl() retrieves the certificate template of B<crm>.
30
31OSSL_CRMF_CERTTEMPLATE_get0_serialNumber() retrieves the serialNumber of the
32given certificate template B<tmpl>.
33
34OSSL_CRMF_CERTTEMPLATE_get0_issuer() retrieves the issuer name of the
35given certificate template B<tmpl>.
36
37OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert() decrypts the certificate in the given
38encryptedValue B<ecert>, using the private key B<pkey>.
39This is needed for the indirect PoP method as in RFC 4210 section 5.2.8.2.
40The function returns the decrypted certificate as a copy, leaving its ownership
41with the caller, who is responsible for freeing it.
42
43OSSL_CRMF_MSG_get_certReqId() retrieves the certReqId of B<crm>.
44
45
46=head1 RETURN VALUES
47
48OSSL_CRMF_MSG_get_certReqId() returns the certificate request ID as a
49non-negative integer or -1 on error.
50
51All other functions return a pointer with the intended result or NULL on error.
52
53=head1 SEE ALSO
54
55B<RFC 4211>
56
57=head1 COPYRIGHT
58
8869ad4a 59Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
2a3b52ea 60
ce9b9964 61Licensed under the Apache License 2.0 (the "License"). You may not use
2a3b52ea
DO
62this file except in compliance with the License. You can obtain a copy
63in the file LICENSE in the source distribution or at
64L<https://www.openssl.org/source/license.html>.
65
66=cut