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 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
|
// 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 verifier
import (
"context"
"crypto/x509"
"encoding/json"
"errors"
"fmt"
"net/http"
"os"
"path/filepath"
"strconv"
"testing"
"time"
"golang.org/x/crypto/ocsp"
"github.com/notaryproject/notation-core-go/revocation"
"github.com/notaryproject/notation-core-go/revocation/purpose"
"github.com/notaryproject/notation-core-go/signature"
_ "github.com/notaryproject/notation-core-go/signature/cose"
"github.com/notaryproject/notation-core-go/testhelper"
corex509 "github.com/notaryproject/notation-core-go/x509"
"github.com/notaryproject/notation-go"
"github.com/notaryproject/notation-go/dir"
"github.com/notaryproject/notation-go/internal/envelope"
"github.com/notaryproject/notation-go/internal/mock"
"github.com/notaryproject/notation-go/plugin/proto"
"github.com/notaryproject/notation-go/signer"
"github.com/notaryproject/notation-go/verifier/trustpolicy"
"github.com/notaryproject/notation-go/verifier/truststore"
ocispec "github.com/opencontainers/image-spec/specs-go/v1"
)
var policy = dummyPolicyDocument()
var invalidPolicy = dummyInvalidPolicyDocument()
var store = truststore.NewX509TrustStore(dir.ConfigFS())
var pm = mock.PluginManager{}
func TestNewVerifier_Error(t *testing.T) {
policyDocument := dummyPolicyDocument()
_, err := New(&policyDocument, nil, nil)
expectedErr := errors.New("trustStore cannot be nil")
if err == nil || err.Error() != expectedErr.Error() {
t.Fatalf("TestNewVerifier_Error expected error %v, got %v", expectedErr, err)
}
}
func TestNewFromConfig(t *testing.T) {
tempRoot := t.TempDir()
dir.UserConfigDir = tempRoot
expectedErrMsg := "trust policy is not present. To create a trust policy, see: https://notaryproject.dev/docs/quickstart/#create-a-trust-policy"
_, err := NewFromConfig()
if err == nil || err.Error() != expectedErrMsg {
t.Fatalf("expected %s, but got %s", expectedErrMsg, err)
}
path := filepath.Join(tempRoot, "trustpolicy.json")
policyJson, _ := json.Marshal(dummyPolicyDocument())
if err := os.WriteFile(path, policyJson, 0600); err != nil {
t.Fatal(err)
}
t.Cleanup(func() { os.RemoveAll(tempRoot) })
_, err = NewFromConfig()
if err != nil {
t.Fatal(err)
}
}
func TestInvalidArtifactUriValidations(t *testing.T) {
verifier := verifier{
trustPolicyDoc: &policy,
pluginManager: mock.PluginManager{},
}
tests := []struct {
uri string
wantErr bool
}{
{"", true},
{"invaliduri", true},
{"domain.com/repository@sha256:", true},
{"domain.com/repository@sha256", true},
{"domain.com/repository@", true},
{"domain.com/repository", true},
{"domain.com/repositorysha256:digest", true},
{"domain.com/repositorysha256digest", true},
{"repository@sha256:digest", true},
}
for i, tt := range tests {
t.Run(strconv.Itoa(i), func(t *testing.T) {
opts := notation.VerifierVerifyOptions{ArtifactReference: tt.uri}
_, err := verifier.Verify(context.Background(), ocispec.Descriptor{}, []byte{}, opts)
if err != nil != tt.wantErr {
t.Fatalf("TestInvalidArtifactUriValidations expected error for %q", tt.uri)
}
})
}
}
func TestErrorNoApplicableTrustPolicy_Error(t *testing.T) {
verifier := verifier{
trustPolicyDoc: &policy,
pluginManager: mock.PluginManager{},
}
opts := notation.VerifierVerifyOptions{ArtifactReference: "non-existent-domain.com/repo@sha256:73c803930ea3ba1e54bc25c2bdc53edd0284c62ed651fe7b00369da519a3c333"}
_, err := verifier.Verify(context.Background(), ocispec.Descriptor{}, []byte{}, opts)
if !errors.Is(err, notation.ErrorNoApplicableTrustPolicy{Msg: "artifact \"non-existent-domain.com/repo@sha256:73c803930ea3ba1e54bc25c2bdc53edd0284c62ed651fe7b00369da519a3c333\" has no applicable trust policy statement. Trust policy applicability for a given artifact is determined by registryScopes. To create a trust policy, see: https://notaryproject.dev/docs/quickstart/#create-a-trust-policy"}) {
t.Fatalf("no applicable trust policy must throw error")
}
}
func TestNotationVerificationCombinations(t *testing.T) {
assertNotationVerification(t, signature.SigningSchemeX509)
assertNotationVerification(t, signature.SigningSchemeX509SigningAuthority)
}
func assertNotationVerification(t *testing.T, scheme signature.SigningScheme) {
var validSigEnv []byte
var invalidSigEnv []byte
var expiredSigEnv []byte
if scheme == signature.SigningSchemeX509 {
validSigEnv = mock.MockCaValidSigEnv
invalidSigEnv = mock.MockCaInvalidSigEnv
expiredSigEnv = mock.MockCaExpiredSigEnv
} else if scheme == signature.SigningSchemeX509SigningAuthority {
validSigEnv = mock.MockSaValidSigEnv
invalidSigEnv = mock.MockSaInvalidSigEnv
expiredSigEnv = mock.MockSaExpiredSigEnv
}
type testCase struct {
signatureBlob []byte
verificationType trustpolicy.ValidationType
verificationLevel *trustpolicy.VerificationLevel
policyDocument trustpolicy.Document
opts notation.VerifierVerifyOptions
expectedErr error
}
var testCases []testCase
verificationLevels := []*trustpolicy.VerificationLevel{trustpolicy.LevelStrict, trustpolicy.LevelPermissive, trustpolicy.LevelAudit}
// Unsupported Signature Envelope
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
expectedErr := fmt.Errorf("unable to parse the digital signature, error : signature envelope format with media type \"application/unsupported+json\" is not supported")
testCases = append(testCases, testCase{
verificationType: trustpolicy.TypeIntegrity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/unsupported+json"},
expectedErr: expectedErr,
})
}
// Integrity Success
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
testCases = append(testCases, testCase{
signatureBlob: validSigEnv,
verificationType: trustpolicy.TypeIntegrity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
})
}
// Integrity Failure
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
expectedErr := fmt.Errorf("signature is invalid. Error: illegal base64 data at input byte 242")
testCases = append(testCases, testCase{
signatureBlob: invalidSigEnv,
verificationType: trustpolicy.TypeIntegrity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
expectedErr: expectedErr,
})
}
// Authenticity Success
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument() // trust store is configured with the root certificate of the signature by default
testCases = append(testCases, testCase{
signatureBlob: validSigEnv,
verificationType: trustpolicy.TypeAuthenticity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
})
}
// Authenticity Failure
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
policyDocument.TrustPolicies[0].TrustStores = []string{"ca:valid-trust-store-2", "signingAuthority:valid-trust-store-2"} // trust store is not configured with the root certificate of the signature
expectedErr := fmt.Errorf("signature is not produced by a trusted signer")
testCases = append(testCases, testCase{
signatureBlob: validSigEnv,
verificationType: trustpolicy.TypeAuthenticity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
expectedErr: expectedErr,
})
}
// Authenticity Failure with trust store missing separator
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
policyDocument.TrustPolicies[0].TrustStores = []string{"ca:valid-trust-store-2", "signingAuthority"}
expectedErr := fmt.Errorf("error while loading the trust store, trust policy statement \"test-statement-name\" is missing separator in trust store value \"signingAuthority\". The required format is <TrustStoreType>:<TrustStoreName>")
testCases = append(testCases, testCase{
signatureBlob: validSigEnv,
verificationType: trustpolicy.TypeAuthenticity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
expectedErr: expectedErr,
})
}
// TrustedIdentity Failure
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
policyDocument.TrustPolicies[0].TrustedIdentities = []string{"x509.subject:CN=LOL,O=DummyOrg,L=Hyderabad,ST=TG,C=IN"} // configure policy to not trust "CN=Notation Test Leaf Cert,O=Notary,L=Seattle,ST=WA,C=US" which is the subject of the signature's signing certificate
expectedErr := fmt.Errorf("signing certificate from the digital signature does not match the X.509 trusted identities [map[\"C\":\"IN\" \"CN\":\"LOL\" \"L\":\"Hyderabad\" \"O\":\"DummyOrg\" \"ST\":\"TG\"]] defined in the trust policy \"test-statement-name\"")
testCases = append(testCases, testCase{
signatureBlob: validSigEnv,
verificationType: trustpolicy.TypeAuthenticity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
expectedErr: expectedErr,
})
}
// TrustedIdentity Failure without separator
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
policyDocument.TrustPolicies[0].TrustedIdentities = []string{"x509.subject"}
expectedErr := fmt.Errorf("trust policy statement \"test-statement-name\" has trusted identity \"x509.subject\" missing separator")
testCases = append(testCases, testCase{
signatureBlob: validSigEnv,
verificationType: trustpolicy.TypeAuthenticity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
expectedErr: expectedErr,
})
}
// TrustedIdentity Failure with empty value
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
policyDocument.TrustPolicies[0].TrustedIdentities = []string{"x509.subject:"}
expectedErr := fmt.Errorf("trust policy statement \"test-statement-name\" has trusted identity \"x509.subject:\" without an identity value")
testCases = append(testCases, testCase{
signatureBlob: validSigEnv,
verificationType: trustpolicy.TypeAuthenticity,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
expectedErr: expectedErr,
})
}
// Expiry Success
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
testCases = append(testCases, testCase{
signatureBlob: validSigEnv,
verificationType: trustpolicy.TypeExpiry,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
})
}
// Expiry Failure
for _, level := range verificationLevels {
policyDocument := dummyPolicyDocument()
expectedErr := fmt.Errorf("digital signature has expired on \"Fri, 29 Jul 2022 23:59:00 +0000\"")
testCases = append(testCases, testCase{
signatureBlob: expiredSigEnv,
verificationType: trustpolicy.TypeExpiry,
verificationLevel: level,
policyDocument: policyDocument,
opts: notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"},
expectedErr: expectedErr,
})
}
for i, tt := range testCases {
t.Run(strconv.Itoa(i), func(t *testing.T) {
tt.policyDocument.TrustPolicies[0].SignatureVerification.VerificationLevel = tt.verificationLevel.Name
expectedResult := notation.ValidationResult{
Type: tt.verificationType,
Action: tt.verificationLevel.Enforcement[tt.verificationType],
Error: tt.expectedErr,
}
dir.UserConfigDir = "testdata"
pluginManager := mock.PluginManager{}
pluginManager.GetPluginError = errors.New("plugin should not be invoked when verification plugin is not specified in the signature")
pluginManager.PluginRunnerLoadError = errors.New("plugin should not be invoked when verification plugin is not specified in the signature")
revocationClient, err := revocation.New(&http.Client{Timeout: 2 * time.Second})
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
verifier := verifier{
trustPolicyDoc: &tt.policyDocument,
trustStore: truststore.NewX509TrustStore(dir.ConfigFS()),
pluginManager: pluginManager,
revocationClient: revocationClient,
}
outcome, _ := verifier.Verify(context.Background(), ocispec.Descriptor{}, tt.signatureBlob, tt.opts)
verifyResult(outcome, expectedResult, tt.expectedErr, t)
})
}
}
func TestVerifyRevocationEnvelope(t *testing.T) {
// Test values
desc := ocispec.Descriptor{
MediaType: "application/vnd.docker.distribution.manifest.v2+json",
Digest: "sha256:60043cf45eaebc4c0867fea485a039b598f52fd09fd5b07b0b2d2f88fad9d74e",
Size: 528,
URLs: []string{},
Annotations: map[string]string{},
Data: []byte("test data"),
Platform: nil,
ArtifactType: "",
}
payload := envelope.Payload{
TargetArtifact: desc,
}
opts := notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
pluginManager := mock.PluginManager{}
pluginManager.GetPluginError = errors.New("plugin should not be invoked when verification plugin is not specified in the signature")
pluginManager.PluginRunnerLoadError = errors.New("plugin should not be invoked when verification plugin is not specified in the signature")
// Get revokable certs and set up mock client (will always say certs are revoked)
revokableChain := testhelper.GetRevokableRSAChain(2)
httpClient := testhelper.MockClient(revokableChain, []ocsp.ResponseStatus{ocsp.Revoked}, nil, true)
revocationClient, err := revocation.New(httpClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
// Generate blob with revokable certs
internalSigner, err := signer.New(revokableChain[0].PrivateKey, []*x509.Certificate{revokableChain[0].Cert, revokableChain[1].Cert})
if err != nil {
t.Fatalf("Unexpected error while creating signer: %v", err)
}
envelopeBlob, _, err := internalSigner.Sign(context.Background(), payload.TargetArtifact, notation.SignerSignOptions{ExpiryDuration: 24 * time.Hour, SignatureMediaType: "application/jose+json"})
if err != nil {
t.Fatalf("Unexpected error while generating blob: %v", err)
}
t.Run("enforced revoked cert", func(t *testing.T) {
testedLevel := trustpolicy.LevelStrict
policyDoc := dummyPolicyDocument()
policyDoc.TrustPolicies[0].SignatureVerification.VerificationLevel = testedLevel.Name
policyDoc.TrustPolicies[0].SignatureVerification.Override = map[trustpolicy.ValidationType]trustpolicy.ValidationAction{
trustpolicy.TypeAuthenticity: trustpolicy.ActionLog,
trustpolicy.TypeRevocation: trustpolicy.ActionEnforce,
}
var expectedErr error = fmt.Errorf("signing certificate with subject %q is revoked", revokableChain[0].Cert.Subject.String())
expectedResult := notation.ValidationResult{
Type: trustpolicy.TypeRevocation,
Action: trustpolicy.ActionEnforce,
Error: expectedErr,
}
dir.UserConfigDir = "testdata"
verifier := verifier{
trustPolicyDoc: &policyDoc,
trustStore: truststore.NewX509TrustStore(dir.ConfigFS()),
pluginManager: pluginManager,
revocationClient: revocationClient,
}
outcome, err := verifier.Verify(context.Background(), desc, envelopeBlob, opts)
if err == nil || err.Error() != expectedErr.Error() {
t.Fatalf("Expected verify to fail with %v, but got %v", expectedErr, err)
}
verifyResult(outcome, expectedResult, expectedErr, t)
})
t.Run("log revoked cert", func(t *testing.T) {
testedLevel := trustpolicy.LevelStrict
policyDoc := dummyPolicyDocument()
policyDoc.TrustPolicies[0].SignatureVerification.VerificationLevel = testedLevel.Name
policyDoc.TrustPolicies[0].SignatureVerification.Override = map[trustpolicy.ValidationType]trustpolicy.ValidationAction{
trustpolicy.TypeAuthenticity: trustpolicy.ActionLog,
trustpolicy.TypeRevocation: trustpolicy.ActionLog,
}
var expectedErr error = fmt.Errorf("signing certificate with subject %q is revoked", revokableChain[0].Cert.Subject.String())
expectedResult := notation.ValidationResult{
Type: trustpolicy.TypeRevocation,
Action: trustpolicy.ActionLog,
Error: expectedErr,
}
dir.UserConfigDir = "testdata"
verifier := verifier{
trustPolicyDoc: &policyDoc,
trustStore: truststore.NewX509TrustStore(dir.ConfigFS()),
pluginManager: pluginManager,
revocationClient: revocationClient,
}
ctx := context.Background()
outcome, err := verifier.Verify(ctx, desc, envelopeBlob, opts)
if err != nil {
t.Fatalf("Unexpected error while verifying: %v", err)
}
verifyResult(outcome, expectedResult, expectedErr, t)
})
t.Run("skip revoked cert", func(t *testing.T) {
testedLevel := trustpolicy.LevelStrict
policyDoc := dummyPolicyDocument()
policyDoc.TrustPolicies[0].SignatureVerification.VerificationLevel = testedLevel.Name
policyDoc.TrustPolicies[0].SignatureVerification.Override = map[trustpolicy.ValidationType]trustpolicy.ValidationAction{
trustpolicy.TypeAuthenticity: trustpolicy.ActionLog,
trustpolicy.TypeRevocation: trustpolicy.ActionSkip,
}
dir.UserConfigDir = "testdata"
verifier := verifier{
trustPolicyDoc: &policyDoc,
trustStore: truststore.NewX509TrustStore(dir.ConfigFS()),
pluginManager: pluginManager,
revocationClient: revocationClient,
}
outcome, err := verifier.Verify(context.Background(), desc, envelopeBlob, opts)
if err != nil {
t.Fatalf("Unexpected error while verifying: %v", err)
}
for _, result := range outcome.VerificationResults {
if result.Type == trustpolicy.TypeRevocation {
t.Fatal("expected no result for TypeRevocation after skip")
}
}
})
}
func createMockOutcome(certChain []*x509.Certificate, signingTime time.Time) *notation.VerificationOutcome {
return ¬ation.VerificationOutcome{
EnvelopeContent: &signature.EnvelopeContent{
SignerInfo: signature.SignerInfo{
SignedAttributes: signature.SignedAttributes{
SigningTime: signingTime,
SigningScheme: signature.SigningSchemeX509SigningAuthority,
},
CertificateChain: certChain,
},
},
VerificationLevel: &trustpolicy.VerificationLevel{
Enforcement: map[trustpolicy.ValidationType]trustpolicy.ValidationAction{trustpolicy.TypeRevocation: trustpolicy.ActionEnforce},
},
}
}
func TestVerifyRevocation(t *testing.T) {
zeroTime := time.Time{}
revokableTuples := testhelper.GetRevokableRSAChain(3)
revokableTuples[0].Cert.NotBefore = zeroTime
revokableTuples[1].Cert.NotBefore = zeroTime
revokableTuples[2].Cert.NotBefore = zeroTime
revokableChain := []*x509.Certificate{revokableTuples[0].Cert, revokableTuples[1].Cert, revokableTuples[2].Cert}
invalidChain := []*x509.Certificate{revokableTuples[1].Cert, revokableTuples[0].Cert, revokableTuples[2].Cert}
goodClient := testhelper.MockClient(revokableTuples, []ocsp.ResponseStatus{ocsp.Good}, nil, true)
revokedClient := testhelper.MockClient(revokableTuples, []ocsp.ResponseStatus{ocsp.Revoked}, nil, true)
revokedInvalidityDate := time.Now().Add(-1 * time.Hour)
revokedInvalidityClient := testhelper.MockClient(revokableTuples, []ocsp.ResponseStatus{ocsp.Revoked}, &revokedInvalidityDate, true)
unknownClient := testhelper.MockClient(revokableTuples, []ocsp.ResponseStatus{ocsp.Unknown}, nil, true)
unknownRevokedClient := testhelper.MockClient(revokableTuples, []ocsp.ResponseStatus{ocsp.Unknown, ocsp.Revoked}, nil, true)
revokedUnknownClient := testhelper.MockClient(revokableTuples, []ocsp.ResponseStatus{ocsp.Revoked, ocsp.Unknown}, nil, true)
pkixNoCheckClient := testhelper.MockClient(revokableTuples, []ocsp.ResponseStatus{ocsp.Good}, nil, false)
timeoutClient := &http.Client{Timeout: 1 * time.Nanosecond}
unknownMsg := fmt.Sprintf("signing certificate with subject %q revocation status is unknown", revokableChain[0].Subject.String())
revokedMsg := fmt.Sprintf("signing certificate with subject %q is revoked", revokableChain[0].Subject.String())
multiMsg := fmt.Sprintf("signing certificate with subject %q is revoked", revokableChain[1].Subject.String())
ctx := context.Background()
t.Run("verifyRevocation nil client", func(t *testing.T) {
v := &verifier{}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
expectedErrMsg := "unable to check revocation status, code signing revocation validator cannot be nil"
if result.Error == nil || result.Error.Error() != expectedErrMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", expectedErrMsg, result.Error)
}
})
t.Run("verifyRevocation invalid chain", func(t *testing.T) {
revocationClient, err := revocation.New(goodClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(invalidChain, time.Now()))
expectedErrMsg := "unable to check revocation status, err: invalid chain: expected chain to be correct and complete: invalid certificates or certificate with subject \"CN=Notation Test Revokable RSA Chain Cert 2,O=Notary,L=Seattle,ST=WA,C=US\" is not issued by \"CN=Notation Test Revokable RSA Chain Cert 3,O=Notary,L=Seattle,ST=WA,C=US\". Error: x509: invalid signature: parent certificate cannot sign this kind of certificate"
if result.Error == nil || result.Error.Error() != expectedErrMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", expectedErrMsg, result.Error)
}
})
t.Run("verifyRevocation non-revoked", func(t *testing.T) {
revocationClient, err := revocation.New(goodClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
if result.Error != nil {
t.Fatalf("expected verifyRevocation to succeed, but got %v", result.Error)
}
})
t.Run("verifyRevocation OCSP revoked no invalidity", func(t *testing.T) {
revocationClient, err := revocation.New(revokedClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
if result.Error == nil || result.Error.Error() != revokedMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", revokedMsg, result.Error)
}
})
t.Run("verifyRevocation OCSP revoked with invalidiy", func(t *testing.T) {
revocationClient, err := revocation.New(revokedInvalidityClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
if result.Error == nil || result.Error.Error() != revokedMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", revokedMsg, result.Error)
}
})
t.Run("verifyRevocation OCSP unknown", func(t *testing.T) {
revocationClient, err := revocation.New(unknownClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
if result.Error == nil || result.Error.Error() != unknownMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", unknownMsg, result.Error)
}
})
t.Run("verifyRevocation OCSP unknown then revoked", func(t *testing.T) {
revocationClient, err := revocation.New(unknownRevokedClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
if result.Error == nil || result.Error.Error() != multiMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", multiMsg, result.Error)
}
})
t.Run("verifyRevocation OCSP revoked then unknown", func(t *testing.T) {
revocationClient, err := revocation.New(revokedUnknownClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
if result.Error == nil || result.Error.Error() != revokedMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", revokedMsg, result.Error)
}
})
t.Run("verifyRevocation missing id-pkix-ocsp-nocheck", func(t *testing.T) {
revocationClient, err := revocation.New(pkixNoCheckClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
if result.Error != nil {
t.Fatalf("expected verifyRevocation to succeed, but got %v", result.Error)
}
})
t.Run("verifyRevocation timeout", func(t *testing.T) {
revocationClient, err := revocation.New(timeoutClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now()))
if result.Error == nil || result.Error.Error() != unknownMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", unknownMsg, result.Error)
}
})
t.Run("verifyRevocation older signing time no invalidity", func(t *testing.T) {
revocationClient, err := revocation.New(revokedClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now().Add(-4*time.Hour)))
if result.Error == nil || result.Error.Error() != revokedMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", revokedMsg, result.Error)
}
})
t.Run("verifyRevocation zero signing time", func(t *testing.T) {
revocationClient, err := revocation.New(revokedClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
expectedErrMsg := "signing certificate with subject \"CN=Notation Test Revokable RSA Chain Cert 3,O=Notary,L=Seattle,ST=WA,C=US\" is revoked"
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, zeroTime))
if result.Error == nil || result.Error.Error() != expectedErrMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", expectedErrMsg, result.Error)
}
if !zeroTime.IsZero() {
t.Fatalf("exected zeroTime.IsZero() to be true")
}
})
t.Run("verifyRevocation older signing time with invalidity", func(t *testing.T) {
revocationClient, err := revocation.New(revokedInvalidityClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, createMockOutcome(revokableChain, time.Now().Add(-4*time.Hour)))
if result.Error != nil {
t.Fatalf("expected verifyRevocation to succeed, but got %v", result.Error)
}
})
t.Run("verifyRevocation non-authentic signing time with invalidity", func(t *testing.T) {
revocationClient, err := revocation.New(revokedInvalidityClient)
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
// Specifying older signing time (which should succeed), but will use zero time since no authentic signing time
outcome := createMockOutcome(revokableChain, time.Now().Add(-4*time.Hour))
outcome.EnvelopeContent.SignerInfo.SignedAttributes.SigningScheme = "notary.x509"
authenticSigningTime, err := outcome.EnvelopeContent.SignerInfo.AuthenticSigningTime()
expectedErr := errors.New("authentic signing time not supported under signing scheme \"notary.x509\"")
if !authenticSigningTime.IsZero() || err == nil || err.Error() != expectedErr.Error() {
t.Fatalf("expected AuthenticSigningTime to fail with %v, but got %v", expectedErr, err)
}
v := &verifier{
revocationClient: revocationClient,
}
result := v.verifyRevocation(ctx, outcome)
if result.Error == nil || result.Error.Error() != revokedMsg {
t.Fatalf("expected verifyRevocation to fail with %s, but got %v", revokedMsg, result.Error)
}
})
}
func TestNew(t *testing.T) {
if _, err := New(&policy, store, pm); err != nil {
t.Fatalf("expected New constructor to succeed, but got %v", err)
}
}
func TestNewWithOptions(t *testing.T) {
if _, err := NewWithOptions(&policy, store, pm, VerifierOptions{}); err != nil {
t.Fatalf("expected NewWithOptions constructor to succeed, but got %v", err)
}
r, err := revocation.New(&http.Client{})
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
opts := VerifierOptions{RevocationClient: r}
_, err = NewWithOptions(&policy, store, pm, opts)
if err != nil {
t.Fatalf("expected NewWithOptions constructor to succeed, but got %v", err)
}
revocationCodeSigningValidator, err := revocation.NewWithOptions(revocation.Options{
OCSPHTTPClient: &http.Client{},
CertChainPurpose: purpose.CodeSigning,
})
if err != nil {
t.Fatal(err)
}
revocationTimestampingValidator, err := revocation.NewWithOptions(revocation.Options{
OCSPHTTPClient: &http.Client{},
CertChainPurpose: purpose.Timestamping,
})
if err != nil {
t.Fatal(err)
}
opts.RevocationCodeSigningValidator = revocationCodeSigningValidator
opts.RevocationTimestampingValidator = revocationTimestampingValidator
_, err = NewWithOptions(&policy, store, pm, opts)
if err != nil {
t.Fatalf("expected NewWithOptions constructor to succeed, but got %v", err)
}
opts.RevocationClient = nil
_, err = NewWithOptions(&policy, store, pm, opts)
if err != nil {
t.Fatalf("expected NewWithOptions constructor to succeed, but got %v", err)
}
}
func TestNewWithOptionsError(t *testing.T) {
r, err := revocation.New(&http.Client{})
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
rt, err := revocation.NewWithOptions(revocation.Options{
OCSPHTTPClient: &http.Client{},
CertChainPurpose: purpose.Timestamping,
})
if err != nil {
t.Fatalf("unexpected error while creating revocation timestamp object: %v", err)
}
opts := VerifierOptions{
RevocationClient: r,
RevocationTimestampingValidator: rt,
}
_, err = NewWithOptions(nil, store, pm, opts)
expectedErrMsg := "trustPolicy cannot be nil"
if err == nil || err.Error() != expectedErrMsg {
t.Errorf("expected %s, but got %s", expectedErrMsg, err)
}
_, err = NewWithOptions(&policy, nil, pm, opts)
expectedErrMsg = "trustStore cannot be nil"
if err == nil || err.Error() != expectedErrMsg {
t.Errorf("expected %s, but got %s", expectedErrMsg, err)
}
_, err = NewWithOptions(&invalidPolicy, store, pm, opts)
expectedErrMsg = "trust policy document has empty version, version must be specified"
if err == nil || err.Error() != expectedErrMsg {
t.Errorf("expected %s, but got %s", expectedErrMsg, err)
}
}
func TestVerificationPluginInteractions(t *testing.T) {
assertPluginVerification(signature.SigningSchemeX509, t)
assertPluginVerification(signature.SigningSchemeX509SigningAuthority, t)
}
func assertPluginVerification(scheme signature.SigningScheme, t *testing.T) {
var pluginSigEnv []byte
if scheme == signature.SigningSchemeX509 {
pluginSigEnv = mock.MockCaPluginSigEnv
} else if scheme == signature.SigningSchemeX509SigningAuthority {
pluginSigEnv = mock.MockSaPluginSigEnv
}
policyDocument := dummyPolicyDocument()
dir.UserConfigDir = "testdata"
x509TrustStore := truststore.NewX509TrustStore(dir.ConfigFS())
// verification plugin is not installed
pluginManager := mock.PluginManager{}
pluginManager.GetPluginError = errors.New("plugin not found")
revocationClient, err := revocation.New(&http.Client{Timeout: 2 * time.Second})
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts := notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err := v.Verify(context.Background(), ocispec.Descriptor{}, pluginSigEnv, opts)
if err == nil || outcome.Error == nil || outcome.Error.Error() != "error while locating the verification plugin \"plugin-name\", make sure the plugin is installed successfully before verifying the signature. error: plugin not found" {
t.Fatalf("verification should fail if the verification plugin is not found")
}
// plugin is installed but without verification capabilities
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilitySignatureGenerator}
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err = v.Verify(context.Background(), ocispec.Descriptor{}, pluginSigEnv, opts)
if err == nil || outcome.Error == nil || outcome.Error.Error() != "digital signature requires plugin \"plugin-name\" with signature verification capabilities (\"SIGNATURE_VERIFIER.TRUSTED_IDENTITY\" and/or \"SIGNATURE_VERIFIER.REVOCATION_CHECK\") installed" {
t.Fatalf("verification should fail if the verification plugin is not found")
}
// plugin interactions with trusted identity verification success
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityTrustedIdentityVerifier}
pluginManager.PluginRunnerExecuteResponse = &proto.VerifySignatureResponse{
VerificationResults: map[proto.Capability]*proto.VerificationResult{
proto.CapabilityTrustedIdentityVerifier: {
Success: true,
},
},
ProcessedAttributes: []interface{}{mock.PluginExtendedCriticalAttribute.Key},
}
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err = v.Verify(context.Background(), mock.ImageDescriptor, pluginSigEnv, opts)
if err != nil || outcome.Error != nil {
t.Fatalf("verification should succeed when the verification plugin succeeds for trusted identity verification. error : %v", outcome.Error)
}
// plugin interactions with trusted identity verification failure
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityTrustedIdentityVerifier}
pluginManager.PluginRunnerExecuteResponse = &proto.VerifySignatureResponse{
VerificationResults: map[proto.Capability]*proto.VerificationResult{
proto.CapabilityTrustedIdentityVerifier: {
Success: false,
Reason: "i feel like failing today",
},
},
ProcessedAttributes: []interface{}{mock.PluginExtendedCriticalAttribute.Key},
}
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err = v.Verify(context.Background(), ocispec.Descriptor{}, pluginSigEnv, opts)
if err == nil || outcome.Error == nil || outcome.Error.Error() != "trusted identify verification by plugin \"plugin-name\" failed with reason \"i feel like failing today\"" {
t.Fatalf("verification should fail when the verification plugin fails for trusted identity verification. error : %v", outcome.Error)
}
// plugin interactions with revocation verification success
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityRevocationCheckVerifier}
pluginManager.PluginRunnerExecuteResponse = &proto.VerifySignatureResponse{
VerificationResults: map[proto.Capability]*proto.VerificationResult{
proto.CapabilityRevocationCheckVerifier: {
Success: true,
},
},
ProcessedAttributes: []interface{}{mock.PluginExtendedCriticalAttribute.Key},
}
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err = v.Verify(context.Background(), mock.ImageDescriptor, pluginSigEnv, opts)
if err != nil || outcome.Error != nil {
t.Fatalf("verification should succeed when the verification plugin succeeds for revocation verification. error : %v", outcome.Error)
}
// plugin interactions with trusted revocation failure
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityRevocationCheckVerifier}
pluginManager.PluginRunnerExecuteResponse = &proto.VerifySignatureResponse{
VerificationResults: map[proto.Capability]*proto.VerificationResult{
proto.CapabilityRevocationCheckVerifier: {
Success: false,
Reason: "i feel like failing today",
},
},
ProcessedAttributes: []interface{}{mock.PluginExtendedCriticalAttribute.Key},
}
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err = v.Verify(context.Background(), ocispec.Descriptor{}, pluginSigEnv, opts)
if err == nil || outcome.Error == nil || outcome.Error.Error() != "revocation check by verification plugin \"plugin-name\" failed with reason \"i feel like failing today\"" {
t.Fatalf("verification should fail when the verification plugin fails for revocation check verification. error : %v", outcome.Error)
}
// plugin interactions with both trusted identity & revocation verification
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityRevocationCheckVerifier, proto.CapabilityTrustedIdentityVerifier}
pluginManager.PluginRunnerExecuteResponse = &proto.VerifySignatureResponse{
VerificationResults: map[proto.Capability]*proto.VerificationResult{
proto.CapabilityRevocationCheckVerifier: {
Success: true,
},
proto.CapabilityTrustedIdentityVerifier: {
Success: true,
},
},
ProcessedAttributes: []interface{}{mock.PluginExtendedCriticalAttribute.Key},
}
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err = v.Verify(context.Background(), mock.ImageDescriptor, pluginSigEnv, opts)
if err != nil || outcome.Error != nil {
t.Fatalf("verification should succeed when the verification plugin succeeds for both trusted identity and revocation check verifications. error : %v", outcome.Error)
}
// plugin interactions with skipped revocation
policyDocument.TrustPolicies[0].SignatureVerification.Override = map[trustpolicy.ValidationType]trustpolicy.ValidationAction{trustpolicy.TypeRevocation: trustpolicy.ActionSkip}
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityRevocationCheckVerifier}
pluginManager.PluginRunnerExecuteError = errors.New("revocation plugin should not be invoked when the trust policy skips revocation check")
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
trustPolicy, err := (&policyDocument).GetApplicableTrustPolicy(opts.ArtifactReference)
if err != nil {
t.Fatalf("cannot get trustPolicy")
}
verificationLevel, _ := trustPolicy.SignatureVerification.GetVerificationLevel()
outcome = ¬ation.VerificationOutcome{
VerificationResults: []*notation.ValidationResult{},
VerificationLevel: verificationLevel,
}
outcome, err = v.Verify(context.Background(), mock.ImageDescriptor, pluginSigEnv, opts)
if err != nil || outcome.Error != nil {
t.Fatalf("revocation plugin should not be invoked when the trust policy skips the revocation check. error : %v", outcome.Error)
}
// plugin unexpected response
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityTrustedIdentityVerifier}
pluginManager.PluginRunnerExecuteResponse = "invalid plugin response"
pluginManager.PluginRunnerExecuteError = errors.New("invalid plugin response")
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
trustPolicy, err = (&policyDocument).GetApplicableTrustPolicy(opts.ArtifactReference)
if err != nil {
t.Fatalf("cannot get trustPolicy")
}
verificationLevel, _ = trustPolicy.SignatureVerification.GetVerificationLevel()
outcome = ¬ation.VerificationOutcome{
VerificationResults: []*notation.ValidationResult{},
VerificationLevel: verificationLevel,
}
outcome, err = v.Verify(context.Background(), mock.ImageDescriptor, pluginSigEnv, opts)
if err == nil || outcome.Error == nil || outcome.Error.Error() != "failed to verify with plugin plugin-name: invalid plugin response" {
t.Fatalf("verification should fail when the verification plugin returns unexpected response. error : %v", outcome.Error)
}
// plugin did not process all extended critical attributes
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityTrustedIdentityVerifier}
pluginManager.PluginRunnerExecuteResponse = &proto.VerifySignatureResponse{
VerificationResults: map[proto.Capability]*proto.VerificationResult{
proto.CapabilityTrustedIdentityVerifier: {
Success: true,
},
},
ProcessedAttributes: []interface{}{}, // exclude the critical attribute
}
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err = v.Verify(context.Background(), mock.ImageDescriptor, pluginSigEnv, opts)
if err == nil || outcome.Error == nil || outcome.Error.Error() != "extended critical attribute \"SomeKey\" was not processed by the verification plugin \"plugin-name\" (all extended critical attributes must be processed by the verification plugin)" {
t.Fatalf("verification should fail when the verification plugin fails to process an extended critical attribute. error : %v", outcome.Error)
}
// plugin returned empty result for a capability
pluginManager = mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityTrustedIdentityVerifier}
pluginManager.PluginRunnerExecuteResponse = &proto.VerifySignatureResponse{
VerificationResults: map[proto.Capability]*proto.VerificationResult{},
ProcessedAttributes: []interface{}{mock.PluginExtendedCriticalAttribute.Key},
}
v = verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts = notation.VerifierVerifyOptions{ArtifactReference: mock.SampleArtifactUri, SignatureMediaType: "application/jose+json"}
outcome, err = v.Verify(context.Background(), mock.ImageDescriptor, pluginSigEnv, opts)
if err == nil || outcome.Error == nil || outcome.Error.Error() != "verification plugin \"plugin-name\" failed to verify \"SIGNATURE_VERIFIER.TRUSTED_IDENTITY\"" {
t.Fatalf("verification should fail when the verification plugin does not return response for a capability. error : %v", outcome.Error)
}
}
func TestVerifyX509TrustedIdentities(t *testing.T) {
certs, _ := corex509.ReadCertificateFile(filepath.FromSlash("testdata/verifier/signing-cert.pem")) // cert's subject is "CN=SomeCN,OU=SomeOU,O=SomeOrg,L=Seattle,ST=WA,C=US"
unsupportedCerts, _ := corex509.ReadCertificateFile(filepath.FromSlash("testdata/verifier/bad-cert.pem")) // cert's subject is "CN=bad=#CN,OU=SomeOU,O=SomeOrg,L=Seattle,ST=WA,C=US"
tests := []struct {
certs []*x509.Certificate
x509Identities []string
wantErr bool
}{
{certs, []string{"x509.subject:C=US,O=SomeOrg,ST=WA"}, false},
{certs, []string{"x509.subject:C=US,O=SomeOrg,ST=WA", "nonX509Prefix:my-custom-identity"}, false},
{certs, []string{"x509.subject:C=US,O=SomeOrg,ST=WA", "x509.subject:C=IND,O=SomeOrg,ST=TS"}, false},
{certs, []string{"nonX509Prefix:my-custom-identity"}, true},
{certs, []string{"*"}, false},
{certs, []string{"x509.subject:C=IND,O=SomeOrg,ST=TS"}, true},
{certs, []string{"x509.subject:C=IND,O=SomeOrg,ST=TS", "nonX509Prefix:my-custom-identity"}, true},
{certs, []string{"x509.subject:C=IND,O=SomeOrg,ST=TS", "x509.subject:C=LOL,O=LOL,ST=LOL"}, true},
{certs, []string{"x509.subject:C=bad=#identity,O=LOL,ST=LOL"}, true},
{unsupportedCerts, []string{"x509.subject:C=US,O=SomeOrg,ST=WA", "nonX509Prefix:my-custom-identity"}, true},
}
for i, tt := range tests {
t.Run(strconv.Itoa(i), func(t *testing.T) {
trustPolicy := trustpolicy.TrustPolicy{
Name: "test-statement-name",
RegistryScopes: []string{"registry.acme-rockets.io/software/net-monitor"},
SignatureVerification: trustpolicy.SignatureVerification{VerificationLevel: "strict"},
TrustStores: []string{"ca:test-store"},
TrustedIdentities: tt.x509Identities,
}
err := verifyX509TrustedIdentities(trustPolicy.Name, trustPolicy.TrustedIdentities, tt.certs)
if tt.wantErr != (err != nil) {
t.Fatalf("TestVerifyX509TrustedIdentities Error: %q WantErr: %v", err, tt.wantErr)
}
})
}
}
func TestVerifyUserMetadata(t *testing.T) {
policyDocument := dummyPolicyDocument()
policyDocument.TrustPolicies[0].SignatureVerification.VerificationLevel = trustpolicy.LevelAudit.Name
pluginManager := mock.PluginManager{}
pluginManager.GetPluginError = errors.New("plugin should not be invoked when verification plugin is not specified in the signature")
pluginManager.PluginRunnerLoadError = errors.New("plugin should not be invoked when verification plugin is not specified in the signature")
revocationClient, err := revocation.New(&http.Client{Timeout: 2 * time.Second})
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
verifier := verifier{
trustPolicyDoc: &policyDocument,
trustStore: truststore.NewX509TrustStore(dir.ConfigFS()),
pluginManager: pluginManager,
revocationClient: revocationClient,
}
tests := []struct {
metadata map[string]string
wantErr bool
}{
{map[string]string{}, false},
{map[string]string{"io.wabbit-networks.buildId": "123"}, false},
{map[string]string{"io.wabbit-networks.buildId": "321"}, true},
{map[string]string{"io.wabbit-networks.buildId": "123", "io.wabbit-networks.buildTime": "1672944615"}, false},
{map[string]string{"io.wabbit-networks.buildId": "123", "io.wabbit-networks.buildTime": "1"}, true},
}
for i, tt := range tests {
t.Run(strconv.Itoa(i), func(t *testing.T) {
_, err := verifier.Verify(
context.Background(),
mock.MetadataSigEnvDescriptor,
mock.MockSigEnvWithMetadata,
notation.VerifierVerifyOptions{
ArtifactReference: mock.SampleArtifactUri,
SignatureMediaType: "application/jose+json",
UserMetadata: tt.metadata,
},
)
if tt.wantErr != (err != nil) {
t.Fatalf("TestVerifyUserMetadata Error: %q WantErr: %v", err, tt.wantErr)
}
})
}
}
func TestPluginVersionCompatibility(t *testing.T) {
errTemplate := "found plugin io.cncf.notary.plugin.unittest.mock with version 1.0.0 but signature verification needs plugin version greater than or equal to "
var policyDocument = trustpolicy.Document{
Version: "1.0",
TrustPolicies: []trustpolicy.TrustPolicy{
{
Name: "wabbit-networks-images",
RegistryScopes: []string{"localhost:5000/net-monitor"},
SignatureVerification: trustpolicy.SignatureVerification{VerificationLevel: trustpolicy.LevelStrict.Name},
TrustStores: []string{"ca:valid-trust-store"},
TrustedIdentities: []string{"x509.subject: CN=wabbit-networks.io,O=Notary,L=Seattle,ST=WA,C=US"},
},
},
}
pluginManager := mock.PluginManager{}
pluginManager.PluginCapabilities = []proto.Capability{proto.CapabilityTrustedIdentityVerifier}
pluginManager.PluginRunnerExecuteResponse = &proto.VerifySignatureResponse{
VerificationResults: map[proto.Capability]*proto.VerificationResult{
proto.CapabilityTrustedIdentityVerifier: {
Success: true,
},
},
ProcessedAttributes: []interface{}{mock.PluginExtendedCriticalAttribute.Key},
}
dir.UserConfigDir = "testdata"
x509TrustStore := truststore.NewX509TrustStore(dir.ConfigFS())
revocationClient, err := revocation.New(&http.Client{Timeout: 2 * time.Second})
if err != nil {
t.Fatalf("unexpected error while creating revocation object: %v", err)
}
v := verifier{
trustPolicyDoc: &policyDocument,
trustStore: x509TrustStore,
pluginManager: pluginManager,
revocationClient: revocationClient,
}
opts := notation.VerifierVerifyOptions{ArtifactReference: "localhost:5000/net-monitor@sha256:fe7e9333395060c2f5e63cf36a38fba10176f183b4163a5794e081a480abba5f", SignatureMediaType: "application/jose+json"}
tests := []struct {
minPluginVerTests []byte
wantErr string
}{
{mock.MockCaIncompatiblePluginVerSigEnv_1_0_9, errTemplate + "1.0.9"},
{mock.MockCaIncompatiblePluginVerSigEnv_1_0_1, errTemplate + "1.0.1"},
{mock.MockCaIncompatiblePluginVerSigEnv_1_2_3, errTemplate + "1.2.3"},
{mock.MockCaIncompatiblePluginVerSigEnv_1_1_0_alpha, errTemplate + "1.1.0-alpha"},
{mock.MockCaCompatiblePluginVerSigEnv_0_0_9, ""},
{mock.MockCaCompatiblePluginVerSigEnv_1_0_0_alpha, ""},
{mock.MockCaCompatiblePluginVerSigEnv_1_0_0_alpha_beta, ""},
{mock.MockCaCompatiblePluginVerSigEnv_1_0_0, ""},
}
for _, tt := range tests {
if _, err := v.Verify(context.Background(), mock.TestImageDescriptor, tt.minPluginVerTests, opts); err != nil && tt.wantErr != "" {
if err.Error() != tt.wantErr {
t.Errorf("TestPluginVersionCompatibility Error: %s, WantErr: %s ", err.Error(), tt.wantErr)
}
}
}
}
func TestIsRequiredVerificationPluginVer(t *testing.T) {
testPlugVer := "1.0.0"
tests := []struct {
minVerTests []string
expectedVal bool
}{
{[]string{"0.0.9"}, true},
{[]string{"1.0.0"}, true},
{[]string{"1.0.0-alpha"}, true},
{[]string{"1-pre+meta"}, true},
{[]string{"1.0.1"}, false},
{[]string{"1.1.0"}, false},
{[]string{"1.2.0"}, false},
{[]string{"1.1.0-alpha"}, false},
}
for _, tt := range tests {
funcVal := isRequiredVerificationPluginVer(testPlugVer, tt.minVerTests[0])
if funcVal != tt.expectedVal {
t.Errorf("TestIsRequiredVerificationPluginVer Error: version comparison mismatch between plugin with version %s and min verification plugin version %s, function output: %v, expected output: %v", testPlugVer, tt.minVerTests[0], funcVal, tt.expectedVal)
}
}
}
func verifyResult(outcome *notation.VerificationOutcome, expectedResult notation.ValidationResult, expectedErr error, t *testing.T) {
var actualResult *notation.ValidationResult
for _, r := range outcome.VerificationResults {
if r.Type == expectedResult.Type {
if actualResult == nil {
actualResult = r
} else {
t.Fatalf("expected only one VerificatiionResult for %q but found one more. first: %+v second: %+v", r.Type, actualResult, r)
}
}
}
if actualResult == nil ||
(expectedResult.Error != nil && expectedResult.Error.Error() != actualResult.Error.Error()) ||
expectedResult.Action != actualResult.Action {
t.Fatalf("assertion failed. expected : %+v got : %+v", expectedResult, actualResult)
}
if expectedResult.Action == trustpolicy.ActionEnforce && expectedErr != nil && outcome.Error.Error() != expectedErr.Error() {
t.Fatalf("assertion failed. expected : %v got : %v", expectedErr, outcome.Error)
}
}
|