Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions Zend/tests/display_error_function_args.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
--TEST--
Displaying function arguments in errors
--INI--
error_include_args=On
--FILE--
<?php

// A function that sets its own parameters in docref call, to compare
unlink('/');

// Something with sensitive parameters that exists in a minimal build,
// and also doesn't set anything in the docref call. cost is set to 4
// to keep the test fast
$flags = ["salt" => "123456789012345678901" . chr(0), "cost" => 4];
password_hash("test", PASSWORD_BCRYPT, $flags);

ini_set("error_include_args", "Off");

unlink('/');
password_hash("test", PASSWORD_BCRYPT, $flags);

?>
--EXPECTF--
Warning: unlink('/'): %s in %s on line %d

Warning: password_hash(Object(SensitiveParameterValue), '2y', Array): The "salt" option has been ignored, since providing a custom salt is no longer supported in %s on line %d

Warning: unlink(/): %s in %s on line %d

Warning: password_hash(): The "salt" option has been ignored, since providing a custom salt is no longer supported in %s on line %d
78 changes: 59 additions & 19 deletions Zend/zend_exceptions.c
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,31 @@ static void _build_trace_args(zval *arg, smart_str *str) /* {{{ */
}
/* }}} */

static void _build_trace_args_list(zval *tmp, smart_str *str) /* {{{ */
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
static void _build_trace_args_list(zval *tmp, smart_str *str) /* {{{ */
static void build_trace_args_list(zval *tmp, smart_str *str) /* {{{ */

Identifiers starting with an underscore are reserved. The static is sufficient to make the function private.

