Skip to content

Commit ec942b9

Browse files
yaronfcursoragent
andcommitted
feat: add NewJWSSignerFromJWK for private JWK signing
Infer alg from a private jwk.Key (same rules as verify), export raw private material, and construct a foreign JWS signer. Closes #24. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent d6befe5 commit ec942b9

7 files changed

Lines changed: 245 additions & 38 deletions

File tree

‎CLAUDE.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ fields.go / digest.go ← Component field abstraction + Content-Digest head
5353

5454
### JWX dual-version support
5555

56-
Optional foreign JWS uses `lestrrat-go/jwx/v4` via `NewJWSSigner` / `NewJWSVerifier` (infer) / `NewJWSVerifierWithAlg` (including ML-DSA with `crypto/mldsa` on Go 1.27+). Requires Go 1.27+.
56+
Optional foreign JWS uses `lestrrat-go/jwx/v4` via `NewJWSSigner` / `NewJWSSignerFromJWK` / `NewJWSVerifier` (infer) / `NewJWSVerifierWithAlg` (including ML-DSA with `crypto/mldsa` on Go 1.27+). Requires Go 1.27+.
5757

5858
### Content-Digest
5959

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,21 @@ in the [API reference](https://pkg.go.dev/github.com/yaronf/httpsign).
3131

3232
**v0.6.0** (shipped) raised the Go floor to **1.27+** and cut foreign JWS over to **jwx v4** + ML-DSA. See [internal-docs/RELEASE-v0.6.0.md](internal-docs/RELEASE-v0.6.0.md).
3333

34-
**v0.6.1** breaks foreign-JWS **verify** again: prefer `NewJWSVerifier(allowed, key, …)` (infer alg); use `NewJWSVerifierWithAlg` when needed; pass a `JWSAlgAllowlist` (`nil` skips policy). `NewJWSSigner` defaults to / requires `SignAlg(false)`.
34+
**v0.6.1** breaks foreign-JWS **verify** again: prefer `NewJWSVerifier(allowed, key, …)` (infer alg); use `NewJWSVerifierWithAlg` when needed; pass a `JWSAlgAllowlist` (`nil` skips policy). `NewJWSSigner` defaults to / requires `SignAlg(false)`; use `NewJWSSignerFromJWK` when the private key is a JWK.
3535

3636
| Caller | Change in v0.6.1 |
3737
|--------|------------------|
3838
| Native algorithms only | None. |
3939
| `NewJWSVerifier(alg, key, …)` (v0.6.0) | Prefer `NewJWSVerifier(allowed, key, …)`; else `NewJWSVerifierWithAlg(allowed, alg, key, …)`. |
40-
| `NewJWSSigner` | Nil config ⇒ `SignAlg(false)`; `SignAlg(true)` errors. |
40+
| `NewJWSSigner` | Nil config ⇒ `SignAlg(false)`; `SignAlg(true)` errors. Prefer `NewJWSSignerFromJWK` for private JWKs. |
4141

4242
Pass a non-nil allowlist when `keyid` can select among keys. `SetAllowedAlgs` still only filters Signature-Input `alg`, not JWS `jwa`.
4343

4444
Full notes: [internal-docs/RELEASE-v0.6.1.md](internal-docs/RELEASE-v0.6.1.md).
4545

4646
### Foreign JWS and ML-DSA
4747

48-
Optional algorithms beyond the native set use [`lestrrat-go/jwx/v4`](https://github.com/lestrrat-go/jwx) (≥ v4.5.0) via `NewJWSSigner` / `NewJWSVerifier`.
48+
Optional algorithms beyond the native set use [`lestrrat-go/jwx/v4`](https://github.com/lestrrat-go/jwx) (≥ v4.5.0) via `NewJWSSigner` / `NewJWSSignerFromJWK` / `NewJWSVerifier`.
4949

5050
**ML-DSA (FIPS 204)** works through the same path with `crypto/mldsa` keys. Prefer inferring the alg from the public key:
5151

‎crypto.go‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ import (
1414
"fmt"
1515

1616
"github.com/lestrrat-go/jwx/v4/jwa"
17+
"github.com/lestrrat-go/jwx/v4/jwk"
1718
"github.com/lestrrat-go/jwx/v4/jws"
1819
)
1920

@@ -129,12 +130,16 @@ func NewEd25519SignerFromSeed(seed []byte, config *SignConfig, fields Fields) (*
129130
// NewJWSSigner creates a generic signer for JWS algorithms via github.com/lestrrat-go/jwx/v4.
130131
// The particular key type for each algorithm is documented in that package (including
131132
// crypto/mldsa keys for ML-DSA on Go 1.27+). HMAC keys must be []byte (not string).
133+
// Do not pass jwk.Key here — use NewJWSSignerFromJWK so alg can be taken from the JWK.
132134
// Config may be nil (defaults with SignAlg(false)). A non-nil config that would emit
133135
// HTTP Signature-Input "alg" is rejected — foreign JWS has no RFC 9421 algorithm id.
134136
func NewJWSSigner(alg jwa.SignatureAlgorithm, key any, config *SignConfig, fields Fields) (*Signer, error) {
135137
if key == nil {
136138
return nil, fmt.Errorf("key must not be nil")
137139
}
140+
if err := rejectJWKKeyForSigner(key); err != nil {
141+
return nil, err
142+
}
138143
alg, err := resolveRegisteredJWSAlg(alg)
139144
if err != nil {
140145
return nil, err
@@ -160,6 +165,18 @@ func NewJWSSigner(alg jwa.SignatureAlgorithm, key any, config *SignConfig, field
160165
}, nil
161166
}
162167

168+
// NewJWSSignerFromJWK creates a foreign-JWS signer by inferring the algorithm from a private jwk.Key
169+
// (JWK alg and/or unambiguous crv), then exporting raw private key material. Preferred when keys
170+
// are stored as JWKs (e.g. WIMSE WIT cnf.jwk). Public-only JWKs are rejected.
171+
// Config may be nil (defaults with SignAlg(false)); SignAlg(true) is rejected as for NewJWSSigner.
172+
func NewJWSSignerFromJWK(key jwk.Key, config *SignConfig, fields Fields) (*Signer, error) {
173+
alg, raw, err := inferJWSSignerKeyFromJWK(key)
174+
if err != nil {
175+
return nil, err
176+
}
177+
return NewJWSSigner(alg, raw, config, fields)
178+
}
179+
163180
func (s Signer) sign(buff []byte) ([]byte, error) {
164181
if s.foreignSigner != nil {
165182
signer, ok := s.foreignSigner.(jws.Signer)

‎crypto_test.go‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"testing"
1313

1414
"github.com/lestrrat-go/jwx/v4/jwa"
15+
"github.com/lestrrat-go/jwx/v4/jwk"
1516

1617
"github.com/stretchr/testify/assert"
1718
"github.com/stretchr/testify/require"
@@ -639,6 +640,142 @@ func TestNewJWSSignerSignAlg(t *testing.T) {
639640
_, err := NewJWSSigner(jwa.HS256(), hmacKey, NewSignConfig().SignAlg(true), *NewFields())
640641
require.Error(t, err)
641642
})
643+
t.Run("jwk key redirected", func(t *testing.T) {
644+
priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
645+
require.NoError(t, err)
646+
key, err := jwk.Import[jwk.Key](priv)
647+
require.NoError(t, err)
648+
_, err = NewJWSSigner(jwa.ES256(), key, nil, *NewFields())
649+
require.Error(t, err)
650+
require.Contains(t, err.Error(), "NewJWSSignerFromJWK")
651+
})
652+
}
653+
654+
func TestNewJWSSignerFromJWK(t *testing.T) {
655+
fields := *NewFields().AddHeader("@method").AddHeader("date").AddHeader("content-type").AddQueryParam("pet")
656+
signCfg := NewSignConfig().SignAlg(false).setFakeCreated(1618884475).SetKeyID("jwk1")
657+
verifyCfg := NewVerifyConfig().SetVerifyCreated(false).SetKeyID("jwk1")
658+
659+
t.Run("ecdsa p256 round trip", func(t *testing.T) {
660+
priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
661+
require.NoError(t, err)
662+
privJWK, err := jwk.Import[jwk.Key](priv)
663+
require.NoError(t, err)
664+
signer, err := NewJWSSignerFromJWK(privJWK, signCfg, fields)
665+
require.NoError(t, err)
666+
667+
pubJWK, err := jwk.Import[jwk.Key](&priv.PublicKey)
668+
require.NoError(t, err)
669+
allowed, err := NewJWSAlgAllowlist(jwa.ES256())
670+
require.NoError(t, err)
671+
verifier, err := NewJWSVerifier(allowed, pubJWK, verifyCfg, fields)
672+
require.NoError(t, err)
673+
674+
req := readRequest(httpreq2)
675+
sigInput, sig, err := SignRequest("sig1", *signer, req)
676+
require.NoError(t, err)
677+
req.Header.Add("Signature-Input", sigInput)
678+
req.Header.Add("Signature", sig)
679+
require.NoError(t, VerifyRequest("sig1", *verifier, req))
680+
})
681+
682+
t.Run("ed25519 round trip", func(t *testing.T) {
683+
pub, priv, err := ed25519.GenerateKey(rand.Reader)
684+
require.NoError(t, err)
685+
privJWK, err := jwk.Import[jwk.Key](priv)
686+
require.NoError(t, err)
687+
require.NoError(t, privJWK.Set(jwk.AlgorithmKey, jwa.EdDSAEd25519()))
688+
signer, err := NewJWSSignerFromJWK(privJWK, signCfg, fields)
689+
require.NoError(t, err)
690+
691+
pubJWK, err := jwk.Import[jwk.Key](pub)
692+
require.NoError(t, err)
693+
allowed, err := NewJWSAlgAllowlist(jwa.EdDSAEd25519())
694+
require.NoError(t, err)
695+
verifier, err := NewJWSVerifier(allowed, pubJWK, verifyCfg, fields)
696+
require.NoError(t, err)
697+
698+
req := readRequest(httpreq2)
699+
sigInput, sig, err := SignRequest("sig1", *signer, req)
700+
require.NoError(t, err)
701+
req.Header.Add("Signature-Input", sigInput)
702+
req.Header.Add("Signature", sig)
703+
require.NoError(t, VerifyRequest("sig1", *verifier, req))
704+
})
705+
706+
t.Run("mldsa44 round trip", func(t *testing.T) {
707+
priv, err := mldsa.GenerateKey(mldsa.MLDSA44())
708+
require.NoError(t, err)
709+
privJWK, err := jwk.Import[jwk.Key](priv)
710+
require.NoError(t, err)
711+
require.NoError(t, privJWK.Set(jwk.AlgorithmKey, jwa.MLDSA44()))
712+
signer, err := NewJWSSignerFromJWK(privJWK, signCfg, fields)
713+
require.NoError(t, err)
714+
715+
pub := priv.Public().(*mldsa.PublicKey)
716+
allowed, err := NewJWSAlgAllowlist(jwa.MLDSA44())
717+
require.NoError(t, err)
718+
verifier, err := NewJWSVerifier(allowed, pub, verifyCfg, fields)
719+
require.NoError(t, err)
720+
721+
req := readRequest(httpreq2)
722+
sigInput, sig, err := SignRequest("sig1", *signer, req)
723+
require.NoError(t, err)
724+
req.Header.Add("Signature-Input", sigInput)
725+
req.Header.Add("Signature", sig)
726+
require.NoError(t, VerifyRequest("sig1", *verifier, req))
727+
})
728+
729+
t.Run("hmac oct with alg", func(t *testing.T) {
730+
raw := []byte(strings.Repeat("k", 32))
731+
octJWK, err := jwk.Import[jwk.Key](raw)
732+
require.NoError(t, err)
733+
require.NoError(t, octJWK.Set(jwk.AlgorithmKey, jwa.HS256()))
734+
signer, err := NewJWSSignerFromJWK(octJWK, signCfg, fields)
735+
require.NoError(t, err)
736+
verifier, err := NewJWSVerifierWithAlg(nil, jwa.HS256(), raw, verifyCfg, fields)
737+
require.NoError(t, err)
738+
739+
req := readRequest(httpreq2)
740+
sigInput, sig, err := SignRequest("sig1", *signer, req)
741+
require.NoError(t, err)
742+
req.Header.Add("Signature-Input", sigInput)
743+
req.Header.Add("Signature", sig)
744+
require.NoError(t, VerifyRequest("sig1", *verifier, req))
745+
})
746+
747+
t.Run("public jwk rejected", func(t *testing.T) {
748+
priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
749+
require.NoError(t, err)
750+
pubJWK, err := jwk.Import[jwk.Key](&priv.PublicKey)
751+
require.NoError(t, err)
752+
_, err = NewJWSSignerFromJWK(pubJWK, nil, *NewFields())
753+
require.Error(t, err)
754+
require.Contains(t, err.Error(), "private")
755+
})
756+
757+
t.Run("rsa without alg rejected", func(t *testing.T) {
758+
priv, err := rsa.GenerateKey(rand.Reader, 2048)
759+
require.NoError(t, err)
760+
rsaJWK, err := jwk.Import[jwk.Key](priv)
761+
require.NoError(t, err)
762+
_, err = NewJWSSignerFromJWK(rsaJWK, nil, *NewFields())
763+
require.Error(t, err)
764+
})
765+
766+
t.Run("nil key", func(t *testing.T) {
767+
_, err := NewJWSSignerFromJWK(nil, nil, *NewFields())
768+
require.Error(t, err)
769+
})
770+
771+
t.Run("SignAlg true rejected", func(t *testing.T) {
772+
priv, err := ecdsa.GenerateKey(elliptic.P256(), rand.Reader)
773+
require.NoError(t, err)
774+
privJWK, err := jwk.Import[jwk.Key](priv)
775+
require.NoError(t, err)
776+
_, err = NewJWSSignerFromJWK(privJWK, NewSignConfig().SignAlg(true), *NewFields())
777+
require.Error(t, err)
778+
})
642779
}
643780

644781
func TestVerify(t *testing.T) {

‎internal-docs/JWS-ALG-POLICY.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ NewJWSVerifier(allowed *JWSAlgAllowlist, key any, config *VerifyConfig, fields F
7676
NewJWSVerifierWithAlg(allowed *JWSAlgAllowlist, alg jwa.SignatureAlgorithm, key any, config *VerifyConfig, fields Fields) (*Verifier, error)
7777

7878
NewJWSSigner(alg jwa.SignatureAlgorithm, key any, config *SignConfig, fields Fields) (*Signer, error) // no allowlist (outbound)
79+
NewJWSSignerFromJWK(key jwk.Key, config *SignConfig, fields Fields) (*Signer, error) // infer from private JWK
7980
```
8081

8182
**Migration:** `NewJWSVerifier(alg, key, cfg, fields)` → `NewJWSVerifierWithAlg(allowed, alg, key, cfg, fields)`, or preferably `NewJWSVerifier(allowed, key, …)` when the key type is inferrable.
@@ -94,7 +95,9 @@ NewJWSSigner(alg jwa.SignatureAlgorithm, key any, config *SignConfig, fields Fie
9495
3. Existing **`validateJWSKeyAlg`**; default “unsupported” → fall through to **`jws.VerifierFor(alg)`** (jwx).
9596
4. Reject raw `jwk.Key` here — use preferred `NewJWSVerifier` (or convert).
9697

97-
**`NewJWSSigner`:** hardening + passthrough; **no** allowlist; force `SignAlg(false)`.
98+
**`NewJWSSigner`:** hardening + passthrough; **no** allowlist; force `SignAlg(false)`. Reject raw `jwk.Key` — use `NewJWSSignerFromJWK`.
99+
100+
**`NewJWSSignerFromJWK`:** require a **private** JWK (symmetric `oct` OK); resolve alg with the same table / EdDSA↔Ed25519 rules as verify; export raw **private** material; then `NewJWSSigner`.
98101

99102
Do **not** put the JWS allowlist on `VerifyConfig`.
100103

‎internal-docs/RELEASE-v0.6.1.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Copy the **Summary** section below into the GitHub release when tagging `v0.6.1`
1111
### Highlights
1212

1313
- **Preferred verify API:** `NewJWSVerifier(allowed, key, …)` infers the JWS algorithm from `jwk.Key`, `*ecdsa.PublicKey`, or `*mldsa.PublicKey`.
14+
- **`NewJWSSignerFromJWK`:** infer alg from a **private** `jwk.Key` and sign (symmetric with preferred verify for JWK-stored keys).
1415
- **Escape hatch:** `NewJWSVerifierWithAlg(allowed, alg, key, …)` when alg cannot be inferred (raw RSA/HMAC) or the store already chose alg. Today’s `NewJWSVerifier(alg, key, …)` migrates here.
1516
- **`JWSAlgAllowlist`:** both verify constructors take an allowlist (`nil` skips policy for tests/lazy use). Prefer a non-nil allowlist when `keyid` can select among keys.
1617
- **`NewJWSSigner`:** nil config defaults to `SignAlg(false)`; configs with `SignAlg(true)` are rejected.
@@ -24,7 +25,7 @@ Copy the **Summary** section below into the GitHub release when tagging `v0.6.1`
2425
|---------|--------|
2526
| **Native only** | No API changes. |
2627
| **`NewJWSVerifier(alg, key, …)`** | Prefer `NewJWSVerifier(allowed, key, …)` when the key is inferrable; else `NewJWSVerifierWithAlg(allowed, alg, key, …)`. |
27-
| **`NewJWSSigner`** | Omit config or keep `SignAlg(false)`; `SignAlg(true)` now errors. |
28+
| **`NewJWSSigner`** | Omit config or keep `SignAlg(false)`; `SignAlg(true)` now errors. Prefer `NewJWSSignerFromJWK` when the private key is a JWK. |
2829
| **HTTP `SetAllowedAlgs`** | Unchanged — Signature-Input `alg` only, not JWS `jwa`. |
2930
| **Response `;req` fields** | Prefer `AddRequestComponent("@method")` (etc.) over `AddHeaderExt(..., false, false, true, false)`. |
3031
| **Locate signature by `tag`** | Prefer `RequestDetailsByTag` / `ResponseDetailsByTag`, then `Verify*` on `details.Label` (see below). |
@@ -54,6 +55,8 @@ priv, _ := mldsa.GenerateKey(mldsa.MLDSA65())
5455
pub := priv.Public().(*mldsa.PublicKey)
5556
allowed, _ := httpsign.NewJWSAlgAllowlist(jwa.MLDSA65())
5657
signer, _ := httpsign.NewJWSSigner(jwa.MLDSA65(), priv, nil, fields)
58+
// or, when the private key is a JWK:
59+
// signer, _ := httpsign.NewJWSSignerFromJWK(privJWK, nil, fields)
5760
verifier, _ := httpsign.NewJWSVerifier(allowed, pub, httpsign.NewVerifyConfig(), fields)
5861
```
5962

0 commit comments

Comments
 (0)