Merge branch 'develop/v2' into v2

Author: Daisuke Maki

.github/workflows/assign-issue.yml

@@ -8,6 +8,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: 'Auto-assign issue'
-        uses: pozil/auto-assign-issue@c5bca5027e680b9e8411b826d16947afd8c76b32 # v2.0.0
+        uses: pozil/auto-assign-issue@39c06395cbac76e79afc4ad4e5c5c6db6ecfdd2e # v2.2.0
         with:
           assignees: lestrrat

.github/workflows/ci.yml

@@ -11,13 +11,13 @@ jobs:
     strategy:
       matrix:
         go_tags: [ 'stdlib', 'goccy', 'es256k', 'secp256k1-pem', 'asmbase64', 'alltags']
-        go: [ '1.23', '1.22', '1.21' ]
+        go: [ '1.24', '1.23', '1.22' ]
     name: "Test [ Go ${{ matrix.go }} / Tags ${{ matrix.go_tags }} ]"
     steps:
       - name: Checkout repository
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
       - name: Cache Go modules
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
+        uses: actions/cache@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4.2.1
         with:
           path: |
             ~/go/pkg/mod

.github/workflows/lint.yml

@@ -9,7 +9,7 @@ jobs:
       - uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2
         with:
           go-version-file: "go.mod"
-      - uses: golangci/golangci-lint-action@971e284b6050e8a5849b72094c50ab08da042db8 # v6.1.1
+      - uses: golangci/golangci-lint-action@2226d7cb06a077cd73e56eedd38eecad18e5d837 # v6.5.0
       - name: Run go vet
         run: |
           go vet ./...

.github/workflows/smoke.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         go_tags: [ 'stdlib', 'goccy', 'es256k', 'alltags' ]
-        go: [ '1.23', '1.22', '1.21' ]
+        go: [ '1.24', '1.23', '1.22' ]
     name: "Smoke [ Go ${{ matrix.go }} / Tags ${{ matrix.go_tags }} ]"
     steps:
       - name: Checkout repository
@@ -23,7 +23,7 @@ jobs:
         run: |
           find . -name '*.md' | xargs env AUTODOC_DRYRUN=1 perl tools/autodoc.pl
       - name: Cache Go modules
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.20
+        uses: actions/cache@0c907a75c2c80ebcb7f088228285e798b750cf8f # v4.2.1
         with:
           path: |
             ~/go/pkg/mod

.github/workflows/stale.yml

@@ -7,7 +7,7 @@ jobs:
   stale:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/stale@28ca1036281a5e5922ead5184a1bbf96e5fc984e # v9.0.0
+      - uses: actions/stale@5bef64f19d7facfb25b37b414482c7164d639639 # v9.1.0
         with:
           stale-issue-message: 'This issue is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 7 days.'
           stale-pr-message: 'This PR is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 14 days.'

.golangci.yml

@@ -1,5 +1,3 @@
-run:
-
 linters-settings:
   govet:
     enable-all: true