{
if (EXPECTED(Z_TYPE_P(tmp) == IS_ARRAY)) {
size_t last_len = ZSTR_LEN(str->s);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know you just moved the code, but this should be smart_str_get_len() (which safely handles the case where no allocation has been made yet (which might be the reason you got the ASAN issues?).

A simpler solution might also be to append the , within the loop and just have a boolean value “first” or “not first”. This avoids manually touching the length of the backing string of the smart_str.

zend_string *name;
zval *arg;

ZEND_HASH_FOREACH_STR_KEY_VAL(Z_ARRVAL_P(tmp), name, arg) {
if (name) {
smart_str_append(str, name);
smart_str_appends(str, ": ");
}
_build_trace_args(arg, str);
} ZEND_HASH_FOREACH_END();

if (last_len != ZSTR_LEN(str->s)) {
ZSTR_LEN(str->s) -= 2; /* remove last ', ' */
}
} else {
/* only happens w/ reflection abuse (Zend/tests/bug63762.phpt) */
zend_error(E_WARNING, "args element is not an array");
}
}
/* }}} */

static void _build_trace_string(smart_str *str, const HashTable *ht, uint32_t num) /* {{{ */
{
zval *file, *tmp;
Expand Down Expand Up @@ -588,30 +613,45 @@ static void _build_trace_string(smart_str *str, const HashTable *ht, uint32_t nu
smart_str_appendc(str, '(');
tmp = zend_hash_find_known_hash(ht, ZSTR_KNOWN(ZEND_STR_ARGS));
if (tmp) {
if (EXPECTED(Z_TYPE_P(tmp) == IS_ARRAY)) {
size_t last_len = ZSTR_LEN(str->s);
zend_string *name;
zval *arg;

ZEND_HASH_FOREACH_STR_KEY_VAL(Z_ARRVAL_P(tmp), name, arg) {
if (name) {
smart_str_append(str, name);
smart_str_appends(str, ": ");
}
_build_trace_args(arg, str);
} ZEND_HASH_FOREACH_END();

if (last_len != ZSTR_LEN(str->s)) {
ZSTR_LEN(str->s) -= 2; /* remove last ', ' */
}
} else {
zend_error(E_WARNING, "args element is not an array");
}
_build_trace_args_list(tmp, str);
}
smart_str_appends(str, ")\n");
}
/* }}} */

/* {{{ Gets the function arguments printed as a string from a backtrace frame. */
ZEND_API zend_string *zend_trace_function_args_to_string(const HashTable *frame) {
smart_str str = {0};
smart_str_appends(&str, "");
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does nothing (useful):

Suggested change
smart_str_appends(&str, "");


zval *tmp = zend_hash_find_known_hash(frame, ZSTR_KNOWN(ZEND_STR_ARGS));
if (tmp) {
_build_trace_args_list(tmp, &str);
}

return smart_str_extract(&str);
}
/* }}} */

/* {{{ Gets the currently executing function's arguments as a string. Used by php_verror. */
ZEND_API zend_string *zend_trace_current_function_args_string(void) {
zend_string *dynamic_params = NULL;
/* get a backtrace to snarf function args */
zval backtrace;
zend_fetch_debug_backtrace(&backtrace, /* skip_last */ 0, /* options */ 0, /* limit */ 1);
/* can fail esp if low memory condition */
if (Z_TYPE(backtrace) != IS_ARRAY) {
return NULL;
}
zval *first_frame = zend_hash_index_find(Z_ARRVAL(backtrace), 0);
if (first_frame) {
dynamic_params = zend_trace_function_args_to_string(Z_ARRVAL_P(first_frame));
}
Comment on lines +643 to +649
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With the return NULL; for “not an array” you are leaking memory if a non-array refcounted value is returned (for whatever reason). I suggest:

Suggested change
if (Z_TYPE(backtrace) != IS_ARRAY) {
return NULL;
}
zval *first_frame = zend_hash_index_find(Z_ARRVAL(backtrace), 0);
if (first_frame) {
dynamic_params = zend_trace_function_args_to_string(Z_ARRVAL_P(first_frame));
}
if (Z_TYPE(backtrace) == IS_ARRAY) {
zval *first_frame = zend_hash_index_find(Z_ARRVAL(backtrace), 0);
if (first_frame) {
dynamic_params = zend_trace_function_args_to_string(Z_ARRVAL_P(first_frame));
}
}

Since dynamic_params is initialized to NULL this should just work.

zval_ptr_dtor(&backtrace);
return dynamic_params;
}
/* }}} */

ZEND_API zend_string *zend_trace_to_string(const HashTable *trace, bool include_main) {
zend_ulong index;
zval *frame;
Expand Down
2 changes: 2 additions & 0 deletions Zend/zend_exceptions.h
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,8 @@ ZEND_API zend_result zend_update_exception_properties(zend_execute_data *execute
/* show an exception using zend_error(severity,...), severity should be E_ERROR */
ZEND_API ZEND_COLD zend_result zend_exception_error(zend_object *exception, int severity);
ZEND_NORETURN void zend_exception_uncaught_error(const char *prefix, ...) ZEND_ATTRIBUTE_FORMAT(printf, 1, 2);
ZEND_API zend_string *zend_trace_function_args_to_string(const HashTable *frame);
ZEND_API zend_string *zend_trace_current_function_args_string(void);
ZEND_API zend_string *zend_trace_to_string(const HashTable *trace, bool include_main);

ZEND_API ZEND_COLD zend_object *zend_create_unwind_exit(void);
Expand Down
3 changes: 2 additions & 1 deletion ext/openssl/tests/ServerClientTestCase.inc
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,8 @@ class ServerClientTestCase
$ini = php_ini_loaded_file();
$cmd = sprintf(
'%s %s "%s" %s',
PHP_BINARY, $ini ? "-n -c $ini" : "",
// XXX: TEST_PHP_EXTRA_ARGS for run-test values won't work here?
PHP_BINARY, $ini ? "-n -c $ini -d error_include_args=0" : "",
__FILE__,
WORKER_ARGV_VALUE
);
Expand Down
11 changes: 10 additions & 1 deletion main/main.c
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
#include "win32/php_registry.h"
#include "ext/standard/flock_compat.h"
#endif
#include "Zend/zend_builtin_functions.h"
#include "Zend/zend_exceptions.h"

#if PHP_SIGCHILD
Expand Down Expand Up @@ -801,6 +802,7 @@ PHP_INI_BEGIN()
STD_PHP_INI_ENTRY_EX("display_errors", "1", PHP_INI_ALL, OnUpdateDisplayErrors, display_errors, php_core_globals, core_globals, display_errors_mode)
STD_PHP_INI_BOOLEAN("display_startup_errors", "1", PHP_INI_ALL, OnUpdateBool, display_startup_errors, php_core_globals, core_globals)
STD_PHP_INI_BOOLEAN("enable_dl", "1", PHP_INI_SYSTEM, OnUpdateBool, enable_dl, php_core_globals, core_globals)
STD_PHP_INI_BOOLEAN("error_include_args", "0", PHP_INI_ALL, OnUpdateBool, error_include_args, php_core_globals, core_globals)
STD_PHP_INI_BOOLEAN("expose_php", "1", PHP_INI_SYSTEM, OnUpdateBool, expose_php, php_core_globals, core_globals)
STD_PHP_INI_ENTRY("docref_root", "", PHP_INI_ALL, OnUpdateString, docref_root, php_core_globals, core_globals)
STD_PHP_INI_ENTRY("docref_ext", "", PHP_INI_ALL, OnUpdateString, docref_ext, php_core_globals, core_globals)
Expand Down Expand Up @@ -1132,7 +1134,14 @@ PHPAPI ZEND_COLD void php_verror(const char *docref, const char *params, int typ

/* if we still have memory then format the origin */
if (is_function) {
origin_len = spprintf(&origin, 0, "%s%s%s(%s)", class_name, space, function, params);
zend_string *dynamic_params = NULL;
if (PG(error_include_args)) {
dynamic_params = zend_trace_current_function_args_string();
}
origin_len = spprintf(&origin, 0, "%s%s%s(%s)", class_name, space, function, dynamic_params ? ZSTR_VAL(dynamic_params) : params);
if (dynamic_params) {
zend_string_release(dynamic_params);
}
} else {
origin_len = strlen(function);
origin = estrndup(function, origin_len);
Expand Down
1 change: 1 addition & 0 deletions main/php_globals.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ struct _php_core_globals {

uint8_t display_errors;
bool display_startup_errors;
bool error_include_args;
bool log_errors;
bool ignore_repeated_errors;
bool ignore_repeated_source;
Expand Down
6 changes: 6 additions & 0 deletions php.ini-development
Original file line number Diff line number Diff line change
Expand Up @@ -611,6 +611,12 @@ ignore_repeated_source = Off
; Production Value: On
;fatal_error_backtraces = On

; This directive controls whether PHP will print the actual arguments of a
; function upon an error. If this is off (or there was an error fetching the
; arguments), the function providing the error may optionally provide some
; additional information after the problem function's name.
;error_include_args = Off

;;;;;;;;;;;;;;;;;
; Data Handling ;
;;;;;;;;;;;;;;;;;
Expand Down
6 changes: 6 additions & 0 deletions php.ini-production
Original file line number Diff line number Diff line change
Expand Up @@ -613,6 +613,12 @@ ignore_repeated_source = Off
; Production Value: On
;fatal_error_backtraces = On

; This directive controls whether PHP will print the actual arguments of a
; function upon an error. If this is off (or there was an error fetching the
; arguments), the function providing the error may optionally provide some
; additional information after the problem function's name.
;error_include_args = Off

;;;;;;;;;;;;;;;;;
; Data Handling ;
;;;;;;;;;;;;;;;;;
Expand Down
1 change: 1 addition & 0 deletions run-tests.php
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,7 @@ function main(): void
'fatal_error_backtraces=Off',
'display_errors=1',
'display_startup_errors=1',
'error_include_args=0',
'log_errors=0',
'html_errors=0',
'track_errors=0',
Expand Down
3 changes: 2 additions & 1 deletion sapi/cli/tests/php_cli_server.inc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ function php_cli_server_start(
file_put_contents($doc_root . '/' . ($router ?: 'index.php'), '<?php ' . $code . ' ?>');
}

$cmd = [$php_executable, '-t', $doc_root, '-n', ...$cmd_args, '-S', 'localhost:0'];
// XXX: This should ideally use the same INI overrides as run-tests
$cmd = [$php_executable, '-d', 'error_include_args=0', '-t', $doc_root, '-n', ...$cmd_args, '-S', 'localhost:0'];
if (!is_null($router)) {
$cmd[] = $router;
}
Expand Down
Loading