Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_SSLENGINE.3, revision 1.1
1.1 ! misho 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 3 "May 31, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
! 24:
! 25: .SH NAME
! 26: CURLOPT_SSLENGINE \- set SSL engine identifier
! 27: .SH SYNOPSIS
! 28: #include <curl/curl.h>
! 29:
! 30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SSLENGINE, char *id);
! 31: .SH DESCRIPTION
! 32: Pass a pointer to a zero terminated string as parameter. It will be used as
! 33: the identifier for the crypto engine you want to use for your private key.
! 34:
! 35: The application does not have to keep the string around after setting this
! 36: option.
! 37: .SH DEFAULT
! 38: NULL
! 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: 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 found.
! 55:
! 56: CURLE_SSL_ENGINE_NOTFOUND - Engine not found, or OpenSSL was not built with
! 57: engine support.
! 58:
! 59: CURLE_SSL_ENGINE_INITFAILED - Engine found but initialization failed.
! 60:
! 61: CURLE_NOT_BUILT_IN - Option not built in, OpenSSL is not the SSL backend.
! 62:
! 63: CURLE_UNKNOWN_OPTION - Option not recognized.
! 64:
! 65: CURLE_OUT_OF_MEMORY - Insufficient heap space.
! 66: .SH "SEE ALSO"
! 67: .BR CURLOPT_SSLENGINE_DEFAULT "(3), " CURLOPT_SSLKEY "(3), "
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>