Skip to content

feat(core): make the JWS and JWE builders immutable #706

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
Spomky merged 1 commit into from
Aug 29, 2026
Merged

feat(core): make the JWS and JWE builders immutable #706

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
284 changes: 1 addition & 283 deletions .ci-tools/phpstan-baseline.neon
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4465,293 +4465,11 @@ parameters:
path: ../src/Library/Encryption/JWE.php

-
rawMessage: 'Call to function is_countable() with array will always evaluate to true.'
identifier: function.alreadyNarrowedType
count: 2
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: Cannot access offset 'header' on mixed.
identifier: offsetAccess.nonOffsetAccessible
count: 3
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: Cannot access offset 'key' on mixed.
identifier: offsetAccess.nonOffsetAccessible
count: 2
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: Cannot access offset 'key_encryption_algorithm' on mixed.
identifier: offsetAccess.nonOffsetAccessible
count: 2
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: Cannot access offset 'sender_key' on mixed.
identifier: offsetAccess.nonOffsetAccessible
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::checkAndSetContentEncryptionAlgorithm() has parameter $completeHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::checkDuplicatedHeaderParameters() has parameter $header1 with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::checkDuplicatedHeaderParameters() has parameter $header2 with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::determineCEK() has parameter $additionalHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::encryptJWE() return type has no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getContentEncryptionAlgorithm() has parameter $completeHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getEncryptedKey() has parameter $additionalHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getEncryptedKey() has parameter $completeHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getEncryptedKeyFromKeyAgreementAndKeyWrappingAlgorithm() has parameter $additionalHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getEncryptedKeyFromKeyAgreementAndKeyWrappingAlgorithm() has parameter $completeHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getEncryptedKeyFromKeyEncryptionAlgorithm() has parameter $additionalHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getEncryptedKeyFromKeyEncryptionAlgorithm() has parameter $completeHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getEncryptedKeyFromKeyWrappingAlgorithm() has parameter $additionalHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getEncryptedKeyFromKeyWrappingAlgorithm() has parameter $completeHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::getKeyEncryptionAlgorithm() has parameter $completeHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::processRecipient() has parameter $additionalHeader with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEBuilder::processRecipient() has parameter $recipient with no value type specified in iterable type array.'
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #1 $algorithm of method Jose\Component\Core\AlgorithmManager::get() expects string, mixed given.'
identifier: argument.type
count: 2
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #1 $ciphertext of class Jose\Component\Encryption\JWE constructor expects string|null, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #1 $header of class Jose\Component\Encryption\Recipient constructor expects array, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #1 $length of function random_bytes expects int<1, max>, (float|int) given.'
identifier: argument.type
count: 2
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #1 $recipient of method Jose\Component\Encryption\JWEBuilder::processRecipient() expects array, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #1 ...$arrays of function array_merge expects array, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #2 $header2 of method Jose\Component\Encryption\JWEBuilder::checkDuplicatedHeaderParameters() expects array, mixed given.'
identifier: argument.type
count: 2
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #2 $iv of class Jose\Component\Encryption\JWE constructor expects string, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #2 ...$arrays of function array_merge expects array, mixed given.'
identifier: argument.type
count: 2
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #2 ...$values of function sprintf expects bool|float|int|string|null, mixed given.'
rawMessage: 'Parameter #1 $length of function random_bytes expects int<1, max>, int given.'
identifier: argument.type
count: 2
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #3 $completeHeader of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyEncryption::encryptKey() expects array<string, mixed>, array given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #3 $completeHeader of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyWrapping::wrapKey() expects array<string, mixed>, array given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #3 $recipientKey of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyAgreement::getAgreementKey() expects Jose\Component\Core\JWK, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #3 $tag of class Jose\Component\Encryption\JWE constructor expects string, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #4 $additionalHeader of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyEncryption::encryptKey() expects array<string, mixed>, array given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #4 $additionalHeader of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyWrapping::wrapKey() expects array<string, mixed>, array given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #4 $senderKey of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyAgreement::getAgreementKey() expects Jose\Component\Core\JWK|null, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #5 $completeHeader of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyAgreement::getAgreementKey() expects array<string, mixed>, array given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #5 $complete_header of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyAgreementWithKeyWrapping::wrapAgreementKey() expects array<string, mixed>, array given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #5 $recipientKey of method Jose\Component\Encryption\JWEBuilder::getEncryptedKey() expects Jose\Component\Core\JWK, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #6 $additionalHeaderValues of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyAgreement::getAgreementKey() expects array<string, mixed>, array given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #6 $additional_header_values of method Jose\Component\Encryption\Algorithm\KeyEncryption\KeyAgreementWithKeyWrapping::wrapAgreementKey() expects array<string, mixed>, array given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Parameter #6 $senderKey of method Jose\Component\Encryption\JWEBuilder::getEncryptedKey() expects Jose\Component\Core\JWK|null, mixed given.'
identifier: argument.type
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: Property Jose\Component\Encryption\JWEBuilder::$recipients type has no value type specified in iterable type array.
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: Property Jose\Component\Encryption\JWEBuilder::$sharedHeader type has no value type specified in iterable type array.
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: Property Jose\Component\Encryption\JWEBuilder::$sharedProtectedHeader type has no value type specified in iterable type array.
identifier: missingType.iterableValue
count: 1
path: ../src/Library/Encryption/JWEBuilder.php

-
rawMessage: 'Method Jose\Component\Encryption\JWEDecrypter::checkCompleteHeader() has parameter $completeHeaders with no value type specified in iterable type array.'
identifier: missingType.iterableValue
Expand Down
2 changes: 1 addition & 1 deletion src/Bundle/Services/JWEBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public function build(): JWE
} catch (Throwable $throwable) {
$this->eventDispatcher->dispatch(new JWEBuiltFailureEvent(
$this->payload,
$this->recipients,
$this->getRecipientsAsArray(),
$this->sharedProtectedHeader,
$this->sharedHeader,
$this->aad,
Expand Down
2 changes: 1 addition & 1 deletion src/Bundle/Services/JWSBuilder.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public function build(): JWS
} catch (Throwable $throwable) {
$this->eventDispatcher->dispatch(new JWSBuiltFailureEvent(
$this->payload,
$this->signatures,
$this->getSignaturesAsArray(),
$this->isPayloadDetached,
$this->isPayloadEncoded,
$throwable
Expand Down
Loading
Loading