docs/libcurl/opts/CURLOPT_PATH_AS_IS.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2016, 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_PATH_AS_IS 3 "17 Jun 2014" "libcurl 7.42.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_PATH_AS_IS \- do not handle dot dot sequences
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PATH_AS_IS, long leaveit);
  30 .SH DESCRIPTION
  31 Set the long \fIleaveit\fP to 1, to explicitly tell libcurl to not alter the
  32 given path before passing it on to the server.
  33
  34 This instructs libcurl to NOT squash sequences of "/../" or "/./" that may
  35 exist in the URL's path part and that is supposed to be removed according to
  36 RFC 3986 section 5.2.4.
  37
  38 Some server implementations are known to (erroneously) require the dot dot
  39 sequences to remain in the path and some clients want to pass these on in
  40 order to try out server implementations.
  41
  42 By default libcurl will merge such sequences before using the path.
  43 .SH DEFAULT
  44 0
  45 .SH PROTOCOLS
  46 All
  47 .SH EXAMPLE
  48 .nf
  49 CURL *curl = curl_easy_init();
  50 if(curl) {
  51   curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/../../etc/password");
  52
  53   curl_easy_setopt(curl, CURLOPT_PATH_AS_IS, 1L);
  54
  55   curl_easy_perform(curl);
  56 }
  57 .fi
  58 .SH AVAILABILITY
  59 Aded in 7.42.0
  60 .SH RETURN VALUE
  61 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
  62 .SH "SEE ALSO"
  63 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "
  64 .BR CURLOPT_URL "(3), "
  65