Make WordPress Core

Opened 20 months ago

Last modified 3 weeks ago

#57304 new enhancement

Add SensitiveParameter attribute to DB connection and login variables

Reported by: tobiasbg's profile TobiasBg Owned by:
Milestone: 6.7 Priority: normal
Severity: normal Version:
Component: Security Keywords: php82 has-patch
Focuses: Cc:


PHP 8.2 introduces a SensitiveParameter attribute that can "mark a parameter that is sensitive and should have its value redacted if present in a stack trace."

WordPress deals with user passwords, database login credentials, etc. To protect these from appearing in logs or stack traces (which sometimes get copied into bug reports in forum threads and similar), using the #[\SensitiveParameter] attribute for such variables should be explored.

As that attribute starts with a #, which indicates a comment, it's safe to use this with older versions of PHP as well (similar to the #[\AllowDynamicProperties] attribute that is already used in Core).

Change History (11)

#1 @jrf
20 months ago

I fully support this proposal.

Note for the implementation: the attribute can only be added to individual parameters in function declarations, so can not be applied to global or function local variables.

Related RFC:

Side-note: we may need to verify that existing tooling, like the documentation generation tooling and WordPressCS, are able to deal with attributes for function parameters in function declarations. If not, those will need to be updated.

#2 @desrosj
18 months ago

Thanks for this one @TobiasBg! I also support this change. Would you be able to create a first pass PR for this?

This ticket was mentioned in Slack in #core by costdev. View the logs.

18 months ago

#4 @costdev
18 months ago

  • Milestone changed from 6.2 to Future Release

This ticket was discussed during the bug scrub. As a patch hasn't been submitted yet, and 6.2 Beta 1 is only a few days away, I'm moving this ticket to the Future Release milestone.

Additional Props: @audrasjb @petitphp

#5 @petitphp
17 months ago

Started working on a patch for this ticket and I encounter a small quirk.

To make this change compatible with PHP7.x and below we'll need to use a custom formatting and include the attribute on its own line or this will cause a Fatal error since it's interpreted as a comment and discard the end of the line (see the demo).

Example for the wpdb constructor we could end up with :

public function __construct(
        #[\SensitiveParameter] <-- should be on its own line
) {

This looks ok to me, but I wanted to have other opinions before putting up a patch.

Last edited 17 months ago by petitphp (previous) (diff)

#6 @johnbillion
17 months ago

That's fine, we do similar for function calls with multi-line parameters. Does this trigger a coding standards violation? If so we can put forward the case to change that.

#7 @petitphp
17 months ago

That's fine

Great! I'll finish the work on the patch. Thanks.

Does this trigger a coding standards violation?

It doesn't on my local machine when running the linter.

This ticket was mentioned in PR #4147 on WordPress/wordpress-develop by @petitphp.

17 months ago

  • Keywords has-patch added; needs-patch removed

Mark credentials with the new SensitiveParameter attribute available in PHP 8.2 to hide them in stack traces or log.

Trac ticket:

#9 @petitphp
17 months ago

I've created a PR to implement this change.

It adds the SensitiveParameter attribute to "password" parameters in various place in the codebase.

The PasswordHash class has not been touch as I wasn't sure if this is still considered an "external library" or if it's part of the core.

#10 @petitphp
3 weeks ago

Could we add this ticket to the 6.7 milestone to move it forward ?

#11 @jrf
3 weeks ago

  • Milestone changed from Future Release to 6.7
Note: See TracTickets for help on using tickets.