docs/libcurl/opts/CURLOPT_SSLCERT.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_SSLCERT 3 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSLCERT \- set SSL client certificate
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERT, char *cert);
  31 .SH DESCRIPTION
  32 Pass a pointer to a zero terminated string as parameter. The string should be
  33 the file name of your client certificate. The default format is "P12" on
  34 Secure Transport and "PEM" on other engines, and can be changed with
  35 \fICURLOPT_SSLCERTTYPE(3)\fP.
  36
  37 With NSS or Secure Transport, this can also be the nickname of the certificate
  38 you wish to authenticate with as it is named in the security database. If you
  39 want to use a file from the current directory, please precede it with "./"
  40 prefix, in order to avoid confusion with a nickname.
  41
  42 When using a client certificate, you most likely also need to provide a
  43 private key with \fICURLOPT_SSLKEY(3)\fP.
  44
  45 The application does not have to keep the string around after setting this
  46 option.
  47 .SH DEFAULT
  48 NULL
  49 .SH PROTOCOLS
  50 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  51 .SH EXAMPLE
  52 .nf
  53 CURL *curl = curl_easy_init();
  54 if(curl) {
  55   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  56   curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
  57   curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
  58   curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret");
  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 TLS enabled, CURLE_UNKNOWN_OPTION if not, or
  67 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  68 .SH "SEE ALSO"
  69 .BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), "