Skip to content

Latest commit

 

History

History
133 lines (93 loc) · 4.71 KB

CHANGELOG.md

File metadata and controls

133 lines (93 loc) · 4.71 KB
Raw

Change Log

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

[Unreleased]

[v2.0.0-RC1] 2021-06-27

  • Non retrocompatible changes

    • Because nimbus-jose-jwt changed the API it provides to validate claims, the JwtValidator implementations provided by this lib don't take an additionalValidations: List[(JWTClaimsSet, SecurityContext) => Option[BadJWTException]] parameter anymore and this lib also doesn't provide the ProvidedValidations helpers anymore.

      Now, the JwtValidator implementations expect a claimsVerifier: JWTClaimsSetVerifier[SecurityContext] which is the interface provided by nimbus-jose-jwt to declare your claims validation rules.
      For more info about this interface and how to express your validations rules, see validating-jwt-access-tokens#claims.
      You can also find some examples in the tests of this lib and in the code of the AwsCognitoJwtValidator and Auth0JwtValidator classes.

    • The JwtValidator interface changed:

      • from def validate(jwtToken: JwtToken): Either[BadJWTException, (JwtToken, JWTClaimsSet)]
      • to def validate(jwtToken: JwtToken): Either[InvalidToken, JWTClaimsSet]

      The JwtToken which was returned by the function was the same as the one passed in parameter. This was useless information.

    • Because of the changes in the API of nimbus-jose-jwt, we can't provide these errors anymore:

      • MissingExpirationClaim
      • InvalidTokenUseClaim
      • InvalidTokenIssuerClaim
      • InvalidTokenSubject
      • InvalidAudienceClaim

      The BadJWTException errors sum type is now replaced by a single class InvalidToken which contains the cause.

    • The ConfigurableJwtValidator constructor is now private. You have to replace new ConfigurableJwtValidator(...) by ConfigurableJwtValidator(...)

    • The AwsCognitoJwtValidator constructor is now private. You have to replace new AwsCognitoJwtValidator(...) by AwsCognitoJwtValidator(...)

    • The Auth0JwtValidator constructor is now private. You have to replace new Auth0JwtValidator(...) by Auth0JwtValidator(...)

    • The SupportedJWSAlgorithm sum type as been moved from com.guizmaii.scalajwt.utils.SupportedJWSAlgorithms.SupportedJWSAlgorithm to com.guizmaii.scalajwt.SupportedJWSAlgorithm

  • Other changes

    • Drop support for Scala 2.11
    • Add more tests, especially on Auth0JwtValidator
    • Update dependencies

[v1.0.2] 2021-04-10

  • Replace Bintray by Maven Central
  • Configure Github Actions && sbt-ci-release
  • Remove TravisCI
  • Update README
  • Update dependencies

[v1.0.1] 2020-10-31

  • Update Scala 2.13 and 2.12
  • Update dependencies, sbt and sbt plugins

[v1.0.0] 2020-05-29

  • Add Scala 2.13 in the CI build matrix and update the Scala 2.12 version used
  • Update nimbus-jose-jwt, scalatest, scalafmt and sbt-scoverage
  • Replace hand written scalac flag by sbt-tpolecat
  • Add support for Scala 2.13
  • Update Nimbus version from 5.10 to 8.17
  • Update SBT to 1.3.10

[v0.9.0] 2018-04-27

  • Fix Scala 2.11 version publishing
  • Improve scalafmt configuration
  • Update Scala 2.12 version
  • Improve scalacOptions config
  • Update dependencies

[v0.8.0] 2017-12-02

  • Improve documentation
  • Add requiredAudience validation
  • Add Auth0JwtValidator
  • Add HS256 tokens support
  • Improve performance by replacing the Try by a try catch block
  • Update sbt to v1.0.4
  • Add missing finals
  • Rename ProvidedAdditionalChelcks to ProvidedValidations
  • Reorganize code
  • Improve documentation
  • Update travis config
  • Update dependencies

[v0.7.0] 2017-08-28

  • Update SBT and its plugins
  • Update dependencies

[v0.6.0] 2017-08-15

  • Only handle RS256 signed tokens for now

[v0.5.0] 2017-08-14

  • Handle every possible Exception
  • Handle the case where the JWT token is invalid
  • Cover ConfigurableJwtValidator with tests
  • Update scalafmt
  • Update Nimbus from v4.39.2 to v4.41.1
  • Update Scala from v2.12.2 to v2.12.3

[v0.4.0] 2017-07-16

  • Add AwsCognitoJwtValidator
  • Reorganize files

[v0.3.0] 2017-07-14

[v0.2.0] 2017-07-14

  • Config sbt-bintray && Scala cross version compilation

[v0.1.0] 2017-07-14

  • First JwtValidator impl: ConfigurableJwtValidator