Silverfish/proton-bridge
1
0
Fork 1
mirror of https://github.com/ProtonMail/proton-bridge.git synced 2025-12-15 14:56:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

feat: verify by checksum and remove if invalid

Browse Source
This commit is contained in:
James Houlahan
2020-12-02 16:31:03 +01:00
parent 98ab794f13
commit eccad4bbfd
11 changed files with 372 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
internal/versioner/version.go
View File

@ -18,14 +18,19 @@
package versioner
import (
"bytes"
"errors"
"io/ioutil"
"os"
"path/filepath"
"github.com/Masterminds/semver/v3"
"github.com/ProtonMail/gopenpgp/v2/crypto"
"github.com/ProtonMail/proton-bridge/pkg/sum"
)
const sumFile = ".sum"
type Version struct {
version *semver.Version
path string
@ -47,31 +52,34 @@ func (v Versions) Swap(i, j int) {
// VerifyFiles verifies all files in the version directory.
func (v *Version) VerifyFiles(kr *crypto.KeyRing) error {
return filepath.Walk(v.path, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
fileBytes, err := ioutil.ReadFile(filepath.Join(v.path, sumFile)) // nolint[gosec]
if err != nil {
return err
}
if filepath.Ext(path) == ".sig" || info.IsDir() {
return nil
}
sigBytes, err := ioutil.ReadFile(filepath.Join(v.path, sumFile+".sig")) // nolint[gosec]
if err != nil {
return err
}
fileBytes, err := ioutil.ReadFile(path) // nolint[gosec]
if err != nil {
return err
}
if err := kr.VerifyDetached(
crypto.NewPlainMessage(fileBytes),
crypto.NewPGPSignature(sigBytes),
crypto.GetUnixTime(),
); err != nil {
return err
}
sigBytes, err := ioutil.ReadFile(path + ".sig") // nolint[gosec]
if err != nil {
return err
}
sum, err := sum.RecursiveSum(v.path, sumFile)
if err != nil {
return err
}
return kr.VerifyDetached(
crypto.NewPlainMessage(fileBytes),
crypto.NewPGPSignature(sigBytes),
crypto.GetUnixTime(),
)
})
if !bytes.Equal(sum, fileBytes) {
return errors.New("sum mismatch")
}
return nil
}
// GetExecutable returns the full path to the executable of the given version.
@ -85,3 +93,8 @@ func (v *Version) GetExecutable(name string) (string, error) {
return exe, nil
}
// Remove removes this version directory.
func (v *Version) Remove() error {
return os.RemoveAll(v.path)
}

56
internal/versioner/version_test.go
View File

@ -26,6 +26,7 @@ import (
"github.com/Masterminds/semver/v3"
"github.com/ProtonMail/gopenpgp/v2/crypto"
"github.com/ProtonMail/proton-bridge/pkg/sum"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
@ -39,12 +40,12 @@ func TestVerifyFiles(t *testing.T) {
path: tempDir,
}
kr := createSignedFiles(t,
filepath.Join(tempDir, "f1.txt"),
filepath.Join(tempDir, "f2.png"),
filepath.Join(tempDir, "f3.dat"),
filepath.Join(tempDir, "sub", "f4.tar"),
filepath.Join(tempDir, "sub", "f5.tgz"),
kr := createSignedFiles(t, tempDir,
"f1.txt",
"f2.png",
"f3.dat",
filepath.Join("sub", "f4.tar"),
filepath.Join("sub", "f5.tgz"),
)
assert.NoError(t, version.VerifyFiles(kr))
@ -59,12 +60,12 @@ func TestVerifyWithBadFile(t *testing.T) {
path: tempDir,
}
kr := createSignedFiles(t,
filepath.Join(tempDir, "f1.txt"),
filepath.Join(tempDir, "f2.png"),
filepath.Join(tempDir, "f3.bad"),
filepath.Join(tempDir, "sub", "f4.tar"),
filepath.Join(tempDir, "sub", "f5.tgz"),
kr := createSignedFiles(t, tempDir,
"f1.txt",
"f2.png",
"f3.bad",
filepath.Join("sub", "f4.tar"),
filepath.Join("sub", "f5.tgz"),
)
badKeyRing := makeKeyRing(t)
@ -82,12 +83,12 @@ func TestVerifyWithBadSubFile(t *testing.T) {
path: tempDir,
}
kr := createSignedFiles(t,
filepath.Join(tempDir, "f1.txt"),
filepath.Join(tempDir, "f2.png"),
filepath.Join(tempDir, "f3.dat"),
filepath.Join(tempDir, "sub", "f4.tar"),
filepath.Join(tempDir, "sub", "f5.bad"),
kr := createSignedFiles(t, tempDir,
"f1.txt",
"f2.png",
"f3.dat",
filepath.Join("sub", "f4.tar"),
filepath.Join("sub", "f5.bad"),
)
badKeyRing := makeKeyRing(t)
@ -96,15 +97,24 @@ func TestVerifyWithBadSubFile(t *testing.T) {
assert.Error(t, version.VerifyFiles(kr))
}
func createSignedFiles(t *testing.T, paths ...string) *crypto.KeyRing {
func createSignedFiles(t *testing.T, root string, paths ...string) *crypto.KeyRing {
kr := makeKeyRing(t)
for _, path := range paths {
require.NoError(t, os.MkdirAll(filepath.Dir(path), 0700))
makeFile(t, path)
signFile(t, path, kr)
makeFile(t, filepath.Join(root, path))
}
sum, err := sum.RecursiveSum(root, "")
require.NoError(t, err)
sumFile, err := os.Create(filepath.Join(root, sumFile))
require.NoError(t, err)
_, err = sumFile.Write(sum)
require.NoError(t, err)
signFile(t, sumFile.Name(), kr)
return kr
}
@ -119,6 +129,8 @@ func makeKeyRing(t *testing.T) *crypto.KeyRing {
}
func makeFile(t *testing.T, path string) {
require.NoError(t, os.MkdirAll(filepath.Dir(path), 0700))
f, err := os.Create(path)
require.NoError(t, err)

52
internal/versioner/versioner_remove_test.go Normal file
View File

@ -0,0 +1,52 @@
// Copyright (c) 2020 Proton Technologies AG
//
// This file is part of ProtonMail Bridge.
//
// ProtonMail Bridge is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// ProtonMail Bridge is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with ProtonMail Bridge. If not, see <https://www.gnu.org/licenses/>.
// +build !darwin
package versioner
import (
"io/ioutil"
"path/filepath"
"testing"
"github.com/Masterminds/semver/v3"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
// RemoveOldVersions is a noop on darwin; we don't test it there.
func TestRemoveOldVersions(t *testing.T) {
updates, err := ioutil.TempDir("", "updates")
require.NoError(t, err)
v := newTestVersioner(t, "myCoolApp", updates, "2.3.4-beta", "2.3.4", "2.3.5", "2.4.0")
allVersions, err := v.ListVersions()
require.NoError(t, err)
require.Len(t, allVersions, 4)
assert.NoError(t, v.RemoveOldVersions())
cleanedVersions, err := v.ListVersions()
assert.NoError(t, err)
assert.Len(t, cleanedVersions, 1)
assert.Equal(t, semver.MustParse("2.4.0"), cleanedVersions[0].version)
assert.Equal(t, filepath.Join(updates, "2.4.0"), cleanedVersions[0].path)
}

20
internal/versioner/versioner_test.go
View File

@ -50,26 +50,6 @@ func TestListVersions(t *testing.T) {
assert.Equal(t, filepath.Join(updates, "2.3.4-beta"), versions[3].path)
}
func TestRemoveOldVersions(t *testing.T) {
updates, err := ioutil.TempDir("", "updates")
require.NoError(t, err)
v := newTestVersioner(t, "myCoolApp", updates, "2.3.4-beta", "2.3.4", "2.3.5", "2.4.0")
allVersions, err := v.ListVersions()
require.NoError(t, err)
require.Len(t, allVersions, 4)
assert.NoError(t, v.RemoveOldVersions())
cleanedVersions, err := v.ListVersions()
assert.NoError(t, err)
assert.Len(t, cleanedVersions, 1)
assert.Equal(t, semver.MustParse("2.4.0"), cleanedVersions[0].version)
assert.Equal(t, filepath.Join(updates, "2.4.0"), cleanedVersions[0].path)
}
func newTestVersioner(t *testing.T, exeName, updates string, versions ...string) *Versioner {
for _, version := range versions {
makeDummyVersionDirectory(t, exeName, updates, version)