docs/libcurl/opts/CURLOPT_SSLKEYTYPE.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 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_SSLKEYTYPE 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSLKEYTYPE \- set type of the private key file
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLKEYTYPE, char *type);
  31 .SH DESCRIPTION
  32 Pass a pointer to a zero terminated string as parameter. The string should be
  33 the format of your private key. Supported formats are "PEM", "DER" and "ENG".
  34
  35 The format "ENG" enables you to load the private key from a crypto engine. In
  36 this case \fICURLOPT_SSLKEY(3)\fP is used as an identifier passed to the
  37 engine. You have to set the crypto engine with \fICURLOPT_SSLENGINE(3)\fP.
  38 \&"DER" format key file currently does not work because of a bug in OpenSSL.
  39
  40 The application does not have to keep the string around after setting this
  41 option.
  42 .SH DEFAULT
  43 "PEM"
  44 .SH PROTOCOLS
  45 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  46 .SH EXAMPLE
  47 .nf
  48 CURL *curl = curl_easy_init();
  49 if(curl) {
  50   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  51   curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
  52   curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
  53   curl_easy_setopt(curl, CURLOPT_SSLKEYTYPE, "PEM");
  54   curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret");
  55   ret = curl_easy_perform(curl);
  56   curl_easy_cleanup(curl);
  57 }
  58 .fi
  59 .SH AVAILABILITY
  60 If built TLS enabled.
  61 .SH RETURN VALUE
  62 Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
  63 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  64 .SH "SEE ALSO"
  65 .BR CURLOPT_SSLKEY "(3), " CURLOPT_SSLCERT "(3), "