| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 |
- .\" **************************************************************************
- .\" * _ _ ____ _
- .\" * Project ___| | | | _ \| |
- .\" * / __| | | | |_) | |
- .\" * | (__| |_| | _ <| |___
- .\" * \___|\___/|_| \_\_____|
- .\" *
- .\" * Copyright (C) 1998 - 2017, 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.haxx.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_SSLKEY 3 "May 31, 2017" "libcurl 7.61.1" "curl_easy_setopt options"
- .SH NAME
- CURLOPT_SSLKEY \- specify private keyfile for TLS and SSL client cert
- .SH SYNOPSIS
- #include <curl/curl.h>
- CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLKEY, char *keyfile);
- .SH DESCRIPTION
- Pass a pointer to a zero terminated string as parameter. The string should be
- the file name of your private key. The default format is "PEM" and can be
- changed with \fICURLOPT_SSLKEYTYPE(3)\fP.
- (iOS and Mac OS X only) This option is ignored if curl was built against
- Secure Transport. Secure Transport expects the private key to be already
- present in the keychain or PKCS#12 file containing the certificate.
- The application does not have to keep the string around after setting this
- option.
- .SH DEFAULT
- NULL
- .SH PROTOCOLS
- All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
- .SH EXAMPLE
- .nf
- CURL *curl = curl_easy_init();
- if(curl) {
- curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
- curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
- curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
- curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret");
- ret = curl_easy_perform(curl);
- curl_easy_cleanup(curl);
- }
- .fi
- .SH AVAILABILITY
- If built TLS enabled.
- .SH RETURN VALUE
- Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
- CURLE_OUT_OF_MEMORY if there was insufficient heap space.
- .SH "SEE ALSO"
- .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLCERT "(3), "
|
