/src/php-src/ext/standard/http_fopen_wrapper.c

Source
/*
   +----------------------------------------------------------------------+
   | Copyright © The PHP Group and Contributors.                          |
   +----------------------------------------------------------------------+
   | This source file is subject to the Modified BSD License that is      |
   | bundled with this package in the file LICENSE, and is available      |
   | through the World Wide Web at <https://www.php.net/license/>.        |
   |                                                                      |
   | SPDX-License-Identifier: BSD-3-Clause                                |
   +----------------------------------------------------------------------+
   | Authors: Rasmus Lerdorf <rasmus@php.net>                             |
   |          Jim Winstead <jimw@php.net>                                 |
   |          Hartmut Holzgraefe <hholzgra@php.net>                       |
   |          Wez Furlong <wez@thebrainroom.com>                          |
   |          Sara Golemon <pollita@php.net>                              |
   +----------------------------------------------------------------------+
 */

#include "php.h"
#include "php_globals.h"
#include "ext/uri/php_uri.h"
#include "php_streams.h"
#include "php_network.h"
#include "php_ini.h"
#include "ext/standard/basic_functions.h"
#include "zend_smart_str.h"
#include "zend_exceptions.h"

#include <stdio.h>
#include <stdlib.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>

#include "php_standard.h"

#ifdef HAVE_SYS_SOCKET_H
#include <sys/socket.h>
#endif

#ifdef PHP_WIN32
#include <winsock2.h>
#else
#include <netinet/in.h>
#include <netdb.h>
#ifdef HAVE_ARPA_INET_H
#include <arpa/inet.h>
#endif
#endif

#if defined(PHP_WIN32) || defined(__riscos__)
#undef AF_UNIX
#endif

#if defined(AF_UNIX)
#include <sys/un.h>
#endif

#include "php_fopen_wrappers.h"

#define HTTP_HEADER_BLOCK_SIZE      1024
#define HTTP_HEADER_MAX_LOCATION_SIZE 8182 /* 8192 - 10 (size of "Location: ") */
#define PHP_URL_REDIRECT_MAX      20
#define HTTP_HEADER_USER_AGENT      1
#define HTTP_HEADER_HOST        2
#define HTTP_HEADER_AUTH        4
#define HTTP_HEADER_FROM        8
#define HTTP_HEADER_CONTENT_LENGTH    16
#define HTTP_HEADER_TYPE        32
#define HTTP_HEADER_CONNECTION      64

#define HTTP_WRAPPER_HEADER_INIT    1
#define HTTP_WRAPPER_REDIRECTED     2
#define HTTP_WRAPPER_KEEP_METHOD    4

static inline void strip_header(char *header_bag, char *lc_header_bag,
    const char *lc_header_name)
{
  char *lc_header_start = strstr(lc_header_bag, lc_header_name);
  if (lc_header_start
  && (lc_header_start == lc_header_bag || *(lc_header_start-1) == '\n')
  ) {
    char *header_start = header_bag + (lc_header_start - lc_header_bag);
    char *lc_eol = strchr(lc_header_start, '\n');

    if (lc_eol) {
      char *eol = header_start + (lc_eol - lc_header_start);
      size_t eollen = strlen(lc_eol);

      memmove(lc_header_start, lc_eol+1, eollen);
      memmove(header_start, eol+1, eollen);
    } else {
      *lc_header_start = '\0';
      *header_start = '\0';
    }
  }
}

static bool check_has_header(const char *headers, const char *header) {
  const char *s = headers;
  while ((s = strstr(s, header))) {
    if (s == headers || (*(s-1) == '\n' && *(s-2) == '\r')) {
      return true;
    }
    s++;
  }
  return false;
}

static zend_result php_stream_handle_proxy_authorization_header(const char *s, smart_str *header)
{
  const char *p;

  do {
    while (*s == ' ' || *s == '\t') s++;
    p = s;
    while (*p != 0 && *p != ':' && *p != '\r' && *p !='\n') p++;
    if (*p == ':') {
      p++;
      if (p - s == sizeof("Proxy-Authorization:") - 1 &&
        zend_binary_strcasecmp(s, sizeof("Proxy-Authorization:") - 1,
                     "Proxy-Authorization:", sizeof("Proxy-Authorization:") - 1) == 0) {
        while (*p != 0 && *p != '\r' && *p !='\n') p++;
        smart_str_appendl(header, s, p - s);
        smart_str_appendl(header, "\r\n", sizeof("\r\n")-1);
        return SUCCESS;
      } else {
        while (*p != 0 && *p != '\r' && *p !='\n') p++;
      }
    }
    s = p;
    while (*s == '\r' || *s == '\n') s++;
  } while (*s != 0);

  return FAILURE;
}

typedef struct _php_stream_http_response_header_info {
  php_stream_filter *transfer_encoding;
  size_t file_size;
  bool error;
  bool follow_location;
  char *location;
  size_t location_len;
} php_stream_http_response_header_info;

static void php_stream_http_response_header_info_init(
    php_stream_http_response_header_info *header_info)
{
  memset(header_info, 0, sizeof(php_stream_http_response_header_info));
  header_info->follow_location = true;
}

/* Trim white spaces from response header line and update its length */
static bool php_stream_http_response_header_trim(char *http_header_line,
    size_t *http_header_line_length)
{
  char *http_header_line_end = http_header_line + *http_header_line_length - 1;
  while (http_header_line_end >= http_header_line && 
      (*http_header_line_end == '\n' || *http_header_line_end == '\r')) {
    http_header_line_end--;
  }

  /* The primary definition of an HTTP header in RFC 7230 states:
  * > Each header field consists of a case-insensitive field name followed
  * > by a colon (":"), optional leading whitespace, the field value, and
  * > optional trailing whitespace. */

  /* Strip trailing whitespace */
  bool space_trim = (*http_header_line_end == ' ' || *http_header_line_end == '\t');
  if (space_trim) {
    do {
      http_header_line_end--;
    } while (http_header_line_end >= http_header_line &&
        (*http_header_line_end == ' ' || *http_header_line_end == '\t'));
  }
  http_header_line_end++;
  *http_header_line_end = '\0';
  *http_header_line_length = http_header_line_end - http_header_line;

  return space_trim;
}

