1=pod
2
3=head1 NAME
4
5OSSL_CMP_MSG_get0_header,
6OSSL_CMP_MSG_get_bodytype,
7OSSL_CMP_MSG_update_transactionID,
8OSSL_CMP_CTX_setup_CRM,
9OSSL_CMP_MSG_read,
10OSSL_CMP_MSG_write,
11d2i_OSSL_CMP_MSG_bio,
12i2d_OSSL_CMP_MSG_bio
13- function(s) manipulating CMP messages
14
15=head1 SYNOPSIS
16
17  #include <openssl/cmp.h>
18
19  OSSL_CMP_PKIHEADER *OSSL_CMP_MSG_get0_header(const OSSL_CMP_MSG *msg);
20  int OSSL_CMP_MSG_get_bodytype(const OSSL_CMP_MSG *msg);
21  int OSSL_CMP_MSG_update_transactionID(OSSL_CMP_CTX *ctx, OSSL_CMP_MSG *msg);
22  OSSL_CRMF_MSG *OSSL_CMP_CTX_setup_CRM(OSSL_CMP_CTX *ctx, int for_KUR, int rid);
23  OSSL_CMP_MSG *OSSL_CMP_MSG_read(const char *file);
24  int OSSL_CMP_MSG_write(const char *file, const OSSL_CMP_MSG *msg);
25  OSSL_CMP_MSG *d2i_OSSL_CMP_MSG_bio(BIO *bio, OSSL_CMP_MSG **msg);
26  int i2d_OSSL_CMP_MSG_bio(BIO *bio, const OSSL_CMP_MSG *msg);
27
28=head1 DESCRIPTION
29
30OSSL_CMP_MSG_get0_header() returns the header of the given CMP message.
31
32OSSL_CMP_MSG_get_bodytype() returns the body type of the given CMP message.
33
34OSSL_CMP_MSG_update_transactionID() updates the transactionID field
35in the header of the given message according to the CMP_CTX.
36This requires re-protecting the message (if it was protected).
37
38OSSL_CMP_CTX_setup_CRM() creates a CRMF certificate request message
39for inclusion in a CMP request message based on details contained in I<ctx>.
40If the CMP context does not include a subject name set via
41L<OSSL_CMP_CTX_set1_subjectName(3)> but includes a reference certificate
42then it copies the subject DN from there
43if I<for_KUR> is set or the I<ctx> does not include a subjectAltName.
44The I<rid> defines the request identifier to use, which typically is 0.
45
46OSSL_CMP_MSG_read() loads a DER-encoded OSSL_CMP_MSG from I<file>.
47
48OSSL_CMP_MSG_write() stores the given OSSL_CMP_MSG to I<file> in DER encoding.
49
50d2i_OSSL_CMP_MSG_bio() parses an ASN.1-encoded OSSL_CMP_MSG from the BIO I<bio>.
51It assigns a pointer to the new structure to I<*msg> if I<msg> is not NULL.
52
53i2d_OSSL_CMP_MSG_bio() writes the OSSL_CMP_MSG I<msg> in ASN.1 encoding
54to BIO I<bio>.
55
56=head1 NOTES
57
58CMP is defined in RFC 4210.
59
60=head1 RETURN VALUES
61
62OSSL_CMP_MSG_get0_header() returns the intended pointer value as described above
63or NULL if the respective entry does not exist and on error.
64
65OSSL_CMP_MSG_get_bodytype() returns the body type or -1 on error.
66
67OSSL_CMP_CTX_setup_CRM() returns a pointer to a OSSL_CRMF_MSG on success,
68NULL on error.
69
70d2i_OSSL_CMP_MSG_bio() returns the parsed message or NULL on error.
71
72OSSL_CMP_MSG_read() and d2i_OSSL_CMP_MSG_bio()
73return the parsed CMP message or NULL on error.
74
75OSSL_CMP_MSG_write() and i2d_OSSL_CMP_MSG_bio() return
76the number of bytes successfully encoded or a negative value if an error occurs.
77
78OSSL_CMP_MSG_update_transactionID() returns 1 on success, 0 on error.
79
80=head1 HISTORY
81
82The OpenSSL CMP support was added in OpenSSL 3.0.
83
84=head1 COPYRIGHT
85
86Copyright 2007-2021 The OpenSSL Project Authors. All Rights Reserved.
87
88Licensed under the Apache License 2.0 (the "License").  You may not use
89this file except in compliance with the License.  You can obtain a copy
90in the file LICENSE in the source distribution or at
91L<https://www.openssl.org/source/license.html>.
92
93=cut
94