From 5f7bb1a3ce346fa890f07a910a500875840a6fda Mon Sep 17 00:00:00 2001 From: lazerg Date: Mon, 16 Nov 2026 19:23:44 +0500 Subject: [PATCH 1/2] Fix GH-25487: sodium_memzero() sets a typed property to null without TypeError --- ext/sodium/libsodium.c | 18 +++++++++----- ext/sodium/tests/gh25487.phpt | 45 +++++++++++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 6 deletions(-) create mode 100644 ext/sodium/tests/gh25487.phpt diff --git a/ext/sodium/libsodium.c b/ext/sodium/libsodium.c index 7c80de9cbf16..ce1592a5da98 100644 --- a/ext/sodium/libsodium.c +++ b/ext/sodium/libsodium.c @@ -191,14 +191,15 @@ PHP_MINFO_FUNCTION(sodium) PHP_FUNCTION(sodium_memzero) { + zval *buf_ref; zval *buf_zv; if (zend_parse_parameters(ZEND_NUM_ARGS(), - "z", &buf_zv) == FAILURE) { + "z", &buf_ref) == FAILURE) { sodium_remove_param_values_from_backtrace(EG(exception)); RETURN_THROWS(); } - ZVAL_DEREF(buf_zv); + buf_zv = Z_REFVAL_P(buf_ref); if (Z_TYPE_P(buf_zv) != IS_STRING) { zend_throw_exception(sodium_exception_ce, "a PHP string is required", 0); RETURN_THROWS(); @@ -210,7 +211,7 @@ PHP_FUNCTION(sodium_memzero) sodium_memzero(buf, (size_t) buf_len); } } - convert_to_null(buf_zv); + ZEND_TRY_ASSIGN_REF_NULL(buf_ref); } PHP_FUNCTION(sodium_increment) @@ -521,17 +522,18 @@ PHP_FUNCTION(sodium_crypto_generichash_final) { crypto_generichash_state state_tmp; zend_string *hash; + zval *state_ref; zval *state_zv; unsigned char *state; size_t state_len; zend_long hash_len = crypto_generichash_BYTES; if (zend_parse_parameters(ZEND_NUM_ARGS(), "z|l", - &state_zv, &hash_len) == FAILURE) { + &state_ref, &hash_len) == FAILURE) { sodium_remove_param_values_from_backtrace(EG(exception)); RETURN_THROWS(); } - ZVAL_DEREF(state_zv); + state_zv = Z_REFVAL_P(state_ref); if (Z_TYPE_P(state_zv) != IS_STRING) { zend_argument_error(sodium_exception_ce, 1, "must be a reference to a state"); RETURN_THROWS(); @@ -560,7 +562,11 @@ PHP_FUNCTION(sodium_crypto_generichash_final) } sodium_memzero(&state_tmp, sizeof state_tmp); sodium_memzero(state, state_len); - convert_to_null(state_zv); + ZEND_TRY_ASSIGN_REF_NULL(state_ref); + if (UNEXPECTED(EG(exception))) { + zend_string_efree(hash); + RETURN_THROWS(); + } ZSTR_VAL(hash)[hash_len] = 0; RETURN_NEW_STR(hash); diff --git a/ext/sodium/tests/gh25487.phpt b/ext/sodium/tests/gh25487.phpt new file mode 100644 index 000000000000..89813f7f59ac --- /dev/null +++ b/ext/sodium/tests/gh25487.phpt @@ -0,0 +1,45 @@ +--TEST-- +GH-25487 (sodium_memzero() sets a typed property to null without a TypeError) +--CREDITS-- +lacatoire +--EXTENSIONS-- +sodium +--FILE-- +s); +} catch (TypeError $e) { + echo $e->getMessage(), "\n"; +} +var_dump($a->s); + +$a->state = sodium_crypto_generichash_init(); +try { + sodium_crypto_generichash_final($a->state); +} catch (TypeError $e) { + echo $e->getMessage(), "\n"; +} +var_dump(strlen($a->state)); + +sodium_memzero($a->nullable); +var_dump($a->nullable); + +$a->nullable = sodium_crypto_generichash_init(); +var_dump(strlen(sodium_crypto_generichash_final($a->nullable))); +var_dump($a->nullable); +?> +--EXPECT-- +Cannot assign null to reference held by property A::$s of type string +string(6) "secret" +Cannot assign null to reference held by property A::$state of type string +int(384) +NULL +int(32) +NULL From 2c74e393a8e3ab6f4274afda5f1eb608e392898e Mon Sep 17 00:00:00 2001 From: lazerg Date: Tue, 17 Nov 2026 06:44:38 +0500 Subject: [PATCH 2/2] Fill non-nullable typed properties with NUL bytes instead of throwing --- ext/sodium/libsodium.c | 29 +++++++++++++++++++++++------ ext/sodium/tests/gh25487.phpt | 28 ++++++++++++---------------- 2 files changed, 35 insertions(+), 22 deletions(-) diff --git a/ext/sodium/libsodium.c b/ext/sodium/libsodium.c index ce1592a5da98..a0e5b8b43ad2 100644 --- a/ext/sodium/libsodium.c +++ b/ext/sodium/libsodium.c @@ -154,6 +154,27 @@ static void sodium_separate_string(zval *zv) { } } +/* Sets an already zeroed string reference to null. A typed property that does + * not accept null keeps a string of NUL bytes with the same length instead. */ +static void sodium_clear_string_ref(zval *ref) { + zval *zv = Z_REFVAL_P(ref); + zend_property_info *prop; + + ZEND_ASSERT(Z_TYPE_P(zv) == IS_STRING); + ZEND_REF_FOREACH_TYPE_SOURCES(Z_REF_P(ref), prop) { + if (!ZEND_TYPE_ALLOW_NULL(prop->type)) { + if (!Z_REFCOUNTED_P(zv) || Z_REFCOUNT_P(zv) > 1) { + zend_string *zeroed = zend_string_alloc(Z_STRLEN_P(zv), 0); + memset(ZSTR_VAL(zeroed), 0, ZSTR_LEN(zeroed) + 1); + Z_TRY_DELREF_P(zv); + ZVAL_NEW_STR(zv, zeroed); + } + return; + } + } ZEND_REF_FOREACH_TYPE_SOURCES_END(); + convert_to_null(zv); +} + PHP_MINIT_FUNCTION(sodium) { if (sodium_init() < 0) { @@ -211,7 +232,7 @@ PHP_FUNCTION(sodium_memzero) sodium_memzero(buf, (size_t) buf_len); } } - ZEND_TRY_ASSIGN_REF_NULL(buf_ref); + sodium_clear_string_ref(buf_ref); } PHP_FUNCTION(sodium_increment) @@ -562,11 +583,7 @@ PHP_FUNCTION(sodium_crypto_generichash_final) } sodium_memzero(&state_tmp, sizeof state_tmp); sodium_memzero(state, state_len); - ZEND_TRY_ASSIGN_REF_NULL(state_ref); - if (UNEXPECTED(EG(exception))) { - zend_string_efree(hash); - RETURN_THROWS(); - } + sodium_clear_string_ref(state_ref); ZSTR_VAL(hash)[hash_len] = 0; RETURN_NEW_STR(hash); diff --git a/ext/sodium/tests/gh25487.phpt b/ext/sodium/tests/gh25487.phpt index 89813f7f59ac..556e8bb714ef 100644 --- a/ext/sodium/tests/gh25487.phpt +++ b/ext/sodium/tests/gh25487.phpt @@ -13,20 +13,16 @@ class A { } $a = new A; -try { - sodium_memzero($a->s); -} catch (TypeError $e) { - echo $e->getMessage(), "\n"; -} -var_dump($a->s); +sodium_memzero($a->s); +var_dump(bin2hex($a->s)); + +$a->s = str_repeat('x', 4); +sodium_memzero($a->s); +var_dump(bin2hex($a->s)); $a->state = sodium_crypto_generichash_init(); -try { - sodium_crypto_generichash_final($a->state); -} catch (TypeError $e) { - echo $e->getMessage(), "\n"; -} -var_dump(strlen($a->state)); +var_dump(strlen(sodium_crypto_generichash_final($a->state))); +var_dump($a->state === str_repeat("\0", 384)); sodium_memzero($a->nullable); var_dump($a->nullable); @@ -36,10 +32,10 @@ var_dump(strlen(sodium_crypto_generichash_final($a->nullable))); var_dump($a->nullable); ?> --EXPECT-- -Cannot assign null to reference held by property A::$s of type string -string(6) "secret" -Cannot assign null to reference held by property A::$state of type string -int(384) +string(12) "000000000000" +string(8) "00000000" +int(32) +bool(true) NULL int(32) NULL