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
|
// Copyright 2024 The Update Framework 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
//
// SPDX-License-Identifier: Apache-2.0
//
package trustedmetadata
import (
"crypto"
"os"
"path/filepath"
"testing"
"time"
"github.com/sigstore/sigstore/pkg/cryptoutils"
"github.com/sigstore/sigstore/pkg/signature"
"github.com/stretchr/testify/assert"
"github.com/theupdateframework/go-tuf/v2/internal/testutils"
"github.com/theupdateframework/go-tuf/v2/metadata"
)
var allRoles map[string][]byte
func setAllRolesBytes(path string) {
log := metadata.GetLogger()
allRoles = make(map[string][]byte)
rootPath := filepath.Join(path, "root.json")
root, err := os.ReadFile(rootPath)
if err != nil {
log.Error(err, "failed to read root bytes")
os.Exit(1)
}
allRoles[metadata.ROOT] = root
targetsPath := filepath.Join(path, "targets.json")
targets, err := os.ReadFile(targetsPath)
if err != nil {
log.Error(err, "failed to read targets bytes")
os.Exit(1)
}
allRoles[metadata.TARGETS] = targets
snapshotPath := filepath.Join(path, "snapshot.json")
snapshot, err := os.ReadFile(snapshotPath)
if err != nil {
log.Error(err, "failed to read snapshot bytes")
os.Exit(1)
}
allRoles[metadata.SNAPSHOT] = snapshot
timestampPath := filepath.Join(path, "timestamp.json")
timestamp, err := os.ReadFile(timestampPath)
if err != nil {
log.Error(err, "failed to read timestamp bytes")
os.Exit(1)
}
allRoles[metadata.TIMESTAMP] = timestamp
role1Path := filepath.Join(path, "role1.json")
role1, err := os.ReadFile(role1Path)
if err != nil {
log.Error(err, "failed to read role1 bytes")
os.Exit(1)
}
allRoles["role1"] = role1
role2Path := filepath.Join(path, "role2.json")
role2, err := os.ReadFile(role2Path)
if err != nil {
log.Error(err, "failed to read role2 bytes")
os.Exit(1)
}
allRoles["role2"] = role2
}
func TestMain(m *testing.M) {
log := metadata.GetLogger()
repoPath := "../../internal/testutils/repository_data/repository/metadata"
keystorePath := "../../internal/testutils/repository_data/keystore"
targetsPath := "../../internal/testutils/repository_data/repository/targets"
err := testutils.SetupTestDirs(repoPath, targetsPath, keystorePath)
defer testutils.Cleanup()
if err != nil {
log.Error(err, "failed to setup test dirs")
os.Exit(1)
}
setAllRolesBytes(testutils.RepoDir)
m.Run()
}
type modifyRoot func(*metadata.Metadata[metadata.RootType])
func modifyRootMetadata(fn modifyRoot) ([]byte, error) {
log := metadata.GetLogger()
root, err := metadata.Root().FromBytes(allRoles[metadata.ROOT])
if err != nil {
log.Error(err, "failed to create root metadata from bytes")
}
fn(root)
signer, err := signature.LoadSignerFromPEMFile(filepath.Join(testutils.KeystoreDir, "root_key"), crypto.SHA256, cryptoutils.SkipPassword)
if err != nil {
log.Error(err, "failed to load signer from pem file")
}
root.ClearSignatures()
_, err = root.Sign(signer)
if err != nil {
log.Error(err, "failed to sign root")
}
return root.ToBytes(true)
}
type modifyTimestamp func(*metadata.Metadata[metadata.TimestampType])
func modifyTimestamptMetadata(fn modifyTimestamp) ([]byte, error) {
log := metadata.GetLogger()
timestamp, err := metadata.Timestamp().FromBytes(allRoles[metadata.TIMESTAMP])
if err != nil {
log.Error(err, "failed to create timestamp metadata from bytes")
}
fn(timestamp)
signer, err := signature.LoadSignerFromPEMFile(filepath.Join(testutils.KeystoreDir, "timestamp_key"), crypto.SHA256, cryptoutils.SkipPassword)
if err != nil {
log.Error(err, "failed to load signer from pem file")
}
timestamp.ClearSignatures()
_, err = timestamp.Sign(signer)
if err != nil {
log.Error(err, "failed to sign timestamp")
}
return timestamp.ToBytes(true)
}
type modifySnapshot func(*metadata.Metadata[metadata.SnapshotType])
func modifySnapshotMetadata(fn modifySnapshot) ([]byte, error) {
log := metadata.GetLogger()
snapshot, err := metadata.Snapshot().FromBytes(allRoles[metadata.SNAPSHOT])
if err != nil {
log.Error(err, "failed to create snapshot metadata from bytes")
}
fn(snapshot)
signer, err := signature.LoadSignerFromPEMFile(filepath.Join(testutils.KeystoreDir, "snapshot_key"), crypto.SHA256, cryptoutils.SkipPassword)
if err != nil {
log.Error(err, "failed to load signer from pem file")
}
snapshot.ClearSignatures()
_, err = snapshot.Sign(signer)
if err != nil {
log.Error(err, "failed to sign snapshot")
}
return snapshot.ToBytes(true)
}
type modifyTargets func(*metadata.Metadata[metadata.TargetsType])
func modifyTargetsMetadata(fn modifyTargets) ([]byte, error) {
log := metadata.GetLogger()
targets, err := metadata.Targets().FromBytes(allRoles[metadata.TARGETS])
if err != nil {
log.Error(err, "failed to create targets metadata from bytes")
}
fn(targets)
signer, err := signature.LoadSignerFromPEMFile(filepath.Join(testutils.KeystoreDir, "targets_key"), crypto.SHA256, cryptoutils.SkipPassword)
if err != nil {
log.Error(err, "failed to load signer from pem file")
}
targets.ClearSignatures()
_, err = targets.Sign(signer)
if err != nil {
log.Error(err, "failed to sign targets")
}
return targets.ToBytes(true)
}
func TestUpdate(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.NoError(t, err)
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.NoError(t, err)
_, err = trustedSet.UpdateDelegatedTargets(allRoles["role1"], "role1", metadata.TARGETS)
assert.NoError(t, err)
_, err = trustedSet.UpdateDelegatedTargets(allRoles["role2"], "role2", "role1")
assert.NoError(t, err)
// The 4 top level metadata objects + 2 additional delegated targets
// self.assertTrue(len(self.trusted_set), 6)
assert.NotNil(t, trustedSet.Root)
assert.NotNil(t, trustedSet.Timestamp)
assert.NotNil(t, trustedSet.Snapshot)
assert.NotNil(t, trustedSet.Targets)
}
func TestOutOfOrderOps(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
// Update snapshot before timestamp
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.ErrorIs(t, err, &metadata.ErrRuntime{Msg: "cannot update snapshot before timestamp"})
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.NoError(t, err)
// Update root after timestamp
_, err = trustedSet.UpdateRoot(allRoles[metadata.ROOT])
assert.ErrorIs(t, err, &metadata.ErrRuntime{Msg: "cannot update root after timestamp"})
// Update targets before snapshot
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.ErrorIs(t, err, &metadata.ErrRuntime{Msg: "cannot load targets before snapshot"})
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.NoError(t, err)
// Update timestamp after snapshot
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.ErrorIs(t, err, &metadata.ErrRuntime{Msg: "cannot update timestamp after snapshot"})
// Update delegated targets before targets
_, err = trustedSet.UpdateDelegatedTargets(allRoles["role1"], "role1", metadata.TARGETS)
assert.ErrorIs(t, err, &metadata.ErrRuntime{Msg: "cannot load targets before delegator"})
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.NoError(t, err)
// Update snapshot after sucessful targets update
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.ErrorIs(t, err, &metadata.ErrRuntime{Msg: "cannot update snapshot after targets"})
_, err = trustedSet.UpdateDelegatedTargets(allRoles["role1"], "role1", metadata.TARGETS)
assert.NoError(t, err)
}
func TestRootWithInvalidJson(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
// Test loading initial root and root update
// root is not json
_, err = trustedSet.UpdateRoot([]byte(""))
assert.ErrorContains(t, err, "unexpected end of JSON input")
// root is not valid
root, err := metadata.Root().FromBytes(allRoles[metadata.ROOT])
assert.NoError(t, err)
root.Signed.Version += 1
rootBytes, err := root.ToBytes(true)
assert.NoError(t, err)
_, err = trustedSet.UpdateRoot(rootBytes)
assert.ErrorIs(t, err, &metadata.ErrUnsignedMetadata{Msg: "Verifying root failed, not enough signatures, got 0, want 1"})
// metadata is of wrong type
_, err = trustedSet.UpdateRoot(allRoles[metadata.SNAPSHOT])
assert.ErrorIs(t, err, &metadata.ErrValue{Msg: "expected metadata type root, got - snapshot"})
}
func TestTopLevelMetadataWithInvalidJSON(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
//TIMESTAMP
// timestamp is not json
_, err = trustedSet.UpdateTimestamp([]byte(""))
assert.ErrorContains(t, err, "unexpected end of JSON input")
// timestamp is not valid
timestamp, err := metadata.Timestamp().FromBytes(allRoles[metadata.TIMESTAMP])
assert.NoError(t, err)
properTimestampBytes, err := timestamp.ToBytes(true)
assert.NoError(t, err)
timestamp.Signed.Version += 1
timestampBytes, err := timestamp.ToBytes(true)
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(timestampBytes)
assert.ErrorIs(t, err, &metadata.ErrUnsignedMetadata{Msg: "Verifying timestamp failed, not enough signatures, got 0, want 1"})
// timestamp is of wrong type
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.ROOT])
assert.ErrorIs(t, err, &metadata.ErrValue{Msg: "expected metadata type timestamp, got - root"})
// SNAPSHOT
_, err = trustedSet.UpdateTimestamp(properTimestampBytes)
assert.NoError(t, err)
// snapshot is not json
_, err = trustedSet.UpdateSnapshot([]byte(""), false)
assert.ErrorContains(t, err, "unexpected end of JSON input")
// snapshot is not valid
snapshot, err := metadata.Snapshot().FromBytes(allRoles[metadata.SNAPSHOT])
assert.NoError(t, err)
properSnapshotBytes, err := snapshot.ToBytes(true)
assert.NoError(t, err)
snapshot.Signed.Version += 1
snapshotBytes, err := snapshot.ToBytes(true)
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(snapshotBytes, false)
assert.ErrorIs(t, err, &metadata.ErrUnsignedMetadata{Msg: "Verifying snapshot failed, not enough signatures, got 0, want 1"})
// snapshot is of wrong type
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.ROOT], false)
assert.ErrorIs(t, err, &metadata.ErrValue{Msg: "expected metadata type snapshot, got - root"})
// TARGETS
_, err = trustedSet.UpdateSnapshot(properSnapshotBytes, false)
assert.NoError(t, err)
// targets is not json
_, err = trustedSet.UpdateTargets([]byte(""))
assert.ErrorContains(t, err, "unexpected end of JSON input")
// targets is not valid
targets, err := metadata.Targets().FromBytes(allRoles[metadata.TARGETS])
assert.NoError(t, err)
targets.Signed.Version += 1
targetsBytes, err := targets.ToBytes(true)
assert.NoError(t, err)
_, err = trustedSet.UpdateTargets(targetsBytes)
assert.ErrorIs(t, err, &metadata.ErrUnsignedMetadata{Msg: "Verifying targets failed, not enough signatures, got 0, want 1"})
// targets is of wrong type
_, err = trustedSet.UpdateTargets(allRoles[metadata.ROOT])
assert.ErrorIs(t, err, &metadata.ErrValue{Msg: "expected metadata type targets, got - root"})
}
func TestUpdateRootNewRoot(t *testing.T) {
// Test that root can be updated with a new valid version
modifyRootVersion := func(root *metadata.Metadata[metadata.RootType]) {
root.Signed.Version += 1
}
root, err := modifyRootMetadata(modifyRootVersion)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateRoot(root)
assert.NoError(t, err)
}
func TestUpdateRootNewRootFailTreshholdVerification(t *testing.T) {
// Increase threshold in new root, do not add enough keys
bumpRootThreshold := func(root *metadata.Metadata[metadata.RootType]) {
root.Signed.Version += 1
root.Signed.Roles[metadata.ROOT].Threshold += 1
}
root, err := modifyRootMetadata(bumpRootThreshold)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateRoot(root)
assert.ErrorIs(t, err, &metadata.ErrUnsignedMetadata{Msg: "Verifying root failed, not enough signatures, got 1, want 2"})
}
func TestUpdateRootNewRootVerSameAsTrustedRootVer(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateRoot(allRoles[metadata.ROOT])
assert.ErrorIs(t, err, &metadata.ErrBadVersionNumber{Msg: "bad version number, expected 2, got 1"})
}
func TestRootExpiredFinalRoot(t *testing.T) {
// test that root can be updated with a new valid version
modifyRootExpiry := func(root *metadata.Metadata[metadata.RootType]) {
root.Signed.Expires = time.Date(1970, 1, 1, 0, 0, 0, 0, time.UTC)
}
// Intermediate root can be expired
root, err := modifyRootMetadata(modifyRootExpiry)
assert.NoError(t, err)
trustedSet, err := New(root)
assert.NoError(t, err)
// Update timestamp to trigger final root expiry check
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.ErrorIs(t, err, &metadata.ErrExpiredMetadata{Msg: "final root.json is expired"})
}
func TestUpdateTimestampNewTimestampVerBelowTrustedVer(t *testing.T) {
// newTimestamp.Version < trustedTimestamp.Version
modifyTimestampVersion := func(timestamp *metadata.Metadata[metadata.TimestampType]) {
timestamp.Signed.Version = 3
}
timestamp, err := modifyTimestamptMetadata(modifyTimestampVersion)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(timestamp)
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.ErrorIs(t, err, &metadata.ErrBadVersionNumber{Msg: "new timestamp version 1 must be >= 3"})
}
func TestUpdateTimestampWithSameTimestamp(t *testing.T) {
// Test that timestamp is NOT updated if:
// newTimestamp.Version = trustedTimestamp.Version
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.NoError(t, err)
initialTimestamp := trustedSet.Timestamp
// Update timestamp with the same version.
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
// EqualVersionNumberError
assert.ErrorIs(t, err, &metadata.ErrEqualVersionNumber{Msg: "new timestamp version 1 equals the old one 1"})
// Verify that the timestamp object was not updated.
assert.Equal(t, initialTimestamp, trustedSet.Timestamp)
}
func TestUpdateTimestampSnapshotCerBellowCurrent(t *testing.T) {
bumpSnapshotVersion := func(timestamp *metadata.Metadata[metadata.TimestampType]) {
timestamp.Signed.Meta["snapshot.json"].Version = 2
// The timestamp version must be increased to initiate a update.
timestamp.Signed.Version += 1
}
// Set current known snapshot.json version to 2
timestamp, err := modifyTimestamptMetadata(bumpSnapshotVersion)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(timestamp)
assert.NoError(t, err)
// new timestamp meta version < trusted timestamp meta version
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.ErrorIs(t, err, &metadata.ErrBadVersionNumber{Msg: "new timestamp version 1 must be >= 2"})
}
func TestUpdateTimestampExpired(t *testing.T) {
// New timestamp has expired
modifyTimestampExpiry := func(timestamp *metadata.Metadata[metadata.TimestampType]) {
timestamp.Signed.Expires = time.Date(1970, 1, 1, 0, 0, 0, 0, time.UTC)
}
// Expired intermediate timestamp is loaded but raises ExpiredMetadataError
timestamp, err := modifyTimestamptMetadata(modifyTimestampExpiry)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(timestamp)
assert.ErrorIs(t, err, &metadata.ErrExpiredMetadata{Msg: "timestamp.json is expired"})
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.ErrorIs(t, err, &metadata.ErrExpiredMetadata{Msg: "timestamp.json is expired"})
}
func TestUpdateSnapshotLengthOrHashMismatch(t *testing.T) {
modifySnapshotLength := func(timestamp *metadata.Metadata[metadata.TimestampType]) {
timestamp.Signed.Meta["snapshot.json"].Length = 1
}
// Set known snapshot.json length to 1
timestamp, err := modifyTimestamptMetadata(modifySnapshotLength)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(timestamp)
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.ErrorIs(t, err, &metadata.ErrLengthOrHashMismatch{Msg: "length verification failed - expected 1, got 652"})
}
func TestUpdateSnapshotFailThreshholdVerification(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.NoError(t, err)
snapshot, err := metadata.Snapshot().FromBytes(allRoles[metadata.SNAPSHOT])
assert.NoError(t, err)
snapshot.ClearSignatures()
snapshotBytes, err := snapshot.ToBytes(true)
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(snapshotBytes, false)
assert.ErrorIs(t, err, &metadata.ErrUnsignedMetadata{Msg: "Verifying snapshot failed, not enough signatures, got 0, want 1"})
}
func TestUpdateSnapshotVersionDivergeTimestampSnapshotVersion(t *testing.T) {
modifyTimestampVersion := func(timestamp *metadata.Metadata[metadata.TimestampType]) {
timestamp.Signed.Meta["snapshot.json"].Version = 2
}
timestamp, err := modifyTimestamptMetadata(modifyTimestampVersion)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(timestamp)
assert.NoError(t, err)
// If intermediate snapshot version is incorrect, load it but also raise
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.ErrorIs(t, err, &metadata.ErrBadVersionNumber{Msg: "expected 2, got 1"})
// Targets update starts but fails if snapshot version does not match
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.ErrorIs(t, err, &metadata.ErrBadVersionNumber{Msg: "expected 2, got 1"})
}
// Update all metadata roles besides targets.
func updateAllBesidesTargets(trustedSet *TrustedMetadata, timestampBytes []byte, snapshotBytes []byte) error {
if len(timestampBytes) <= 0 {
timestampBytes = allRoles[metadata.TIMESTAMP]
}
_, err := trustedSet.UpdateTimestamp(timestampBytes)
if err != nil {
return err
}
if len(snapshotBytes) <= 0 {
snapshotBytes = allRoles[metadata.SNAPSHOT]
}
_, err = trustedSet.UpdateSnapshot(snapshotBytes, false)
if err != nil {
return err
}
return nil
}
func TestUpdateSnapshotFileRemovedFromMeta(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
err = updateAllBesidesTargets(trustedSet, allRoles[metadata.TIMESTAMP], []byte{})
assert.NoError(t, err)
removeFileFromMeta := func(snaphot *metadata.Metadata[metadata.SnapshotType]) {
delete(snaphot.Signed.Meta, "targets.json")
}
// Test removing a meta_file in new_snapshot compared to the old snapshot
snapshot, err := modifySnapshotMetadata(removeFileFromMeta)
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(snapshot, false)
assert.ErrorIs(t, err, &metadata.ErrRepository{Msg: "new snapshot is missing info for targets.json"})
}
func TestUpdateSnapshotMetaVersionDecreases(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.NoError(t, err)
modifyMetaVersion := func(snaphot *metadata.Metadata[metadata.SnapshotType]) {
snaphot.Signed.Meta["targets.json"].Version += 1
}
snapshot, err := modifySnapshotMetadata(modifyMetaVersion)
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(snapshot, false)
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.ErrorIs(t, err, &metadata.ErrBadVersionNumber{Msg: "expected targets.json version 1, got 2"})
}
func TestUpdateSnapshotExpiredNewSnapshot(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.NoError(t, err)
modifySnapshotExpired := func(snaphot *metadata.Metadata[metadata.SnapshotType]) {
snaphot.Signed.Expires = time.Date(1970, 1, 1, 0, 0, 0, 0, time.UTC)
}
// Expired intermediate snapshot is loaded but will raise
snapshot, err := modifySnapshotMetadata(modifySnapshotExpired)
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(snapshot, false)
assert.ErrorIs(t, err, &metadata.ErrExpiredMetadata{Msg: "snapshot.json is expired"})
// Targets update does start but fails because snapshot is expired
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.ErrorIs(t, err, &metadata.ErrExpiredMetadata{Msg: "snapshot.json is expired"})
}
func TestUpdateSnapshotSuccessfulRollbackChecks(t *testing.T) {
// Load a "local" timestamp, then update to newer one:
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(allRoles[metadata.TIMESTAMP])
assert.NoError(t, err)
bumpMetaVersion := func(timestamp *metadata.Metadata[metadata.TimestampType]) {
timestamp.Signed.Meta["snapshot.json"].Version += 1
// The timestamp version must be increased to initiate a update.
timestamp.Signed.Version += 1
}
newTimestamp, err := modifyTimestamptMetadata(bumpMetaVersion)
assert.NoError(t, err)
_, err = trustedSet.UpdateTimestamp(newTimestamp)
assert.NoError(t, err)
// Load a "local" snapshot with mismatching version (loading happens but
// ErrBadVersionNumber is raised), then update to newer one:
_, err = trustedSet.UpdateSnapshot(allRoles[metadata.SNAPSHOT], false)
assert.ErrorIs(t, err, &metadata.ErrBadVersionNumber{Msg: "expected 2, got 1"})
bumpVersion := func(snapahot *metadata.Metadata[metadata.SnapshotType]) {
snapahot.Signed.Version += 1
}
newSnapshot, err := modifySnapshotMetadata(bumpVersion)
assert.NoError(t, err)
_, err = trustedSet.UpdateSnapshot(newSnapshot, false)
assert.NoError(t, err)
// Update targets to trigger final snapshot meta version check
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.NoError(t, err)
}
func TestUpdateTargetsMoMetaInSnapshot(t *testing.T) {
clearMeta := func(snapshot *metadata.Metadata[metadata.SnapshotType]) {
for key := range snapshot.Signed.Meta {
delete(snapshot.Signed.Meta, key)
}
}
snapshot, err := modifySnapshotMetadata(clearMeta)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
err = updateAllBesidesTargets(trustedSet, allRoles[metadata.TIMESTAMP], snapshot)
assert.NoError(t, err)
// Remove meta information with information about targets from snapshot
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.ErrorIs(t, err, &metadata.ErrRepository{Msg: "snapshot does not contain information for targets"})
}
func TestUpdateTargetsHashDiverfeFromSnapshotMetaHash(t *testing.T) {
modifyMetaLength := func(snapshot *metadata.Metadata[metadata.SnapshotType]) {
for metafilePath := range snapshot.Signed.Meta {
snapshot.Signed.Meta[metafilePath] = &metadata.MetaFiles{
Version: 1,
Length: 1,
}
}
}
snapshot, err := modifySnapshotMetadata(modifyMetaLength)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
err = updateAllBesidesTargets(trustedSet, allRoles[metadata.TIMESTAMP], snapshot)
assert.NoError(t, err)
// Observed hash != stored hash in snapshot meta for targets
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.ErrorIs(t, err, &metadata.ErrLengthOrHashMismatch{Msg: "length verification failed - expected 1, got 1266"})
}
func TestUpdateTargetsVersionDivergeSnapshotMetaVersion(t *testing.T) {
modifyMeta := func(snapshot *metadata.Metadata[metadata.SnapshotType]) {
for metafilePath := range snapshot.Signed.Meta {
snapshot.Signed.Meta[metafilePath] = &metadata.MetaFiles{Version: 2}
}
}
snapshot, err := modifySnapshotMetadata(modifyMeta)
assert.NoError(t, err)
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
err = updateAllBesidesTargets(trustedSet, allRoles[metadata.TIMESTAMP], snapshot)
assert.NoError(t, err)
// New delegate sigfned version != meta version stored in snapshot
_, err = trustedSet.UpdateTargets(allRoles[metadata.TARGETS])
assert.ErrorIs(t, err, &metadata.ErrBadVersionNumber{Msg: "expected targets version 2, got 1"})
}
func TestUpdateTargetsExpiredMewTarget(t *testing.T) {
trustedSet, err := New(allRoles[metadata.ROOT])
assert.NoError(t, err)
err = updateAllBesidesTargets(trustedSet, allRoles[metadata.TIMESTAMP], allRoles[metadata.SNAPSHOT])
assert.NoError(t, err)
// New delegated target has expired
modifyTargetExpiry := func(targets *metadata.Metadata[metadata.TargetsType]) {
targets.Signed.Expires = time.Date(1970, 1, 1, 0, 0, 0, 0, time.UTC)
}
targets, err := modifyTargetsMetadata(modifyTargetExpiry)
assert.NoError(t, err)
_, err = trustedSet.UpdateTargets(targets)
assert.ErrorIs(t, err, &metadata.ErrExpiredMetadata{Msg: "new targets is expired"})
}
|