docs/libcurl/opts/CURLOPT_REDIR_PROTOCOLS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2014, 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_REDIR_PROTOCOLS 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_REDIR_PROTOCOLS \- set protocols allowed to redirect to
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_REDIR_PROTOCOLS, long bitmask);
  30 .SH DESCRIPTION
  31 Pass a long that holds a bitmask of CURLPROTO_* defines. If used, this bitmask
  32 limits what protocols libcurl may use in a transfer that it follows to in a
  33 redirect when \fICURLOPT_FOLLOWLOCATION(3)\fP is enabled. This allows you to
  34 limit specific transfers to only be allowed to use a subset of protocols in
  35 redirections.
  36
  37 By default libcurl will allow all protocols on redirect except several disabled
  38 for security reasons: Since 7.19.4 FILE and SCP are disabled, and since 7.40.0
  39 SMB and SMBS are also disabled. \fICURLPROTO_ALL\fP enables all protocols on
  40 redirect, including those disabled for security.
  41
  42 These are the available protocol defines:
  43 .nf
  44 CURLPROTO_DICT
  45 CURLPROTO_FILE
  46 CURLPROTO_FTP
  47 CURLPROTO_FTPS
  48 CURLPROTO_GOPHER
  49 CURLPROTO_HTTP
  50 CURLPROTO_HTTPS
  51 CURLPROTO_IMAP
  52 CURLPROTO_IMAPS
  53 CURLPROTO_LDAP
  54 CURLPROTO_LDAPS
  55 CURLPROTO_POP3
  56 CURLPROTO_POP3S
  57 CURLPROTO_RTMP
  58 CURLPROTO_RTMPE
  59 CURLPROTO_RTMPS
  60 CURLPROTO_RTMPT
  61 CURLPROTO_RTMPTE
  62 CURLPROTO_RTMPTS
  63 CURLPROTO_RTSP
  64 CURLPROTO_SCP
  65 CURLPROTO_SFTP
  66 CURLPROTO_SMB
  67 CURLPROTO_SMBS
  68 CURLPROTO_SMTP
  69 CURLPROTO_SMTPS
  70 CURLPROTO_TELNET
  71 CURLPROTO_TFTP
  72 .fi
  73 .SH DEFAULT
  74 All protocols except for FILE, SCP and since 7.40.0 SMB and SMBS.
  75 .SH PROTOCOLS
  76 All
  77 .SH EXAMPLE
  78 .nf
  79 curl = curl_easy_init();
  80 if(curl) {
  81   /* pass in the URL from an external source */
  82   curl_easy_setopt(curl, CURLOPT_URL, argv[1]);
  83
  84   /* only allow redirects to HTTP and HTTPS URLs */
  85   curl_easy_setopt(curl, CURLOPT_REDIR_PROTOCOLS,
  86                    CURLPROTO_HTTP | CURLPROTO_HTTPS);
  87
  88   /* Perform the request */
  89   curl_easy_perform(curl);
  90 }
  91 .fi
  92 .SH AVAILABILITY
  93 Added in 7.19.4, before then it would follow all protocols.
  94 .SH RETURN VALUE
  95 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  96 .SH "SEE ALSO"
  97 .BR CURLOPT_PROTOCOLS "(3), "