Files
wonderwall/pkg/openid/client/client_test.go
Trong Huu Nguyen da69847027 feat(openid): add opt-in toggle for typ header in accordance with RFC7523bis
Some providers require that the `typ` header has a value exactly equal
to `client-authentication+jwt` in accordance with changes introduced by
RFC7523bis.

This commit allows for opting in to setting the `typ` header with this new value.

The default behaviour is to use the previous de facto standard value, `JWT`.
Once the changes in RFC7523bis lands in the affected standards and
identity providers start supporting the new `typ` header (Entra ID being
notable for not supporting this as of this commit), we will default to
use `client-authentication+jwt`.
2025-08-26 08:29:27 +02:00

133 lines
3.5 KiB
Go

package client_test
import (
"encoding/base64"
"encoding/json"
"strings"
"testing"
"time"
"github.com/lestrrat-go/jwx/v3/jwa"
"github.com/lestrrat-go/jwx/v3/jws"
"github.com/lestrrat-go/jwx/v3/jwt"
"github.com/stretchr/testify/assert"
"github.com/nais/wonderwall/pkg/mock"
"github.com/nais/wonderwall/pkg/openid/client"
)
func TestClientAuthenticationAssertion(t *testing.T) {
cfg := mock.Config()
cfg.OpenID.ClientID = "some-client-id"
openidConfig := mock.NewTestConfiguration(cfg)
openidConfig.TestProvider.SetIssuer("some-issuer")
c := newTestClientWithConfig(openidConfig)
expiry := 30 * time.Second
jwtAssertion, err := c.ClientAuthenticationAssertion(expiry)
assert.NoError(t, err)
assertFlattenedAudience(t, jwtAssertion)
key := openidConfig.Client().ClientJWK()
publicKey, err := key.PublicKey()
assert.NoError(t, err)
alg, ok := publicKey.Algorithm()
assert.True(t, ok)
opts := []jwt.ParseOption{
jwt.WithKey(alg, publicKey),
jwt.WithRequiredClaim(jwt.IssuedAtKey),
jwt.WithRequiredClaim(jwt.ExpirationKey),
jwt.WithRequiredClaim(jwt.JwtIDKey),
}
assertion, err := jwt.ParseString(jwtAssertion, opts...)
assert.NoError(t, err)
aud, ok := assertion.Audience()
assert.True(t, ok)
assert.ElementsMatch(t, []string{"some-issuer"}, aud)
iss, ok := assertion.Issuer()
assert.True(t, ok)
assert.Equal(t, "some-client-id", iss)
sub, ok := assertion.Subject()
assert.True(t, ok)
assert.Equal(t, "some-client-id", sub)
iat, ok := assertion.IssuedAt()
assert.True(t, ok)
assert.True(t, iat.Before(time.Now()))
exp, ok := assertion.Expiration()
assert.True(t, ok)
assert.True(t, exp.After(time.Now()))
assert.True(t, exp.Before(time.Now().Add(expiry)))
msg, err := jws.ParseString(jwtAssertion)
assert.NoError(t, err)
assert.Len(t, msg.Signatures(), 1)
headers := msg.Signatures()[0].ProtectedHeaders()
typ, ok := headers.Type()
assert.True(t, ok)
assert.Equal(t, "JWT", typ)
alg, ok = headers.Algorithm()
assert.True(t, ok)
assert.Equal(t, jwa.RS256(), alg)
expectedKid, ok := key.KeyID()
assert.True(t, ok)
kid, ok := headers.KeyID()
assert.True(t, ok)
assert.Equal(t, expectedKid, kid)
}
func TestClientAuthenticationAssertionHeader(t *testing.T) {
cfg := mock.Config()
cfg.OpenID.ClientID = "some-client-id"
cfg.OpenID.NewClientAuthJWTType = true
openidConfig := mock.NewTestConfiguration(cfg)
openidConfig.TestProvider.SetIssuer("some-issuer")
c := newTestClientWithConfig(openidConfig)
expiry := 30 * time.Second
jwtAssertion, err := c.ClientAuthenticationAssertion(expiry)
assert.NoError(t, err)
msg, err := jws.ParseString(jwtAssertion)
assert.NoError(t, err)
assert.Len(t, msg.Signatures(), 1)
headers := msg.Signatures()[0].ProtectedHeaders()
typ, ok := headers.Type()
assert.True(t, ok)
assert.Equal(t, "client-authentication+jwt", typ)
}
// assertFlattenedAudience asserts that the raw JWT assertion has a flattened audience claim, i.e. aud is a string value.
// We do this as the jwx library only exposes the audience as a slice of strings for parsed JWTs.
func assertFlattenedAudience(t *testing.T, jwtAssertion string) {
parts := strings.Split(jwtAssertion, ".")
assert.Len(t, parts, 3)
rawClaims, err := base64.RawURLEncoding.DecodeString(parts[1])
assert.NoError(t, err)
claims := make(map[string]any)
err = json.Unmarshal(rawClaims, &claims)
assert.NoError(t, err)
assert.Equal(t, "some-issuer", claims["aud"])
}
func newTestClientWithConfig(config *mock.TestConfiguration) *client.Client {
jwksProvider := mock.NewTestJwksProvider()
return client.NewClient(config, jwksProvider)
}