Skip to content

Fix GH-19044: Protected properties are not scoped according to their prototype #19046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: PHP-8.4
Choose a base branch
from
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
2 changes: 2 additions & 0 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ PHP NEWS
. Fixed bug GH-18907 (Leak when creating cycle in hook). (ilutov)
. Fix OSS-Fuzz #427814456. (nielsdos)
. Fix OSS-Fuzz #428983568 and #428760800. (nielsdos)
. Fixed bug GH-19044 (Protected properties are not scoped according to their
prototype). (Bob)

- Curl:
. Fix memory leaks when returning refcounted value from curl callback.
Expand Down
28 changes: 28 additions & 0 deletions Zend/tests/asymmetric_visibility/gh19044.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype (protected(set) on non-hooked property)
--FILE--
<?php

class P {
public mixed $foo { get => 42; }
}

class C1 extends P {
public protected(set) mixed $foo = 1;
}

class C2 extends P {
public protected(set) mixed $foo;

static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new C1));

?>
--EXPECTF--
Fatal error: Uncaught Error: Cannot modify protected(set) property C1::$foo from scope C2 in %s:%d
Stack trace:
#0 %s(%d): C2::foo(Object(C1))
#1 {main}
thrown in %s on line %d
26 changes: 26 additions & 0 deletions Zend/tests/gh19044.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype
--FILE--
<?php

abstract class P {
protected $foo;
}

class C1 extends P {
protected $foo = 1;
}

class C2 extends P {
protected $foo = 2;

static function foo($c) { return $c->foo; }
}

var_dump(C2::foo(new C2));
var_dump(C2::foo(new C1));

?>
--EXPECT--
int(2)
int(1)
26 changes: 26 additions & 0 deletions Zend/tests/property_hooks/gh19044-1.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype (common ancestor has a protected setter)
--FILE--
<?php

abstract class P {
abstract public mixed $foo { get; }
}

class C1 extends P {
public protected(set) mixed $foo { get => 1; set {} }
}

class GrandC1 extends C1 {
Copy link
Member

Choose a reason for hiding this comment

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

This naming is quite confusing. It's the child of C1, grand implies grand-child or grand-parent.

Copy link
Member Author

Choose a reason for hiding this comment

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

C1 = Child 1, hence GrandC1 :-D (Just like GrandP in some other test)

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure how exactly to rename them, but feel free to just push to my branch for that.

public protected(set) mixed $foo { get => 2; set {} }
}

class C2 extends C1 {
static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new GrandC1));

?>
--EXPECT--
int(3)
30 changes: 30 additions & 0 deletions Zend/tests/property_hooks/gh19044-2.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype (common ancestor does not have a setter)
--FILE--
<?php

abstract class P {
abstract public mixed $foo { get; }
}

class C1 extends P {
public mixed $foo { get => 1; }
}

class GrandC1 extends C1 {
public protected(set) mixed $foo { get => 2; set {} }
}

class C2 extends C1 {
static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new GrandC1));

?>
--EXPECTF--
Fatal error: Uncaught Error: Cannot modify protected(set) property GrandC1::$foo from scope C2 in %s:%d
Stack trace:
#0 %s(%d): C2::foo(Object(GrandC1))
#1 {main}
thrown in %s on line %d
24 changes: 24 additions & 0 deletions Zend/tests/property_hooks/gh19044-3.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype (abstract parent defining visibility only takes precedence)
--FILE--
<?php

abstract class P {
abstract protected(set) mixed $foo { get; set; }
}

class C1 extends P {
public protected(set) mixed $foo { get => 2; set {} }
}

class C2 extends P {
public mixed $foo = 1;

static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new C1));

?>
--EXPECT--
int(3)
28 changes: 28 additions & 0 deletions Zend/tests/property_hooks/gh19044-4.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype (abstract parent sets protected(set) with not having grandparent a setter - both inherit from parent)
--FILE--
<?php

abstract class GP {
abstract mixed $foo { get; }
}

