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
|
// +build debian_disabled
// disabled in debian as these tests require internet connectivity
//
// Copyright 2022 The Sigstore 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 tuf
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io/fs"
"net/http"
"net/http/httptest"
"os"
"path"
"path/filepath"
"reflect"
"sort"
"strings"
"sync"
"testing"
"testing/fstest"
"time"
"github.com/google/go-cmp/cmp"
"github.com/google/go-cmp/cmp/cmpopts"
"github.com/theupdateframework/go-tuf"
"github.com/theupdateframework/go-tuf/data"
"github.com/theupdateframework/go-tuf/verify"
)
// These are the expected targets from the Sigstore root.
// This may not be the total complete list to ensure that targets
// can be added during new ceremonies.
var targets = []string{
"artifact.pub",
"fulcio_v1.crt.pem",
"ctfe.pub",
"rekor.pub",
"ctfe_2022.pub",
"fulcio.crt.pem",
"fulcio_intermediate_v1.crt.pem",
"trusted_root.json",
}
func TestNewFromEnv(t *testing.T) {
td := t.TempDir()
t.Setenv("TUF_ROOT", td)
ctx := context.Background()
// Make sure nothing is expired
tuf, err := NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
checkTargetsAndMeta(t, tuf, targets)
resetForTests()
// Now try with expired targets
forceExpiration(t, true)
tuf, err = NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
checkTargetsAndMeta(t, tuf, targets)
resetForTests()
if err := Initialize(ctx, DefaultRemoteRoot, nil); err != nil {
t.Error()
}
if l := dirLen(t, td); l == 0 {
t.Errorf("expected filesystem writes, got %d entries", l)
}
// And go from there!
tuf, err = NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
checkTargetsAndMeta(t, tuf, targets)
resetForTests()
}
func TestLegacyURLToCDN(t *testing.T) {
td := t.TempDir()
t.Setenv("TUF_ROOT", td)
remoteInfo := &remoteCache{Mirror: defaultRemoteRootNoCDN}
b, err := json.Marshal(remoteInfo)
if err != nil {
t.Fatal(err)
}
if err := os.WriteFile(cachedRemote(td), b, 0o600); err != nil {
t.Fatalf("storing remote: %v", err)
}
// First initialization, populate the cache.
tuf, err := NewFromEnv(context.Background())
if err != nil {
t.Fatal(err)
}
if tuf.Mirror() != DefaultRemoteRoot {
t.Fatal("legacy prod GCS HTTP endpoint was not mapped to CDN")
}
}
func TestAltLegacyURLToCDN(t *testing.T) {
td := t.TempDir()
t.Setenv("TUF_ROOT", td)
remoteInfo := &remoteCache{Mirror: defaultRemoteRootNoCDNAlt}
b, err := json.Marshal(remoteInfo)
if err != nil {
t.Fatal(err)
}
if err := os.WriteFile(cachedRemote(td), b, 0o600); err != nil {
t.Fatalf("storing remote: %v", err)
}
// First initialization, populate the cache.
tuf, err := NewFromEnv(context.Background())
if err != nil {
t.Fatal(err)
}
if tuf.Mirror() != DefaultRemoteRoot {
t.Fatal("legacy prod GCS HTTP endpoint was not mapped to CDN")
}
}
func TestCDNRewriteforMirror(t *testing.T) {
tuf := &TUF{
mirror: defaultRemoteGCSBucket,
}
if tuf.Mirror() != DefaultRemoteRoot {
t.Fatal("reference to default remote GCS bucket was not redirected to CDN")
}
tuf.mirror = defaultRemoteRootNoCDN
if tuf.Mirror() != DefaultRemoteRoot {
t.Fatal("reference to default remote GCS HTTP endpoint was not redirected to CDN")
}
tuf.mirror = defaultRemoteRootNoCDNAlt
if tuf.Mirror() != DefaultRemoteRoot {
t.Fatal("reference to alternate remote GCS HTTP endpoint was not redirected to CDN")
}
}
func TestLegacyBucketToCDN(t *testing.T) {
td := t.TempDir()
t.Setenv("TUF_ROOT", td)
remoteInfo := &remoteCache{Mirror: defaultRemoteGCSBucket}
b, err := json.Marshal(remoteInfo)
if err != nil {
t.Fatal(err)
}
if err := os.WriteFile(cachedRemote(td), b, 0o600); err != nil {
t.Fatalf("storing remote: %v", err)
}
// First initialization, populate the cache.
tuf, err := NewFromEnv(context.Background())
if err != nil {
t.Fatal(err)
}
if tuf.Mirror() != DefaultRemoteRoot {
t.Fatal("legacy prod bucket was not mapped to CDN")
}
}
func TestNoCache(t *testing.T) {
ctx := context.Background()
// Once more with NO_CACHE
t.Setenv("SIGSTORE_NO_CACHE", "true")
td := t.TempDir()
t.Setenv("TUF_ROOT", td)
// First initialization, populate the cache.
tuf, err := NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
checkTargetsAndMeta(t, tuf, targets)
resetForTests()
// Force expiration so we have some content to download
forceExpiration(t, true)
tuf, err = NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
checkTargetsAndMeta(t, tuf, targets)
resetForTests()
// No filesystem writes when using SIGSTORE_NO_CACHE.
if l := dirLen(t, td); l != 0 {
t.Errorf("expected no filesystem writes, got %d entries", l)
}
resetForTests()
}
func TestCache(t *testing.T) {
ctx := context.Background()
// Once more with cache.
t.Setenv("SIGSTORE_NO_CACHE", "false")
td := t.TempDir()
t.Setenv("TUF_ROOT", td)
// Make sure nothing is in that directory to start with
if l := dirLen(t, td); l != 0 {
t.Errorf("expected no filesystem writes, got %d entries", l)
}
// First initialization, populate the cache. Expect disk writes.
tuf, err := NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
checkTargetsAndMeta(t, tuf, targets)
resetForTests()
cachedDirLen := dirLen(t, td)
if cachedDirLen == 0 {
t.Errorf("expected filesystem writes, got %d entries", cachedDirLen)
}
// Nothing should get downloaded if everything is up to date.
forceExpiration(t, false)
_, err = NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
resetForTests()
if l := dirLen(t, td); cachedDirLen != l {
t.Errorf("expected no filesystem writes, got %d entries", l-cachedDirLen)
}
// Forcing expiration, but expect no disk writes because all targets up to date.
forceExpiration(t, true)
tuf, err = NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
if l := dirLen(t, td); l != cachedDirLen {
t.Errorf("expected filesystem writes, got %d entries", l)
}
checkTargetsAndMeta(t, tuf, targets)
resetForTests()
}
func TestCustomRoot(t *testing.T) {
ctx := context.Background()
// Create a remote repository.
td := t.TempDir()
remote, r := newTufRepo(t, td, "foo")
// Serve remote repository.
s := httptest.NewServer(http.FileServer(http.Dir(filepath.Join(td, "repository"))))
defer s.Close()
// Initialize with custom root.
tufRoot := t.TempDir()
t.Setenv("TUF_ROOT", tufRoot)
meta, err := remote.GetMeta()
if err != nil {
t.Error(err)
}
rootBytes, ok := meta["root.json"]
if !ok {
t.Error(err)
}
if err := Initialize(ctx, s.URL, rootBytes); err != nil {
t.Error(err)
}
if l := dirLen(t, tufRoot); l == 0 {
t.Errorf("expected filesystem writes, got %d entries", l)
}
// Successfully get target.
tufObj, err := NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
if b, err := tufObj.GetTarget("foo.txt"); err != nil || !bytes.Equal(b, []byte("foo")) {
t.Fatal(err)
}
resetForTests()
// Force expiration on the first timestamp and internal go-tuf verification.
forceExpirationVersion(t, 1)
oldIsExpired := verify.IsExpired
verify.IsExpired = func(time time.Time) bool {
return true
}
// This should cause an error that remote metadata is expired.
if _, err = NewFromEnv(ctx); err == nil {
t.Errorf("expected expired timestamp from the remote")
}
// Let internal TUF verification succeed normally now.
verify.IsExpired = oldIsExpired
// Update remote targets, issue a timestamp v2.
updateTufRepo(t, td, r, "foo1")
// Use newTuf and successfully get updated metadata using the cached remote location.
resetForTests()
tufObj, err = NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
if b, err := tufObj.GetTarget("foo.txt"); err != nil || !bytes.Equal(b, []byte("foo1")) {
t.Fatal(err)
}
resetForTests()
}
func TestCustomRootFileRemoteStore(t *testing.T) {
ctx := context.Background()
// Create a remote repository.
td := t.TempDir()
remote, r := newTufRepo(t, td, "foo")
// Initialize with custom root.
tufRoot := t.TempDir()
t.Setenv("TUF_ROOT", tufRoot)
meta, err := remote.GetMeta()
if err != nil {
t.Error(err)
}
rootBytes, ok := meta["root.json"]
if !ok {
t.Error(err)
}
// Tack on repository to the end of the td above since that's where
// newTufRepo creates the repository.
fileURI := fmt.Sprintf("file://%s", filepath.Join(td, "repository"))
if err := Initialize(ctx, fileURI, rootBytes); err != nil {
t.Error(err)
}
if l := dirLen(t, tufRoot); l == 0 {
t.Errorf("expected filesystem writes, got %d entries", l)
}
// Successfully get target.
tufObj, err := NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
if b, err := tufObj.GetTarget("foo.txt"); err != nil || !bytes.Equal(b, []byte("foo")) {
t.Fatal(err)
}
resetForTests()
// Force expiration on the first timestamp and internal go-tuf verification.
forceExpirationVersion(t, 1)
oldIsExpired := verify.IsExpired
verify.IsExpired = func(time time.Time) bool {
return true
}
// This should cause an error that remote metadata is expired.
if _, err = NewFromEnv(ctx); err == nil {
t.Errorf("expected expired timestamp from the remote")
}
// Let internal TUF verification succeed normally now.
verify.IsExpired = oldIsExpired
// Update remote targets, issue a timestamp v2.
updateTufRepo(t, td, r, "foo1")
// Use newTuf and successfully get updated metadata using the cached remote location.
resetForTests()
tufObj, err = NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
if b, err := tufObj.GetTarget("foo.txt"); err != nil || !bytes.Equal(b, []byte("foo1")) {
t.Fatal(err)
}
resetForTests()
}
func TestGetTargetsByMeta(t *testing.T) {
ctx := context.Background()
// Create a remote repository.
td := t.TempDir()
remote, _ := newTufCustomRepo(t, td, "foo")
// Serve remote repository.
s := httptest.NewServer(http.FileServer(http.Dir(filepath.Join(td, "repository"))))
defer s.Close()
// Initialize with custom root.
tufRoot := t.TempDir()
t.Setenv("TUF_ROOT", tufRoot)
meta, err := remote.GetMeta()
if err != nil {
t.Error(err)
}
rootBytes, ok := meta["root.json"]
if !ok {
t.Error(err)
}
if err := Initialize(ctx, s.URL, rootBytes); err != nil {
t.Error(err)
}
if l := dirLen(t, tufRoot); l == 0 {
t.Errorf("expected filesystem writes, got %d entries", l)
}
tufObj, err := NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
defer resetForTests()
// Fetch a target with no custom metadata.
targets, err := tufObj.GetTargetsByMeta(UnknownUsage, []string{"fooNoCustom.txt"})
if err != nil {
t.Fatal(err)
}
if len(targets) != 1 {
t.Fatalf("expected one target without custom metadata, got %d targets", len(targets))
}
if !bytes.Equal(targets[0].Target, []byte("foo")) {
t.Fatalf("target metadata mismatched, expected: %s, got: %s", "foo", string(targets[0].Target))
}
if targets[0].Status != Active {
t.Fatalf("target without custom metadata not active, got: %v", targets[0].Status)
}
// Fetch multiple targets with no custom metadata.
targets, err = tufObj.GetTargetsByMeta(UnknownUsage, []string{"fooNoCustom.txt", "fooNoCustomOther.txt"})
if err != nil {
t.Fatal(err)
}
if len(targets) != 2 {
t.Fatalf("expected two targets without custom metadata, got %d targets", len(targets))
}
if targets[0].Status != Active || targets[1].Status != Active {
t.Fatalf("target without custom metadata not active, got: %v and %v", targets[0].Status, targets[1].Status)
}
// Specify multiple fallbacks with no custom metadata.
targets, err = tufObj.GetTargetsByMeta(UnknownUsage, []string{"fooNoCustom.txt", "fooNoCustomOtherMissingTarget.txt"})
if err != nil {
t.Fatal(err)
}
if len(targets) != 1 {
t.Fatalf("expected one targets without custom metadata, got %d targets", len(targets))
}
if targets[0].Status != Active {
t.Fatalf("target without custom metadata not active, got: %v and %v", targets[0].Status, targets[1].Status)
}
// Fetch targets with custom metadata.
targets, err = tufObj.GetTargetsByMeta(Fulcio, []string{"fooNoCustom.txt"})
if err != nil {
t.Fatal(err)
}
if len(targets) != 2 {
t.Fatalf("expected two targets without custom metadata, got %d targets", len(targets))
}
targetBytes := []string{string(targets[0].Target), string(targets[1].Target)}
expectedTB := []string{"foo", "foo"}
if !reflect.DeepEqual(targetBytes, expectedTB) {
t.Fatalf("target metadata mismatched, expected: %v, got: %v", expectedTB, targetBytes)
}
targetStatuses := []StatusKind{targets[0].Status, targets[1].Status}
sort.Slice(targetStatuses, func(i, j int) bool {
return targetStatuses[i] < targetStatuses[j]
})
expectedTS := []StatusKind{Active, Expired}
if !reflect.DeepEqual(targetStatuses, expectedTS) {
t.Fatalf("unexpected target status with custom metadata, expected %v, got: %v", expectedTS, targetStatuses)
}
// Error when fetching target that does not exist.
_, err = tufObj.GetTargetsByMeta(UsageKind(UnknownStatus), []string{"unknown.txt"})
expectedErr := "file not found: unknown.txt"
if !strings.Contains(err.Error(), "not found: unknown.txt") {
t.Fatalf("unexpected error fetching missing metadata, expected: %s, got: %s", expectedErr, err.Error())
}
}
func makeMapFS(repo string) (fs fstest.MapFS) {
fs = make(fstest.MapFS)
_ = filepath.Walk(repo,
func(fpath string, info os.FileInfo, err error) error {
if err != nil {
return err
}
rel, _ := filepath.Rel(repo, fpath)
if info.IsDir() {
fs[path.Join("repository", rel)] = &fstest.MapFile{Mode: os.ModeDir}
} else {
b, _ := os.ReadFile(fpath)
fs[path.Join("repository", rel)] = &fstest.MapFile{Data: b}
}
return nil
})
return
}
// Regression test for failure to fetch a target that does not exist in the embedded
// repository on an update. The new target exists on the remote before the TUF object
// is initialized.
func TestUpdatedTargetNamesEmbedded(t *testing.T) {
td := t.TempDir()
// Set the TUF_ROOT so we don't interact with other tests and local TUF roots.
t.Setenv("TUF_ROOT", td)
origEmbedded := getEmbedded
origDefaultRemote := getRemoteRoot
// Create an "expired" embedded repository that does not contain newTarget.
ctx := context.Background()
store, r := newTufCustomRepo(t, td, "foo")
repository := filepath.FromSlash(filepath.Join(td, "repository"))
mapfs := makeMapFS(repository)
getEmbedded = func() fs.FS { return mapfs }
oldIsExpired := isExpiredTimestamp
isExpiredTimestamp = func(metadata []byte) bool {
m, _ := store.GetMeta()
timestampExpires, _ := getExpiration(m["timestamp.json"])
metadataExpires, _ := getExpiration(metadata)
return metadataExpires.Sub(*timestampExpires) <= 0
}
defer func() {
getEmbedded = origEmbedded
getRemoteRoot = origDefaultRemote
isExpiredTimestamp = oldIsExpired
}()
// Assert that the embedded repository does not contain the newTarget.
newTarget := "fooNew.txt"
rd, ok := getEmbedded().(fs.ReadFileFS)
if !ok {
t.Fatal("fs.ReadFileFS unimplemented for embedded repo")
}
if _, err := rd.ReadFile(path.Join("repository", "targets", newTarget)); err == nil {
t.Fatal("embedded repository should not contain new target")
}
// Serve an updated remote repository with the newTarget.
addNewCustomTarget(t, td, r, map[string]string{newTarget: "newdata"})
s := httptest.NewServer(http.FileServer(http.Dir(repository)))
defer s.Close()
getRemoteRoot = func() string { return s.URL }
// Initialize.
tufObj, err := NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
defer resetForTests()
// Try to retrieve the newly added target.
targets, err := tufObj.GetTargetsByMeta(Fulcio, []string{"fooNoCustom.txt"})
if err != nil {
t.Fatal(err)
}
if len(targets) != 3 {
t.Fatalf("expected three target without custom metadata, got %d targets", len(targets))
}
targetBytes := []string{string(targets[0].Target), string(targets[1].Target), string(targets[2].Target)}
expectedTB := []string{"foo", "foo", "newdata"}
if !cmp.Equal(targetBytes, expectedTB,
cmpopts.SortSlices(func(a, b string) bool { return a < b })) {
t.Fatalf("target data mismatched, expected: %v, got: %v", expectedTB, targetBytes)
}
}
func checkTargetsAndMeta(t *testing.T, tuf *TUF, expected []string) {
// Check the targets
t.Helper()
for _, target := range expected {
if _, err := tuf.GetTarget(target); err != nil {
t.Fatal(err)
}
}
// An invalid target
if _, err := tuf.GetTarget("invalid"); err == nil {
t.Error("expected error reading target, got nil")
}
// Check root status.
_, err := tuf.getRootStatus()
if err != nil {
t.Fatal(err)
}
}
func dirLen(t *testing.T, td string) int {
t.Helper()
de, err := os.ReadDir(td)
if err != nil {
t.Fatal(err)
}
return len(de)
}
func forceExpiration(t *testing.T, expire bool) {
oldIsExpiredTimestamp := isExpiredTimestamp
isExpiredTimestamp = func(_ []byte) bool {
return expire
}
t.Cleanup(func() {
isExpiredTimestamp = oldIsExpiredTimestamp
})
}
func forceExpirationVersion(t *testing.T, version int64) {
oldIsExpiredTimestamp := isExpiredTimestamp
isExpiredTimestamp = func(metadata []byte) bool {
s := &data.Signed{}
if err := json.Unmarshal(metadata, s); err != nil {
return true
}
sm := &data.Timestamp{}
if err := json.Unmarshal(s.Signed, sm); err != nil {
return true
}
return sm.Version <= version
}
t.Cleanup(func() {
isExpiredTimestamp = oldIsExpiredTimestamp
})
}
// newTufCustomRepo initializes a TUF repository with root, targets, snapshot, and timestamp roles
// 4 targets are created to exercise various code paths, including two targets with no custom metadata,
// one target with custom metadata marked as active, and another with custom metadata marked as expired.
func newTufCustomRepo(t *testing.T, td, targetData string) (tuf.LocalStore, *tuf.Repo) {
scmActive, err := json.Marshal(&sigstoreCustomMetadata{Sigstore: customMetadata{Usage: Fulcio, Status: Active}})
if err != nil {
t.Error(err)
}
scmExpired, err := json.Marshal(&sigstoreCustomMetadata{Sigstore: customMetadata{Usage: Fulcio, Status: Expired}})
if err != nil {
t.Error(err)
}
remote := tuf.FileSystemStore(td, nil)
r, err := tuf.NewRepo(remote)
if err != nil {
t.Error(err)
}
if err := r.Init(false); err != nil {
t.Error(err)
}
for _, role := range []string{"root", "targets", "snapshot", "timestamp"} {
if _, err := r.GenKey(role); err != nil {
t.Error(err)
}
}
for name, scm := range map[string]json.RawMessage{
"fooNoCustom.txt": nil, "fooNoCustomOther.txt": nil,
"fooActive.txt": scmActive, "fooExpired.txt": scmExpired,
} {
targetPath := filepath.FromSlash(filepath.Join(td, "staged", "targets", name))
if err := os.MkdirAll(filepath.Dir(targetPath), 0o755); err != nil {
t.Error(err)
}
if err := os.WriteFile(targetPath, []byte(targetData), 0o600); err != nil {
t.Error(err)
}
if err := r.AddTarget(name, scm); err != nil {
t.Error(err)
}
}
if err := r.Snapshot(); err != nil {
t.Error(err)
}
if err := r.Timestamp(); err != nil {
t.Error(err)
}
if err := r.Commit(); err != nil {
t.Error(err)
}
return remote, r
}
func addNewCustomTarget(t *testing.T, td string, r *tuf.Repo, targetData map[string]string) {
scmActive, err := json.Marshal(&sigstoreCustomMetadata{Sigstore: customMetadata{Usage: Fulcio, Status: Active}})
if err != nil {
t.Error(err)
}
for name, data := range targetData {
targetPath := filepath.FromSlash(filepath.Join(td, "staged", "targets", name))
if err := os.MkdirAll(filepath.Dir(targetPath), 0o755); err != nil {
t.Error(err)
}
if err := os.WriteFile(targetPath, []byte(data), 0o600); err != nil {
t.Error(err)
}
if err := r.AddTarget(name, scmActive); err != nil {
t.Error(err)
}
}
if err := r.Snapshot(); err != nil {
t.Error(err)
}
if err := r.Timestamp(); err != nil {
t.Error(err)
}
if err := r.Commit(); err != nil {
t.Error(err)
}
}
func newTufRepo(t *testing.T, td, targetData string) (tuf.LocalStore, *tuf.Repo) {
remote := tuf.FileSystemStore(td, nil)
r, err := tuf.NewRepo(remote)
if err != nil {
t.Error(err)
}
if err := r.Init(false); err != nil {
t.Error(err)
}
for _, role := range []string{"root", "targets", "snapshot", "timestamp"} {
if _, err := r.GenKey(role); err != nil {
t.Error(err)
}
}
targetPath := filepath.FromSlash(filepath.Join(td, "staged", "targets", "foo.txt"))
if err := os.MkdirAll(filepath.Dir(targetPath), 0o755); err != nil {
t.Error(err)
}
if err := os.WriteFile(targetPath, []byte(targetData), 0o600); err != nil {
t.Error(err)
}
if err := r.AddTarget("foo.txt", nil); err != nil {
t.Error(err)
}
if err := r.Snapshot(); err != nil {
t.Error(err)
}
if err := r.Timestamp(); err != nil {
t.Error(err)
}
if err := r.Commit(); err != nil {
t.Error(err)
}
return remote, r
}
func updateTufRepo(t *testing.T, td string, r *tuf.Repo, targetData string) {
targetPath := filepath.FromSlash(filepath.Join(td, "staged", "targets", "foo.txt"))
if err := os.MkdirAll(filepath.Dir(targetPath), 0o755); err != nil {
t.Error(err)
}
if err := os.WriteFile(targetPath, []byte(targetData), 0o600); err != nil {
t.Error(err)
}
if err := r.AddTarget("foo.txt", nil); err != nil {
t.Error(err)
}
if err := r.Snapshot(); err != nil {
t.Error(err)
}
if err := r.Timestamp(); err != nil {
t.Error(err)
}
if err := r.Commit(); err != nil {
t.Error(err)
}
}
func TestConcurrentAccessNewFromEnv(t *testing.T) {
var wg sync.WaitGroup
for i := 0; i < 20; i++ {
wg.Add(1)
go func() {
defer wg.Done()
tufObj, err := NewFromEnv(context.Background())
if err != nil {
t.Errorf("Failed to construct NewFromEnv: %s", err)
}
if tufObj == nil {
t.Error("Got back nil tufObj")
}
time.Sleep(1 * time.Second)
}()
}
wg.Wait()
resetForTests()
}
func TestConcurrentAccessInitialize(t *testing.T) {
var wg sync.WaitGroup
for i := 0; i < 20; i++ {
wg.Add(1)
go func() {
defer wg.Done()
err := Initialize(context.Background(), DefaultRemoteRoot, nil)
if err != nil {
t.Errorf("Failed to construct NewFromEnv: %s", err)
}
time.Sleep(1 * time.Second)
}()
}
wg.Wait()
resetForTests()
}
// Test to validate that sigstore TUF client can cache targets that
// are located in sub-folders.
func TestTargetsSubfolder(t *testing.T) {
ctx := context.Background()
// Create a remote repository.
td := t.TempDir()
remote, r := newTufCustomRepo(t, td, "foo")
newTarget := "subfolder/fooNew.txt"
addNewCustomTarget(t, td, r, map[string]string{newTarget: "newdata"})
// Serve remote repository.
s := httptest.NewServer(http.FileServer(http.Dir(filepath.Join(td, "repository"))))
defer s.Close()
// Initialize with custom root.
tufRoot := t.TempDir()
// Set the TUF_ROOT so we don't interact with other tests and local TUF roots.
t.Setenv("TUF_ROOT", tufRoot)
meta, err := remote.GetMeta()
if err != nil {
t.Error(err)
}
rootBytes, ok := meta["root.json"]
if !ok {
t.Error(err)
}
if err := Initialize(ctx, s.URL, rootBytes); err != nil {
t.Error(err)
}
defer resetForTests()
tuf, err := NewFromEnv(ctx)
if err != nil {
t.Fatal(err)
}
checkTargetsAndMeta(t, tuf, []string{newTarget})
}
func Test_remoteFromMirror(t *testing.T) {
// test GCS mirror
mirror := "test-bucket"
_, err := remoteFromMirror(mirror)
if err != nil {
t.Fatalf("unexpected error with GCS mirror: %v", err)
}
// test HTTP mirror
mirror = "https://tuf-repo-cdn.sigstage.dev"
_, err = remoteFromMirror(mirror)
if err != nil {
t.Fatalf("unexpected error with GCS mirror: %v", err)
}
// test local mirror
tufRoot := t.TempDir()
os.Mkdir(fmt.Sprintf("%s/targets", tufRoot), 0o0750)
mirror = fmt.Sprintf("file://%s", tufRoot)
_, err = remoteFromMirror(mirror)
if err != nil {
t.Fatalf("unexpected error with GCS mirror: %v", err)
}
}
|