CURLOPT_PROXY_PINNEDPUBLICKEY.3 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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_PROXY_PINNEDPUBLICKEY 3 "24 Nov 2016" "libcurl 7.52.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_PROXY_PINNEDPUBLICKEY \- pinned public key for https proxy
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_PINNEDPUBLICKEY, char *pinnedpubkey);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a pointer to a null-terminated string as parameter. The string can be the
  33. file name of your pinned public key. The file format expected is "PEM" or "DER".
  34. The string can also be any number of base64 encoded sha256 hashes preceded by
  35. "sha256//" and separated by ";"
  36. When negotiating a TLS or SSL connection, the https proxy sends a certificate
  37. indicating its identity. A public key is extracted from this certificate and
  38. if it does not exactly match the public key provided to this option, curl will
  39. abort the connection before sending or receiving any data.
  40. On mismatch, \fICURLE_SSL_PINNEDPUBKEYNOTMATCH\fP is returned.
  41. The application does not have to keep the string around after setting this
  42. option.
  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. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
  52. curl_easy_setopt(curl, CURLOPT_PROXY, "https://proxy:443");
  53. curl_easy_setopt(curl, CURLOPT_PROXY_PINNEDPUBLICKEY,
  54. "sha256//YhKJKSzoTt2b5FP18fvpHo7fJYqQCjAa3HWY3tvRMwE=;sha256//t62CeU2tQiqkexU74Gxa2eg7fRbEgoChTociMee9wno=");
  55. /* Perform the request */
  56. curl_easy_perform(curl);
  57. }
  58. .fi
  59. .SH PUBLIC KEY EXTRACTION
  60. If you do not have the https proxy server's public key file you can extract it
  61. from the https proxy server's certificate.
  62. .nf
  63. # retrieve the server's certificate if you do not already have it
  64. #
  65. # be sure to examine the certificate to see if it is what you expected
  66. #
  67. # Windows-specific:
  68. # - Use NUL instead of /dev/null.
  69. # - OpenSSL may wait for input instead of disconnecting. Hit enter.
  70. # - If you do not have sed, then just copy the certificate into a file:
  71. # Lines from -----BEGIN CERTIFICATE----- to -----END CERTIFICATE-----.
  72. #
  73. openssl s_client -servername www.example.com -connect www.example.com:443 < /dev/null | sed -n "/-----BEGIN/,/-----END/p" > www.example.com.pem
  74. # extract public key in pem format from certificate
  75. openssl x509 -in www.example.com.pem -pubkey -noout > www.example.com.pubkey.pem
  76. # convert public key from pem to der
  77. openssl asn1parse -noout -inform pem -in www.example.com.pubkey.pem -out www.example.com.pubkey.der
  78. # sha256 hash and base64 encode der to string for use
  79. openssl dgst -sha256 -binary www.example.com.pubkey.der | openssl base64
  80. .fi
  81. The public key in PEM format contains a header, base64 data and a
  82. footer:
  83. .nf
  84. -----BEGIN PUBLIC KEY-----
  85. [BASE 64 DATA]
  86. -----END PUBLIC KEY-----
  87. .fi
  88. .SH AVAILABILITY
  89. PEM/DER support:
  90. 7.52.0: GSKit, GnuTLS, NSS, OpenSSL, mbedtls, wolfSSL
  91. sha256 support:
  92. 7.52.0: GnuTLS, NSS, OpenSSL, mbedtls, wolfSSL
  93. Other SSL backends not supported.
  94. .SH RETURN VALUE
  95. Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
  96. CURLE_OUT_OF_MEMORY if there was insufficient heap space.
  97. .SH "SEE ALSO"
  98. .BR CURLOPT_PROXY_SSL_VERIFYPEER "(3), "
  99. .BR CURLOPT_PROXY_SSL_VERIFYHOST "(3), "
  100. .BR CURLOPT_PROXY_CAINFO "(3), "
  101. .BR CURLOPT_PROXY_CAPATH "(3), "