92f60008678f4539d66dda18c188b6b3cd4a8d5e
[openssl.git] / doc / man3 / OSSL_CMP_MSG_http_perform.pod
1 =pod
2
3 =head1 NAME
4
5 OSSL_CMP_MSG_http_perform
6 - implementation of HTTP transfer for CMP messages
7
8 =head1 SYNOPSIS
9
10  #include <openssl/cmp.h>
11
12  SSL_CMP_MSG *OSSL_CMP_MSG_http_perform(OSSL_CMP_CTX *ctx,
13                                         const OSSL_CMP_MSG *req);
14
15 =head1 DESCRIPTION
16
17 This is the API for creating a BIO for CMP (Certificate Management
18 Protocol) over HTTP(S) with OpenSSL.
19
20 OSSL_CMP_MSG_http_perform() sends the given PKIMessage req to the CMP server
21 specified in ctx. On success it returns the server's response.
22
23 =head1 NOTES
24
25 CMP is defined in RFC 4210 (and CRMF in RFC 4211).
26
27 =head1 RETURN VALUES
28
29 OSSL_CMP_MSG_http_perform() returns a message on success or else NULL.
30 It uses ctx->http_cb if set and respects ctx->msgTimeOut.
31
32 =head1 SEE ALSO
33
34 L<OSSL_CMP_CTX_new(3)>, L<OSSL_CMP_exec_IR_ses(3)>
35
36 =head1 HISTORY
37
38 The OpenSSL CMP support was added in OpenSSL 3.0.
39
40 =head1 COPYRIGHT
41
42 Copyright 2007-2019 The OpenSSL Project Authors. All Rights Reserved.
43
44 Licensed under the Apache License 2.0 (the "License").  You may not use
45 this file except in compliance with the License.  You can obtain a copy
46 in the file LICENSE in the source distribution or at
47 L<https://www.openssl.org/source/license.html>.
48
49 =cut