Remove the --compression option when creating snapshots, ref. TAP10 (#151)

* Update README.md file by removing the compression manifest option

Signed-off-by: Radoslav Dimitrov <[email protected]>

* Remove the --compression option when creating snapshots, ref. TAP10

Based on TAP10, the compression option is no longer applicable and
so it should be removed from the code base.

Signed-off-by: Radoslav Dimitrov <[email protected]>

* Update the tests affected by the removal of the --compression option

Signed-off-by: Radoslav Dimitrov <[email protected]>

* Update README.md file

Signed-off-by: Radoslav Dimitrov <[email protected]>

Author: rdimitrov

README.md

@@ -1,5 +1,6 @@
 # go-tuf
-[![build](https://github.com/theupdateframework/go-tuf/workflows/build/badge.svg)](https://github.com/theupdateframework/go-tuf/actions?query=workflow%3Abuild) [![Coverage Status](https://coveralls.io/repos/github/theupdateframework/go-tuf/badge.svg)](https://coveralls.io/github/theupdateframework/go-tuf) [![PkgGoDev](https://pkg.go.dev/badge/github.com/theupdateframework/go-tuf)](https://pkg.go.dev/github.com/theupdateframework/go-tuf) [![Go Report Card](https://goreportcard.com/badge/github.com/theupdateframework/go-tuf)](https://goreportcard.com/report/github.com/theupdateframework/go-tuf)  
+
+[![build](https://github.com/theupdateframework/go-tuf/workflows/build/badge.svg)](https://github.com/theupdateframework/go-tuf/actions?query=workflow%3Abuild) [![Coverage Status](https://coveralls.io/repos/github/theupdateframework/go-tuf/badge.svg)](https://coveralls.io/github/theupdateframework/go-tuf) [![PkgGoDev](https://pkg.go.dev/badge/github.com/theupdateframework/go-tuf)](https://pkg.go.dev/github.com/theupdateframework/go-tuf) [![Go Report Card](https://goreportcard.com/badge/github.com/theupdateframework/go-tuf)](https://goreportcard.com/report/github.com/theupdateframework/go-tuf)
 
 This is a Go implementation of [The Update Framework (TUF)](http://theupdateframework.com/),
 a framework for securing software update systems.
@@ -19,11 +20,11 @@ A TUF repository has the following directory layout:
 
 The directories contain the following files:
 
-* `keys/` - signing keys (optionally encrypted) with filename pattern `ROLE.json`
-* `repository/` - signed manifests
-* `repository/targets/` - hashed target files
-* `staged/` - either signed, unsigned or partially signed manifests
-* `staged/targets/` - unhashed target files
+- `keys/` - signing keys (optionally encrypted) with filename pattern `ROLE.json`
+- `repository/` - signed manifests
+- `repository/targets/` - hashed target files
+- `staged/` - either signed, unsigned or partially signed manifests
+- `staged/targets/` - unhashed target files
 
 ## CLI
 
@@ -70,10 +71,11 @@ Stages the removal of files with the given path(s) from the `targets` manifest
 (they get removed from the filesystem when the change is committed). Specifying
 no paths removes all files from the `targets` manifest.
 
-#### `tuf snapshot [--compression=<format>]`
+#### `tuf snapshot [--expires=<days>]`
 
 Expects a staged, fully signed `targets` manifest and stages an appropriate
-`snapshot` manifest. It optionally compresses the staged `targets` manifest.
+`snapshot` manifest. Optionally one can set number of days after which
+the snapshot manifest will expire.
 
 #### `tuf timestamp`
 

client/client_test.go

@@ -106,7 +106,7 @@ func (s *ClientSuite) SetUpTest(c *C) {
 		"timestamp": s.genKey(c, "timestamp"),
 	}
 	c.Assert(s.repo.AddTarget("foo.txt", nil), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 
@@ -162,7 +162,7 @@ func (s *ClientSuite) syncRemote(c *C) {
 
 func (s *ClientSuite) addRemoteTarget(c *C, name string) {
 	c.Assert(s.repo.AddTarget(name, nil), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -245,7 +245,7 @@ func (s *ClientSuite) TestInitRootTooLarge(c *C) {
 
 func (s *ClientSuite) TestInitRootExpired(c *C) {
 	s.genKeyExpired(c, "targets")
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -325,7 +325,7 @@ func (s *ClientSuite) TestNewRoot(c *C) {
 
 	// update metadata
 	c.Assert(s.repo.Sign("targets.json"), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -389,7 +389,7 @@ func (s *ClientSuite) TestNewTimestampKey(c *C) {
 	newIDs := s.genKey(c, "timestamp")
 
 	// generate new snapshot (because root has changed) and timestamp
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -426,7 +426,7 @@ func (s *ClientSuite) TestNewSnapshotKey(c *C) {
 	newIDs := s.genKey(c, "snapshot")
 
 	// generate new snapshot and timestamp
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -466,7 +466,7 @@ func (s *ClientSuite) TestNewTargetsKey(c *C) {
 
 	// re-sign targets and generate new snapshot and timestamp
 	c.Assert(s.repo.Sign("targets.json"), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -512,7 +512,7 @@ func (s *ClientSuite) TestLocalExpired(c *C) {
 
 	// locally expired snapshot.json is ok
 	version = client.snapshotVer
-	c.Assert(s.repo.SnapshotWithExpires(tuf.CompressionTypeNone, s.expiredTime), IsNil)
+	c.Assert(s.repo.SnapshotWithExpires(s.expiredTime), IsNil)
 	s.syncLocal(c)
 	s.withMetaExpired(func() {
 		c.Assert(client.getLocalMeta(), IsNil)
@@ -585,7 +585,7 @@ func (s *ClientSuite) TestUpdateRemoteExpired(c *C) {
 		s.assertErrExpired(c, err, "timestamp.json")
 	})
 
-	c.Assert(s.repo.SnapshotWithExpires(tuf.CompressionTypeNone, s.expiredTime), IsNil)
+	c.Assert(s.repo.SnapshotWithExpires(s.expiredTime), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	s.syncRemote(c)
 	s.withMetaExpired(func() {
@@ -594,7 +594,7 @@ func (s *ClientSuite) TestUpdateRemoteExpired(c *C) {
 	})
 
 	c.Assert(s.repo.AddTargetWithExpires("bar.txt", nil, s.expiredTime), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	s.syncRemote(c)
 	s.withMetaExpired(func() {
@@ -604,7 +604,7 @@ func (s *ClientSuite) TestUpdateRemoteExpired(c *C) {
 
 	s.genKeyExpired(c, "timestamp")
 	c.Assert(s.repo.RemoveTarget("bar.txt"), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -631,7 +631,7 @@ func (s *ClientSuite) TestUpdateLocalRootExpiredKeyChange(c *C) {
 
 	// update metadata
 	c.Assert(s.repo.Sign("targets.json"), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	c.Assert(s.repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -651,7 +651,7 @@ func (s *ClientSuite) TestUpdateMixAndMatchAttack(c *C) {
 	// generate metadata with an explicit expires so we can make predictable changes
 	expires := time.Now().Add(time.Hour)
 	c.Assert(s.repo.AddTargetWithExpires("foo.txt", nil, expires), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	s.syncRemote(c)
 	client := s.updatedClient(c)
@@ -664,7 +664,7 @@ func (s *ClientSuite) TestUpdateMixAndMatchAttack(c *C) {
 
 	// generate new remote metadata, but replace targets.json with the old one
 	c.Assert(s.repo.AddTargetWithExpires("bar.txt", nil, expires), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	s.syncRemote(c)
 	newTargets, ok := s.remote.meta["targets.json"]
@@ -679,7 +679,7 @@ func (s *ClientSuite) TestUpdateMixAndMatchAttack(c *C) {
 
 	// do the same but keep the size the same
 	c.Assert(s.repo.RemoveTargetWithExpires("foo.txt", expires), IsNil)
-	c.Assert(s.repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(s.repo.Snapshot(), IsNil)
 	c.Assert(s.repo.Timestamp(), IsNil)
 	s.syncRemote(c)
 	s.remote.meta["targets.json"] = oldTargets
@@ -937,7 +937,7 @@ func (s *ClientSuite) TestUnknownKeyIDs(c *C) {
 	// the TUF-0.9 update workflow, where we decide to update the root
 	// metadata when we observe a new root through the snapshot.
 	repo, err := tuf.NewRepo(s.store)
-	c.Assert(repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(repo.Snapshot(), IsNil)
 	c.Assert(repo.Timestamp(), IsNil)
 	c.Assert(repo.Commit(), IsNil)
 	s.syncRemote(c)
@@ -964,7 +964,7 @@ func generateRepoFS(c *C, dir string, files map[string][]byte, consistentSnapsho
 		c.Assert(ioutil.WriteFile(path, data, 0644), IsNil)
 		c.Assert(repo.AddTarget(file, nil), IsNil)
 	}
-	c.Assert(repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(repo.Snapshot(), IsNil)
 	c.Assert(repo.Timestamp(), IsNil)
 	c.Assert(repo.Commit(), IsNil)
 	return repo

client/python_interop/python_interop_test.go

@@ -108,7 +108,7 @@ func generateRepoFS(c *C, dir string, files map[string][]byte, consistentSnapsho
 		c.Assert(ioutil.WriteFile(path, data, 0644), IsNil)
 		c.Assert(repo.AddTarget(file, nil), IsNil)
 	}
-	c.Assert(repo.Snapshot(tuf.CompressionTypeNone), IsNil)
+	c.Assert(repo.Snapshot(), IsNil)
 	c.Assert(repo.Timestamp(), IsNil)
 	c.Assert(repo.Commit(), IsNil)
 	return repo

client/testdata/go-tuf-transition-M3/generate.go

@@ -40,7 +40,7 @@ func newRepo(dir string) *tuf.Repo {
 }
 
 func commit(dir string, repo *tuf.Repo) {
-	assertNotNil(repo.SnapshotWithExpires(tuf.CompressionTypeNone, expirationDate))
+	assertNotNil(repo.SnapshotWithExpires(expirationDate))
 	assertNotNil(repo.TimestampWithExpires(expirationDate))
 	assertNotNil(repo.Commit())
 

client/testdata/go-tuf-transition-M4/generate.go

@@ -40,7 +40,7 @@ func newRepo(dir string) *tuf.Repo {
 }
 
 func commit(dir string, repo *tuf.Repo) {
-	assertNotNil(repo.SnapshotWithExpires(tuf.CompressionTypeNone, expirationDate))
+	assertNotNil(repo.SnapshotWithExpires(expirationDate))
 	assertNotNil(repo.TimestampWithExpires(expirationDate))
 	assertNotNil(repo.Commit())
 

client/testdata/go-tuf/generator/generator.go

@@ -40,7 +40,7 @@ func newRepo(dir string) *tuf.Repo {
 }
 
 func commit(dir string, repo *tuf.Repo) {
-	assertNotNil(repo.SnapshotWithExpires(tuf.CompressionTypeNone, expirationDate))
+	assertNotNil(repo.SnapshotWithExpires(expirationDate))
 	assertNotNil(repo.TimestampWithExpires(expirationDate))
 	assertNotNil(repo.Commit())
 

cmd/tuf/snapshot.go

@@ -7,7 +7,7 @@ import (
 
 func init() {
 	register("snapshot", cmdSnapshot, `
-usage: tuf snapshot [--expires=<days>] [--compression=<format>]
+usage: tuf snapshot [--expires=<days>]
 
 Update the snapshot manifest.
 
@@ -17,13 +17,12 @@ Options:
 }
 
 func cmdSnapshot(args *docopt.Args, repo *tuf.Repo) error {
-	// TODO: parse --compression
 	if arg := args.String["--expires"]; arg != "" {
 		expires, err := parseExpires(arg)
 		if err != nil {
 			return err
 		}
-		return repo.SnapshotWithExpires(tuf.CompressionTypeNone, expires)
+		return repo.SnapshotWithExpires(expires)
 	}
-	return repo.Snapshot(tuf.CompressionTypeNone)
+	return repo.Snapshot()
 }

repo.go

@@ -16,13 +16,6 @@ import (
 	"github.com/theupdateframework/go-tuf/verify"
 )
 
-type CompressionType uint8
-
-const (
-	CompressionTypeNone CompressionType = iota
-	CompressionTypeGzip
-)
-
 // topLevelManifests determines the order signatures are verified when committing.
 var topLevelManifests = []string{
 	"root.json",
@@ -761,11 +754,11 @@ func (r *Repo) RemoveTargetsWithExpires(paths []string, expires time.Time) error
 	return r.setMeta("targets.json", t)
 }
 
-func (r *Repo) Snapshot(t CompressionType) error {
-	return r.SnapshotWithExpires(t, data.DefaultExpires("snapshot"))
+func (r *Repo) Snapshot() error {
+	return r.SnapshotWithExpires(data.DefaultExpires("snapshot"))
 }
 
-func (r *Repo) SnapshotWithExpires(t CompressionType, expires time.Time) error {
+func (r *Repo) SnapshotWithExpires(expires time.Time) error {
 	if !validExpires(expires) {
 		return ErrInvalidExpires{expires}
 	}
@@ -778,7 +771,7 @@ func (r *Repo) SnapshotWithExpires(t CompressionType, expires time.Time) error {
 	if err != nil {
 		return err
 	}
-	// TODO: generate compressed manifests
+
 	for _, name := range snapshotManifests {
 		if err := r.verifySignature(name, db); err != nil {
 			return err