abstract class P extends GP {
abstract protected(set) mixed $foo { get; set; }
}

class C1 extends P {
public protected(set) mixed $foo { get => 2; set {} }
}

class C2 extends P {
public mixed $foo = 1;

static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new C1));

?>
--EXPECT--
int(3)
32 changes: 32 additions & 0 deletions Zend/tests/property_hooks/gh19044-5.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype (abstract parent sets protected(set) with not having grandparent a setter - one inherits from grandparent)
--FILE--
<?php

abstract class GP {
abstract mixed $foo { get; }
}

abstract class P extends GP {
abstract protected(set) mixed $foo { get; set; }
}

class C1 extends P {
public protected(set) mixed $foo { get => 2; set {} }
}

class C2 extends GP {
public mixed $foo = 1;

static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new C1));

?>
--EXPECTF--
Fatal error: Uncaught Error: Cannot modify protected(set) property C1::$foo from scope C2 in %s:%d
Stack trace:
#0 %s(%d): C2::foo(Object(C1))
#1 {main}
thrown in %s on line %d
28 changes: 28 additions & 0 deletions Zend/tests/property_hooks/gh19044-6.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype (abstract parent has implicit set hook)
--FILE--
<?php

abstract class GP {
public abstract mixed $foo { get; }
}

class P extends GP {
public protected(set) mixed $foo { get => $this->foo; }
}

class C1 extends P {
public protected(set) mixed $foo = 1;
}

class C2 extends P {
public protected(set) mixed $foo;

static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new C1));

?>
--EXPECT--
int(2)
26 changes: 26 additions & 0 deletions Zend/tests/property_hooks/gh19044.phpt
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
--TEST--
GH-19044: Protected properties must be scoped according to their prototype (hooks variation)
--FILE--
<?php

abstract class P {
abstract protected $foo { get; }
}

class C1 extends P {
protected $foo = 1;
}

class C2 extends P {
protected $foo = 2;

static function foo($c) { return $c->foo; }
}

var_dump(C2::foo(new C2));
var_dump(C2::foo(new C1));

?>
--EXPECT--
int(2)
int(1)
34 changes: 29 additions & 5 deletions Zend/zend_object_handlers.c
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,31 @@ static zend_always_inline bool is_derived_class(const zend_class_entry *child_cl
static zend_never_inline int is_protected_compatible_scope(const zend_class_entry *ce, const zend_class_entry *scope) /* {{{ */
{
return scope &&
(is_derived_class(ce, scope) || is_derived_class(scope, ce));
(ce == scope || is_derived_class(ce, scope) || is_derived_class(scope, ce));
}
/* }}} */

static int is_asymmetric_set_protected_property_compatible_scope(const zend_property_info *info, const zend_class_entry *scope) /* {{{ */
{
zend_class_entry *ce;
/* we need to identify the common protected(set) ancestor: if the prototype has the protected(set), it's straightforward */
if (info->prototype->flags & ZEND_ACC_PROTECTED_SET) {
ce = info->prototype->ce;
} else if (info->hooks && info->hooks[ZEND_PROPERTY_HOOK_SET]) {
Copy link
Member

@iluuu1994 iluuu1994 Jul 6, 2025

Choose a reason for hiding this comment

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

I believe this is wrong still. The setprototype may not necessarily link to the first writable property in the chain.

<?php

abstract class GP {
    public abstract mixed $foo { get; }
}

class P extends GP {
    public protected(set) mixed $foo;
}

class C1 extends P {
    public protected(set) mixed $foo = 1 { set { parent::$foo::set($value); } }
}

class C2 extends P {
    public protected(set) mixed $foo;

    static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new C1));

// Fatal error: Uncaught Error: Cannot modify protected(set) property C1::$foo from scope C2 in %s:%d

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh, I assumed that you cannot put a setter in a child when the parent is a bare property for some reason, well, yeah, then let's just remove that branch.

/* shortcut: the visibility of hooks cannot be overwritten */
zend_function *hook = info->hooks[ZEND_PROPERTY_HOOK_SET];
ce = zend_get_function_root_class(hook);
} else {
/* we do not have an easy way to find the ancestor which introduces the protected(set), let's iterate */
do {
ce = info->ce;
if (!ce->parent->properties_info_table) {
break;
}
info = ce->parent->properties_info_table[OBJ_PROP_TO_NUM(info->offset)];
Copy link
Member

Choose a reason for hiding this comment

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

It's not safe to index into ce->parent->properties_info_table with info->offset. The child may have a higher index since #17870.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, it's not safe, but that led to #19053.

Copy link
Member Author

Choose a reason for hiding this comment

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

So yeah, the only way to iterate is then the very expensive hashtable lookup? At that point I think maybe we should simply admit defeat and go by the prototype only...

} while (info->flags & ZEND_ACC_PROTECTED_SET);
Copy link
Member

@iluuu1994 iluuu1994 Jul 6, 2025

Choose a reason for hiding this comment

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

Shouldn't we stop this loop before setting info? I.e. we want to select the last property that still sets the protected(set) flag, rather than the first that does not. See:

<?php

abstract class GP {
    public abstract mixed $foo { get; }
    public $dummy;
}

class P1 extends GP {
    public protected(set) mixed $foo;
}

class P2 extends GP {
    public protected(set) mixed $foo;
}

class C1 extends P1 {
    public protected(set) mixed $foo = 1;
}

class C2 extends P2 {
    public protected(set) mixed $foo;

    static function foo($c) { return $c->foo += 1; }
}

var_dump(C2::foo(new C1));

This crashes due to out-of-bounds first due to the error above, but I believe after fixing that this would mistakenly allow the assignment.

}
return is_protected_compatible_scope(ce, scope);
}
/* }}} */