/* Process folding headers of the current line and if there are none, parse last full response
 * header line. It returns NULL if the last header is finished, otherwise it returns updated
 * last header line.  */
static zend_string *php_stream_http_response_headers_parse(php_stream_wrapper *wrapper,
    php_stream *stream, php_stream_context *context, int options,
    zend_string *last_header_line, char *header_line, size_t *header_line_length,
    int response_code, zval *response_header,
    php_stream_http_response_header_info *header_info)
{
  /* Process non empty header line. */
  if (header_line && (*header_line != '\n' && *header_line != '\r')) {
    /* Removing trailing white spaces. */
    if (php_stream_http_response_header_trim(header_line, header_line_length) &&
        *header_line_length == 0) {
      /* Only spaces so treat as an empty folding header. */
      return last_header_line;
    }

    /* Process folding headers if starting with a space or a tab. */
    if (header_line && (*header_line == ' ' || *header_line == '\t')) {
      const char *http_folded_header_line = header_line;
      size_t http_folded_header_line_length = *header_line_length;
      /* Remove the leading white spaces. */
      while (*http_folded_header_line == ' ' || *http_folded_header_line == '\t') {
        http_folded_header_line++;
        http_folded_header_line_length--;
      }
      /* It has to have some characters because it would get returned after the call
       * php_stream_http_response_header_trim above. */
      ZEND_ASSERT(http_folded_header_line_length > 0);
      /* Concatenate last header line, space and current header line. */
      zend_string *extended_header_str = zend_string_concat3(
          ZSTR_VAL(last_header_line), ZSTR_LEN(last_header_line),
          " ", 1,
          http_folded_header_line, http_folded_header_line_length);
      zend_string_efree(last_header_line);
      last_header_line = extended_header_str;
      /* Return new header line. */
      return last_header_line;
    }
  }

  /* Find header separator position. */
  char *last_header_value = memchr(ZSTR_VAL(last_header_line), ':', ZSTR_LEN(last_header_line));
  if (last_header_value) {
    /* Verify there is no space in header name */
    const char *last_header_name = ZSTR_VAL(last_header_line) + 1;
    while (last_header_name < last_header_value) {
      if (*last_header_name == ' ' || *last_header_name == '\t') {
        header_info->error = true;
        php_stream_wrapper_log_warn(wrapper, context, options, InvalidResponse,
          "HTTP invalid response format (space in header name)!");
        zend_string_efree(last_header_line);
        return NULL;
      }
      ++last_header_name;
    }

    last_header_value++; /* Skip ':'. */

    /* Strip leading whitespace. */
    const char *last_header_line_end = ZSTR_VAL(last_header_line) + ZSTR_LEN(last_header_line) - 1;
    while (last_header_value < last_header_line_end
        && (*last_header_value == ' ' || *last_header_value == '\t')) {
      last_header_value++;
    }
  } else {
    /* There is no colon which means invalid response so error. */
    header_info->error = true;
    php_stream_wrapper_log_warn(wrapper, context, options, InvalidResponse,
        "HTTP invalid response format (no colon in header line)!");
    zend_string_efree(last_header_line);
    return NULL;
  }

  bool store_header = true;
  zval *tmpzval = NULL;

  if (zend_string_starts_with_literal_ci(last_header_line, "Location:")) {
    /* Check if the location should be followed. */
    if (context && (tmpzval = php_stream_context_get_option(context, "http", "follow_location")) != NULL) {
      header_info->follow_location = zend_is_true(tmpzval);
    } else if (!((response_code >= 300 && response_code < 304)
        || 307 == response_code || 308 == response_code)) {
      /* The redirection should not be automatic if follow_location is not set and
       * response_code not in (300, 301, 302, 303 and 307)
       * see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.1
       * RFC 7238 defines 308: http://tools.ietf.org/html/rfc7238 */
      header_info->follow_location = false;
    }
    size_t last_header_value_len = strlen(last_header_value);
    if (last_header_value_len > HTTP_HEADER_MAX_LOCATION_SIZE) {
      header_info->error = true;
      php_stream_wrapper_log_warn(wrapper, context, options, InvalidResponse,
          "HTTP Location header size is over the limit of %d bytes",
          HTTP_HEADER_MAX_LOCATION_SIZE);
      zend_string_efree(last_header_line);
      return NULL;
    }
    if (header_info->location_len == 0) {
      header_info->location = emalloc(last_header_value_len + 1);
    } else if (header_info->location_len <= last_header_value_len) {
      header_info->location = erealloc(header_info->location, last_header_value_len + 1);
    }
    header_info->location_len = last_header_value_len;
    memcpy(header_info->location, last_header_value, last_header_value_len + 1);
  } else if (zend_string_starts_with_literal_ci(last_header_line, "Content-Type:")) {
    php_stream_notify_info(context, PHP_STREAM_NOTIFY_MIME_TYPE_IS, last_header_value, 0);
  } else if (zend_string_starts_with_literal_ci(last_header_line, "Content-Length:")) {
    /* https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length */
    const char *ptr = last_header_value;
    /* must contain only digits, no + or - symbols */
    if (*ptr >= '0' && *ptr <= '9') {
      char *endptr = NULL;
      size_t parsed = ZEND_STRTOUL(ptr, &endptr, 10);
      /* check whether there was no garbage in the header value and the conversion was successful */
      if (endptr && !*endptr) {
        /* truncate for 32-bit such that no negative file sizes occur */
        header_info->file_size = MIN(parsed, ZEND_LONG_MAX);
        php_stream_notify_file_size(context, header_info->file_size, ZSTR_VAL(last_header_line), 0);
      }
    }
  } else if (
    zend_string_starts_with_literal_ci(last_header_line, "Transfer-Encoding:")
    && !strncasecmp(last_header_value, "Chunked", sizeof("Chunked")-1)
  ) {
    /* Create filter to decode response body. */
    if (!(options & STREAM_ONLY_GET_HEADERS)) {
      bool decode = true;

      if (context && (tmpzval = php_stream_context_get_option(context, "http", "auto_decode")) != NULL) {
        decode = zend_is_true(tmpzval);
      }
      if (decode) {
        if (header_info->transfer_encoding != NULL) {
          /* Prevent a memory leak in case there are more transfer-encoding headers. */
          php_stream_filter_free(header_info->transfer_encoding);
        }
        header_info->transfer_encoding = php_stream_filter_create(
            "dechunk", NULL, php_stream_is_persistent(stream));
        if (header_info->transfer_encoding != NULL) {
          /* Do not store transfer-encoding header. */
          store_header = false;
        }
      }
    }
  }

  if (store_header) {
    zval http_header;
    ZVAL_NEW_STR(&http_header, last_header_line);
    zend_hash_next_index_insert(Z_ARRVAL_P(response_header), &http_header);
  } else {
    zend_string_efree(last_header_line);
  }

  return NULL;
}

