CURLOPT_REDIR_PROTOCOLS.3 3.3 KB

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