blob: c123b28b22f3288ec89a7909383bbe497ce8edf9 [file] [log] [blame]
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Elliott Hughes82be86d2017-09-20 17:00:17 -07008.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07009.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
Alex Deymo8f1a2142016-06-28 14:49:26 -070012.\" * are also available at https://curl.haxx.se/docs/copyright.html.
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070013.\" *
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.\"
Haibo Huang445085a2019-09-11 13:33:50 -070023.TH CURLOPT_FTPSSLAUTH 3 "May 31, 2017" "libcurl 7.66.0" "curl_easy_setopt options"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070025.SH NAME
26CURLOPT_FTPSSLAUTH \- set order in which to attempt TLS vs SSL when using FTP
27.SH SYNOPSIS
28#include <curl/curl.h>
29
30CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTPSSLAUTH, long order);
31.SH DESCRIPTION
32Pass a long using one of the values from below, to alter how libcurl issues
33\&"AUTH TLS" or "AUTH SSL" when FTP over SSL is activated. This is only
34interesting if \fICURLOPT_USE_SSL(3)\fP is also set.
35
36Possible \fIorder\fP values:
37.IP CURLFTPAUTH_DEFAULT
38Allow libcurl to decide.
39.IP CURLFTPAUTH_SSL
40Try "AUTH SSL" first, and only if that fails try "AUTH TLS".
41.IP CURLFTPAUTH_TLS
42Try "AUTH TLS" first, and only if that fails try "AUTH SSL".
43.SH DEFAULT
44CURLFTPAUTH_DEFAULT
45.SH PROTOCOLS
46FTP
47.SH EXAMPLE
Elliott Hughes82be86d2017-09-20 17:00:17 -070048.nf
49CURL *curl = curl_easy_init();
50if(curl) {
51 curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
52 curl_easy_setopt(curl, CURLOPT_USE_SSL, CURLUSESSL_TRY);
53 /* funny server, ask for SSL before TLS */
54 curl_easy_setopt(curl, CURLOPT_FTPSSLAUTH, CURLFTPAUTH_SSL);
55 ret = curl_easy_perform(curl);
56 curl_easy_cleanup(curl);
57}
58.fi
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070059.SH AVAILABILITY
60Added in 7.12.2
61.SH RETURN VALUE
62Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
63.SH "SEE ALSO"
64.BR CURLOPT_USE_SSL "(3), " CURLOPT_FTP_SSL_CCC "(3), "