xref: /freebsd/crypto/openssl/doc/man3/OSSL_CRMF_MSG_get0_tmpl.pod (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1=pod
2
3=head1 NAME
4
5OSSL_CRMF_MSG_get0_tmpl,
6OSSL_CRMF_CERTTEMPLATE_get0_serialNumber,
7OSSL_CRMF_CERTTEMPLATE_get0_subject,
8OSSL_CRMF_CERTTEMPLATE_get0_issuer,
9OSSL_CRMF_CERTTEMPLATE_get0_extensions,
10OSSL_CRMF_CERTID_get0_serialNumber,
11OSSL_CRMF_CERTID_get0_issuer,
12OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert,
13OSSL_CRMF_MSG_get_certReqId
14- functions reading from CRMF CertReqMsg structures
15
16=head1 SYNOPSIS
17
18 #include <openssl/crmf.h>
19
20 OSSL_CRMF_CERTTEMPLATE *OSSL_CRMF_MSG_get0_tmpl(const OSSL_CRMF_MSG *crm);
21 const ASN1_INTEGER
22 *OSSL_CRMF_CERTTEMPLATE_get0_serialNumber(const OSSL_CRMF_CERTTEMPLATE *tmpl);
23 const X509_NAME
24 *OSSL_CRMF_CERTTEMPLATE_get0_subject(const OSSL_CRMF_CERTTEMPLATE *tmpl);
25 const X509_NAME
26 *OSSL_CRMF_CERTTEMPLATE_get0_issuer(const OSSL_CRMF_CERTTEMPLATE *tmpl);
27 X509_EXTENSIONS
28 *OSSL_CRMF_CERTTEMPLATE_get0_extensions(const OSSL_CRMF_CERTTEMPLATE *tmpl);
29
30 const ASN1_INTEGER
31 *OSSL_CRMF_CERTID_get0_serialNumber(const OSSL_CRMF_CERTID *cid);
32 const X509_NAME *OSSL_CRMF_CERTID_get0_issuer(const OSSL_CRMF_CERTID *cid);
33
34 X509
35 *OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert(const OSSL_CRMF_ENCRYPTEDVALUE *ecert,
36                                        OSSL_LIB_CTX *libctx, const char *propq,
37                                        EVP_PKEY *pkey);
38
39 int OSSL_CRMF_MSG_get_certReqId(const OSSL_CRMF_MSG *crm);
40
41
42=head1 DESCRIPTION
43
44OSSL_CRMF_MSG_get0_tmpl() retrieves the certificate template of I<crm>.
45
46OSSL_CRMF_CERTTEMPLATE_get0_serialNumber() retrieves the serialNumber of the
47given certificate template I<tmpl>.
48
49OSSL_CRMF_CERTTEMPLATE_get0_subject() retrieves the subject name of the
50given certificate template I<tmpl>.
51
52OSSL_CRMF_CERTTEMPLATE_get0_issuer() retrieves the issuer name of the
53given certificate template I<tmpl>.
54
55OSSL_CRMF_CERTTEMPLATE_get0_extensions() retrieves the X.509 extensions
56of the given certificate template I<tmpl>, or NULL if not present.
57
58OSSL_CRMF_CERTID_get0_serialNumber retrieves the serialNumber
59of the given CertId I<cid>.
60
61OSSL_CRMF_CERTID_get0_issuer retrieves the issuer name
62of the given CertId I<cid>, which must be of ASN.1 type GEN_DIRNAME.
63
64OSSL_CRMF_ENCRYPTEDVALUE_get1_encCert() decrypts the certificate in the given
65encryptedValue I<ecert>, using the private key I<pkey>, library context
66I<libctx> and property query string I<propq> (see L<OSSL_LIB_CTX(3)>).
67This is needed for the indirect POPO method as in RFC 4210 section 5.2.8.2.
68The function returns the decrypted certificate as a copy, leaving its ownership
69with the caller, who is responsible for freeing it.
70
71OSSL_CRMF_MSG_get_certReqId() retrieves the certReqId of I<crm>.
72
73
74=head1 RETURN VALUES
75
76OSSL_CRMF_MSG_get_certReqId() returns the certificate request ID as a
77nonnegative integer or -1 on error.
78
79All other functions return a pointer with the intended result or NULL on error.
80
81=head1 SEE ALSO
82
83RFC 4211
84
85=head1 HISTORY
86
87The OpenSSL CRMF support was added in OpenSSL 3.0.
88
89=head1 COPYRIGHT
90
91Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
92
93Licensed under the Apache License 2.0 (the "License").  You may not use
94this file except in compliance with the License.  You can obtain a copy
95in the file LICENSE in the source distribution or at
96L<https://www.openssl.org/source/license.html>.
97
98=cut
99