static inline void smart_str_append_header_value(smart_str *dest, const zend_string *value, const char *header_name)
{
  const char *src = ZSTR_VAL(value);
  size_t len = ZSTR_LEN(value);
  size_t i = 0;
  while (i < len && src[i] != '\r' && src[i] != '\n') {
    i++;
  }
  if (i < len) {
    smart_str_appendl(dest, src, i);
    php_error_docref(NULL, E_WARNING,
      "Header %s value contains newline characters and has been truncated", header_name);
  } else {
    smart_str_append(dest, value);
  }
}

static php_stream *php_stream_url_wrap_http_ex(php_stream_wrapper *wrapper,
    const char *path, const char *mode, int options, zend_string **opened_path,
    php_stream_context *context, int redirect_max, int flags,
    zval *response_header STREAMS_DC) /* {{{ */
{
  php_stream *stream = NULL;
  php_uri *resource = NULL;
  int use_ssl;
  int use_proxy = 0;
  zend_string *tmp = NULL;
  zend_string *ua_str = NULL;
  zval *ua_zval = NULL, *tmpzval = NULL, ssl_proxy_peer_name;
  int reqok = 0;
  char *http_header_line = NULL;
  zend_string *last_header_line_str = NULL;
  php_stream_http_response_header_info header_info;
  char tmp_line[128];
  size_t chunk_size = 0;
  int eol_detect = 0;
  zend_string *transport_string;
  zend_string *errstr = NULL;
  int have_header = 0;
  bool request_fulluri = false, ignore_errors = false;
  struct timeval timeout;
  char *user_headers = NULL;
  int header_init = ((flags & HTTP_WRAPPER_HEADER_INIT) != 0);
  int redirected = ((flags & HTTP_WRAPPER_REDIRECTED) != 0);
  int redirect_keep_method = ((flags & HTTP_WRAPPER_KEEP_METHOD) != 0);
  int response_code;
  smart_str req_buf = {0};
  bool custom_request_method;

  tmp_line[0] = '\0';

  if (redirect_max < 1) {
    php_stream_wrapper_log_warn(wrapper, context, options, RedirectLimit,
      "Redirection limit reached, aborting");
    return NULL;
  }

  const php_uri_parser *uri_parser = php_stream_context_get_uri_parser("http", context);
  if (uri_parser == NULL) {
    zend_value_error("%s(): Provided stream context has invalid value for the \"uri_parser_class\" option", get_active_function_name());
    return NULL;
  }
  resource = php_uri_parse_to_struct(uri_parser, path, strlen(path), PHP_URI_COMPONENT_READ_MODE_RAW, true);
  if (resource == NULL) {
    return NULL;
  }

  ZEND_ASSERT(resource->scheme);
  if (!zend_string_equals_literal_ci(resource->scheme, "http") &&
    !zend_string_equals_literal_ci(resource->scheme, "https")) {
    if (!context ||
      (tmpzval = php_stream_context_get_option(context, wrapper->wops->label, "proxy")) == NULL ||
      Z_TYPE_P(tmpzval) != IS_STRING ||
      Z_STRLEN_P(tmpzval) == 0) {
      php_uri_struct_free(resource);
      return php_stream_open_wrapper_ex(path, mode, REPORT_ERRORS, NULL, context);
    }
    /* Called from a non-http wrapper with http proxying requested (i.e. ftp) */
    request_fulluri = true;
    use_ssl = 0;
    use_proxy = 1;
    transport_string = zend_string_copy(Z_STR_P(tmpzval));
  } else {
    /* Normal http request (possibly with proxy) */

    if (strpbrk(mode, "awx+")) {
      php_stream_wrapper_log_warn(wrapper, context, options, ModeNotSupported,
        "HTTP wrapper does not support writeable connections");
      php_uri_struct_free(resource);
      return NULL;
    }

    /* Should we send the entire path in the request line, default to no. */
    if (context && (tmpzval = php_stream_context_get_option(context, "http", "request_fulluri")) != NULL) {
      request_fulluri = zend_is_true(tmpzval);
    }

    use_ssl = (ZSTR_LEN(resource->scheme) > 4) && ZSTR_VAL(resource->scheme)[4] == 's';
    /* choose default ports */
    if (use_ssl && resource->port == 0)
      resource->port = 443;
    else if (resource->port == 0)
      resource->port = 80;

    if (context &&
      (tmpzval = php_stream_context_get_option(context, wrapper->wops->label, "proxy")) != NULL &&
      Z_TYPE_P(tmpzval) == IS_STRING &&
      Z_STRLEN_P(tmpzval) > 0) {
      use_proxy = 1;
      transport_string = zend_string_copy(Z_STR_P(tmpzval));
    } else {
      transport_string = zend_strpprintf(0, "%s://%s:" ZEND_LONG_FMT, use_ssl ? "ssl" : "tcp", ZSTR_VAL(resource->host), resource->port);
    }
  }

  if (request_fulluri && (strchr(path, '\n') != NULL || strchr(path, '\r') != NULL)) {
    php_stream_wrapper_log_warn(wrapper, context, options, InvalidUrl,
      "HTTP wrapper full URI path does not allow CR or LF characters");
    php_uri_struct_free(resource);
    zend_string_release(transport_string);
    return NULL;
  }

  if (context && (tmpzval = php_stream_context_get_option(context, wrapper->wops->label, "timeout")) != NULL) {
    double d = zval_get_double(tmpzval);
#ifndef PHP_WIN32
    const double timeoutmax = (double) PHP_TIMEOUT_ULL_MAX / 1000000.0;
#else
    const double timeoutmax = (double) LONG_MAX / 1000000.0;
#endif

    if (d > timeoutmax) {
      php_stream_wrapper_log_warn(wrapper, context, options, InvalidParam,
        "timeout must be lower than " ZEND_ULONG_FMT, (zend_ulong)timeoutmax);
      zend_string_release(transport_string);
      php_uri_struct_free(resource);
      return NULL;
    }
#ifndef PHP_WIN32
    timeout.tv_sec = (time_t) d;
    timeout.tv_usec = (size_t) ((d - timeout.tv_sec) * 1000000);
#else
    timeout.tv_sec = (long) d;
    timeout.tv_usec = (long) ((d - timeout.tv_sec) * 1000000);
#endif
  } else {
#ifndef PHP_WIN32
    timeout.tv_sec = FG(default_socket_timeout);
#else
    timeout.tv_sec = (long)FG(default_socket_timeout);
#endif
    timeout.tv_usec = 0;
  }

  stream = php_stream_xport_create(ZSTR_VAL(transport_string), ZSTR_LEN(transport_string), options,
      STREAM_XPORT_CLIENT | STREAM_XPORT_CONNECT,
      NULL, &timeout, context, &errstr, NULL);

  if (stream) {
    php_stream_set_option(stream, PHP_STREAM_OPTION_READ_TIMEOUT, 0, &timeout);
  }

  if (errstr) {
    php_stream_wrapper_log_warn(wrapper, context, options, ProtocolError,
      "%s", ZSTR_VAL(errstr));
    zend_string_release_ex(errstr, 0);
    errstr = NULL;
  }

  zend_string_release(transport_string);

  if (stream && use_proxy && use_ssl) {
    smart_str header = {0};
    bool reset_ssl_peer_name = false;

    /* Set peer_name or name verification will try to use the proxy server name */
    if (!context || (tmpzval = php_stream_context_get_option(context, "ssl", "peer_name")) == NULL) {
      ZVAL_STR_COPY(&ssl_proxy_peer_name, resource->host);
      php_stream_context_set_option(PHP_STREAM_CONTEXT(stream), "ssl", "peer_name", &ssl_proxy_peer_name);
      zval_ptr_dtor(&ssl_proxy_peer_name);
      reset_ssl_peer_name = true;
    }

    smart_str_appendl(&header, "CONNECT ", sizeof("CONNECT ")-1);
    smart_str_append(&header, resource->host);
    smart_str_appendc(&header, ':');
    smart_str_append_unsigned(&header, resource->port);
    smart_str_appendl(&header, " HTTP/1.0\r\n", sizeof(" HTTP/1.0\r\n")-1);

      /* check if we have Proxy-Authorization header */
    if (context && (tmpzval = php_stream_context_get_option(context, "http", "header")) != NULL) {
      const char *s;

      if (Z_TYPE_P(tmpzval) == IS_ARRAY) {
        zval *tmpheader = NULL;

        ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(tmpzval), tmpheader) {
          if (Z_TYPE_P(tmpheader) == IS_STRING) {
            s = Z_STRVAL_P(tmpheader);
            if (php_stream_handle_proxy_authorization_header(s, &header) == SUCCESS) {
              goto finish;
            }
          }
        } ZEND_HASH_FOREACH_END();
      } else if (Z_TYPE_P(tmpzval) == IS_STRING && Z_STRLEN_P(tmpzval)) {
        s = Z_STRVAL_P(tmpzval);
        if (php_stream_handle_proxy_authorization_header(s, &header) == SUCCESS) {
          goto finish;
        }
      }
    }
finish:
    smart_str_appendl(&header, "\r\n", sizeof("\r\n")-1);

    if (php_stream_write(stream, ZSTR_VAL(header.s), ZSTR_LEN(header.s)) != ZSTR_LEN(header.s)) {
      if (reset_ssl_peer_name) {
        php_stream_context_unset_option(PHP_STREAM_CONTEXT(stream), "ssl", "peer_name");
      }
      php_stream_wrapper_log_warn(wrapper, context, options, ProtocolError,
        "Cannot connect to HTTPS server through proxy");
      php_stream_close(stream);
      stream = NULL;
    }
    smart_str_free(&header);

    if (stream) {
      char header_line[HTTP_HEADER_BLOCK_SIZE];

      /* get response header */
      while (php_stream_gets(stream, header_line, HTTP_HEADER_BLOCK_SIZE-1) != NULL) {
        if (header_line[0] == '\n' ||
            header_line[0] == '\r' ||
            header_line[0] == '\0') {
          break;
        }
      }
    }

    /* enable SSL transport layer */
    if (stream) {
      php_stream_context *old_context = PHP_STREAM_CONTEXT(stream);

      if (php_stream_xport_crypto_setup(stream, STREAM_CRYPTO_METHOD_SSLv23_CLIENT, NULL) < 0 ||
          php_stream_xport_crypto_enable(stream, 1) < 0) {
        php_stream_wrapper_log_warn(wrapper, context, options, SslNotSupported,
          "Cannot connect to HTTPS server through proxy");
        php_stream_close(stream);
        stream = NULL;
      }

      if (reset_ssl_peer_name) {
        php_stream_context_unset_option(old_context, "ssl", "peer_name");
      }
    }
  }

  php_stream_http_response_header_info_init(&header_info);

  if (stream == NULL)
    goto out;

  /* avoid buffering issues while reading header */
  if (options & STREAM_WILL_CAST)
    chunk_size = php_stream_set_chunk_size(stream, 1);

  /* avoid problems with auto-detecting when reading the headers -> the headers
   * are always in canonical \r\n format */
  eol_detect = stream->flags & (PHP_STREAM_FLAG_DETECT_EOL | PHP_STREAM_FLAG_EOL_MAC);
  stream->flags &= ~(PHP_STREAM_FLAG_DETECT_EOL | PHP_STREAM_FLAG_EOL_MAC);

  php_stream_context_set(stream, context);

  php_stream_notify_info(context, PHP_STREAM_NOTIFY_CONNECT, NULL, 0);

  if (header_init && context && (tmpzval = php_stream_context_get_option(context, "http", "max_redirects")) != NULL) {
    redirect_max = (int)zval_get_long(tmpzval);
  }

  custom_request_method = false;
  if (context && (tmpzval = php_stream_context_get_option(context, "http", "method")) != NULL) {
    if (Z_TYPE_P(tmpzval) == IS_STRING && Z_STRLEN_P(tmpzval) > 0) {
      /* As per the RFC, automatically redirected requests MUST NOT use other methods than
       * GET and HEAD unless it can be confirmed by the user. */
      if (!redirected || redirect_keep_method
        || zend_string_equals_literal(Z_STR_P(tmpzval), "GET")
        || zend_string_equals_literal(Z_STR_P(tmpzval), "HEAD")
      ) {
        custom_request_method = true;
        smart_str_append(&req_buf, Z_STR_P(tmpzval));
        smart_str_appendc(&req_buf, ' ');
      }
    }
  }

  if (!custom_request_method) {
    smart_str_appends(&req_buf, "GET ");
  }

  if (request_fulluri) {
    /* Ask for everything */
    smart_str_appends(&req_buf, path);
  } else {
    /* Send the traditional /path/to/file?query_string */

    /* file */
    if (resource->path && ZSTR_LEN(resource->path)) {
      smart_str_append(&req_buf, resource->path);
    } else {
      smart_str_appendc(&req_buf, '/');
    }

    /* query string */
    if (resource->query) {
      smart_str_appendc(&req_buf, '?');
      smart_str_append(&req_buf, resource->query);
    }
  }

  /* protocol version we are speaking */
  if (context && (tmpzval = php_stream_context_get_option(context, "http", "protocol_version")) != NULL) {
    smart_str_appends(&req_buf, " HTTP/");
    smart_str_append_printf(&req_buf, "%.1F", zval_get_double(tmpzval));
    smart_str_appends(&req_buf, "\r\n");
  } else {
    smart_str_appends(&req_buf, " HTTP/1.1\r\n");
  }

  if (context && (tmpzval = php_stream_context_get_option(context, "http", "header")) != NULL) {
    tmp = NULL;

    if (Z_TYPE_P(tmpzval) == IS_ARRAY) {
      zval *tmpheader = NULL;
      smart_str tmpstr = {0};

      ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(tmpzval), tmpheader) {
        if (Z_TYPE_P(tmpheader) == IS_STRING) {
          smart_str_append(&tmpstr, Z_STR_P(tmpheader));
          smart_str_appendl(&tmpstr, "\r\n", sizeof("\r\n") - 1);
        }
      } ZEND_HASH_FOREACH_END();
      smart_str_0(&tmpstr);
      /* Remove newlines and spaces from start and end. there's at least one extra \r\n at the end that needs to go. */
      if (tmpstr.s) {
        tmp = php_trim(tmpstr.s, NULL, 0, 3);
        smart_str_free(&tmpstr);
      }
    } else if (Z_TYPE_P(tmpzval) == IS_STRING && Z_STRLEN_P(tmpzval)) {
      /* Remove newlines and spaces from start and end php_trim will estrndup() */
      tmp = php_trim(Z_STR_P(tmpzval), NULL, 0, 3);
    }
    if (tmp && ZSTR_LEN(tmp)) {
      char *s;
      char *t;

      user_headers = estrndup(ZSTR_VAL(tmp), ZSTR_LEN(tmp));

      if (ZSTR_IS_INTERNED(tmp)) {
        tmp = zend_string_init(ZSTR_VAL(tmp), ZSTR_LEN(tmp), 0);
      } else if (GC_REFCOUNT(tmp) > 1) {
        GC_DELREF(tmp);
        tmp = zend_string_init(ZSTR_VAL(tmp), ZSTR_LEN(tmp), 0);
      }

      /* Make lowercase for easy comparison against 'standard' headers */
      zend_str_tolower(ZSTR_VAL(tmp), ZSTR_LEN(tmp));
      t = ZSTR_VAL(tmp);

      if (!header_init && !redirect_keep_method) {
        /* strip POST headers on redirect */
        strip_header(user_headers, t, "content-length:");
        strip_header(user_headers, t, "content-type:");
      }

      if (check_has_header(t, "user-agent:")) {
        have_header |= HTTP_HEADER_USER_AGENT;
      }
      if (check_has_header(t, "host:")) {
        have_header |= HTTP_HEADER_HOST;
      }
      if (check_has_header(t, "from:")) {
        have_header |= HTTP_HEADER_FROM;
      }
      if (check_has_header(t, "authorization:")) {
        have_header |= HTTP_HEADER_AUTH;
      }
      if (check_has_header(t, "content-length:")) {
        have_header |= HTTP_HEADER_CONTENT_LENGTH;
      }
      if (check_has_header(t, "content-type:")) {
        have_header |= HTTP_HEADER_TYPE;
      }
      if (check_has_header(t, "connection:")) {
        have_header |= HTTP_HEADER_CONNECTION;
      }

      /* remove Proxy-Authorization header */
      if (use_proxy && use_ssl && (s = strstr(t, "proxy-authorization:")) &&
          (s == t || *(s-1) == '\n')) {
        char *p = s + sizeof("proxy-authorization:") - 1;

        while (s > t && (*(s-1) == ' ' || *(s-1) == '\t')) s--;
        while (*p != 0 && *p != '\r' && *p != '\n') p++;
        while (*p == '\r' || *p == '\n') p++;
        if (*p == 0) {
          if (s == t) {
            efree(user_headers);
            user_headers = NULL;
          } else {
            while (s > t && (*(s-1) == '\r' || *(s-1) == '\n')) s--;
            user_headers[s - t] = 0;
          }
        } else {
          memmove(user_headers + (s - t), user_headers + (p - t), strlen(p) + 1);
        }
      }

    }
    if (tmp) {
      zend_string_release_ex(tmp, 0);
    }
  }

  /* auth header if it was specified */
  if (((have_header & HTTP_HEADER_AUTH) == 0) && resource->user) {
    smart_str scratch = {0};

    /* decode the strings first */
    ZSTR_LEN(resource->user) = php_url_decode(ZSTR_VAL(resource->user), ZSTR_LEN(resource->user));

    smart_str_append(&scratch, resource->user);
    smart_str_appendc(&scratch, ':');

    /* Note: password is optional! */
    if (resource->password) {
      ZSTR_LEN(resource->password) = php_url_decode(ZSTR_VAL(resource->password), ZSTR_LEN(resource->password));
      smart_str_append(&scratch, resource->password);
    }

    zend_string *scratch_str = smart_str_extract(&scratch);
    zend_string *stmp = php_base64_encode((unsigned char*)ZSTR_VAL(scratch_str), ZSTR_LEN(scratch_str));

    smart_str_appends(&req_buf, "Authorization: Basic ");
    smart_str_append(&req_buf, stmp);
    smart_str_appends(&req_buf, "\r\n");

    php_stream_notify_info(context, PHP_STREAM_NOTIFY_AUTH_REQUIRED, NULL, 0);

    zend_string_efree(scratch_str);
    zend_string_free(stmp);
  }

  /* if the user has configured who they are, send a From: line */
  if (!(have_header & HTTP_HEADER_FROM) && FG(from_address)) {
    smart_str_appends(&req_buf, "From: ");
    smart_str_append_header_value(&req_buf, FG(from_address), "From");
    smart_str_appends(&req_buf, "\r\n");
  }

  /* Send Host: header so name-based virtual hosts work */
  if ((have_header & HTTP_HEADER_HOST) == 0) {
    smart_str_appends(&req_buf, "Host: ");
    smart_str_append(&req_buf, resource->host);
    if ((use_ssl && resource->port != 443 && resource->port != 0) ||
      (!use_ssl && resource->port != 80 && resource->port != 0)) {
      smart_str_appendc(&req_buf, ':');
      smart_str_append_unsigned(&req_buf, resource->port);
    }
    smart_str_appends(&req_buf, "\r\n");
  }

  /* Send a Connection: close header to avoid hanging when the server
   * interprets the RFC literally and establishes a keep-alive connection,
   * unless the user specifically requests something else by specifying a
   * Connection header in the context options. Send that header even for
   * HTTP/1.0 to avoid issues when the server respond with an HTTP/1.1
   * keep-alive response, which is the preferred response type. */
  if ((have_header & HTTP_HEADER_CONNECTION) == 0) {
    smart_str_appends(&req_buf, "Connection: close\r\n");
  }

  if (context &&
      (ua_zval = php_stream_context_get_option(context, "http", "user_agent")) != NULL &&
    Z_TYPE_P(ua_zval) == IS_STRING) {
    ua_str = Z_STR_P(ua_zval);
  } else if (FG(user_agent)) {
    ua_str = FG(user_agent);
  }

  if (((have_header & HTTP_HEADER_USER_AGENT) == 0) && ua_str && ZSTR_LEN(ua_str)) {
    smart_str_appends(&req_buf, "User-Agent: ");
    smart_str_append_header_value(&req_buf, ua_str, "User-Agent");
    smart_str_appends(&req_buf, "\r\n");
  }

  if (user_headers) {
    /* A bit weird, but some servers require that Content-Length be sent prior to Content-Type for POST
     * see bug #44603 for details. Since Content-Type maybe part of user's headers we need to do this check first.
     */
    if (
        (header_init || redirect_keep_method) &&
        context &&
        !(have_header & HTTP_HEADER_CONTENT_LENGTH) &&
        (tmpzval = php_stream_context_get_option(context, "http", "content")) != NULL &&
        Z_TYPE_P(tmpzval) == IS_STRING && Z_STRLEN_P(tmpzval) > 0
    ) {
      smart_str_appends(&req_buf, "Content-Length: ");
      smart_str_append_unsigned(&req_buf, Z_STRLEN_P(tmpzval));
      smart_str_appends(&req_buf, "\r\n");
      have_header |= HTTP_HEADER_CONTENT_LENGTH;
    }

    smart_str_appends(&req_buf, user_headers);
    smart_str_appends(&req_buf, "\r\n");
    efree(user_headers);
  }

  /* Request content, such as for POST requests */
  if ((header_init || redirect_keep_method) && context &&
    (tmpzval = php_stream_context_get_option(context, "http", "content")) != NULL &&
    Z_TYPE_P(tmpzval) == IS_STRING && Z_STRLEN_P(tmpzval) > 0) {
    if (!(have_header & HTTP_HEADER_CONTENT_LENGTH)) {
      smart_str_appends(&req_buf, "Content-Length: ");
      smart_str_append_unsigned(&req_buf, Z_STRLEN_P(tmpzval));
      smart_str_appends(&req_buf, "\r\n");
    }
    if (!(have_header & HTTP_HEADER_TYPE)) {
      smart_str_appends(&req_buf, "Content-Type: application/x-www-form-urlencoded\r\n");
      php_stream_wrapper_notice(wrapper, context, options, InvalidHeader,
        "Content-type not specified assuming application/x-www-form-urlencoded");
    }
    smart_str_appends(&req_buf, "\r\n");
    smart_str_append(&req_buf, Z_STR_P(tmpzval));
  } else {
    smart_str_appends(&req_buf, "\r\n");
  }

  /* send it */
  php_stream_write(stream, ZSTR_VAL(req_buf.s), ZSTR_LEN(req_buf.s));

  if (Z_ISUNDEF_P(response_header)) {
    array_init(response_header);
  }

  {
    /* get response header */
    size_t tmp_line_len;
    if (!php_stream_eof(stream) &&
      php_stream_get_line(stream, tmp_line, sizeof(tmp_line) - 1, &tmp_line_len) != NULL) {
      zval http_response;

      if (tmp_line_len > 9) {
        response_code = atoi(tmp_line + 9);
      } else {
        response_code = 0;
      }
      if (context && NULL != (tmpzval = php_stream_context_get_option(context, "http", "ignore_errors"))) {
        ignore_errors = zend_is_true(tmpzval);
      }
      /* when we request only the header, don't fail even on error codes */
      if ((options & STREAM_ONLY_GET_HEADERS) || ignore_errors) {
        reqok = 1;
      }

      /* status codes of 1xx are "informational", and will be followed by a real response
       * e.g "100 Continue". RFC 7231 states that unexpected 1xx status MUST be parsed,
       * and MAY be ignored. As such, we need to skip ahead to the "real" status*/
      if (response_code >= 100 && response_code < 200 && response_code != 101) {
        /* consume lines until we find a line starting 'HTTP/1' */
        while (
          !php_stream_eof(stream)
          && php_stream_get_line(stream, tmp_line, sizeof(tmp_line) - 1, &tmp_line_len) != NULL
          && ( tmp_line_len < sizeof("HTTP/1") - 1 || strncasecmp(tmp_line, "HTTP/1", sizeof("HTTP/1") - 1) )
        );

        if (tmp_line_len > 9) {
          response_code = atoi(tmp_line + 9);
        } else {
          response_code = 0;
        }
      }
      /* all status codes in the 2xx range are defined by the specification as successful;
       * all status codes in the 3xx range are for redirection, and so also should never
       * fail */
      if (response_code >= 200 && response_code < 400) {
        reqok = 1;
      } else {
        switch(response_code) {
          case 403:
            php_stream_notify_error(context, PHP_STREAM_NOTIFY_AUTH_RESULT,
                tmp_line, response_code);
            break;
          default:
            /* safety net in the event tmp_line == NULL */
            if (!tmp_line_len) {
              tmp_line[0] = '\0';
            }
            php_stream_notify_error(context, PHP_STREAM_NOTIFY_FAILURE,
                tmp_line, response_code);
        }
      }
      if (tmp_line_len >= 1 && tmp_line[tmp_line_len - 1] == '\n') {
        --tmp_line_len;
        if (tmp_line_len >= 1 &&tmp_line[tmp_line_len - 1] == '\r') {
          --tmp_line_len;
        }
      } else {
        // read and discard rest of status line
        char *line = php_stream_get_line(stream, NULL, 0, NULL);
        efree(line);
      }
      ZVAL_STRINGL(&http_response, tmp_line, tmp_line_len);
      zend_hash_next_index_insert(Z_ARRVAL_P(response_header), &http_response);
    } else {
      php_stream_close(stream);
      stream = NULL;
      php_stream_wrapper_log_warn(wrapper, context, options, ProtocolError,
        "HTTP request failed!");
      goto out;
    }
  }

  /* read past HTTP headers */
  while (!php_stream_eof(stream)) {
    size_t http_header_line_length;

    if (http_header_line != NULL) {
      efree(http_header_line);
    }
    if ((http_header_line = php_stream_get_line(stream, NULL, 0, &http_header_line_length))) {
      bool last_line;
      if (*http_header_line == '\r') {
        if (http_header_line[1] != '\n') {
          php_stream_close(stream);
          stream = NULL;
          php_stream_wrapper_log_warn(wrapper, context, options, InvalidResponse,
              "HTTP invalid header name (cannot start with CR character)!");
          goto out;
        }
        last_line = true;
      } else if (*http_header_line == '\n') {
        last_line = true;
      } else {
        last_line = false;
      }
      
      if (last_header_line_str != NULL) {
        /* Parse last header line. */
        last_header_line_str = php_stream_http_response_headers_parse(wrapper, stream,
            context, options, last_header_line_str, http_header_line,
            &http_header_line_length, response_code, response_header, &header_info);
        if (EXPECTED(last_header_line_str == NULL)) {
          if (UNEXPECTED(header_info.error)) {
            php_stream_close(stream);
            stream = NULL;
            goto out;
          }
        } else {
          /* Folding header present so continue. */
          continue;
        }
      } else if (!last_line) {
        /* The first line cannot start with spaces. */
        if (*http_header_line == ' ' || *http_header_line == '\t') {
          php_stream_close(stream);
          stream = NULL;
          php_stream_wrapper_log_warn(wrapper, context, options, InvalidResponse,
              "HTTP invalid response format (folding header at the start)!");
          goto out;
        }
        /* Trim the first line if it is not the last line. */
        php_stream_http_response_header_trim(http_header_line, &http_header_line_length);
      }
      if (last_line) {
        /* For the last line the last header line must be NULL. */
        ZEND_ASSERT(last_header_line_str == NULL);
        break;
      }
      /* Save current line as the last line so it gets parsed in the next round. */
      last_header_line_str = zend_string_init(http_header_line, http_header_line_length, 0);
    } else {
      break;
    }
  }

  /* If the stream was closed early, we still want to process the last line to keep BC. */
  if (last_header_line_str != NULL) {
    php_stream_http_response_headers_parse(wrapper, stream, context, options,
        last_header_line_str, NULL, NULL, response_code, response_header, &header_info);
  }

  if (!reqok || (header_info.location != NULL && header_info.follow_location)) {
    if (!header_info.follow_location || (((options & STREAM_ONLY_GET_HEADERS) || ignore_errors) && redirect_max <= 1)) {
      goto out;
    }

    if (header_info.location != NULL)
      php_stream_notify_info(context, PHP_STREAM_NOTIFY_REDIRECTED, header_info.location, 0);

    php_stream_close(stream);
    stream = NULL;

    if (header_info.transfer_encoding) {
      php_stream_filter_free(header_info.transfer_encoding);
      header_info.transfer_encoding = NULL;
    }

    if (header_info.location != NULL) {

      char *new_path = NULL;

      if (header_info.location_len < 8 ||
          (strncasecmp(header_info.location, "http://", sizeof("http://")-1) &&
              strncasecmp(header_info.location, "https://", sizeof("https://")-1) &&
              strncasecmp(header_info.location, "ftp://", sizeof("ftp://")-1) &&
              strncasecmp(header_info.location, "ftps://", sizeof("ftps://")-1)))
      {
        char *loc_path = NULL;
        if (*header_info.location != '/') {
          if (header_info.location_len > 1 && resource->path) {
            char *s = strrchr(ZSTR_VAL(resource->path), '/');
            if (!s) {
              s = ZSTR_VAL(resource->path);
              if (!ZSTR_LEN(resource->path)) {
                zend_string_release_ex(resource->path, 0);
                resource->path = ZSTR_INIT_LITERAL("/", 0);
                s = ZSTR_VAL(resource->path);
              } else {
                *s = '/';
              }
            }
            s[1] = '\0';
            if (resource->path &&
              ZSTR_VAL(resource->path)[0] == '/' &&
              ZSTR_VAL(resource->path)[1] == '\0') {
              spprintf(&loc_path, 0, "%s%s", ZSTR_VAL(resource->path), header_info.location);
            } else {
              spprintf(&loc_path, 0, "%s/%s", ZSTR_VAL(resource->path), header_info.location);
            }
          } else {
            spprintf(&loc_path, 0, "/%s", header_info.location);
          }
        } else {
          loc_path = header_info.location;
          header_info.location = NULL;
        }
        if ((use_ssl && resource->port != 443) || (!use_ssl && resource->port != 80)) {
          spprintf(&new_path, 0, "%s://%s:" ZEND_LONG_FMT "%s", ZSTR_VAL(resource->scheme),
              ZSTR_VAL(resource->host), resource->port, loc_path);
        } else {
          spprintf(&new_path, 0, "%s://%s%s", ZSTR_VAL(resource->scheme),
              ZSTR_VAL(resource->host), loc_path);
        }
        efree(loc_path);
      } else {
        new_path = header_info.location;
        header_info.location = NULL;
      }

      php_uri_struct_free(resource);
      /* check for invalid redirection URLs */
      if ((resource = php_uri_parse_to_struct(uri_parser, new_path, strlen(new_path), PHP_URI_COMPONENT_READ_MODE_RAW, true)) == NULL) {
        php_stream_wrapper_log_warn(wrapper, context, options, InvalidUrl,
          "Invalid redirect URL! %s", new_path);
        efree(new_path);
        goto out;
      }

#define CHECK_FOR_CNTRL_CHARS(val) { \
  if (val) { \
    unsigned char *s, *e; \
    ZSTR_LEN(val) = php_url_decode(ZSTR_VAL(val), ZSTR_LEN(val)); \
    s = (unsigned char*)ZSTR_VAL(val); e = s + ZSTR_LEN(val); \
    while (s < e) { \
      if (iscntrl(*s)) { \
        php_stream_wrapper_log_warn(wrapper, context, options, InvalidUrl, \
          "Invalid redirect URL! %s", new_path); \
        efree(new_path); \
        goto out; \
      } \
      s++; \
    } \
  } \
}
      /* check for control characters in login, password & path */
      if (strncasecmp(new_path, "http://", sizeof("http://") - 1) || strncasecmp(new_path, "https://", sizeof("https://") - 1)) {
        CHECK_FOR_CNTRL_CHARS(resource->user);
        CHECK_FOR_CNTRL_CHARS(resource->password);
        CHECK_FOR_CNTRL_CHARS(resource->path);
      }
      int new_flags = HTTP_WRAPPER_REDIRECTED;
      if (response_code == 307 || response_code == 308) {
        /* RFC 7538 specifies that status code 308 does not allow changing the request method from POST to GET.
         * RFC 7231 does the same for status code 307.
         * To keep consistency between POST and PATCH requests, we'll also not change the request method from PATCH to GET, even though it's allowed it's not mandated by the RFC. */
        new_flags |= HTTP_WRAPPER_KEEP_METHOD;
      }
      stream = php_stream_url_wrap_http_ex(
        wrapper, new_path, mode, options, opened_path, context,
        --redirect_max, new_flags, response_header STREAMS_CC);
      efree(new_path);
    } else {
      php_stream_wrapper_log_warn(wrapper, context, options, ProtocolError,
        "HTTP request failed! %s", tmp_line);
    }
  }
