SensitiveParameter アトリビュート

(PHP 8 >= 8.2.0)

はじめに

このアトリビュートを使うと、スタックトレース中に現れた場合に、値を削除すべき秘密の値としてパラメータをマークできます。

クラス概要

final class SensitiveParameter {

/* メソッド */

public __construct()

}

例

<?php

function defaultBehavior(
    string $secret,
    string $normal
) {
    throw new Exception('Error!');
}

function sensitiveParametersWithAttribute(
    #[\SensitiveParameter]
    string $secret,
    string $normal
) {
    throw new Exception('Error!');
}

try {
    defaultBehavior('password', 'normal');
} catch (Exception $e) {
    echo $e, PHP_EOL, PHP_EOL;
}

try {
    sensitiveParametersWithAttribute('password', 'normal');
} catch (Exception $e) {
    echo $e, PHP_EOL, PHP_EOL;
}

?>

上の例の PHP 8.2 での出力は、たとえば以下のようになります。:

Exception: Error! in example.php:7
Stack trace:
#0 example.php(19): defaultBehavior('password', 'normal')
#1 {main}

Exception: Error! in example.php:15
Stack trace:
#0 example.php(25): sensitiveParametersWithAttribute(Object(SensitiveParameterValue), 'normal')
#1 {main}

参考

Beware this attribute does nothing on object interfaces and will permit password exposure when used incorrectly.

<?php

interface Server
{
    public function connect(
        #[\SensitiveParameter]
        string $password,
    );
}

class TestServer implements Server
{
    public function connect(
        string $password,
    ) {
        throw new Exception('Guess what?');
    }
}

($var = new TestServer())->connect('wrl!L3=6O57T9?r');

＋add a note

SensitiveParameter アトリビュート

はじめに

クラス概要

例

参考

目次

Found A Problem?

User Contributed Notes 1 note