Components | All | New | MacOS | Windows | Linux | iOS | ||||
Examples | Mac & Win | Server | Client | Guides | Statistic | FMM | Blog | Deprecated | Old |
CURL.SetOptionRedirProtocolsString
Sets the protocols allowed to redirect to.
Component | Version | macOS | Windows | Linux | Server | iOS SDK |
CURL | 12.4 | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
MBS( "CURL.SetOptionRedirProtocolsString"; curl; Value ) More
Parameters
Parameter | Description | Example |
---|---|---|
curl | The CURL session handle. | $curl |
Value | The new value. |
Result
Returns OK or error.
Description
Sets the protocols allowed to redirect to.Pass string that holds a comma-separated list of case insensitive protocol names (URL schemes). That list limits what protocols libcurl may use in a transfer that it follows to in a redirect when CURL.SetOptionFollowLocation is enabled. This option allows applications to limit specific transfers to only be allowed to use a subset of protocols in redirections.
Protocols denied by CURL.SetOptionProtocolsString are not overridden by this option.
By default libcurl will allow HTTP, HTTPS, FTP and FTPS on redirects (since 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.
These are the available protocols:
DICT, FILE, FTP, FTPS, GOPHER, GOPHERS, HTTP, HTTPS, IMAP, IMAPS, LDAP, LDAPS, POP3, POP3S, RTMP, RTMPE, RTMPS, RTMPT, RTMPTE, RTMPTS, RTSP, SCP, SFTP, SMB, SMBS, SMTP, SMTPS, TELNET, TFTP
You can set "ALL" as a short-cut to enable all protocols. Note that by setting all, you may enable protocols that were not supported the day you write this but are introduced in a future libcurl version.
If trying to set a non-existing protocol or if no matching protocol at all is set, it returns error.
Default
HTTP, HTTPS, FTP and FTPS (Added in 7.65.2).
Older versions defaulted to all protocols except FILE, SCP and since 7.40.0 SMB and SMBS.
See also
- CURL.SetOptionFollowLocation
- CURL.SetOptionProtocols
- CURL.SetOptionProtocolsString
- CURL.SetOptionRedirProtocols
Release notes
- Version 13.0
- Deprecated CURL.SetOptionRedirProtocols in favor of CURL.SetOptionRedirProtocolsString function.
Blog Entries
This function checks for a license.
Created 1st September 2022, last changed 21st December 2022