out:

  smart_str_free(&req_buf);

  if (http_header_line) {
    efree(http_header_line);
  }

  if (header_info.location != NULL) {
    efree(header_info.location);
  }

  if (resource) {
    php_uri_struct_free(resource);
  }

  if (stream) {
    if (header_init) {
      ZVAL_COPY(&stream->wrapperdata, response_header);
    }
    php_stream_notify_progress_init(context, 0, header_info.file_size);

    /* Restore original chunk size now that we're done with headers */
    if (options & STREAM_WILL_CAST)
      php_stream_set_chunk_size(stream, (int)chunk_size);

    /* restore the users auto-detect-line-endings setting */
    stream->flags |= eol_detect;

    /* as far as streams are concerned, we are now at the start of
     * the stream */
    stream->position = 0;

    /* restore mode */
    strlcpy(stream->mode, mode, sizeof(stream->mode));

    if (header_info.transfer_encoding) {
      php_stream_filter_append(&stream->readfilters, header_info.transfer_encoding);
    }

    /* It's possible that the server already sent in more data than just the headers.
     * We account for this by adjusting the progress counter by the difference of
     * already read header data and the body. */
    if (stream->writepos > stream->readpos) {
      php_stream_notify_progress_increment(context, stream->writepos - stream->readpos, 0);
    }
  }

  return stream;
}
/* }}} */

