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 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
|
// Copyright The Notary Project Authors.
// 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.
package base
import (
"crypto/x509"
"errors"
"reflect"
"testing"
"time"
"github.com/notaryproject/notation-core-go/signature"
"github.com/notaryproject/notation-core-go/testhelper"
"github.com/notaryproject/tspclient-go"
)
var (
errMsg = "error msg"
invalidTimestamper tspclient.Timestamper
invalidSigningAgent = "test/1"
validSigningAgent = "test/0"
invalidContentType = "text/plain"
validContentType = "application/vnd.cncf.notary.payload.v1+json"
validContent = "test content"
validBytes = []byte(validContent)
time08_02 time.Time
time08_03 time.Time
timeLayout = "2006-01-02"
signiningSchema = signature.SigningScheme("notary.x509")
validSignerInfo = &signature.SignerInfo{
Signature: validBytes,
SignatureAlgorithm: signature.AlgorithmPS384,
SignedAttributes: signature.SignedAttributes{
SigningTime: testhelper.GetRSALeafCertificate().Cert.NotBefore,
Expiry: testhelper.GetECLeafCertificate().Cert.NotAfter,
SigningScheme: signiningSchema,
},
CertificateChain: []*x509.Certificate{
testhelper.GetRSALeafCertificate().Cert,
testhelper.GetRSARootCertificate().Cert,
},
}
validPayload = &signature.Payload{
ContentType: validContentType,
Content: validBytes,
}
validEnvelopeContent = &signature.EnvelopeContent{
SignerInfo: *validSignerInfo,
Payload: *validPayload,
}
validReq = &signature.SignRequest{
Payload: signature.Payload{
ContentType: validContentType,
Content: validBytes,
},
SigningTime: testhelper.GetRSALeafCertificate().Cert.NotBefore,
Expiry: testhelper.GetRSALeafCertificate().Cert.NotAfter,
SigningScheme: signiningSchema,
Signer: &mockSigner{
keySpec: signature.KeySpec{
Type: signature.KeyTypeRSA,
Size: 3072,
},
certs: []*x509.Certificate{
testhelper.GetRSALeafCertificate().Cert,
testhelper.GetRSARootCertificate().Cert,
},
},
SigningAgent: validSigningAgent,
}
signReq1 = &signature.SignRequest{
Payload: signature.Payload{
ContentType: validContentType,
Content: validBytes,
},
SigningTime: testhelper.GetRSALeafCertificate().Cert.NotBefore,
Expiry: testhelper.GetRSALeafCertificate().Cert.NotAfter,
SigningScheme: signiningSchema,
Signer: &mockSigner{
keySpec: signature.KeySpec{
Type: signature.KeyTypeRSA,
Size: 3072,
},
certs: []*x509.Certificate{
testhelper.GetRSALeafCertificate().Cert,
testhelper.GetRSARootCertificate().Cert,
},
},
SigningAgent: invalidSigningAgent,
}
reqWithInvalidTSAurl = &signature.SignRequest{
Payload: signature.Payload{
ContentType: validContentType,
Content: validBytes,
},
SigningTime: testhelper.GetRSALeafCertificate().Cert.NotBefore,
Expiry: testhelper.GetRSALeafCertificate().Cert.NotAfter,
SigningScheme: signiningSchema,
Signer: &mockSigner{
keySpec: signature.KeySpec{
Type: signature.KeyTypeRSA,
Size: 3072,
},
certs: []*x509.Certificate{
testhelper.GetRSALeafCertificate().Cert,
testhelper.GetRSARootCertificate().Cert,
},
},
SigningAgent: validSigningAgent,
Timestamper: invalidTimestamper,
}
)
func init() {
time08_02, _ = time.Parse(timeLayout, "2020-08-02")
time08_03, _ = time.Parse(timeLayout, "2020-08-03")
invalidTimestamper, _ = tspclient.NewHTTPTimestamper(nil, "invalid")
}
// Mock an internal envelope that implements signature.Envelope.
type mockEnvelope struct {
payload *signature.Payload
signerInfo *signature.SignerInfo
content *signature.EnvelopeContent
failTimestamp bool
failVerify bool
}
// Sign implements Sign of signature.Envelope.
func (e mockEnvelope) Sign(req *signature.SignRequest) ([]byte, error) {
switch req.SigningAgent {
case invalidSigningAgent:
return nil, errors.New(errMsg)
case validSigningAgent:
if e.failTimestamp {
return validBytes, &signature.TimestampError{}
}
return validBytes, nil
}
return nil, nil
}
// Verify implements Verify of signature.Envelope.
func (e mockEnvelope) Verify() (*signature.EnvelopeContent, error) {
if e.failVerify {
return nil, errors.New(errMsg)
}
return e.content, nil
}
// SignerInfo implements SignerInfo of signature.Envelope.
func (e mockEnvelope) Content() (*signature.EnvelopeContent, error) {
if e.content == nil {
return nil, errors.New(errMsg)
}
return e.content, nil
}
// Mock a signer implements signature.Signer.
type mockSigner struct {
certs []*x509.Certificate
keySpec signature.KeySpec
}
// CertificateChain implements CertificateChain of signature.Signer.
func (s *mockSigner) CertificateChain() ([]*x509.Certificate, error) {
if len(s.certs) == 0 {
return nil, errors.New(errMsg)
}
return s.certs, nil
}
// Sign implements Sign of signature.Signer.
func (s *mockSigner) Sign(payload []byte) ([]byte, []*x509.Certificate, error) {
return nil, nil, nil
}
// KeySpec implements KeySpec of signature.Signer.
func (s *mockSigner) KeySpec() (signature.KeySpec, error) {
var emptyKeySpec signature.KeySpec
if s.keySpec == emptyKeySpec {
return s.keySpec, errors.New(errMsg)
}
return s.keySpec, nil
}
func TestSign(t *testing.T) {
tests := []struct {
name string
req *signature.SignRequest
env *Envelope
expect []byte
expectErr bool
}{
{
name: "invalid request",
req: &signature.SignRequest{
SigningTime: time08_02,
Expiry: time08_02,
},
env: &Envelope{
Raw: nil,
Envelope: mockEnvelope{},
},
expect: nil,
expectErr: true,
},
{
name: "internal envelope fails to sign",
req: signReq1,
env: &Envelope{
Raw: nil,
Envelope: mockEnvelope{},
},
expect: nil,
expectErr: true,
},
{
name: "internal envelope fails to get content",
req: validReq,
env: &Envelope{
Raw: nil,
Envelope: mockEnvelope{},
},
expect: nil,
expectErr: true,
},
{
name: "invalid certificate chain",
req: validReq,
env: &Envelope{
Raw: nil,
Envelope: mockEnvelope{
content: &signature.EnvelopeContent{},
},
},
expect: nil,
expectErr: true,
},
{
name: "successfully signed",
req: validReq,
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
content: &signature.EnvelopeContent{
SignerInfo: *validSignerInfo,
},
},
},
expect: validBytes,
expectErr: false,
},
{
name: "failed to timestamp",
req: reqWithInvalidTSAurl,
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
content: &signature.EnvelopeContent{
SignerInfo: *validSignerInfo,
},
failTimestamp: true,
},
},
expect: nil,
expectErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
sig, err := tt.env.Sign(tt.req)
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
if !reflect.DeepEqual(sig, tt.expect) {
t.Errorf("expect %+v, got %+v", tt.expect, sig)
}
if tt.name == "failed to timestamp" {
var timestampErr *signature.TimestampError
if !errors.As(err, ×tampErr) {
t.Fatal("expecting error to be signature.TimestampError")
}
expectedErrMsg := "timestamp error"
if timestampErr.Error() != expectedErrMsg {
t.Fatalf("expected error %s, but got %v", expectedErrMsg, err)
}
}
})
}
}
func TestVerify(t *testing.T) {
tests := []struct {
name string
env *Envelope
expectContent *signature.EnvelopeContent
expectErr bool
}{
{
name: "empty raw",
env: &Envelope{},
expectContent: nil,
expectErr: true,
},
{
name: "err returned by internal envelope",
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
failVerify: true,
payload: validPayload,
},
},
expectContent: nil,
expectErr: true,
},
{
name: "payload validation failed after internal envelope verfication",
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
content: &signature.EnvelopeContent{
Payload: signature.Payload{
ContentType: invalidContentType,
},
},
},
},
expectContent: nil,
expectErr: true,
},
{
name: "signerInfo validation failed after internal envelope verfication",
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
content: &signature.EnvelopeContent{
Payload: *validPayload,
SignerInfo: signature.SignerInfo{},
},
},
},
expectContent: nil,
expectErr: true,
},
{
name: "verify successfully",
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
content: &signature.EnvelopeContent{
Payload: *validPayload,
SignerInfo: *validSignerInfo,
},
},
},
expectContent: &signature.EnvelopeContent{
Payload: *validPayload,
SignerInfo: *validSignerInfo,
},
expectErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
content, err := tt.env.Verify()
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
if !reflect.DeepEqual(content, tt.expectContent) {
t.Errorf("expect content: %+v, got %+v", tt.expectContent, content)
}
})
}
}
func TestContent(t *testing.T) {
tests := []struct {
name string
env *Envelope
expect *signature.EnvelopeContent
expectErr bool
}{
{
name: "empty raw",
env: &Envelope{},
expect: nil,
expectErr: true,
},
{
name: "err returned by internal envelope",
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{},
},
expect: nil,
expectErr: true,
},
{
name: "invalid payload",
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
content: &signature.EnvelopeContent{
Payload: signature.Payload{},
},
},
},
expect: nil,
expectErr: true,
},
{
name: "valid payload and invalid signerInfo",
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
content: &signature.EnvelopeContent{
Payload: *validPayload,
},
signerInfo: &signature.SignerInfo{},
},
},
expect: nil,
expectErr: true,
},
{
name: "valid payload and valid signerInfo",
env: &Envelope{
Raw: validBytes,
Envelope: &mockEnvelope{
content: &signature.EnvelopeContent{
Payload: *validPayload,
SignerInfo: *validSignerInfo,
},
},
},
expect: validEnvelopeContent,
expectErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
content, err := tt.env.Content()
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
if !reflect.DeepEqual(content, tt.expect) {
t.Errorf("expect %+v, got %+v", tt.expect, content)
}
})
}
}
func TestValidateSignRequest(t *testing.T) {
tests := []struct {
name string
req *signature.SignRequest
expectErr bool
}{
{
name: "invalid payload",
req: &signature.SignRequest{},
expectErr: true,
},
{
name: "invalid signing time",
req: &signature.SignRequest{
Payload: signature.Payload{
ContentType: validContentType,
Content: validBytes,
},
},
expectErr: true,
},
{
name: "signer is nil",
req: &signature.SignRequest{
Payload: signature.Payload{
ContentType: validContentType,
Content: validBytes,
},
SigningTime: time08_02,
Expiry: time08_03,
},
expectErr: true,
},
{
name: "keySpec is empty",
req: &signature.SignRequest{
Payload: signature.Payload{
ContentType: validContentType,
Content: validBytes,
},
SigningTime: time08_02,
Expiry: time08_03,
SigningScheme: signiningSchema,
Signer: &mockSigner{
certs: []*x509.Certificate{
testhelper.GetRSALeafCertificate().Cert,
testhelper.GetRSARootCertificate().Cert,
},
keySpec: signature.KeySpec{},
},
},
expectErr: true,
},
{
name: "invalid signing schema",
req: &signature.SignRequest{
Payload: signature.Payload{
ContentType: validContentType,
Content: validBytes,
},
SigningTime: time08_02,
Expiry: time08_03,
Signer: &mockSigner{
keySpec: signature.KeySpec{
Type: signature.KeyTypeRSA,
Size: 3072,
},
certs: []*x509.Certificate{
testhelper.GetRSALeafCertificate().Cert,
testhelper.GetRSARootCertificate().Cert,
},
},
},
expectErr: true,
},
{
name: "valid request",
req: validReq,
expectErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := validateSignRequest(tt.req)
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
})
}
}
func TestValidateSignerInfo(t *testing.T) {
tests := []struct {
name string
info *signature.SignerInfo
expectErr bool
}{
{
name: "empty signature",
info: &signature.SignerInfo{},
expectErr: true,
},
{
name: "missing signature algorithm",
info: &signature.SignerInfo{
Signature: validBytes,
},
expectErr: true,
},
{
name: "invalid signing time",
info: &signature.SignerInfo{
Signature: validBytes,
SignatureAlgorithm: signature.AlgorithmPS256,
},
expectErr: true,
},
{
name: "invalid signing schema",
info: &signature.SignerInfo{
Signature: validBytes,
SignatureAlgorithm: signature.AlgorithmPS384,
SignedAttributes: signature.SignedAttributes{
SigningTime: testhelper.GetRSALeafCertificate().Cert.NotBefore,
Expiry: testhelper.GetECLeafCertificate().Cert.NotAfter,
},
},
expectErr: true,
},
{
name: "valid signerInfo",
info: validSignerInfo,
expectErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := validateSignerInfo(tt.info)
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
})
}
}
func TestValidateSigningTime(t *testing.T) {
tests := []struct {
name string
signingTime time.Time
expireTime time.Time
expectErr bool
}{
{
name: "zero signing time",
signingTime: time.Time{},
expireTime: time.Now(),
expectErr: true,
},
{
name: "no expire time",
signingTime: time.Now(),
expireTime: time.Time{},
expectErr: false,
},
{
name: "expireTime set but invalid",
signingTime: time08_03,
expireTime: time08_02,
expectErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := validateSigningAndExpiryTime(tt.signingTime, tt.expireTime)
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
})
}
}
func TestValidatePayload(t *testing.T) {
tests := []struct {
name string
payload *signature.Payload
expectErr bool
}{
{
name: "invalid payload content type",
payload: &signature.Payload{
ContentType: invalidContentType,
},
expectErr: true,
},
{
name: "payload content is empty",
payload: &signature.Payload{
ContentType: validContentType,
Content: []byte{},
},
expectErr: true,
},
{
name: "valid payload",
payload: validPayload,
expectErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := validatePayload(tt.payload)
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
})
}
}
func TestValidateCertificateChain(t *testing.T) {
tests := []struct {
name string
certs []*x509.Certificate
signTime time.Time
alg signature.Algorithm
expectErr bool
}{
{
name: "empty certs",
certs: []*x509.Certificate{},
signTime: time.Now(),
alg: signature.AlgorithmES256,
expectErr: true,
},
{
name: "invalid certificates",
certs: []*x509.Certificate{
testhelper.GetECLeafCertificate().Cert,
},
signTime: time.Now(),
alg: signature.AlgorithmES256,
expectErr: true,
},
{
name: "unmatched signing algorithm",
certs: []*x509.Certificate{
testhelper.GetRSALeafCertificate().Cert,
testhelper.GetRSARootCertificate().Cert,
},
signTime: testhelper.GetRSALeafCertificate().Cert.NotBefore,
alg: signature.AlgorithmPS256,
expectErr: true,
},
{
name: "valid certificate chain",
certs: []*x509.Certificate{
testhelper.GetRSALeafCertificate().Cert,
testhelper.GetRSARootCertificate().Cert,
},
signTime: testhelper.GetRSALeafCertificate().Cert.NotBefore,
alg: signature.AlgorithmPS384,
expectErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
err := validateCertificateChain(tt.certs, &tt.signTime, tt.alg)
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
})
}
}
func TestGetSignatureAlgorithm(t *testing.T) {
tests := []struct {
name string
cert *x509.Certificate
expect signature.Algorithm
expectErr bool
}{
{
name: "unsupported cert",
cert: testhelper.GetUnsupportedRSACert().Cert,
expect: 0,
expectErr: true,
},
{
name: "valid cert",
cert: testhelper.GetRSALeafCertificate().Cert,
expect: signature.AlgorithmPS384,
expectErr: false,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
alg, err := getSignatureAlgorithm(tt.cert)
if (err != nil) != tt.expectErr {
t.Errorf("error = %v, expectErr = %v", err, tt.expectErr)
}
if !reflect.DeepEqual(alg, tt.expect) {
t.Errorf("expect %+v, got %+v", tt.expect, alg)
}
})
}
}
|