Expand Down Expand Up @@ -419,7 +443,7 @@ static zend_always_inline uintptr_t zend_get_property_offset(zend_class_entry *c
}
} else {
ZEND_ASSERT(flags & ZEND_ACC_PROTECTED);
if (UNEXPECTED(!is_protected_compatible_scope(property_info->ce, scope))) {
if (UNEXPECTED(!is_protected_compatible_scope(property_info->prototype->ce, scope))) {
goto wrong;
}
}
Expand Down Expand Up @@ -514,7 +538,7 @@ ZEND_API zend_property_info *zend_get_property_info(const zend_class_entry *ce,
}
} else {
ZEND_ASSERT(flags & ZEND_ACC_PROTECTED);
if (UNEXPECTED(!is_protected_compatible_scope(property_info->ce, scope))) {
if (UNEXPECTED(!is_protected_compatible_scope(property_info->prototype->ce, scope))) {
goto wrong;
}
}
Expand Down Expand Up @@ -585,7 +609,7 @@ ZEND_API bool ZEND_FASTCALL zend_asymmetric_property_has_set_access(const zend_p
return true;
}
return EXPECTED((prop_info->flags & ZEND_ACC_PROTECTED_SET)
&& is_protected_compatible_scope(prop_info->ce, scope));
&& is_asymmetric_set_protected_property_compatible_scope(prop_info, scope));
}

static void zend_property_guard_dtor(zval *el) /* {{{ */ {
Expand Down Expand Up @@ -2030,7 +2054,7 @@ ZEND_API zval *zend_std_get_static_property_with_info(zend_class_entry *ce, zend
zend_class_entry *scope = get_fake_or_executed_scope();
if (property_info->ce != scope) {
if (UNEXPECTED(property_info->flags & ZEND_ACC_PRIVATE)
|| UNEXPECTED(!is_protected_compatible_scope(property_info->ce, scope))) {
|| UNEXPECTED(!is_protected_compatible_scope(property_info->prototype->ce, scope))) {
if (type != BP_VAR_IS) {
zend_bad_property_access(property_info, ce, property_name);
}
Expand Down