Blame view

3rdparty/curl/share/man/man3/CURLOPT_REDIR_PROTOCOLS.3 3.31 KB
a86c63ca   Hu Chunming   提交三方库文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
  .\" **************************************************************************
  .\" *                                  _   _ ____  _
  .\" *  Project                     ___| | | |  _ \| |
  .\" *                             / __| | | | |_) | |
  .\" *                            | (__| |_| |  _ <| |___
  .\" *                             \___|\___/|_| \_\_____|
  .\" *
  .\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
  .\" *
  .\" * This software is licensed as described in the file COPYING, which
  .\" * you should have received as part of this distribution. The terms
  .\" * are also available at https://curl.se/docs/copyright.html.
  .\" *
  .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
  .\" * copies of the Software, and permit persons to whom the Software is
  .\" * furnished to do so, under the terms of the COPYING file.
  .\" *
  .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  .\" * KIND, either express or implied.
  .\" *
  .\" **************************************************************************
  .\"
  .TH CURLOPT_REDIR_PROTOCOLS 3 "November 04, 2020" "libcurl 7.77.0" "curl_easy_setopt options"
  
  .SH NAME
  CURLOPT_REDIR_PROTOCOLS \- set protocols allowed to redirect to
  .SH SYNOPSIS
  #include <curl/curl.h>
  
  CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REDIR_PROTOCOLS, long bitmask);
  .SH DESCRIPTION
  Pass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask
  limits what protocols libcurl may use in a transfer that it follows to in a
  redirect when \fICURLOPT_FOLLOWLOCATION(3)\fP is enabled. This allows you to
  limit specific transfers to only be allowed to use a subset of protocols in
  redirections.
  
  Protocols denied by \fICURLOPT_PROTOCOLS(3)\fP are not overridden by this
  option.
  
  By default libcurl will allow HTTP, HTTPS, FTP and FTPS on redirect (7.65.2).
  Older versions of libcurl allowed all protocols on redirect except several
  disabled for security reasons: Since 7.19.4 FILE and SCP are disabled, and
  since 7.40.0 SMB and SMBS are also disabled. \fICURLPROTO_ALL\fP enables all
  protocols on redirect, including those disabled for security.
  
  These are the available protocol defines:
  .nf
  CURLPROTO_DICT
  CURLPROTO_FILE
  CURLPROTO_FTP
  CURLPROTO_FTPS
  CURLPROTO_GOPHER
  CURLPROTO_HTTP
  CURLPROTO_HTTPS
  CURLPROTO_IMAP
  CURLPROTO_IMAPS
  CURLPROTO_LDAP
  CURLPROTO_LDAPS
  CURLPROTO_POP3
  CURLPROTO_POP3S
  CURLPROTO_RTMP
  CURLPROTO_RTMPE
  CURLPROTO_RTMPS
  CURLPROTO_RTMPT
  CURLPROTO_RTMPTE
  CURLPROTO_RTMPTS
  CURLPROTO_RTSP
  CURLPROTO_SCP
  CURLPROTO_SFTP
  CURLPROTO_SMB
  CURLPROTO_SMBS
  CURLPROTO_SMTP
  CURLPROTO_SMTPS
  CURLPROTO_TELNET
  CURLPROTO_TFTP
  .fi
  .SH DEFAULT
  HTTP, HTTPS, FTP and FTPS (Since 7.65.2).
  
  Older versions defaulted to all protocols except FILE, SCP and since 7.40.0
  SMB and SMBS.
  .SH PROTOCOLS
  All
  .SH EXAMPLE
  .nf
  curl = curl_easy_init();
  if(curl) {
    /* pass in the URL from an external source */
    curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
  
    /* only allow redirects to HTTP and HTTPS URLs */
    curl_easy_setopt(curl, CURLOPT_REDIR_PROTOCOLS,
                     CURLPROTO_HTTP | CURLPROTO_HTTPS);
  
    /* Perform the request */
    curl_easy_perform(curl);
  }
  .fi
  .SH AVAILABILITY
  Added in 7.19.4, before then it would follow all protocols.
  .SH RETURN VALUE
  Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  .SH "SEE ALSO"
  .BR CURLOPT_PROTOCOLS "(3), "