CURLOPT_SSLCERT_BLOB.3 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2020, 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.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_BLOB 3 "24 Jun 2020" "libcurl 7.71.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SSLCERT_BLOB \- SSL client certificate from memory blob
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLCERT_BLOB, struct curl_blob *stblob);
  29. .SH DESCRIPTION
  30. Pass a pointer to a curl_blob structure, which contains (pointer and size) a
  31. client certificate. The format must be "P12" on Secure Transport or
  32. Schannel. The format must be "P12" or "PEM" on OpenSSL. The string "P12" or
  33. "PEM" must be specified with \fICURLOPT_SSLCERTTYPE(3)\fP.
  34. If the blob is initialized with the flags member of struct curl_blob set to
  35. CURL_BLOB_COPY, the application does not have to keep the buffer around after
  36. setting this.
  37. This option is an alternative to \fICURLOPT_SSLCERT(3)\fP which instead
  38. expects a file name as input.
  39. .SH DEFAULT
  40. NULL
  41. .SH PROTOCOLS
  42. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  43. .SH EXAMPLE
  44. .nf
  45. CURL *curl = curl_easy_init();
  46. if(curl) {
  47. struct curl_blob stblob;
  48. stblob.data = certificateData;
  49. stblob.len = filesize;
  50. stblob.flags = CURL_BLOB_COPY;
  51. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  52. curl_easy_setopt(curl, CURLOPT_SSLCERT_BLOB, &stblob);
  53. curl_easy_setopt(curl, CURLOPT_SSLCERTTYPE, "P12");
  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. Added in libcurl 7.71.0. This option is supported by the OpenSSL, Secure
  61. Transport and Schannel backends.
  62. .SH RETURN VALUE
  63. Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
  64. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  65. .SH "SEE ALSO"
  66. .BR CURLOPT_SSLCERTTYPE "(3), " CURLOPT_SSLKEY "(3), "