mirror of
https://github.com/moparisthebest/curl
synced 2024-12-25 01:28:51 -05:00
80 lines
3.3 KiB
Groff
80 lines
3.3 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at https://curl.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_ISSUERCERT_BLOB 3 "24 Jun 2020" "libcurl 7.71.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_ISSUERCERT_BLOB \- issuer SSL certificate from memory blob
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ISSUERCERT_BLOB, struct curl_blob *stblob);
|
|
.SH DESCRIPTION
|
|
Pass a pointer to a curl_blob structure, which contains information (pointer
|
|
and size) about a memory block with binary data of a CA certificate in PEM
|
|
format. If the option is set, an additional check against the peer certificate
|
|
is performed to verify the issuer is indeed the one associated with the
|
|
certificate provided by the option. This additional check is useful in
|
|
multi-level PKI where one needs to enforce that the peer certificate is from a
|
|
specific branch of the tree.
|
|
|
|
This option should be used in combination with the
|
|
\fICURLOPT_SSL_VERIFYPEER(3)\fP option. Otherwise, the result of the check is
|
|
not considered as failure.
|
|
|
|
A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option,
|
|
which is returned if the setup of the SSL/TLS session has failed due to a
|
|
mismatch with the issuer of peer certificate (\fICURLOPT_SSL_VERIFYPEER(3)\fP
|
|
has to be set too for the check to fail).
|
|
|
|
If the blob is initialized with the flags member of struct curl_blob set to
|
|
CURL_BLOB_COPY, the application does not have to keep the buffer around after
|
|
setting this.
|
|
|
|
This option is an alternative to \fICURLOPT_ISSUERCERT(3)\fP which instead
|
|
expects a file name as input.
|
|
.SH DEFAULT
|
|
NULL
|
|
.SH PROTOCOLS
|
|
All TLS-based protocols
|
|
.SH EXAMPLE
|
|
.nf
|
|
CURL *curl = curl_easy_init();
|
|
if(curl) {
|
|
struct curl_blob blob;
|
|
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
|
|
blob.data = certificateData;
|
|
blob.len = filesize;
|
|
blob.flags = CURL_BLOB_COPY;
|
|
curl_easy_setopt(curl, CURLOPT_ISSUERCERT_BLOB, &blob);
|
|
ret = curl_easy_perform(curl);
|
|
curl_easy_cleanup(curl);
|
|
}
|
|
.fi
|
|
.SH AVAILABILITY
|
|
Added in libcurl 7.71.0. This option is supported by the OpenSSL backends.
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
|
|
CURLE_OUT_OF_MEMORY if there was insufficient heap space.
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_ISSUERCERT "(3),"
|
|
.BR CURLOPT_CRLFILE "(3), " CURLOPT_SSL_VERIFYPEER "(3), "
|