| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2014, 2017, Daniel Stenberg, <[email protected]>, et al. |
| 9 |
.\" * |
| 10 |
.\" * This software is licensed as described in the file COPYING, which |
| 11 |
.\" * you should have received as part of this distribution. The terms |
| 12 |
.\" * are also available at https://curl.haxx.se/docs/copyright.html. |
| 13 |
.\" * |
| 14 |
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell |
| 15 |
.\" * copies of the Software, and permit persons to whom the Software is |
| 16 |
.\" * furnished to do so, under the terms of the COPYING file. |
| 17 |
.\" * |
| 18 |
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY |
| 19 |
.\" * KIND, either express or implied. |
| 20 |
.\" * |
| 21 |
.\" ************************************************************************** |
| 22 |
.\" |
| 23 |
.TH CURLOPT_ISSUERCERT 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_ISSUERCERT \- issuer SSL certificate filename |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ISSUERCERT, char *file); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a char * to a zero terminated string naming a \fIfile\fP holding a CA |
| 32 |
certificate in PEM format. If the option is set, an additional check against |
| 33 |
the peer certificate is performed to verify the issuer is indeed the one |
| 34 |
associated with the certificate provided by the option. This additional check |
| 35 |
is useful in multi-level PKI where one needs to enforce that the peer |
| 36 |
certificate is from a specific branch of the tree. |
| 37 |
|
| 38 |
This option makes sense only when used in combination with the |
| 39 |
\fICURLOPT_SSL_VERIFYPEER(3)\fP option. Otherwise, the result of the check is |
| 40 |
not considered as failure. |
| 41 |
|
| 42 |
A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option, |
| 43 |
which is returned if the setup of the SSL/TLS session has failed due to a |
| 44 |
mismatch with the issuer of peer certificate (\fICURLOPT_SSL_VERIFYPEER(3)\fP |
| 45 |
has to be set too for the check to fail). (Added in 7.19.0) |
| 46 |
|
| 47 |
The application does not have to keep the string around after setting this |
| 48 |
option. |
| 49 |
.SH DEFAULT |
| 50 |
NULL |
| 51 |
.SH PROTOCOLS |
| 52 |
All TLS-based protocols |
| 53 |
.SH EXAMPLE |
| 54 |
.nf |
| 55 |
CURL *curl = curl_easy_init(); |
| 56 |
if(curl) { |
| 57 |
curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/"); |
| 58 |
curl_easy_setopt(curl, CURLOPT_ISSUERCERT, "/etc/certs/cacert.pem"); |
| 59 |
ret = curl_easy_perform(curl); |
| 60 |
curl_easy_cleanup(curl); |
| 61 |
} |
| 62 |
.fi |
| 63 |
.SH AVAILABILITY |
| 64 |
If built TLS enabled |
| 65 |
.SH RETURN VALUE |
| 66 |
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or |
| 67 |
CURLE_OUT_OF_MEMORY if there was insufficient heap space. |
| 68 |
.SH "SEE ALSO" |
| 69 |
.BR CURLOPT_CRLFILE "(3), " CURLOPT_SSL_VERIFYPEER "(3), " |