CURLOPT_SSLENGINE.3 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556
  1. .\" generated by cd2nroff 0.1 from CURLOPT_SSLENGINE.md
  2. .TH CURLOPT_SSLENGINE 3 "2025-01-17" libcurl
  3. .SH NAME
  4. CURLOPT_SSLENGINE \- SSL engine identifier
  5. .SH SYNOPSIS
  6. .nf
  7. #include <curl/curl.h>
  8. CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE, char *id);
  9. .fi
  10. .SH DESCRIPTION
  11. Pass a pointer to a null\-terminated string as parameter. It is used as the
  12. identifier for the crypto engine you want to use for your private key.
  13. The application does not have to keep the string around after setting this
  14. option.
  15. .SH DEFAULT
  16. NULL
  17. .SH PROTOCOLS
  18. This functionality affects all TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  19. This option works only with the following TLS backends:
  20. OpenSSL
  21. .SH EXAMPLE
  22. .nf
  23. int main(void)
  24. {
  25. CURL *curl = curl_easy_init();
  26. if(curl) {
  27. CURLcode res;
  28. curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  29. curl_easy_setopt(curl, CURLOPT_SSLENGINE, "dynamic");
  30. res = curl_easy_perform(curl);
  31. curl_easy_cleanup(curl);
  32. }
  33. }
  34. .fi
  35. .SH AVAILABILITY
  36. Added in curl 7.9.3
  37. .SH RETURN VALUE
  38. CURLE_OK \- Engine found.
  39. CURLE_SSL_ENGINE_NOTFOUND \- Engine not found, or OpenSSL was not built with
  40. engine support.
  41. CURLE_SSL_ENGINE_INITFAILED \- Engine found but initialization failed.
  42. CURLE_NOT_BUILT_IN \- Option not built in, OpenSSL is not the SSL backend.
  43. CURLE_UNKNOWN_OPTION \- Option not recognized.
  44. CURLE_OUT_OF_MEMORY \- Insufficient heap space.
  45. .SH SEE ALSO
  46. .BR CURLINFO_SSL_ENGINES (3),
  47. .BR CURLOPT_SSLENGINE_DEFAULT (3),
  48. .BR CURLOPT_SSLKEY (3)