CURLOPT_SSLCERT.3 3.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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 "April 18, 2018" "libcurl 7.61.1" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SSLCERT \- set SSL client certificate
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERT, char *cert);
  29. .SH DESCRIPTION
  30. Pass a pointer to a zero terminated string as parameter. The string should be
  31. the file name of your client certificate. The default format is "P12" on
  32. Secure Transport and "PEM" on other engines, and can be changed with
  33. \fICURLOPT_SSLCERTTYPE(3)\fP.
  34. With NSS or Secure Transport, this can also be the nickname of the certificate
  35. you wish to authenticate with as it is named in the security database. If you
  36. want to use a file from the current directory, please precede it with "./"
  37. prefix, in order to avoid confusion with a nickname.
  38. (Schannel/WinSSL only) Client certificates must be specified by a path
  39. expression to a certificate store. (Loading PFX is not supported; you can
  40. import it to a store first). You can use
  41. "<store location>\\<store name>\\<thumbprint>" to refer to a certificate
  42. in the system certificates store, for example,
  43. "CurrentUser\\MY\\934a7ac6f8a5d579285a74fa61e19f23ddfe8d7a". Thumbprint is
  44. usually a SHA-1 hex string which you can see in certificate details. Following
  45. store locations are supported: CurrentUser, LocalMachine, CurrentService,
  46. Services, CurrentUserGroupPolicy, LocalMachineGroupPolicy,
  47. LocalMachineEnterprise.
  48. When using a client certificate, you most likely also need to provide a
  49. private key with \fICURLOPT_SSLKEY(3)\fP.
  50. The application does not have to keep the string around after setting this
  51. option.
  52. .SH DEFAULT
  53. NULL
  54. .SH PROTOCOLS
  55. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  56. .SH EXAMPLE
  57. .nf
  58. CURL *curl = curl_easy_init();
  59. if(curl) {
  60. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  61. curl_easy_setopt(curl, CURLOPT_SSLCERT, "client.pem");
  62. curl_easy_setopt(curl, CURLOPT_SSLKEY, "key.pem");
  63. curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret");
  64. ret = curl_easy_perform(curl);
  65. curl_easy_cleanup(curl);
  66. }
  67. .fi
  68. .SH AVAILABILITY
  69. If built TLS enabled.
  70. .SH RETURN VALUE
  71. Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
  72. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  73. .SH "SEE ALSO"
  74. .BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), "