@@ -92,7 +90,7 @@ issues:
         - forbidigo
     - path: /*_test.go
       text: "var-naming: "
-      litners:
+      linters:
         - revive
 
   # Maximum issues count per one linter. Set to 0 to disable. Default is 50.

Changes

@@ -4,6 +4,11 @@ Changes
 v2 has many incompatibilities with v1. To see the full list of differences between
 v1 and v2, please read the Changes-v2.md file (https://github.com/lestrrat-go/jwx/blob/develop/v2/Changes-v2.md)
 
+v2.1.4 Feb 25 2025
+  * Update code to work with go1.24
+  * Update tests to work with recent latchset/jose
+  * Fix build pipeline to work with latest golangci-lint
+
 v2.1.3 24 Nov 2024
   * [jwe] Test has been fixed to work under 32-bit systems.
 

README.md

@@ -45,7 +45,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWX() {
+func Example_jwx_readme() {
   // Parse, serialize, slice and dice JWKs!
   privkey, err := jwk.ParseKey(jsonRSAPrivateKey)
   if err != nil {

deps.bzl

@@ -12,15 +12,15 @@ def go_dependencies():
         name = "com_github_decred_dcrd_crypto_blake256",
         build_file_proto_mode = "disable_global",
         importpath = "github.com/decred/dcrd/crypto/blake256",
-        sum = "h1:7PltbUIQB7u/FfZ39+DGa/ShuMyJ5ilcvdfma9wOH6Y=",
-        version = "v1.0.1",
+        sum = "h1:zPMNGQCm0g4QTY27fOCorQW7EryeQ/U0x++OzVrdms8=",
+        version = "v1.1.0",
     )
     go_repository(
         name = "com_github_decred_dcrd_dcrec_secp256k1_v4",
         build_file_proto_mode = "disable_global",
         importpath = "github.com/decred/dcrd/dcrec/secp256k1/v4",
-        sum = "h1:rpfIENRNNilwHwZeG5+P150SMrnNEcHYvcCuK6dPZSg=",
-        version = "v4.3.0",
+        sum = "h1:NMZiJj8QnKe1LgsbDayM4UoHwbvwDRwnI3hwNaAHRnc=",
+        version = "v4.4.0",
     )
     go_repository(
         name = "com_github_goccy_go_json",
@@ -92,8 +92,8 @@ def go_dependencies():
         name = "com_github_stretchr_testify",
         build_file_proto_mode = "disable_global",
         importpath = "github.com/stretchr/testify",
-        sum = "h1:HtqpIVDClZ4nwg75+f6Lvsy/wHu+3BoSGCbBAcpTsTg=",
-        version = "v1.9.0",
+        sum = "h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=",
+        version = "v1.10.0",
     )
 
     go_repository(
@@ -115,8 +115,8 @@ def go_dependencies():
         name = "org_golang_x_crypto",
         build_file_proto_mode = "disable_global",
         importpath = "golang.org/x/crypto",
-        sum = "h1:L5SG1JTTXupVV3n6sUqMTeWbjAyfPwoda2DLX8J8FrQ=",
-        version = "v0.29.0",
+        sum = "h1:euUpcYgM8WcP71gNpTqQCn6rC2t6ULUPiOzfWaXVVfc=",
+        version = "v0.32.0",
     )
 
     go_repository(
@@ -131,21 +131,21 @@ def go_dependencies():
         name = "org_golang_x_sys",
         build_file_proto_mode = "disable_global",
         importpath = "golang.org/x/sys",
-        sum = "h1:wBqf8DvsY9Y/2P8gAfPDEYNuS30J4lPHJxXSb/nJZ+s=",
-        version = "v0.27.0",
+        sum = "h1:TPYlXGxvx1MGTn2GiZDhnjPA9wZzZeGKHHmKhHYvgaU=",
+        version = "v0.29.0",
     )
     go_repository(
         name = "org_golang_x_term",
         build_file_proto_mode = "disable_global",
         importpath = "golang.org/x/term",
-        sum = "h1:WEQa6V3Gja/BhNxg540hBip/kkaYtRg3cxg4oXSw4AU=",
-        version = "v0.26.0",
+        sum = "h1:/Ts8HFuMR2E6IP/jlo7QVLZHggjKQbhu/7H0LJFr3Gg=",
+        version = "v0.28.0",
     )
 
     go_repository(
         name = "org_golang_x_text",
         build_file_proto_mode = "disable_global",
         importpath = "golang.org/x/text",
-        sum = "h1:gK/Kv2otX8gz+wn7Rmb3vT96ZwuoxnQlY+HlJVj7Qug=",
-        version = "v0.20.0",
+        sum = "h1:zyQAAkrwaneQ066sspRyJaG9VNi/YJ1NfzcGB3hZ/qo=",
+        version = "v0.21.0",
     )

docs/01-jwt.md

@@ -81,7 +81,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_Parse() {
+func Example_jwt_parse() {
   tok, err := jwt.Parse(jwtSignedWithHS256, jwt.WithKey(jwa.HS256, jwkSymmetricKey))
   if err != nil {
     fmt.Printf("%s\n", err)
@@ -112,7 +112,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ReadFile() {
+func Example_jwt_readfile() {
   f, err := os.CreateTemp(``, `jwt_readfile-*.jws`)
   if err != nil {
     fmt.Printf("failed to create temporary file: %s\n", err)
@@ -154,7 +154,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ParseRequest_Authorization() {
+func Example_jwt_parse_request_authorization() {
   req, err := http.NewRequest(http.MethodGet, `https://github.com/lestrrat-go/jwx`, nil)
   if err != nil {
     fmt.Printf("failed to create request: %s\n", err)
@@ -239,7 +239,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_Construct() {
+func Example_jwt_construct() {
   tok := jwt.New()
   if err := tok.Set(jwt.IssuerKey, `github.com/lestrrat-go/jwx`); err != nil {
     fmt.Printf("failed to set claim: %s\n", err)
@@ -284,7 +284,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_Builder() {
+func Example_jwt_builder() {
   tok, err := jwt.NewBuilder().
     Claim(`claim1`, `value1`).
     Claim(`claim2`, `value2`).
@@ -324,7 +324,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ParseWithKey() {
+func Example_jwt_parse_with_key() {
   const keysrc = `{"kty":"oct","k":"AyM1SysPpbyDfgZld3umj1qzKObwVMkoqQ-EstJQLr_T-1qS0gZH75aKtMN3Yj0iPS4hcgUuTwjAzZr1Z9CAow"}`
 
   key, err := jwk.ParseKey([]byte(keysrc))
@@ -369,7 +369,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ParseWithKeySet() {
+func Example_jwt_parse_with_keyset() {
   var serialized []byte
   var signingKey jwk.Key
   var keyset jwk.Set
@@ -512,7 +512,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ParseWithKeyProvider_UseToken() {
+func Example_jwt_parse_with_key_provider_use_token() {
   // This example shows how one might use the information in the JWT to
   // load different keys.
 
@@ -581,7 +581,7 @@ func ExampleJWT_ParseWithKeyProvider_UseToken() {
   //
 }
 
-func ExampleJWT_ParseWithKeyProvider() {
+func Example_jwt_parse_with_key_provider() {
   // Pretend that this is a storage somewhere (maybe a database) that maps
   // a signature algorithm to a key
   store := make(map[jwa.KeyAlgorithm]interface{})
@@ -666,7 +666,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ParseWithJKU() {
+func Example_jwt_parse_with_jku() {
   set := jwk.NewSet()
 
   var signingKey jwk.Key
@@ -753,7 +753,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_Validate() {
+func Example_validate_jwt() {
   tok, err := jwt.NewBuilder().
     Issuer(`github.com/lestrrat-go/jwx`).
     Expiration(time.Now().Add(-1 * time.Hour)).
@@ -813,7 +813,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ValidateIssuer() {
+func Example_jwt_validate_issuer() {
   tok, err := jwt.NewBuilder().
     Issuer(`github.com/lestrrat-go/jwx`).
     Expiration(time.Now().Add(time.Hour)).
@@ -853,7 +853,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ValidateValidator() {
+func Example_jwt_validate_validator() {
   validator := jwt.ValidatorFunc(func(_ context.Context, t jwt.Token) jwt.ValidationError {
     if t.IssuedAt().Month() != 8 {
       return jwt.NewValidationError(errors.New(`tokens are only valid if issued during August!`))
@@ -900,7 +900,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_ValidateDetectErrorType() {
+func Example_jwt_validate_detect_error_type() {
   tok, err := jwt.NewBuilder().
     Issuer(`github.com/lestrrat-go/jwx`).
     Expiration(time.Now().Add(-1 * time.Hour)).
@@ -982,7 +982,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_SerializeJSON() {
+func Example_jwt_serialize_json() {
   tok, err := jwt.NewBuilder().
     Issuer(`github.com/lestrrat-go/jwx`).
     IssuedAt(time.Unix(aLongLongTimeAgo, 0)).
@@ -1019,7 +1019,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_SerializeJWS() {
+func Example_jwt_serialize_jws() {
   tok, err := jwt.NewBuilder().
     Issuer(`github.com/lestrrat-go/jwx`).
     IssuedAt(time.Unix(aLongLongTimeAgo, 0)).
@@ -1085,7 +1085,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_SerializeJWEJWS() {
+func Example_jwt_serialize_jwe_and_jws() {
   tok, err := jwt.NewBuilder().
     Issuer(`github.com/lestrrat-go/jwx`).
     IssuedAt(time.Unix(aLongLongTimeAgo, 0)).
@@ -1164,7 +1164,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWT_FlattenAudience() {
+func Example_jwt_flatten_audience() {
   // Sometimes you need to "flatten" the "aud" claim because of
   // parsers developed by people who apparently didn't read the RFC.
   //
@@ -1262,7 +1262,7 @@ import (
   "github.com/lestrrat-go/jwx/v2/jwt"
 )
 
-func ExampleJWTPlainStruct() {
+func Example_jwt_plain_struct() {
   t1, err := jwt.NewBuilder().
     Issuer("https://github.com/lestrrat-go/jwx/v2/examples").
     Subject("raw_struct").