ERR: Implement the macros ERR_raise() and ERR_raise_data() and use them
[openssl.git] / doc / man3 / OSSL_CRMF_MSG_get0_tmpl.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_CRMF_MSG_get0_tmpl,
6 OSSL_CRMF_CERTTEMPLATE_get0_serialNumber,
7 OSSL_CRMF_CERTTEMPLATE_get0_issuer,
8 OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert,
9 OSSL_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
29 OSSL_CRMF_MSG_get0_tmpl() retrieves the certificate template of B<crm>.
30
31 OSSL_CRMF_CERTTEMPLATE_get0_serialNumber() retrieves the serialNumber of the
32 given certificate template B<tmpl>.
33
34 OSSL_CRMF_CERTTEMPLATE_get0_issuer() retrieves the issuer name of the
35 given certificate template B<tmpl>.
36
37 OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert() decrypts the certificate in the given
38 encryptedValue B<ecert>, using the private key B<pkey>.
39 This is needed for the indirect PoP method as in RFC 4210 section 5.2.8.2.
40 The function returns the decrypted certificate as a copy, leaving its ownership
41 with the caller, who is responsible for freeing it.
42
43 OSSL_CRMF_MSG_get_certReqId() retrieves the certReqId of B<crm>.
44
45
46 =head1 RETURN VALUES
47
48 OSSL_CRMF_MSG_get_certReqId() returns the certificate request ID as a
49 non-negative integer or -1 on error.
50
51 All other functions return a pointer with the intended result or NULL on error.
52
53 =head1 SEE ALSO
54
55 B<RFC 4211>
56
57 =head1 COPYRIGHT
58
59 Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
60
61 Licensed under the Apache License 2.0 (the "License").  You may not use
62 this file except in compliance with the License.  You can obtain a copy
63 in the file LICENSE in the source distribution or at
64 L<https://www.openssl.org/source/license.html>.
65
66 =cut