summaryrefslogtreecommitdiff
path: root/static/netbsd/man3/OSSL_CMP_MSG_http_perform.3
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:55:15 -0400
commit253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch)
treeadf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man3/OSSL_CMP_MSG_http_perform.3
parenta9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff)
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/OSSL_CMP_MSG_http_perform.3')
-rw-r--r--static/netbsd/man3/OSSL_CMP_MSG_http_perform.3130
1 files changed, 130 insertions, 0 deletions
diff --git a/static/netbsd/man3/OSSL_CMP_MSG_http_perform.3 b/static/netbsd/man3/OSSL_CMP_MSG_http_perform.3
new file mode 100644
index 00000000..44eb2dee
--- /dev/null
+++ b/static/netbsd/man3/OSSL_CMP_MSG_http_perform.3
@@ -0,0 +1,130 @@
+.\" $NetBSD: OSSL_CMP_MSG_http_perform.3,v 1.5 2026/04/08 17:06:45 christos Exp $
+.\"
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\"
+.\" Required to disable full justification in groff 1.23.0.
+.if n .ds AD l
+.\" ========================================================================
+.\"
+.IX Title "OSSL_CMP_MSG_http_perform 3"
+.TH OSSL_CMP_MSG_http_perform 3 2026-04-07 3.5.6 OpenSSL
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+OSSL_CMP_MSG_http_perform
+\&\- client\-side HTTP(S) transfer of a CMP request\-response pair
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& #include <openssl/cmp.h>
+\&
+\& OSSL_CMP_MSG *OSSL_CMP_MSG_http_perform(OSSL_CMP_CTX *ctx,
+\& const OSSL_CMP_MSG *req);
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+\&\fBOSSL_CMP_MSG_http_perform()\fR sends the given PKIMessage \fIreq\fR to the
+CMP server specified in \fIctx\fR and returns the result obtained from it.
+.PP
+If \fBOSSL_CMP_CTX_set_transfer_cb_arg\fR\|(3) has been used to set the transfer
+callback argument then the provided pointer \fIbios\fR is taken as
+a two\-element \fBBIO\fR array to use for the exchange with the server
+as described for the \fIbio\fR and \fIrbio\fR parameters of \fBOSSL_HTTP_open\fR\|(3).
+For instance, the two BIO pointers may be equal and refer to a TLS connection,
+such as in BRSKI\-AE where a pre\-established TLS channel is reused for CMP.
+.PP
+Otherwise the server specified via \fBOSSL_CMP_CTX_set1_server\fR\|(3)
+and optionally \fBOSSL_CMP_CTX_set_serverPort\fR\|(3) is contacted,
+where the default port is 80 for HTTP and 443 for HTTPS.
+The HTTP path (aka "CMP alias" in this context) to use is by default \f(CW\*(C`/\*(C'\fR,
+otherwise the string specified via \fBOSSL_CMP_CTX_set1_serverPath\fR\|(3).
+On success the function returns the server\*(Aqs response PKIMessage.
+.PP
+The function makes use of any HTTP callback function
+set via \fBOSSL_CMP_CTX_set_http_cb\fR\|(3).
+It respects any timeout value set via \fBOSSL_CMP_CTX_set_option\fR\|(3)
+with an \fBOSSL_CMP_OPT_MSG_TIMEOUT\fR argument.
+It also respects any HTTP(S) proxy options set via \fBOSSL_CMP_CTX_set1_proxy\fR\|(3)
+and \fBOSSL_CMP_CTX_set1_no_proxy\fR\|(3) and the respective environment variables.
+Proxying plain HTTP is supported directly,
+while using a proxy for HTTPS connections requires a suitable callback function
+such as \fBOSSL_HTTP_proxy_connect\fR\|(3).
+.SH NOTES
+.IX Header "NOTES"
+CMP is defined in RFC 9810.
+HTTP transfer for CMP is defined in RFC 9811.
+.SH "RETURN VALUES"
+.IX Header "RETURN VALUES"
+\&\fBOSSL_CMP_MSG_http_perform()\fR
+returns the received CMP response message on success, else NULL.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+\&\fBOSSL_CMP_CTX_new\fR\|(3), \fBOSSL_HTTP_open\fR\|(3), and \fBOSSL_HTTP_proxy_connect\fR\|(3).
+.SH HISTORY
+.IX Header "HISTORY"
+The OpenSSL CMP support was added in OpenSSL 3.0.
+.PP
+The \fBOSSL_CMP_MSG_http_perform()\fR use of transfer_cb_arg was added in OpenSSL 3.5.
+.SH COPYRIGHT
+.IX Header "COPYRIGHT"
+Copyright 2007\-2025 The OpenSSL Project Authors. All Rights Reserved.
+.PP
+Licensed under the Apache License 2.0 (the "License"). You may not use
+this file except in compliance with the License. You can obtain a copy
+in the file LICENSE in the source distribution or at
+<https://www.openssl.org/source/license.html>.