Skip to content

Let callers set other JWK fields when converting privateKey #22

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
leelynne merged 1 commit into from
May 29, 2025
Merged

Let callers set other JWK fields when converting privateKey #22

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
17 changes: 11 additions & 6 deletions keyutil/jwk.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,24 @@ func ReadJWK(jwkBytes []byte) (JWK, error) {
}, nil
}

// ReadJWKFromPEM converts a PEM encoded private key to JWK
func ReadJWKFromPEM(pkeyBytes []byte) (JWK, error) {
// ReadJWKFromPEM converts a PEM encoded private key to JWK. Use 'fields' to set additional fields like kty, and kid. alg is set based on the passed in PrivateKey.
func ReadJWKFromPEM(fields JWK, pkeyBytes []byte) (JWK, error) {
pkey, err := ReadPrivateKey(pkeyBytes)
if err != nil {
return JWK{}, err
}
return FromPrivateKey(pkey)
return FromPrivateKey(fields, pkey)
}

func FromPrivateKey(pkey crypto.PrivateKey) (JWK, error) {
// FromPrivateKey creates a JWK from a crypto.PrivateKey. Use 'fields' to set additional fields like kty, and kid. alg is set based on the passed in PrivateKey.
func FromPrivateKey(fields JWK, pkey crypto.PrivateKey) (JWK, error) {
switch key := pkey.(type) {
case *ecdsa.PrivateKey:
jwk := jwkEC{
jwk: jwk{
KeyType: "EC",
Algo: fields.Algorithm,
KeyID: fields.KeyID,
},
Curve: key.Curve.Params().Name,
X: octet{key.X},
Expand All @@ -59,8 +62,10 @@ func FromPrivateKey(pkey crypto.PrivateKey) (JWK, error) {
return JWK{}, fmt.Errorf("Error marshalling JWK: %w", err)
}
return JWK{
KeyType: "EC",
raw: out,
KeyType: "EC",
Algorithm: fields.Algorithm,
KeyID: fields.KeyID,
raw: out,
}, nil
default:
return JWK{}, fmt.Errorf("Unsupported private key type '%T'", pkey)
Expand Down
10 changes: 8 additions & 2 deletions keyutil/jwk_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,12 @@ func TestJWKMarshalRoundTrip(t *testing.T) {
name string
inputType string
expectedErrContains string
keyid string
}{
{
name: "EC Key Round Trip",
inputType: "EC",
keyid: "mykey_123",
},
}

Expand All @@ -95,7 +97,10 @@ func TestJWKMarshalRoundTrip(t *testing.T) {
t.Fatal(err)
}
}
original, err := FromPrivateKey(pk)
original, err := FromPrivateKey(JWK{
KeyID: tc.keyid,
}, pk)

if err != nil {
if tc.expectedErrContains != "" {
if !strings.Contains(err.Error(), tc.expectedErrContains) {
Expand All @@ -120,11 +125,12 @@ func TestJWKMarshalRoundTrip(t *testing.T) {

// Compare original and round-tripped JWKs
Diff(t, original, roundTripped, "Round-tripped JWK differs from original", cmpopts.IgnoreUnexported(JWK{}))
Diff(t, tc.keyid, roundTripped.KeyID, "Round-tripped JWK differs from original", cmpopts.IgnoreUnexported(JWK{}))
})
}
}

func Diff(t *testing.T, expected, actual interface{}, msg string, opts ...cmp.Option) bool {
func Diff(t *testing.T, expected, actual any, msg string, opts ...cmp.Option) bool {
if diff := cmp.Diff(expected, actual, opts...); diff != "" {
t.Errorf("%s (-want +got):\n%s", msg, diff)
return true
Expand Down