diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6743e8d..5b051f8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -46,11 +46,7 @@ jobs: release_dir="dist/release" mkdir -p "$release_dir" - for target in darwin_amd64 darwin_arm64 linux_amd64 linux_arm64; do - cp "dist/lbctl_${target}" "$release_dir/" - done - cp dist/lbctl_windows_amd64.exe "$release_dir/" - cp dist/lbctl_windows_arm64.exe "$release_dir/" + cp dist/lbctl_* "$release_dir/" cp install.sh "$release_dir/" cp install.ps1 "$release_dir/" diff --git a/internal/deploy/update.go b/internal/deploy/update.go index 81838e7..2755395 100644 --- a/internal/deploy/update.go +++ b/internal/deploy/update.go @@ -1,12 +1,15 @@ package deploy import ( + "bytes" + "compress/gzip" "context" "crypto/sha256" "encoding/hex" "encoding/json" "errors" "fmt" + "io" "net/http" "os" "os/exec" @@ -112,21 +115,44 @@ func (updater Updater) Update(ctx context.Context, current string, check bool) ( if err != nil { return result, err } - expected := "" + checksums := make(map[string]string) for _, line := range strings.Split(string(manifest), "\n") { fields := strings.Fields(line) - if len(fields) == 2 && strings.TrimPrefix(fields[1], "*") == asset { - expected = strings.ToLower(fields[0]) - break + if len(fields) == 2 && len(fields[0]) == 64 { + checksums[strings.TrimPrefix(fields[1], "*")] = strings.ToLower(fields[0]) } } - if len(expected) != 64 { + expected, ok := checksums[asset] + if !ok { return result, fmt.Errorf(i18n.T("release checksum absent for %s"), asset) } - data, err := Fetch(ctx, updater.client(), base+asset, 200<<20) + download := asset + if _, ok := checksums[asset+".gz"]; ok { + download += ".gz" + } + const maxBinarySize = 200 << 20 + data, err := Fetch(ctx, updater.client(), base+download, maxBinarySize) if err != nil { return result, err } + if download != asset { + sum := sha256.Sum256(data) + if hex.EncodeToString(sum[:]) != checksums[download] { + return result, errors.New(i18n.T("lbctl checksum mismatch")) + } + reader, err := gzip.NewReader(bytes.NewReader(data)) + if err != nil { + return result, err + } + defer reader.Close() + data, err = io.ReadAll(io.LimitReader(reader, maxBinarySize+1)) + if err != nil { + return result, err + } + if len(data) > maxBinarySize { + return result, errors.New(i18n.T("download exceeds size limit")) + } + } sum := sha256.Sum256(data) if hex.EncodeToString(sum[:]) != expected { return result, errors.New(i18n.T("lbctl checksum mismatch")) diff --git a/internal/deploy/update_test.go b/internal/deploy/update_test.go index 188a91e..c904705 100644 --- a/internal/deploy/update_test.go +++ b/internal/deploy/update_test.go @@ -1,6 +1,8 @@ package deploy import ( + "bytes" + "compress/gzip" "context" "crypto/sha256" "fmt" @@ -91,7 +93,7 @@ func TestUpdateCacheRefreshesEachReleaseIndependently(t *testing.T) { } func TestSelfUpdateChecksChecksumAndReplacesBinary(t *testing.T) { - for _, mode := range []string{"update", "check", "bad-checksum", "brew"} { + for _, mode := range []string{"update", "check", "bad-checksum", "brew", "gzip", "bad-gzip", "bad-gzip-checksum", "bad-expanded-checksum"} { t.Run(mode, func(t *testing.T) { path := filepath.Join(t.TempDir(), "lbctl") if mode == "brew" { @@ -103,20 +105,49 @@ func TestSelfUpdateChecksChecksumAndReplacesBinary(t *testing.T) { if err := os.WriteFile(path, []byte("old binary"), 0o755); err != nil { t.Fatal(err) } + const asset = "lbctl_linux_amd64" + compressed := strings.Contains(mode, "gzip") || mode == "bad-expanded-checksum" + binary := []byte("new binary") + var archive bytes.Buffer + gzipWriter := gzip.NewWriter(&archive) + if _, err := gzipWriter.Write(binary); err != nil { + t.Fatal(err) + } + if err := gzipWriter.Close(); err != nil { + t.Fatal(err) + } + if mode == "bad-gzip" { + archive.Truncate(archive.Len() - 1) + } downloads := 0 server := httptest.NewServer(http.HandlerFunc(func(writer http.ResponseWriter, request *http.Request) { switch request.URL.Path { case "/latest.json": fmt.Fprint(writer, `{"version":"v0.5.0"}`) case "/releases/v0.5.0/checksums.txt": - digest := fmt.Sprintf("%x", sha256.Sum256([]byte("new binary"))) - if mode == "bad-checksum" { + digest := fmt.Sprintf("%x", sha256.Sum256(binary)) + if mode == "bad-checksum" || mode == "bad-expanded-checksum" { digest = strings.Repeat("0", 64) } - fmt.Fprintf(writer, "%s lbctl_linux_amd64\n", digest) - case "/releases/v0.5.0/lbctl_linux_amd64": + fmt.Fprintf(writer, "%s %s\n", digest, asset) + if compressed { + digest := fmt.Sprintf("%x", sha256.Sum256(archive.Bytes())) + if mode == "bad-gzip-checksum" { + digest = strings.Repeat("0", 64) + } + fmt.Fprintf(writer, "%s %s.gz\n", digest, asset) + } + case "/releases/v0.5.0/" + asset + ".gz": + if !compressed { + t.Error("requested an unlisted archive") + } + writer.Write(archive.Bytes()) + case "/releases/v0.5.0/" + asset: + if compressed { + t.Error("requested the raw binary despite a listed archive") + } downloads++ - fmt.Fprint(writer, "new binary") + writer.Write(binary) default: t.Errorf("unexpected URL %s", request.URL.Path) http.NotFound(writer, request) @@ -128,15 +159,15 @@ func TestSelfUpdateChecksChecksumAndReplacesBinary(t *testing.T) { if readErr != nil { t.Fatal(readErr) } - if mode == "update" { + if mode == "update" || mode == "gzip" { if err != nil || !result.Updated || string(data) != "new binary" { t.Fatalf("%+v %s %v", result, data, err) } } else if result.Updated || string(data) != "old binary" { t.Fatalf("changed binary: %+v %s", result, data) } - if mode == "bad-checksum" && err == nil { - t.Fatal("accepted invalid checksum") + if strings.HasPrefix(mode, "bad-") && err == nil { + t.Fatal("accepted invalid download") } if (mode == "check" || mode == "brew") && downloads != 0 { t.Fatal("downloaded binary during check/package-managed update") diff --git a/scripts/build.sh b/scripts/build.sh index 9c89144..7a46bb8 100644 --- a/scripts/build.sh +++ b/scripts/build.sh @@ -15,6 +15,7 @@ for target in darwin/amd64 darwin/arm64 linux/amd64 linux/arm64 windows/amd64 wi CGO_ENABLED=0 GOOS="$target_os" GOARCH="$target_arch" "$GO" build -trimpath \ -ldflags "-s -w -X main.version=$VERSION -X main.commit=$COMMIT -X main.buildDate=$BUILD_DATE" \ -o "dist/$artifact" ./cmd/lbctl + gzip -n -9 -c "dist/$artifact" > "dist/$artifact.gz" done cd dist if command -v sha256sum >/dev/null 2>&1; then