search

ONSdigital / eq-survey-runner

eQ Survey Runner
MIT License
21 stars 14 forks source link

Bump jwcrypto from 0.6.0 to 1.4 #2919

Closed dependabot[bot] closed 11 months ago

dependabot[bot] commented 2 years ago

Bumps jwcrypto from 0.6.0 to 1.4.

Release notes

Sourced from jwcrypto's releases.

Version 1.4

This is a security release to address CVE-2022-3102.

The JWT code can auto-detect the type of token being provided, and this can lead the application to incorrect conclusions about the trustworthiness of the token. Quoting the private disclosure we received : "Under certain circumstances, it is possible to substitute a [..] signed JWS with a JWE that is encrypted with the public key that is normally used for signature validation." This substitution attack can occur only if the validating application also have access to the private key, normally used to sign the tokens, available during validation of the received JWT. The significance of this attacks depends on the use of the token, it may lead to authentication bypass or authorization bypass (respectively if claims are used to authenticate or authorize certain actions), because the attacker has full control of the data placed in the JWE and can inject any desired claim value.

Several mitigating factors exist that can protect applications from this issue:

  • If the private key corresponding to the public key used to encrypt the JWE is not available to the application an exception will be raised.
  • If the JWK is specified with the 'use' parameter set to 'sig' (as expected for keys used only for signing/verification) an exception will be raised.
  • If the JWK is specified with the 'key_ops' parameter set and it does not include the 'decrypt' operation an exception will be raised.
  • Applications may check the token type before validation, in this case they would fail to detect an expected JWS

Normally, signing and validation are done by different applications, so this scenario should be unlikely. However it is possible to have applications that both sign and validate tokens and do not separate JWKs in use, or do not set a JWK 'use' type.

Due to the mitigating factors, and the fact that specific operational constraints and conditions need to be in place to successfully exploit this issue to generate an authentication bypass, we rate this security issue as moderate. Other avenues may decide on a different rating based on use case, always verify what conditions apply to your use of the library to assess risk.

Many thanks to Tom Tervoort of Secura for finding and reporting this issue.

Important Note

In order to address this security issue certain changes had to be made that may make this update incompatible with some existing applications. Namely, a new 'expect_type' argument has been added to JWT; this argument now defaults to 'JWS' if not explicitly set unless a non default set of algorithms that include exclusively non-signing algorithms is set. In that case the default is switched to 'JWE', this is done to be as much backwards compatible as possible with any hint we are provided.

If the token passed to JWT for validation is not of the 'expected' type, an exception will be raised on validation. Note that a token can be de-serialized w/o validation by not providing a key at the time of de-serialization. This operation will continue to work regardless of expected type. The expectation apply exclusively at validation time. This is intentional as it allows applications that were de-serializing and then checking the type of token to keep working or do so with minimal modifications.

For applications that need more time to update there is a 'born-deprecated' module level variable that can be set to restore the old behavior and disregard expectations. See the jwcrypto jwt module documentation under the variables section for more details about that. We strongly discourage the use of this workaround and invite application developers to refactor their code to be safe rather then apply an unsafe workaround.

What's Changed

New Contributors

Full Changelog: https://github.com/latchset/jwcrypto/compare/v1.3.1...v1.4.0

Version 1.3.1

Handle a regression when the JWTMissing Key exception was removed when a key is not found in a JWKSet. This adds a new generic JWKeyNotFound exception now returned by JWS and JWE when a JWKSet is used and JWTMissingKey now subclasses this new exception. This way code can now simply trap JWkeyNotFound, while older code can still use JWTMissingKey. Also fix documentation generation.

What's Changed

... (truncated)

Commits
  • 84f121f Version 1.4
  • 34b6525 Add global workaround for applications
  • f4e912f Make JWT require to know what to expect
  • 5a13cfc Add support for RFC 9278: JWK Thumbprint URI
  • e5c1e42 Upgrade GitHub Actions
  • e1b4c36 Version 1.3.1
  • 997b900 Introduce a new JWKeyNotFound exception
  • 60fc7ee Disable HW optimizations on ppc64le
  • 1e5c385 Fix sphinx nitpicked errors
  • 793fb43 Add documentation for jwcrypto.common
  • Additional commits viewable in compare view


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) - `@dependabot use these labels` will set the current labels as the default for future PRs for this repo and language - `@dependabot use these reviewers` will set the current reviewers as the default for future PRs for this repo and language - `@dependabot use these assignees` will set the current assignees as the default for future PRs for this repo and language - `@dependabot use this milestone` will set the current milestone as the default for future PRs for this repo and language You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/ONSdigital/eq-survey-runner/network/alerts).
dependabot[bot] commented 11 months ago

OK, I won't notify you again about this release, but will get in touch when a new version is available. If you'd rather skip all updates until the next major or minor version, let me know by commenting @dependabot ignore this major version or @dependabot ignore this minor version.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.