docs/libcurl/opts/CURLOPT_REDIR_PROTOCOLS.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2  "http://www.w3.org/TR/html4/loose.dtd">
   3 <html><head>
   4 <title>CURLOPT_REDIR_PROTOCOLS man page</title>
   5 <meta name="generator" content="roffit">
   6 <STYLE type="text/css">
   7 pre {
   8   overflow: auto;
   9   margin: 0;
  10 }
  11
  12 P.level0, pre.level0 {
  13  padding-left: 2em;
  14 }
  15
  16 P.level1, pre.level1 {
  17  padding-left: 4em;
  18 }
  19
  20 P.level2, pre.level2 {
  21  padding-left: 6em;
  22 }
  23
  24 span.emphasis {
  25  font-style: italic;
  26 }
  27
  28 span.bold {
  29  font-weight: bold;
  30 }
  31
  32 span.manpage {
  33  font-weight: bold;
  34 }
  35
  36 h2.nroffsh {
  37  background-color: #e0e0e0;
  38 }
  39
  40 span.nroffip {
  41  font-weight: bold;
  42  font-size: 120%;
  43  font-family: monospace;
  44 }
  45
  46 p.roffit {
  47  text-align: center;
  48  font-size: 80%;
  49 }
  50 </STYLE>
  51 </head><body>
  52
  53 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
  54 <p class="level0">CURLOPT_REDIR_PROTOCOLS - set protocols allowed to redirect to <a name="SYNOPSIS"></a><h2 class="nroffsh">SYNOPSIS</h2>
  55 <p class="level0">&#35;include &lt;curl/curl.h&gt;
  56 <p class="level0">CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REDIR_PROTOCOLS, long bitmask); <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
  57 <p class="level0">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 <a Class="emphasis" href="./CURLOPT_FOLLOWLOCATION.html">CURLOPT_FOLLOWLOCATION</a> is enabled. This allows you to limit specific transfers to only be allowed to use a subset of protocols in redirections.
  58 <p class="level0">By default libcurl will allow 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. <span Class="emphasis">CURLPROTO_ALL</span> enables all protocols on redirect, including those disabled for security.
  59 <p class="level0">These are the available protocol defines: <pre class="level0">
  60 CURLPROTO_DICT
  61 CURLPROTO_FILE
  62 CURLPROTO_FTP
  63 CURLPROTO_FTPS
  64 CURLPROTO_GOPHER
  65 CURLPROTO_HTTP
  66 CURLPROTO_HTTPS
  67 CURLPROTO_IMAP
  68 CURLPROTO_IMAPS
  69 CURLPROTO_LDAP
  70 CURLPROTO_LDAPS
  71 CURLPROTO_POP3
  72 CURLPROTO_POP3S
  73 CURLPROTO_RTMP
  74 CURLPROTO_RTMPE
  75 CURLPROTO_RTMPS
  76 CURLPROTO_RTMPT
  77 CURLPROTO_RTMPTE
  78 CURLPROTO_RTMPTS
  79 CURLPROTO_RTSP
  80 CURLPROTO_SCP
  81 CURLPROTO_SFTP
  82 CURLPROTO_SMB
  83 CURLPROTO_SMBS
  84 CURLPROTO_SMTP
  85 CURLPROTO_SMTPS
  86 CURLPROTO_TELNET
  87 CURLPROTO_TFTP
  88 </pre>
  89
  90 <p class="level0"><a name="DEFAULT"></a><h2 class="nroffsh">DEFAULT</h2>
  91 <p class="level0">All protocols except for FILE, SCP and since 7.40.0 SMB and SMBS. <a name="PROTOCOLS"></a><h2 class="nroffsh">PROTOCOLS</h2>
  92 <p class="level0">All <a name="EXAMPLE"></a><h2 class="nroffsh">EXAMPLE</h2>
  93 <p class="level0"><pre class="level0">
  94 curl = curl_easy_init();
  95 if(curl) {
  96 &nbsp; /* pass in the URL from an external source */
  97 &nbsp; curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
  98 &nbsp;
  99 &nbsp; /* only allow redirects to HTTP and HTTPS URLs */
 100 &nbsp; curl_easy_setopt(curl, CURLOPT_REDIR_PROTOCOLS,
 101 &nbsp;                  CURLPROTO_HTTP | CURLPROTO_HTTPS);
 102 &nbsp;
 103 &nbsp; /* Perform the request */
 104 &nbsp; curl_easy_perform(curl);
 105 }
 106 </pre>
 107
 108 <p class="level0"><a name="AVAILABILITY"></a><h2 class="nroffsh">AVAILABILITY</h2>
 109 <p class="level0">Added in 7.19.4, before then it would follow all protocols. <a name="RETURN"></a><h2 class="nroffsh">RETURN VALUE</h2>
 110 <p class="level0">Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not. <a name="SEE"></a><h2 class="nroffsh">SEE ALSO</h2>
 111 <p class="level0"><a Class="manpage" href="./CURLOPT_PROTOCOLS.html">CURLOPT_PROTOCOLS</a><p class="roffit">
 112  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
 113 </body></html>