2
0

CURLOPT_SSLKEY_BLOB.3 2.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2021, 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_SSLKEY_BLOB 3 "24 Jun 2020" "libcurl 7.71.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SSLKEY_BLOB \- private key for client cert from memory blob
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLKEY_BLOB,
  30. struct curl_blob *blob);
  31. .fi
  32. .SH DESCRIPTION
  33. Pass a pointer to a curl_blob structure, which contains information (pointer
  34. and size) for a private key. Compatible with OpenSSL. The format (like "PEM")
  35. must be specified with \fICURLOPT_SSLKEYTYPE(3)\fP.
  36. If the blob is initialized with the flags member of struct curl_blob set to
  37. CURL_BLOB_COPY, the application does not have to keep the buffer around after
  38. setting this.
  39. This option is an alternative to \fICURLOPT_SSLKEY(3)\fP which instead expects
  40. a file name as input.
  41. .SH DEFAULT
  42. NULL
  43. .SH PROTOCOLS
  44. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  45. .SH EXAMPLE
  46. .nf
  47. CURL *curl = curl_easy_init();
  48. if(curl) {
  49. struct curl_blob blob;
  50. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  51. blob.data = certificateData;
  52. blob.len = filesize;
  53. blob.flags = CURL_BLOB_COPY;
  54. curl_easy_setopt(curl, CURLOPT_SSLCERT_BLOB, &blob);
  55. curl_easy_setopt(curl, CURLOPT_SSLCERTTYPE, "PEM");
  56. blob.data = privateKeyData;
  57. blob.len = privateKeySize;
  58. curl_easy_setopt(curl, CURLOPT_SSLKEY_BLOB, &blob);
  59. curl_easy_setopt(curl, CURLOPT_KEYPASSWD, "s3cret");
  60. curl_easy_setopt(curl, CURLOPT_SSLKEYTYPE, "PEM");
  61. ret = curl_easy_perform(curl);
  62. curl_easy_cleanup(curl);
  63. }
  64. .fi
  65. .SH AVAILABILITY
  66. Added in 7.71.0. This option is supported by the OpenSSL backends.
  67. .SH RETURN VALUE
  68. Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
  69. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  70. .SH "SEE ALSO"
  71. .BR CURLOPT_SSLKEYTYPE "(3), " CURLOPT_SSLKEY "(3), "