CURLOPT_SSLKEY_BLOB.3 2.8 KB

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