CURLOPT_SSLENGINE_DEFAULT.3 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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_SSLENGINE_DEFAULT 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24. .SH NAME
  25. CURLOPT_SSLENGINE_DEFAULT \- make SSL engine default
  26. .SH SYNOPSIS
  27. .nf
  28. #include <curl/curl.h>
  29. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE_DEFAULT, long val);
  30. .fi
  31. .SH DESCRIPTION
  32. Pass a long set to 1 to make the already specified crypto engine the default
  33. for (asymmetric) crypto operations.
  34. This option has no effect unless set after \fICURLOPT_SSLENGINE(3)\fP.
  35. .SH DEFAULT
  36. None
  37. .SH PROTOCOLS
  38. All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  39. .SH EXAMPLE
  40. .nf
  41. CURL *curl = curl_easy_init();
  42. if(curl) {
  43. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  44. curl_easy_setopt(curl, CURLOPT_SSLENGINE, "dynamic");
  45. curl_easy_setopt(curl, CURLOPT_SSLENGINE_DEFAULT, 1L);
  46. ret = curl_easy_perform(curl);
  47. curl_easy_cleanup(curl);
  48. }
  49. .fi
  50. .SH AVAILABILITY
  51. Only if the SSL backend is OpenSSL built with engine support.
  52. .SH RETURN VALUE
  53. CURLE_OK - Engine set as default.
  54. CURLE_SSL_ENGINE_SETFAILED - Engine could not be set as default.
  55. CURLE_NOT_BUILT_IN - Option not built in, OpenSSL is not the SSL backend.
  56. CURLE_UNKNOWN_OPTION - Option not recognized.
  57. CURLE_OUT_OF_MEMORY - Insufficient heap space.
  58. .SH "SEE ALSO"
  59. .BR CURLOPT_SSLENGINE "(3), " CURLOPT_SSLCERT "(3), "