CURLOPT_PROXY_SSLCERT_BLOB.3 3.0 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_PROXY_SSLCERT_BLOB 3 "24 Jun 2020" libcurl libcurl
  26. .SH NAME
  27. CURLOPT_PROXY_SSLCERT_BLOB \- SSL proxy client certificate from memory blob
  28. .SH SYNOPSIS
  29. .nf
  30. #include <curl/curl.h>
  31. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SSLCERT_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) about a memory block with binary data of the certificate used to
  37. connect to the HTTPS proxy. The format must be "P12" on Secure Transport or
  38. Schannel. The format must be "P12" or "PEM" on OpenSSL. The string "P12" or
  39. "PEM" must be specified with \fICURLOPT_PROXY_SSLCERTTYPE(3)\fP.
  40. If the blob is initialized with the flags member of struct curl_blob set to
  41. CURL_BLOB_COPY, the application does not have to keep the buffer around after
  42. setting this.
  43. This option is an alternative to \fICURLOPT_PROXY_SSLCERT(3)\fP which instead
  44. expects a file name as input.
  45. .SH DEFAULT
  46. NULL
  47. .SH PROTOCOLS
  48. Used with HTTPS proxy
  49. .SH EXAMPLE
  50. .nf
  51. CURL *curl = curl_easy_init();
  52. if(curl) {
  53. struct curl_blob blob;
  54. blob.data = certificateData;
  55. blob.len = filesize;
  56. blob.flags = CURL_BLOB_COPY;
  57. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  58. curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy");
  59. curl_easy_setopt(curl, CURLOPT_PROXY_SSLKEY, "key.pem");
  60. curl_easy_setopt(curl, CURLOPT_PROXY_KEYPASSWD, "s3cret");
  61. curl_easy_setopt(curl, CURLOPT_PROXY_SSLCERT_BLOB, &blob);
  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, Secure Transport and
  68. Schannel 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_PROXY_SSLCERTTYPE "(3), " CURLOPT_PROXY_SSLKEY "(3), "
  74. .BR CURLOPT_PROXY_SSLCERT "(3), "