romenskiy2012/curl

mirror of https://github.com/curl/curl.git synced 2026-04-25 11:32:11 +03:00

Daniel Stenberg 54ded66618

docs/libcurl: improve easy setopt examples

- always assign the curl_easy_perform() return code (and declare
  the necessary 'result' variable for it)

- always call curl_easy_cleanup() on the created easy handles

Closes #21364

2026-04-18 23:34:39 +02:00

1.8 KiB

Raw Blame History

SPDX-License-Identifier

Title

Section

Source

See-also

Protocol

Added-in

curl

CURLOPT_PATH_AS_IS

libcurl

CURLOPT_DEBUGFUNCTION (3)

CURLOPT_STDERR (3)

CURLOPT_URL (3)

curl_url_set (3)

All

7.42.0

NAME

CURLOPT_PATH_AS_IS - do not handle dot-dot sequences

SYNOPSIS

#include <curl/curl.h>

CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PATH_AS_IS, long leaveit);

DESCRIPTION

Set the long leaveit to 1, to explicitly tell libcurl to not alter the given path before passing it on to the server.

This instructs libcurl to NOT squash sequences of "/../" or "/./" that may exist in the URL's path part and that is supposed to be removed according to RFC 3986 section 5.2.4.

Some server implementations are known to (erroneously) require the dot-dot sequences to remain in the path and some clients want to pass these on in order to try out server implementations.

By default libcurl normalizes such sequences before using the path.

This is a request for the first request libcurl issues. When following redirects, it may no longer apply.

The corresponding flag for the curl_url_set(3) function is called CURLU_PATH_AS_IS.

DEFAULT

%PROTOCOLS%

EXAMPLE

int main(void)
{
  CURL *curl = curl_easy_init();
  if(curl) {
    CURLcode result;
    curl_easy_setopt(curl, CURLOPT_URL,
                     "https://example.com/../../etc/password");

    curl_easy_setopt(curl, CURLOPT_PATH_AS_IS, 1L);

    result = curl_easy_perform(curl);
    curl_easy_cleanup(curl);
  }
}

%AVAILABILITY%

RETURN VALUE

curl_easy_setopt(3) returns a CURLcode indicating success or error.

CURLE_OK (0) means everything was OK, non-zero means an error occurred, see libcurl-errors(3).

1.8 KiB Raw Blame History