2
0
mirror of https://codeberg.org/kiss-community/repo synced 2024-12-24 00:10:05 -07:00
repo/core/curl/files/CURLOPT_SSL_VERIFYPEER.3

80 lines
3.0 KiB
Groff
Raw Normal View History

.\" generated by cd2nroff 0.1 from CURLOPT_SSL_VERIFYPEER.md
2024-07-29 18:00:04 -06:00
.TH CURLOPT_SSL_VERIFYPEER 3 "2024-07-29" libcurl
.SH NAME
CURLOPT_SSL_VERIFYPEER \- verify the peer\(aqs SSL certificate
.SH SYNOPSIS
.nf
#include <curl/curl.h>
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_VERIFYPEER, long verify);
.fi
.SH DESCRIPTION
Pass a long as parameter to enable or disable.
This option determines whether curl verifies the authenticity of the peer\(aqs
certificate. A value of 1 means curl verifies; 0 (zero) means it does not.
When negotiating a TLS or SSL connection, the server sends a certificate
indicating its identity. Curl verifies whether the certificate is authentic,
i.e. that you can trust that the server is who the certificate says it is.
This trust is based on a chain of digital signatures, rooted in certification
authority (CA) certificates you supply. curl uses a default bundle of CA
certificates (the path for that is determined at build time) and you can
specify alternate certificates with the \fICURLOPT_CAINFO(3)\fP option or the
\fICURLOPT_CAPATH(3)\fP option.
When \fICURLOPT_SSL_VERIFYPEER(3)\fP is enabled, and the verification fails to
prove that the certificate is signed by a CA, the connection fails.
When this option is disabled (set to zero), the CA certificates are not loaded
and the peer certificate verification is simply skipped.
Authenticating the certificate is not enough to be sure about the server. You
typically also want to ensure that the server is the server you mean to be
talking to. Use \fICURLOPT_SSL_VERIFYHOST(3)\fP for that. The check that the host
name in the certificate is valid for the hostname you are connecting to is
done independently of the \fICURLOPT_SSL_VERIFYPEER(3)\fP option.
WARNING: disabling verification of the certificate allows bad guys to
man\-in\-the\-middle the communication without you knowing it. Disabling
verification makes the communication insecure. Just having encryption on a
transfer is not enough as you cannot be sure that you are communicating with
the correct end\-point.
When libcurl uses secure protocols it trusts responses and allows for example
HSTS and Alt\-Svc information to be stored and used subsequently. Disabling
certificate verification can make libcurl trust and use such information from
malicious servers.
.SH DEFAULT
1 \- enabled
.SH PROTOCOLS
2024-07-29 18:00:04 -06:00
This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
2024-03-30 12:28:04 -06:00
All TLS backends support this option.
.SH EXAMPLE
.nf
int main(void)
{
CURL *curl = curl_easy_init();
if(curl) {
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
/* Set the default value: strict certificate check please */
curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 1L);
curl_easy_perform(curl);
}
}
.fi
.SH AVAILABILITY
2024-07-29 18:00:04 -06:00
Added in curl 7.4.2
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH SEE ALSO
.BR CURLINFO_CAINFO (3),
.BR CURLINFO_CAPATH (3),
.BR CURLOPT_CAINFO (3),
.BR CURLOPT_PROXY_SSL_VERIFYHOST (3),
.BR CURLOPT_PROXY_SSL_VERIFYPEER (3),
.BR CURLOPT_SSL_VERIFYHOST (3)