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 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
|
package jwtsvid_test
import (
"crypto"
"crypto/ecdsa"
"crypto/ed25519"
"crypto/elliptic"
"crypto/rand"
"crypto/rsa"
"fmt"
"testing"
"time"
"github.com/go-jose/go-jose/v4"
"github.com/go-jose/go-jose/v4/cryptosigner"
"github.com/go-jose/go-jose/v4/jwt"
"github.com/spiffe/go-spiffe/v2/bundle/jwtbundle"
"github.com/spiffe/go-spiffe/v2/spiffeid"
"github.com/spiffe/go-spiffe/v2/svid/jwtsvid"
"github.com/stretchr/testify/require"
)
const hs256Token = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG" +
"4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
var (
key1, _ = ecdsa.GenerateKey(elliptic.P384(), rand.Reader)
key2, _ = rsa.GenerateKey(rand.Reader, 2048)
testAllowedSignatureAlgorithms = []jose.SignatureAlgorithm{
jose.RS256,
jose.RS384,
jose.RS512,
jose.ES256,
jose.ES384,
jose.ES512,
jose.PS256,
jose.PS384,
jose.PS512,
}
)
func TestParseAndValidate(t *testing.T) {
// Create numeric dates
issuedAt := jwt.NewNumericDate(time.Now())
expiresTime := time.Now().Add(time.Minute)
expires := jwt.NewNumericDate(expiresTime)
// Create trust domain
trustDomain1 := spiffeid.RequireTrustDomainFromString("trustdomain")
// Create a bundle and add keys
bundle1 := jwtbundle.New(trustDomain1)
err := bundle1.AddJWTAuthority("authority1", key1.Public())
require.NoError(t, err)
err = bundle1.AddJWTAuthority("authority2", key2.Public())
require.NoError(t, err)
testCases := []struct {
name string
bundle *jwtbundle.Bundle
audience []string
generateToken func(testing.TB) string
err string
svid *jwtsvid.SVID
}{
{
name: "success",
bundle: bundle1,
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "authority1")
},
svid: &jwtsvid.SVID{
ID: spiffeid.RequireFromPath(trustDomain1, "/host"),
Audience: []string{"audience"},
Expiry: expiresTime,
},
},
{
name: "malformed",
bundle: bundle1,
generateToken: func(tb testing.TB) string {
return "invalid token"
},
err: "jwtsvid: unable to parse JWT token",
},
{
name: "unsupported algorithm",
bundle: bundle1,
generateToken: func(tb testing.TB) string {
return hs256Token
},
err: "jwtsvid: unable to parse JWT token",
},
{
name: "missing subject",
bundle: bundle1,
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "authority1")
},
err: "jwtsvid: token missing subject claim",
},
{
name: "missing expiration claim",
bundle: bundle1,
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "authority1")
},
err: "jwtsvid: token missing exp claim",
},
{
name: "expired",
bundle: bundle1,
audience: []string{"audience"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: jwt.NewNumericDate(time.Now().Add(-1 * time.Minute)),
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "authority1")
},
err: "jwtsvid: token has expired",
},
{
name: "unexpected audience",
bundle: bundle1,
audience: []string{"another"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "authority1")
},
err: `jwtsvid: expected audience in ["another"] (audience=["audience"])`,
},
{
name: "invalid subject claim",
bundle: bundle1,
audience: []string{"audience"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: "invalid subject",
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "authority1")
},
err: `jwtsvid: token has an invalid subject claim: scheme is missing or invalid`,
},
{
name: "missing key",
bundle: bundle1,
audience: []string{"audience"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "")
},
err: "jwtsvid: token header missing key id",
},
{
name: "no bundle for trust domain",
bundle: bundle1,
audience: []string{"audience"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: "spiffe://another.domain/host",
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "noAuthority")
},
err: `jwtsvid: no bundle found for trust domain "another.domain"`,
},
{
name: "no bundle for authority",
bundle: bundle1,
audience: []string{"audience"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "noKey")
},
err: `jwtsvid: no JWT authority "noKey" found for trust domain "trustdomain"`,
},
{
name: "mismatched JWT authority",
bundle: bundle1,
audience: []string{"audience"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key2, "authority1")
},
err: "jwtsvid: unable to get claims from token: go-jose/go-jose: error in cryptographic primitive",
},
}
for _, testCase := range testCases {
t.Run(testCase.name, func(t *testing.T) {
// Generate token
token := testCase.generateToken(t)
// Parse and validate
svid, err := jwtsvid.ParseAndValidate(token, testCase.bundle, testCase.audience)
// Verify returned error, in case it is expected
if testCase.err != "" {
require.EqualError(t, err, testCase.err)
return
}
require.NoError(t, err)
// Verify returned svid
require.Equal(t, testCase.svid.ID, svid.ID)
require.Equal(t, testCase.svid.Expiry.Unix(), svid.Expiry.Unix())
require.Equal(t, testCase.svid.Audience, svid.Audience)
claims := parseToken(t, token)
require.Equal(t, claims, svid.Claims)
})
}
}
func TestParseInsecure(t *testing.T) {
// Create numeric dates
issuedAt := jwt.NewNumericDate(time.Now())
expiresTime := time.Now().Add(time.Minute)
expires := jwt.NewNumericDate(expiresTime)
// Create trust domain
trustDomain1 := spiffeid.RequireTrustDomainFromString("trustdomain")
testCases := []struct {
name string
audience []string
generateToken func(testing.TB) string
err string
svid *jwtsvid.SVID
}{
{
name: "success",
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "key1")
},
svid: &jwtsvid.SVID{
ID: spiffeid.RequireFromPath(trustDomain1, "/host"),
Audience: []string{"audience"},
Expiry: expiresTime,
},
},
{
name: "malformed",
generateToken: func(tb testing.TB) string {
return "invalid token"
},
err: "jwtsvid: unable to parse JWT token",
},
{
name: "invalid algorithm",
generateToken: func(tb testing.TB) string {
return hs256Token
},
err: "jwtsvid: unable to parse JWT token",
},
{
name: "missing subject claim",
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "key1")
},
err: "jwtsvid: token missing subject claim",
},
{
name: "missing expiration claim",
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "key1")
},
err: "jwtsvid: token missing exp claim",
},
{
name: "expired",
audience: []string{"audience"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: jwt.NewNumericDate(time.Now().Add(-1 * time.Minute)),
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "key1")
},
err: "jwtsvid: token has expired",
},
{
name: "unexpected audience",
audience: []string{"another"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "key1")
},
err: `jwtsvid: expected audience in ["another"] (audience=["audience"])`,
},
{
name: "invalid subject claim",
audience: []string{"audience"},
generateToken: func(tb testing.TB) string {
claims := jwt.Claims{
Subject: "invalid subject",
Issuer: "issuer",
Expiry: expires,
Audience: []string{"audience"},
IssuedAt: issuedAt,
}
return generateToken(tb, claims, key1, "key1")
},
err: `jwtsvid: token has an invalid subject claim: scheme is missing or invalid`,
},
}
for _, testCase := range testCases {
t.Run(testCase.name, func(t *testing.T) {
// Create token
token := testCase.generateToken(t)
// Call ParseInsecure
svid, err := jwtsvid.ParseInsecure(token, testCase.audience)
// Verify returned error, in case it is expected
if testCase.err != "" {
require.EqualError(t, err, testCase.err)
return
}
require.NoError(t, err)
// Verify SVID
require.Equal(t, testCase.svid.ID, svid.ID)
require.Equal(t, testCase.svid.Expiry.Unix(), svid.Expiry.Unix())
require.Equal(t, testCase.svid.Audience, svid.Audience)
claims := parseToken(t, token)
require.Equal(t, claims, svid.Claims)
})
}
}
func TestMarshal(t *testing.T) {
// Generate trust domain
trustDomain1 := spiffeid.RequireTrustDomainFromString("trustdomain")
// Generate Token
claims := jwt.Claims{
Subject: spiffeid.RequireFromPath(trustDomain1, "/host").String(),
Issuer: "issuer",
Expiry: jwt.NewNumericDate(time.Now()),
Audience: []string{"audience"},
IssuedAt: jwt.NewNumericDate(time.Now().Add(time.Minute)),
}
token := generateToken(t, claims, key1, "key1")
// Create SVID
svid, err := jwtsvid.ParseInsecure(token, []string{"audience"})
require.NoError(t, err)
// Validate token is returned
require.Equal(t, token, svid.Marshal())
// Update SVID does not affect token
svid.ID = spiffeid.RequireFromPath(trustDomain1, "/host2")
require.Equal(t, token, svid.Marshal())
// Empty Marshall when no token
svid = &jwtsvid.SVID{}
require.Empty(t, svid.Marshal())
}
func parseToken(t testing.TB, token string) map[string]interface{} {
tok, err := jwt.ParseSigned(token, testAllowedSignatureAlgorithms)
require.NoError(t, err)
claimsMap := make(map[string]interface{})
err = tok.UnsafeClaimsWithoutVerification(&claimsMap)
require.NoError(t, err)
return claimsMap
}
// Generate generates a signed string token
func generateToken(tb testing.TB, claims jwt.Claims, signer crypto.Signer, keyID string) string {
// Get signer algorithm
alg, err := getSignerAlgorithm(signer)
require.NoError(tb, err)
// Create signer using crypto.Signer and its algorithm along with provided key ID
jwtSigner, err := jose.NewSigner(
jose.SigningKey{
Algorithm: alg,
Key: jose.JSONWebKey{
Key: cryptosigner.Opaque(signer),
KeyID: keyID,
},
},
new(jose.SignerOptions).WithType("JWT"),
)
require.NoError(tb, err)
// Sign and serialize token
token, err := jwt.Signed(jwtSigner).Claims(claims).Serialize()
require.NoError(tb, err)
return token
}
// getSignerAlgorithm deduces signer algorithm and return it
func getSignerAlgorithm(signer crypto.Signer) (jose.SignatureAlgorithm, error) {
switch publicKey := signer.Public().(type) {
case *rsa.PublicKey:
// Prevent the use of keys smaller than 2048 bits
if publicKey.Size() < 256 {
return "", fmt.Errorf("unsupported RSA key size: %d", publicKey.Size())
}
return jose.RS256, nil
case *ecdsa.PublicKey:
params := publicKey.Params()
switch params.BitSize {
case 256:
return jose.ES256, nil
case 384:
return jose.ES384, nil
default:
return "", fmt.Errorf("unable to determine signature algorithm for EC public key size %d", params.BitSize)
}
case ed25519.PublicKey:
return jose.EdDSA, nil
default:
return "", fmt.Errorf("unable to determine signature algorithm for public key type %T", publicKey)
}
}
|