CURLOPT_SSLENGINE_DEFAULT.3 2.4 KB

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