docs/libcurl/opts/CURLOPT_SSLENGINE_DEFAULT.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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.haxx.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 "May 31, 2017" "libcurl 7.59.0" "curl_easy_setopt options"
  24
  25 .SH NAME
  26 CURLOPT_SSLENGINE_DEFAULT \- make SSL engine default
  27 .SH SYNOPSIS
  28 #include <curl/curl.h>
  29
  30 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE_DEFAULT, long val);
  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
  35 This option has no effect unless set after \fICURLOPT_SSLENGINE(3)\fP.
  36 .SH DEFAULT
  37 None
  38 .SH PROTOCOLS
  39 All TLS based protocols: HTTPS, FTPS, IMAPS, POP3S, SMTPS etc.
  40 .SH EXAMPLE
  41 .nf
  42 CURL *curl = curl_easy_init();
  43 if(curl) {
  44   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
  45   curl_easy_setopt(curl, CURLOPT_SSLENGINE, "dynamic");
  46   curl_easy_setopt(curl, CURLOPT_SSLENGINE_DEFAULT, 1L);
  47   ret = curl_easy_perform(curl);
  48   curl_easy_cleanup(curl);
  49 }
  50 .fi
  51 .SH AVAILABILITY
  52 Only if the SSL backend is OpenSSL built with engine support.
  53 .SH RETURN VALUE
  54 CURLE_OK - Engine set as default.
  55
  56 CURLE_SSL_ENGINE_SETFAILED - Engine could not be set as default.
  57
  58 CURLE_NOT_BUILT_IN - Option not built in, OpenSSL is not the SSL backend.
  59
  60 CURLE_UNKNOWN_OPTION - Option not recognized.
  61
  62 CURLE_OUT_OF_MEMORY - Insufficient heap space.
  63 .SH "SEE ALSO"
  64 .BR CURLOPT_SSLENGINE "(3), " CURLOPT_SSLCERT "(3), "