php_stream *php_stream_url_wrap_http(php_stream_wrapper *wrapper, const char *path, const char *mode, int options, zend_string **opened_path, php_stream_context *context STREAMS_DC) /* {{{ */
{
  php_stream *stream;
  zval headers;

  ZVAL_UNDEF(&headers);

  zval_ptr_dtor(&BG(last_http_headers));
  ZVAL_UNDEF(&BG(last_http_headers));

  stream = php_stream_url_wrap_http_ex(
    wrapper, path, mode, options, opened_path, context,
    PHP_URL_REDIRECT_MAX, HTTP_WRAPPER_HEADER_INIT, &headers STREAMS_CC);

  if (!Z_ISUNDEF(headers)) {
    ZVAL_COPY(&BG(last_http_headers), &headers);

    if (FAILURE == zend_set_local_var_str(
        "http_response_header", sizeof("http_response_header")-1, &headers, 0)) {
      zval_ptr_dtor(&headers);
    }
  }

  return stream;
}
/* }}} */

static int php_stream_http_stream_stat(php_stream_wrapper *wrapper, php_stream *stream, php_stream_statbuf *ssb) /* {{{ */
{
  /* one day, we could fill in the details based on Date: and Content-Length:
   * headers.  For now, we return with a failure code to prevent the underlying
   * file's details from being used instead. */
  return -1;
}
/* }}} */

static const php_stream_wrapper_ops http_stream_wops = {
  php_stream_url_wrap_http,
  NULL, /* stream_close */
  php_stream_http_stream_stat,
  NULL, /* stat_url */
  NULL, /* opendir */
  "http",
  NULL, /* unlink */
  NULL, /* rename */
  NULL, /* mkdir */
  NULL, /* rmdir */
  NULL
};

PHPAPI const php_stream_wrapper php_stream_http_wrapper = {
  &http_stream_wops,
  NULL,
  1 /* is_url */
};

Coverage Report

Created: 2026-09-14 06:25