Skip to content

fix(cryptography): add key:generate hint to invalid key exceptions #1925

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

Merged
innocenzi merged 3 commits into from
Jan 27, 2026
+14 −7
Merged

fix(cryptography): add key:generate hint to invalid key exceptions #1925

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
524344d
fix(cryptography): add key:generate hint to invalid key exceptions
xHeaven Jan 27, 2026
7306df9
refactor: update exception messages
innocenzi Jan 27, 2026
64cc54b
feat: add `generate:key` alias
innocenzi Jan 27, 2026
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: 1 addition & 1 deletion packages/cryptography/src/Encryption/EncryptionKey.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ public function __construct(
}

if (strlen($value) !== $algorithm->getKeyLength()) {
throw EncryptionKeyWasInvalid::becauseLengthMismatched($algorithm);
throw EncryptionKeyWasInvalid::becauseLengthMismatched($algorithm, strlen($value));
}
}

Expand Down
11 changes: 7 additions & 4 deletions packages/cryptography/src/Encryption/Exceptions/EncryptionKeyWasInvalid.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,17 @@ public function __construct(

public static function becauseItIsMissing(EncryptionAlgorithm $algorithm): self
{
return new self('The encryption key is missing or empty. Ensure you have a `SIGNING_KEY` environment variable.', $algorithm);
return new self(
message: 'The encryption key is missing or empty. Generate a valid `SIGNING_KEY` with `php tempest key:generate`.',
algorithm: $algorithm,
);
}

public static function becauseLengthMismatched(EncryptionAlgorithm $algorithm): self
public static function becauseLengthMismatched(EncryptionAlgorithm $algorithm, int $actualLength): self
{
return new self(
"The encryption key length does not match the expected length ({$algorithm->getKeyLength()}).",
$algorithm,
message: "The encryption key length ({$actualLength}) does not match the expected length ({$algorithm->getKeyLength()}). Generate a valid `SIGNING_KEY` with `php tempest key:generate`.",
algorithm: $algorithm,
);
}
}
6 changes: 5 additions & 1 deletion packages/cryptography/src/GenerateSigningKeyCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,11 @@ public function __construct(
private Console $console,
) {}

#[ConsoleCommand('key:generate', description: 'Generates the signing key required to sign and verify data.')]
#[ConsoleCommand(
name: 'key:generate',
description: 'Generates the signing key required to sign and verify data.',
aliases: ['generate:key'],
)]
public function __invoke(bool $override = true): ExitCode
{
$key = EncryptionKey::generate($this->encryptionConfig->algorithm);
Expand Down
2 changes: 1 addition & 1 deletion packages/cryptography/src/Signing/Exceptions/SigningKeyWasInvalid.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ final class SigningKeyWasInvalid extends Exception implements SigningException
{
public static function becauseItIsMissing(): self
{
return new self('The signing key is missing or empty. Ensure you have a `SIGNING_KEY` environment variable.');
return new self('The signing key is missing or empty. Generate a valid `SIGNING_KEY` with `php tempest key:generate`.');
}
}