Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add #[SensitiveParameter] attribute to sensitive parameters #1082

Merged
merged 1 commit into from
Nov 7, 2024
Merged

Add #[SensitiveParameter] attribute to sensitive parameters #1082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
32 changes: 24 additions & 8 deletions src/Signer/Key/InMemory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
use Lcobucci\JWT\Signer\InvalidKeyProvided;
use Lcobucci\JWT\Signer\Key;
use Lcobucci\JWT\SodiumBase64Polyfill;
use SensitiveParameter;
use SplFileObject;
use Throwable;

Expand All @@ -15,21 +16,33 @@
final class InMemory implements Key
{
/** @param non-empty-string $contents */
private function __construct(public readonly string $contents, public readonly string $passphrase)
{
private function __construct(
#[SensitiveParameter]
public readonly string $contents,
slknijnenburg marked this conversation as resolved.
Show resolved Hide resolved
#[SensitiveParameter]
public readonly string $passphrase,
) {
}

/** @param non-empty-string $contents */
public static function plainText(string $contents, string $passphrase = ''): self
{
public static function plainText(
#[SensitiveParameter]
string $contents,
slknijnenburg marked this conversation as resolved.
Show resolved Hide resolved
#[SensitiveParameter]
string $passphrase = '',
): self {
self::guardAgainstEmptyKey($contents);

return new self($contents, $passphrase);
}

/** @param non-empty-string $contents */
public static function base64Encoded(string $contents, string $passphrase = ''): self
{
public static function base64Encoded(
#[SensitiveParameter]
string $contents,
slknijnenburg marked this conversation as resolved.
Show resolved Hide resolved
#[SensitiveParameter]
string $passphrase = '',
): self {
$decoded = SodiumBase64Polyfill::base642bin(
$contents,
SodiumBase64Polyfill::SODIUM_BASE64_VARIANT_ORIGINAL,
Expand All @@ -45,8 +58,11 @@ public static function base64Encoded(string $contents, string $passphrase = ''):
*
* @throws FileCouldNotBeRead
*/
public static function file(string $path, string $passphrase = ''): self
{
public static function file(
string $path,
#[SensitiveParameter]
string $passphrase = '',
): self {
try {
$file = new SplFileObject($path);
} catch (Throwable $exception) {
Expand Down
11 changes: 9 additions & 2 deletions src/Signer/OpenSSL.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

use Lcobucci\JWT\Signer;
use OpenSSLAsymmetricKey;
use SensitiveParameter;

use function array_key_exists;
use function assert;
Expand Down Expand Up @@ -40,7 +41,9 @@ abstract class OpenSSL implements Signer
* @throws InvalidKeyProvided
*/
final protected function createSignature(
#[SensitiveParameter]
string $pem,
#[SensitiveParameter]
string $passphrase,
string $payload,
): string {
Expand All @@ -56,8 +59,12 @@ final protected function createSignature(
}

/** @throws CannotSignPayload */
private function getPrivateKey(string $pem, string $passphrase): OpenSSLAsymmetricKey
{
private function getPrivateKey(
#[SensitiveParameter]
string $pem,
#[SensitiveParameter]
string $passphrase,
): OpenSSLAsymmetricKey {
return $this->validateKey(openssl_pkey_get_private($pem, $passphrase));
}

Expand Down