CURLOPT_SSL_OPTIONS.3 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. .\" **************************************************************************
  2. .\" * _ _ ____ _
  3. .\" * Project ___| | | | _ \| |
  4. .\" * / __| | | | |_) | |
  5. .\" * | (__| |_| | _ <| |___
  6. .\" * \___|\___/|_| \_\_____|
  7. .\" *
  8. .\" * Copyright (C) 1998 - 2020, 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_SSL_OPTIONS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SSL_OPTIONS \- set SSL behavior options
  26. .SH SYNOPSIS
  27. #include <curl/curl.h>
  28. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSL_OPTIONS, long bitmask);
  29. .SH DESCRIPTION
  30. Pass a long with a bitmask to tell libcurl about specific SSL
  31. behaviors. Available bits:
  32. .IP CURLSSLOPT_ALLOW_BEAST
  33. Tells libcurl to not attempt to use any workarounds for a security flaw in the
  34. SSL3 and TLS1.0 protocols. If this option isn't used or this bit is set to 0,
  35. the SSL layer libcurl uses may use a work-around for this flaw although it
  36. might cause interoperability problems with some (older) SSL
  37. implementations. WARNING: avoiding this work-around lessens the security, and
  38. by setting this option to 1 you ask for exactly that. This option is only
  39. supported for Secure Transport, NSS and OpenSSL.
  40. .IP CURLSSLOPT_NO_REVOKE
  41. Tells libcurl to disable certificate revocation checks for those SSL backends
  42. where such behavior is present. This option is only supported for Schannel
  43. (the native Windows SSL library), with an exception in the case of Windows'
  44. Untrusted Publishers block list which it seems can't be bypassed. (Added in
  45. 7.44.0)
  46. .IP CURLSSLOPT_NO_PARTIALCHAIN
  47. Tells libcurl to not accept "partial" certificate chains, which it otherwise
  48. does by default. This option is only supported for OpenSSL and will fail the
  49. certificate verification if the chain ends with an intermediate certificate
  50. and not with a root cert. (Added in 7.68.0)
  51. .IP CURLSSLOPT_REVOKE_BEST_EFFORT
  52. Tells libcurl to ignore certificate revocation checks in case of missing or
  53. offline distribution points for those SSL backends where such behavior is
  54. present. This option is only supported for Schannel (the native Windows SSL
  55. library). If combined with \fICURLSSLOPT_NO_REVOKE\fP, the latter takes
  56. precedence. (Added in 7.70.0)
  57. .IP CURLSSLOPT_NATIVE_CA
  58. Tell libcurl to use the operating system's native CA store for certificate
  59. verification. Works only on Windows when built to use OpenSSL. This option is
  60. experimental and behavior is subject to change.
  61. (Added in 7.71.0)
  62. .SH DEFAULT
  63. 0
  64. .SH PROTOCOLS
  65. All TLS-based protocols
  66. .SH EXAMPLE
  67. .nf
  68. CURL *curl = curl_easy_init();
  69. if(curl) {
  70. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  71. /* weaken TLS only for use with silly servers */
  72. curl_easy_setopt(curl, CURLOPT_SSL_OPTIONS, CURLSSLOPT_ALLOW_BEAST |
  73. CURLSSLOPT_NO_REVOKE);
  74. ret = curl_easy_perform(curl);
  75. curl_easy_cleanup(curl);
  76. }
  77. .fi
  78. .SH AVAILABILITY
  79. Added in 7.25.0
  80. .SH RETURN VALUE
  81. Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  82. .SH "SEE ALSO"
  83. .BR CURLOPT_SSLVERSION "(3), " CURLOPT_SSL_CIPHER_LIST "(3), "