Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
24496880c5 | ||
|
|
61238e4071 |
+13
-9
@@ -75,15 +75,15 @@ After decompressing `innerMessage`, the result is a serialized `MFFile`
|
|||||||
|
|
||||||
Each file entry contains:
|
Each file entry contains:
|
||||||
|
|
||||||
| Field | Number | Type | Description |
|
| Field | Number | Type | Description |
|
||||||
| ---------- | ------ | ------------------------- | ----------------------------------- |
|
| ---------- | ------ | ------------------------- | ------------------------------------------------------------- |
|
||||||
| `path` | 1 | string | Relative file path (see Path Rules) |
|
| `path` | 1 | string | Relative file path (see Path Rules) |
|
||||||
| `size` | 2 | int64 | File size in bytes |
|
| `size` | 2 | int64 | File size in bytes |
|
||||||
| `hashes` | 3 | repeated `MFFileChecksum` | At least one hash required |
|
| `hashes` | 3 | repeated `MFFileChecksum` | At least one hash required; readers reject an entry with none |
|
||||||
| `mimeType` | 301 | string (optional) | MIME type |
|
| `mimeType` | 301 | string (optional) | MIME type |
|
||||||
| `mtime` | 302 | Timestamp (optional) | Modification time |
|
| `mtime` | 302 | Timestamp (optional) | Modification time |
|
||||||
| `ctime` | 303 | Timestamp (optional) | Change time (inode metadata change) |
|
| `ctime` | 303 | Timestamp (optional) | Change time (inode metadata change) |
|
||||||
| `mode` | 304 | uint32 | Permission bits (see File Mode) |
|
| `mode` | 304 | uint32 | Permission bits (see File Mode) |
|
||||||
|
|
||||||
## File Mode
|
## File Mode
|
||||||
|
|
||||||
@@ -174,6 +174,10 @@ also refuses a manifest whose `signingPubKey` holds a DSA key or subkey, or any
|
|||||||
secret key or subkey, since checking the self-signatures of a DSA key or the
|
secret key or subkey, since checking the self-signatures of a DSA key or the
|
||||||
numbers of a secret key can take hours when those numbers are very large.
|
numbers of a secret key can take hours when those numbers are very large.
|
||||||
|
|
||||||
|
A signing key that has expired does not make the signature bad, because a
|
||||||
|
manifest outlives its key. A signature past its own expiry time is not good,
|
||||||
|
whether or not the key has expired too.
|
||||||
|
|
||||||
## Deterministic Serialization
|
## Deterministic Serialization
|
||||||
|
|
||||||
By default, manifests are generated deterministically:
|
By default, manifests are generated deterministically:
|
||||||
|
|||||||
+12
-4
@@ -28,9 +28,15 @@ const (
|
|||||||
scanProgressInterval = 100
|
scanProgressInterval = 100
|
||||||
)
|
)
|
||||||
|
|
||||||
// errEntryMissingMtime indicates a manifest entry that carries no
|
var (
|
||||||
// modification time where one is required to carry it forward unchanged.
|
// errEntryMissingMtime indicates a manifest entry that carries no
|
||||||
var errEntryMissingMtime = errors.New("manifest entry has no mtime")
|
// modification time where one is required to carry it forward unchanged.
|
||||||
|
errEntryMissingMtime = errors.New("manifest entry has no mtime")
|
||||||
|
|
||||||
|
// errEntryMissingHash indicates a manifest entry that carries no hash
|
||||||
|
// to carry forward.
|
||||||
|
errEntryMissingHash = errors.New("manifest entry has no hash")
|
||||||
|
)
|
||||||
|
|
||||||
// FreshenStatus contains progress information for the freshen operation.
|
// FreshenStatus contains progress information for the freshen operation.
|
||||||
type FreshenStatus struct {
|
type FreshenStatus struct {
|
||||||
@@ -644,6 +650,8 @@ func addFileToBuilder(
|
|||||||
// Entries reach this path only when recordEntry classified them as
|
// Entries reach this path only when recordEntry classified them as
|
||||||
// unchanged, which requires a recorded mtime, so an absent mtime here is
|
// unchanged, which requires a recorded mtime, so an absent mtime here is
|
||||||
// an error rather than something to paper over with the Unix epoch.
|
// an error rather than something to paper over with the Unix epoch.
|
||||||
|
// Loading refuses an entry with no hash; one that got here anyway is an
|
||||||
|
// error too, not a file to leave out of the manifest.
|
||||||
func addExistingToBuilder(b *mfer.Builder, entry *mfer.MFFilePath) error {
|
func addExistingToBuilder(b *mfer.Builder, entry *mfer.MFFilePath) error {
|
||||||
mtime, ok := entryMtime(entry)
|
mtime, ok := entryMtime(entry)
|
||||||
if !ok {
|
if !ok {
|
||||||
@@ -651,7 +659,7 @@ func addExistingToBuilder(b *mfer.Builder, entry *mfer.MFFilePath) error {
|
|||||||
}
|
}
|
||||||
|
|
||||||
if len(entry.GetHashes()) == 0 {
|
if len(entry.GetHashes()) == 0 {
|
||||||
return nil
|
return fmt.Errorf("%w: %s", errEntryMissingHash, entry.GetPath())
|
||||||
}
|
}
|
||||||
|
|
||||||
err := b.AddFileWithHash(mfer.RelFilePath(entry.GetPath()),
|
err := b.AddFileWithHash(mfer.RelFilePath(entry.GetPath()),
|
||||||
|
|||||||
@@ -471,6 +471,24 @@ func TestFreshenAddExistingRejectsMissingMtime(t *testing.T) {
|
|||||||
assert.Contains(t, err.Error(), "file1.txt")
|
assert.Contains(t, err.Error(), "file1.txt")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// TestFreshenAddExistingRejectsMissingHash pins that an entry with no hash
|
||||||
|
// is an error rather than a file left out of the rebuilt manifest.
|
||||||
|
func TestFreshenAddExistingRejectsMissingHash(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
b := mfer.NewBuilder()
|
||||||
|
entry := &mfer.MFFilePath{
|
||||||
|
Path: "data.bin",
|
||||||
|
Size: 8,
|
||||||
|
Mtime: &mfer.Timestamp{Seconds: 1_700_000_000},
|
||||||
|
}
|
||||||
|
|
||||||
|
err := addExistingToBuilder(b, entry)
|
||||||
|
require.ErrorIs(t, err, errEntryMissingHash)
|
||||||
|
assert.Contains(t, err.Error(), "data.bin")
|
||||||
|
assert.Zero(t, b.FileCount())
|
||||||
|
}
|
||||||
|
|
||||||
// TestFreshenAddExistingRejectsShortHash pins that an existing manifest
|
// TestFreshenAddExistingRejectsShortHash pins that an existing manifest
|
||||||
// entry whose hash the builder refuses is reported as a problem with the
|
// entry whose hash the builder refuses is reported as a problem with the
|
||||||
// manifest, with the command that fixes it.
|
// manifest, with the command that fixes it.
|
||||||
|
|||||||
+7
-1
@@ -27,6 +27,7 @@ var (
|
|||||||
errUUIDMismatch = errors.New("outer and inner UUID mismatch")
|
errUUIDMismatch = errors.New("outer and inner UUID mismatch")
|
||||||
errInvalidFileFormat = errors.New("invalid file format")
|
errInvalidFileFormat = errors.New("invalid file format")
|
||||||
errInvalidManifestPath = errors.New("invalid file entry")
|
errInvalidManifestPath = errors.New("invalid file entry")
|
||||||
|
errEntryMissingHash = errors.New("file entry has no hash")
|
||||||
errDecodedTooLarge = errors.New("too much memory needed")
|
errDecodedTooLarge = errors.New("too much memory needed")
|
||||||
errSignerNotSigningKey = errors.New(
|
errSignerNotSigningKey = errors.New(
|
||||||
"signer is not the fingerprint of the key that made the signature")
|
"signer is not the fingerprint of the key that made the signature")
|
||||||
@@ -293,7 +294,8 @@ func (m *manifest) deserializeInner() error {
|
|||||||
// untrusted .mf. Reject loudly on the first offender rather than
|
// untrusted .mf. Reject loudly on the first offender rather than
|
||||||
// dropping entries, which would let a hostile manifest hide files from a
|
// dropping entries, which would let a hostile manifest hide files from a
|
||||||
// check. A path listed twice is refused too: check would check the one
|
// check. A path listed twice is refused too: check would check the one
|
||||||
// file against both entries.
|
// file against both entries. So is an entry with no hash: there is
|
||||||
|
// nothing to check the file against.
|
||||||
seen := make(map[string]bool, len(m.pbInner.GetFiles()))
|
seen := make(map[string]bool, len(m.pbInner.GetFiles()))
|
||||||
|
|
||||||
for _, f := range m.pbInner.GetFiles() {
|
for _, f := range m.pbInner.GetFiles() {
|
||||||
@@ -302,6 +304,10 @@ func (m *manifest) deserializeInner() error {
|
|||||||
return fmt.Errorf("%w: %w", errInvalidManifestPath, err)
|
return fmt.Errorf("%w: %w", errInvalidManifestPath, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
if len(f.GetHashes()) == 0 {
|
||||||
|
return fmt.Errorf("%w: %q", errEntryMissingHash, f.GetPath())
|
||||||
|
}
|
||||||
|
|
||||||
if seen[f.GetPath()] {
|
if seen[f.GetPath()] {
|
||||||
return fmt.Errorf("%w %q", errDuplicatePath, f.GetPath())
|
return fmt.Errorf("%w %q", errDuplicatePath, f.GetPath())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -165,6 +165,24 @@ func TestDeserializeRefusesPathListedTwice(t *testing.T) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// A manifest holding a file entry with no hash is refused as it is loaded,
|
||||||
|
// naming the path: there is nothing to check the file against.
|
||||||
|
func TestDeserializeRefusesEntryWithNoHash(t *testing.T) {
|
||||||
|
t.Parallel()
|
||||||
|
|
||||||
|
id := uuid.NewV4()
|
||||||
|
inner, err := proto.Marshal(&MFFile{
|
||||||
|
Version: MFFile_VERSION_ONE,
|
||||||
|
Files: []*MFFilePath{{Path: "x", Size: 1}},
|
||||||
|
Uuid: id[:],
|
||||||
|
})
|
||||||
|
require.NoError(t, err)
|
||||||
|
|
||||||
|
_, err = NewManifestFromReader(bytes.NewReader(wrapInner(t, id, inner)))
|
||||||
|
require.ErrorIs(t, err, errEntryMissingHash)
|
||||||
|
require.EqualError(t, err, `file entry has no hash: "x"`)
|
||||||
|
}
|
||||||
|
|
||||||
// Entries of a path, an empty hash, an empty MIME type and empty modification
|
// Entries of a path, an empty hash, an empty MIME type and empty modification
|
||||||
// and change times are counted at 432 bytes each (176 + 112 + 16 + 64 + 64)
|
// and change times are counted at 432 bytes each (176 + 112 + 16 + 64 + 64)
|
||||||
// and take 16 bytes plus the path to encode. A 37-character path makes that
|
// and take 16 bytes plus the path to encode. A 37-character path makes that
|
||||||
@@ -229,6 +247,8 @@ func TestDeserializeDropsUnknownFields(t *testing.T) {
|
|||||||
|
|
||||||
entry := protowire.AppendTag(nil, 1, protowire.BytesType) // MFFilePath.path
|
entry := protowire.AppendTag(nil, 1, protowire.BytesType) // MFFilePath.path
|
||||||
entry = protowire.AppendString(entry, "a")
|
entry = protowire.AppendString(entry, "a")
|
||||||
|
entry = protowire.AppendTag(entry, 3, protowire.BytesType) // MFFilePath.hashes
|
||||||
|
entry = protowire.AppendBytes(entry, nil)
|
||||||
entry = append(entry, unknown...)
|
entry = append(entry, unknown...)
|
||||||
|
|
||||||
id := uuid.NewV4()
|
id := uuid.NewV4()
|
||||||
|
|||||||
+13
-6
@@ -8,6 +8,7 @@ import (
|
|||||||
"io"
|
"io"
|
||||||
"slices"
|
"slices"
|
||||||
"strings"
|
"strings"
|
||||||
|
"time"
|
||||||
|
|
||||||
"github.com/ProtonMail/go-crypto/openpgp"
|
"github.com/ProtonMail/go-crypto/openpgp"
|
||||||
"github.com/ProtonMail/go-crypto/openpgp/armor"
|
"github.com/ProtonMail/go-crypto/openpgp/armor"
|
||||||
@@ -242,10 +243,10 @@ func fingerprint(key *openpgp.Entity) string {
|
|||||||
return strings.ToUpper(hex.EncodeToString(key.PrimaryKey.Fingerprint))
|
return strings.ToUpper(hex.EncodeToString(key.PrimaryKey.Fingerprint))
|
||||||
}
|
}
|
||||||
|
|
||||||
// verifySignature checks that signature is one good OpenPGP signature
|
// verifySignature checks that signature is one good, unexpired OpenPGP
|
||||||
// over data, made by the one primary key in pubKey or one of its subkeys,
|
// signature over data, made by the one primary key in pubKey or one of its
|
||||||
// and returns that primary key's fingerprint. signature and pubKey may each
|
// subkeys, and returns that primary key's fingerprint. signature and pubKey
|
||||||
// be armored or binary.
|
// may each be armored or binary.
|
||||||
func verifySignature(data, signature, pubKey []byte) (string, error) {
|
func verifySignature(data, signature, pubKey []byte) (string, error) {
|
||||||
key, err := readOneKey(pubKey, "embedded public key block", true)
|
key, err := readOneKey(pubKey, "embedded public key block", true)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -266,10 +267,16 @@ func verifySignature(data, signature, pubKey []byte) (string, error) {
|
|||||||
return "", fmt.Errorf("%w, found %d", errNotOneSignature, sigs)
|
return "", fmt.Errorf("%w, found %d", errNotOneSignature, sigs)
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err = openpgp.CheckDetachedSignature(openpgp.EntityList{key},
|
sig, _, err := openpgp.VerifyDetachedSignature(openpgp.EntityList{key},
|
||||||
bytes.NewReader(data), bytes.NewReader(sigData), nil)
|
bytes.NewReader(data), bytes.NewReader(sigData), nil)
|
||||||
// A manifest outlives its signing key, so a signature by a key that
|
// A manifest outlives its signing key, so a signature by a key that
|
||||||
// has expired since is still good.
|
// has expired since is still good, unless the signature has expired
|
||||||
|
// itself. The library does not check that once it finds the key
|
||||||
|
// expired.
|
||||||
|
if errors.Is(err, pgperrors.ErrKeyExpired) && sig.SigExpired(time.Now()) {
|
||||||
|
err = pgperrors.ErrSignatureExpired
|
||||||
|
}
|
||||||
|
|
||||||
if err != nil && !errors.Is(err, pgperrors.ErrKeyExpired) {
|
if err != nil && !errors.Is(err, pgperrors.ErrKeyExpired) {
|
||||||
return "", fmt.Errorf("verify signature: %w", err)
|
return "", fmt.Errorf("verify signature: %w", err)
|
||||||
}
|
}
|
||||||
|
|||||||
+14
-3
@@ -18,6 +18,7 @@ import (
|
|||||||
"github.com/ProtonMail/go-crypto/openpgp"
|
"github.com/ProtonMail/go-crypto/openpgp"
|
||||||
"github.com/ProtonMail/go-crypto/openpgp/armor"
|
"github.com/ProtonMail/go-crypto/openpgp/armor"
|
||||||
"github.com/ProtonMail/go-crypto/openpgp/elgamal"
|
"github.com/ProtonMail/go-crypto/openpgp/elgamal"
|
||||||
|
pgperrors "github.com/ProtonMail/go-crypto/openpgp/errors"
|
||||||
"github.com/ProtonMail/go-crypto/openpgp/packet"
|
"github.com/ProtonMail/go-crypto/openpgp/packet"
|
||||||
"github.com/spf13/afero"
|
"github.com/spf13/afero"
|
||||||
"github.com/stretchr/testify/assert"
|
"github.com/stretchr/testify/assert"
|
||||||
@@ -416,8 +417,10 @@ func TestVerifySignature(t *testing.T) {
|
|||||||
assert.Error(t, err)
|
assert.Error(t, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
// TestVerifySignatureKeyExpiredSince verifies a signature made in 2020 by
|
// TestVerifySignatureKeyExpiredSince verifies two signatures made in 2020
|
||||||
// a key that expired a day after it was made. The signature is still good.
|
// by a key that expired a day after it was made. A signature with no
|
||||||
|
// expiry time is still good. One that expired an hour after it was made is
|
||||||
|
// refused, although the key has expired too.
|
||||||
func TestVerifySignatureKeyExpiredSince(t *testing.T) {
|
func TestVerifySignatureKeyExpiredSince(t *testing.T) {
|
||||||
t.Parallel()
|
t.Parallel()
|
||||||
|
|
||||||
@@ -429,9 +432,14 @@ func TestVerifySignatureKeyExpiredSince(t *testing.T) {
|
|||||||
key := newTestKey(t, config)
|
key := newTestKey(t, config)
|
||||||
data := []byte("signed in 2020")
|
data := []byte("signed in 2020")
|
||||||
|
|
||||||
var sig bytes.Buffer
|
var sig, expiringSig bytes.Buffer
|
||||||
|
|
||||||
require.NoError(t, openpgp.ArmoredDetachSign(&sig, key, bytes.NewReader(data), config))
|
require.NoError(t, openpgp.ArmoredDetachSign(&sig, key, bytes.NewReader(data), config))
|
||||||
|
require.NoError(t, openpgp.ArmoredDetachSign(&expiringSig, key,
|
||||||
|
bytes.NewReader(data), &packet.Config{
|
||||||
|
Time: config.Time,
|
||||||
|
SigLifetimeSecs: uint32(time.Hour.Seconds()),
|
||||||
|
}))
|
||||||
|
|
||||||
pubKey, err := armoredPublicKey(key)
|
pubKey, err := armoredPublicKey(key)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
@@ -439,6 +447,9 @@ func TestVerifySignatureKeyExpiredSince(t *testing.T) {
|
|||||||
signer, err := verifySignature(data, sig.Bytes(), pubKey)
|
signer, err := verifySignature(data, sig.Bytes(), pubKey)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.Equal(t, fingerprint(key), signer)
|
assert.Equal(t, fingerprint(key), signer)
|
||||||
|
|
||||||
|
_, err = verifySignature(data, expiringSig.Bytes(), pubKey)
|
||||||
|
require.ErrorIs(t, err, pgperrors.ErrSignatureExpired)
|
||||||
}
|
}
|
||||||
|
|
||||||
func TestManifestSignatureVerification(t *testing.T) {
|
func TestManifestSignatureVerification(t *testing.T) {
|
||||||
|
|||||||
Reference in New Issue
Block a user