CURLOPT_PROXY_SSLKEY_BLOB.3 2.8 KB

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