jwt_signer_test.go

// Copyright 2024 Thales Group
//
// Permission is hereby granted, free of charge, to any person obtaining
// a copy of this software and associated documentation files (the
// "Software"), to deal in the Software without restriction, including
// without limitation the rights to use, copy, modify, merge, publish,
// distribute, sublicense, and/or sell copies of the Software, and to
// permit persons to whom the Software is furnished to do so, subject to
// the following conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package gose

import (
	"encoding/base64"
	"encoding/json"
	"errors"
	"strings"
	"testing"

	"github.com/ThalesGroup/gose/jose"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/mock"
	"github.com/stretchr/testify/require"
)

func TestNewJwtSigner(t *testing.T) {
	// Setup
	mockedKey := MockedSigner{}
	// Act and Assert
	assert.NotNil(t, NewJwtSigner("issuer", &mockedKey))
}

func TestJwtSignerImpl_Sign(t *testing.T) {
	// Setup
	expectedSignature := []byte{1, 2, 3, 4}
	mockedKey := MockedSigner{}
	mockedKey.On("Kid").Return("keyid")
	mockedKey.On("Algorithm").Return(jose.AlgPS256)
	mockedKey.On("Sign", jose.KeyOpsSign, mock.AnythingOfType("[]uint8")).Return(expectedSignature, nil)
	signer := NewJwtSigner("issuer", &mockedKey)
	claims := jose.SettableJwtClaims{
		Audiences: jose.Audiences{Aud: []string{"audience"}},
		Subject:   "subject",
	}
	untyped := map[string]interface{}{
		"name": "John Doe",
	}

	// Act
	jwt, err := signer.Sign(&claims, untyped)

	// Assert
	require.NotEmpty(t, jwt)
	assert.NoError(t, err)

	parts := strings.Split(jwt, ".")
	require.Len(t, parts, 3)

	// header verification
	var header jose.JwsHeader
	require.NoError(t, err)
	headerBytes, err := base64.RawURLEncoding.DecodeString(parts[0])
	require.NoError(t, err)
	err = json.Unmarshal(headerBytes, &header)
	assert.NoError(t, err)
	assert.Equal(t, jose.AlgPS256, header.Alg)
	assert.Equal(t, jose.JwtType, header.Typ)
	assert.Equal(t, "keyid", header.Kid)
	assert.Empty(t, header.Crit)

	// MarshalBody verification
	var recoveredClaims jose.JwtClaims
	claimsBytes, err := base64.RawURLEncoding.DecodeString(parts[1])
	err = json.Unmarshal(claimsBytes, &recoveredClaims)
	require.NoError(t, err)
	assert.Equal(t, claims.Audiences, recoveredClaims.Audiences)
	assert.Equal(t, "issuer", recoveredClaims.Issuer)
	assert.Equal(t, claims.Subject, recoveredClaims.Subject)
	assert.Len(t, recoveredClaims.UntypedClaims, 1)
	var name string
	err = recoveredClaims.UnmarshalCustomClaim("name", &name)
	require.NoError(t, err)
	assert.Equal(t, "John Doe", name)

	// Signature check
	rawSignature, err := base64.RawURLEncoding.DecodeString(parts[2])
	require.NoError(t, err)
	assert.Equal(t, expectedSignature, rawSignature)
}

func TestJwtSignerImpl_Sign_FailsWhenSigningFails(t *testing.T) {
	// Setup
	expectedError := errors.New("Expected")
	mockedKey := MockedSigner{}
	mockedKey.On("Kid").Return("keyid")
	mockedKey.On("Algorithm").Return(jose.AlgPS256)
	mockedKey.On("Sign", jose.KeyOpsSign, mock.AnythingOfType("[]uint8")).Return(nil, expectedError)
	signer := NewJwtSigner("issuer", &mockedKey)
	claims := jose.SettableJwtClaims{
		Audiences: jose.Audiences{Aud: []string{"audience"}},
		Subject:   "subject",
	}

	// Act
	jwt, err := signer.Sign(&claims, nil)

	// Assert
	require.Empty(t, jwt)
	assert.Equal(t, err, expectedError)
}