1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
|
// Copyright 2024 OpenPubkey
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0
package gq
import (
"crypto/rand"
"crypto/rsa"
"encoding/json"
"testing"
"time"
"github.com/lestrrat-go/jwx/v2/jwa"
"github.com/lestrrat-go/jwx/v2/jws"
"github.com/openpubkey/openpubkey/util"
"github.com/stretchr/testify/require"
)
func TestSignVerifyJWT(t *testing.T) {
oidcPrivKey, err := rsa.GenerateKey(rand.Reader, 2048)
require.NoError(t, err)
oidcPubKey := &oidcPrivKey.PublicKey
idToken, err := createOIDCToken(oidcPrivKey, "test")
require.NoError(t, err)
signerVerifier, err := NewSignerVerifier(oidcPubKey, 256)
require.NoError(t, err)
gqToken, err := signerVerifier.SignJWT(idToken)
require.NoError(t, err)
ok := signerVerifier.VerifyJWT(gqToken)
require.True(t, ok, "signature verification failed")
}
func TestGQ256SignJWT(t *testing.T) {
oidcPrivKey, err := rsa.GenerateKey(rand.Reader, 2048)
require.NoError(t, err)
idToken, err := createOIDCToken(oidcPrivKey, "test")
require.NoError(t, err)
gqToken1, err := GQ256SignJWT(&oidcPrivKey.PublicKey, idToken)
require.NoError(t, err)
ok, err := GQ256VerifyJWT(&oidcPrivKey.PublicKey, gqToken1)
require.NoError(t, err)
require.True(t, ok)
// Test that we throw the correct error if the wrong RSA public key is sent to SignJWT
oidcPrivKeyWrong, err := rsa.GenerateKey(rand.Reader, 2048)
require.NoError(t, err)
require.NotEqual(t, oidcPrivKey, oidcPrivKeyWrong)
gqToken2, err := GQ256SignJWT(&oidcPrivKeyWrong.PublicKey, idToken)
require.EqualError(t, err, "incorrect public key supplied when GQ signing jwt: could not verify message using any of the signatures or keys")
require.Nil(t, gqToken2)
// Test specifying with extra claims
expKey1 := "key1" // Expected claim keys, values
expValue1 := "value1"
expKey2 := "key2"
expValue2 := "value2"
gqTokenExtraClaims, err := GQ256SignJWT(&oidcPrivKey.PublicKey, idToken,
WithExtraClaim(expKey1, expValue1),
WithExtraClaim(expKey2, expValue2))
require.NoError(t, err)
retValue1, ok, err := getClaimInProtected(expKey1, gqTokenExtraClaims)
require.NoError(t, err)
require.True(t, ok)
require.Equal(t, expValue1, retValue1)
retValue2, ok, err := getClaimInProtected(expKey2, gqTokenExtraClaims)
require.NoError(t, err)
require.True(t, ok)
require.Equal(t, expValue2, retValue2)
// Test that we don't find a claim we didn't add
retClaimValue, ok, err := getClaimInProtected("noSuchKey", gqTokenExtraClaims)
require.NoError(t, err)
require.False(t, ok, "we didn't add this claim, yet somehow it was in the protected header")
require.Nil(t, retClaimValue)
// Test that we throw the correct error if reserved header is used
gqTokenReservedClaim, err := GQ256SignJWT(&oidcPrivKey.PublicKey, idToken,
WithExtraClaim("alg", "ES256"))
require.Error(t, err, "use of reserved claim name, alg, should throw an error")
require.EqualError(t, err,
"error creating GQ signature: use of reserved header name, alg, in additional headers",
"incorrect error throw")
require.Nil(t, gqTokenReservedClaim)
}
func TestVerifyModifiedIdPayload(t *testing.T) {
oidcPrivKey, err := rsa.GenerateKey(rand.Reader, 2048)
require.NoError(t, err)
oidcPubKey := &oidcPrivKey.PublicKey
idToken, err := createOIDCToken(oidcPrivKey, "test")
require.NoError(t, err)
// modify the ID Token payload to detect IdP signature invalidity via GQ verify
modifiedToken, err := modifyTokenPayload(idToken, "fail")
require.NoError(t, err)
_, err = jws.Verify(modifiedToken, jws.WithKey(jwa.RS256, oidcPubKey))
require.Error(t, err, "ID token signature should fail for modified token")
signerVerifier, err := NewSignerVerifier(oidcPubKey, 256)
require.NoError(t, err)
gqToken, err := signerVerifier.SignJWT(modifiedToken)
require.NoError(t, err)
ok := signerVerifier.VerifyJWT(gqToken)
require.False(t, ok, "GQ signature verification passed for invalid payload")
}
func TestVerifyModifiedGqPayload(t *testing.T) {
oidcPrivKey, err := rsa.GenerateKey(rand.Reader, 2048)
require.NoError(t, err)
oidcPubKey := &oidcPrivKey.PublicKey
idToken, err := createOIDCToken(oidcPrivKey, "test")
require.NoError(t, err)
signerVerifier, err := NewSignerVerifier(oidcPubKey, 256)
require.NoError(t, err)
gqToken, err := signerVerifier.SignJWT(idToken)
require.NoError(t, err)
// modify the ID Token payload to detect GQ signature invalidity
modifiedToken, err := modifyTokenPayload(gqToken, "fail")
require.NoError(t, err)
ok := signerVerifier.VerifyJWT(modifiedToken)
require.False(t, ok, "GQ signature verification passed for invalid payload")
}
func TestRejectUnsupportedPublicKey(t *testing.T) {
oidcPrivKey, err := rsa.GenerateKey(rand.Reader, 2048)
require.NoError(t, err)
oidcPrivKey.E = 3
oidcPubKey := &oidcPrivKey.PublicKey
signerVerifier, err := NewSignerVerifier(oidcPubKey, 256)
require.ErrorContains(t, err, "only 65537 is currently supported, unsupported RSA public key exponent")
require.Nil(t, signerVerifier)
}
func modifyTokenPayload(token []byte, audience string) ([]byte, error) {
headers, _, signature, err := jws.SplitCompact(token)
if err != nil {
return nil, err
}
newPayload := map[string]any{
"sub": "1",
"iss": "test",
"aud": audience,
"iat": time.Now().Unix(),
}
modifiedPayload, err := json.Marshal(newPayload)
if err != nil {
return nil, err
}
newToken := util.JoinJWTSegments(headers, util.Base64EncodeForJWT(modifiedPayload), signature)
return newToken, nil
}
func createOIDCToken(oidcPrivKey *rsa.PrivateKey, audience string) ([]byte, error) {
alg := jwa.RS256 // RSASSA-PKCS-v1.5 using SHA-256
oidcHeader := jws.NewHeaders()
err := oidcHeader.Set(jws.AlgorithmKey, alg)
if err != nil {
return nil, err
}
err = oidcHeader.Set(jws.TypeKey, "JWT")
if err != nil {
return nil, err
}
oidcPayload := map[string]any{
"sub": "1",
"iss": "test",
"aud": audience,
"iat": time.Now().Unix(),
}
payloadBytes, err := json.Marshal(oidcPayload)
if err != nil {
return nil, err
}
return jws.Sign(
payloadBytes,
jws.WithKey(
alg,
oidcPrivKey,
jws.WithProtectedHeaders(oidcHeader),
),
)
}
func getClaimInProtected(claimKey string, token []byte) (any, bool, error) {
headersB64, _, _, err := jws.SplitCompact(token)
if err != nil {
return nil, false, err
}
headersJson, err := util.Base64DecodeForJWT(headersB64)
if err != nil {
return nil, false, err
}
headers := jws.NewHeaders()
err = json.Unmarshal(headersJson, &headers)
if err != nil {
return nil, false, err
}
claimValue, ok := headers.Get(claimKey)
return claimValue, ok, nil
}
|