| 1 |
.\" ************************************************************************** |
| 2 |
.\" * _ _ ____ _ |
| 3 |
.\" * Project ___| | | | _ \| | |
| 4 |
.\" * / __| | | | |_) | | |
| 5 |
.\" * | (__| |_| | _ <| |___ |
| 6 |
.\" * \___|\___/|_| \_\_____| |
| 7 |
.\" * |
| 8 |
.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <[email protected]>, 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_USE_SSL 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options" |
| 24 |
.SH NAME |
| 25 |
CURLOPT_USE_SSL \- request using SSL / TLS for the transfer |
| 26 |
.SH SYNOPSIS |
| 27 |
#include <curl/curl.h> |
| 28 |
|
| 29 |
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_USE_SSL, long level); |
| 30 |
.SH DESCRIPTION |
| 31 |
Pass a long using one of the values from below, to make libcurl use your |
| 32 |
desired \fIlevel\fP of SSL for the transfer. |
| 33 |
|
| 34 |
These are all protocols that start out plain text and get "upgraded" to SSL |
| 35 |
using the STARTTLS command. |
| 36 |
|
| 37 |
This is for enabling SSL/TLS when you use FTP, SMTP, POP3, IMAP etc. |
| 38 |
.IP CURLUSESSL_NONE |
| 39 |
Don't attempt to use SSL. |
| 40 |
.IP CURLUSESSL_TRY |
| 41 |
Try using SSL, proceed as normal otherwise. |
| 42 |
.IP CURLUSESSL_CONTROL |
| 43 |
Require SSL for the control connection or fail with \fICURLE_USE_SSL_FAILED\fP. |
| 44 |
.IP CURLUSESSL_ALL |
| 45 |
Require SSL for all communication or fail with \fICURLE_USE_SSL_FAILED\fP. |
| 46 |
.SH DEFAULT |
| 47 |
CURLUSESSL_NONE |
| 48 |
.SH PROTOCOLS |
| 49 |
FTP, SMTP, POP3, IMAP |
| 50 |
.SH EXAMPLE |
| 51 |
.nf |
| 52 |
CURL *curl = curl_easy_init(); |
| 53 |
if(curl) { |
| 54 |
curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/dir/file.ext"); |
| 55 |
|
| 56 |
/* require use of SSL for this, or fail */ |
| 57 |
curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_ALL); |
| 58 |
|
| 59 |
/* Perform the request */ |
| 60 |
curl_easy_perform(curl); |
| 61 |
} |
| 62 |
.fi |
| 63 |
.SH AVAILABILITY |
| 64 |
Added in 7.11.0. This option was known as CURLOPT_FTP_SSL up to 7.16.4, and |
| 65 |
the constants were known as CURLFTPSSL_* |
| 66 |
.SH RETURN VALUE |
| 67 |
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. |
| 68 |
.SH "SEE ALSO" |
| 69 |
.BR CURLOPT_SSLVERSION "(3), " CURLOPT_PROXY_SSLVERSION "(3), " |
| 70 |
.BR CURLOPT_SSL_OPTIONS "(3), " |