curl/docs/libcurl/opts/CURLOPT_SSLENGINE_DEFAULT.md
Daniel Stenberg 8c1d9378ac
curldown: make 'added-in:' a mandatory header field
- generate AVAILABILITY manpage sections automatically - for consistent
  wording

- allows us to double-check against other documumentation (symbols-in-versions
  etc)

- enables proper automation/scripting based on this data

- lots of them were wrong or missing in the manpages

- several of them repeated (sometimes mismatching) backend support info

Add test 1488 to verify "added-in" version numbers against
symbols-in-versions.

Closes #14217
2024-07-18 18:04:09 +02:00

1.3 KiB

c SPDX-License-Identifier Title Section Source See-also Protocol TLS-backend Added-in
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. curl CURLOPT_SSLENGINE_DEFAULT 3 libcurl
CURLOPT_SSLCERT (3)
CURLOPT_SSLENGINE (3)
TLS
OpenSSL
7.9.3

NAME

CURLOPT_SSLENGINE_DEFAULT - make SSL engine default

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE_DEFAULT, long val);

DESCRIPTION

Pass a long set to 1 to make the already specified crypto engine the default for (asymmetric) crypto operations.

This option has no effect unless set after CURLOPT_SSLENGINE(3).

DEFAULT

None

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode res;
    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
    curl_easy_setopt(curl, CURLOPT_SSLENGINE, "dynamic");
    curl_easy_setopt(curl, CURLOPT_SSLENGINE_DEFAULT, 1L);
    res = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

RETURN VALUE

CURLE_OK - Engine set as default.

CURLE_SSL_ENGINE_SETFAILED - Engine could not be set as default.

CURLE_NOT_BUILT_IN - Option not built in, OpenSSL is not the SSL backend.

CURLE_UNKNOWN_OPTION - Option not recognized.

CURLE_OUT_OF_MEMORY - Insufficient heap space.