Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_ISSUERCERT.3, revision 1.1
1.1 ! misho 1: .\" **************************************************************************
! 2: .\" * _ _ ____ _
! 3: .\" * Project ___| | | | _ \| |
! 4: .\" * / __| | | | |_) | |
! 5: .\" * | (__| |_| | _ <| |___
! 6: .\" * \___|\___/|_| \_\_____|
! 7: .\" *
! 8: .\" * Copyright (C) 1998 - 2014, 2017, Daniel Stenberg, <daniel@haxx.se>, 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 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_ISSUERCERT \- issuer SSL certificate filename
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_ISSUERCERT, char *file);
! 31: .SH DESCRIPTION
! 32: Pass a char * to a zero terminated string naming a \fIfile\fP holding a CA
! 33: certificate in PEM format. If the option is set, an additional check against
! 34: the peer certificate is performed to verify the issuer is indeed the one
! 35: associated with the certificate provided by the option. This additional check
! 36: is useful in multi-level PKI where one needs to enforce that the peer
! 37: certificate is from a specific branch of the tree.
! 38:
! 39: This option makes sense only when used in combination with the
! 40: \fICURLOPT_SSL_VERIFYPEER(3)\fP option. Otherwise, the result of the check is
! 41: not considered as failure.
! 42:
! 43: A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option,
! 44: which is returned if the setup of the SSL/TLS session has failed due to a
! 45: mismatch with the issuer of peer certificate (\fICURLOPT_SSL_VERIFYPEER(3)\fP
! 46: has to be set too for the check to fail). (Added in 7.19.0)
! 47:
! 48: The application does not have to keep the string around after setting this
! 49: option.
! 50: .SH DEFAULT
! 51: NULL
! 52: .SH PROTOCOLS
! 53: All TLS-based protocols
! 54: .SH EXAMPLE
! 55: .nf
! 56: CURL *curl = curl_easy_init();
! 57: if(curl) {
! 58: curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
! 59: curl_easy_setopt(curl, CURLOPT_ISSUERCERT, "/etc/certs/cacert.pem");
! 60: ret = curl_easy_perform(curl);
! 61: curl_easy_cleanup(curl);
! 62: }
! 63: .fi
! 64: .SH AVAILABILITY
! 65: If built TLS enabled
! 66: .SH RETURN VALUE
! 67: Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
! 68: CURLE_OUT_OF_MEMORY if there was insufficient heap space.
! 69: .SH "SEE ALSO"
! 70: .BR CURLOPT_CRLFILE "(3), " CURLOPT_SSL_VERIFYPEER "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>