1 Commits
Author SHA1 Message Date
clawbot b1860d7931 Sign and verify manifests in Go with OpenPGP instead of running gpg (closes #181)
check / check (push) Canceled after 0s
mfer ran the gpg binary to sign, export keys and verify, so signing and
loading signed manifests failed wherever gpg is missing. It now uses
github.com/ProtonMail/go-crypto/openpgp. --sign-key and MFER_SIGN_KEY
name a file holding one OpenPGP secret key; a protected key's passphrase
comes from MFER_SIGN_KEY_PASSPHRASE or a prompt on the terminal, and is
checked before any file is read. Verification keeps the rules of the
--require-signature fix: one primary key in the embedded block, counted
from its packets so that keys the library skips count too, exactly one
signature, made by that key or one of its subkeys, and signer equal to
its fingerprint. An armored key or signature must be one block and
nothing else.

Model: opus-5-5
2026-10-08 03:17:34 +00:00
13 changed files with 79 additions and 522 deletions
+1 -4
View File
@@ -302,10 +302,7 @@ are now tracked only in the [issues](https://git.eeqj.de/sneak/mfer/issues).
binary, as `gpg --export-secret-keys` writes it; `MFER_SIGN_KEY` names the binary, as `gpg --export-secret-keys` writes it; `MFER_SIGN_KEY` names the
file too. mfer signs it itself and does not need `gpg`. A file holding file too. mfer signs it itself and does not need `gpg`. A file holding
more than one key is refused, and a key held only on a smartcard cannot more than one key is refused, and a key held only on a smartcard cannot
sign. The key must be a version 4 key, whose 40-character fingerprint is sign
what `--require-signature` takes, and not a DSA key. A key that cannot
sign, because it has expired or been revoked or its passphrase is wrong,
stops `gen` and `freshen` before they read any file
- takes a protected key's passphrase from `MFER_SIGN_KEY_PASSPHRASE`, or - takes a protected key's passphrase from `MFER_SIGN_KEY_PASSPHRASE`, or
else asks for it at the terminal else asks for it at the terminal
- `mfer fetch https://example.com/stuff/` - `mfer fetch https://example.com/stuff/`
+1 -4
View File
@@ -152,10 +152,7 @@ primary key, `signature` is one good signature over the canonical string made by
that key (or one of its subkeys), and `signer` is that key's fingerprint. The that key (or one of its subkeys), and `signer` is that key's fingerprint. The
reference implementation refuses to load a manifest that fails these checks; reference implementation refuses to load a manifest that fails these checks;
`check` and `fetch` given `--require-signature` then compare the required `check` and `fetch` given `--require-signature` then compare the required
fingerprint with `signer`. It also refuses a manifest whose `signingPubKey` fingerprint with `signer`.
holds a DSA key or subkey, or any 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.
## Deterministic Serialization ## Deterministic Serialization
+2 -2
View File
@@ -21,8 +21,8 @@ import (
"sneak.berlin/go/mfer/mfer" "sneak.berlin/go/mfer/mfer"
) )
// fingerprintHexLen is the length in hex characters of the fingerprint of // fingerprintHexLen is the length of a full OpenPGP key fingerprint in hex
// an OpenPGP version 4 key, the only version mfer signs with. // characters.
const fingerprintHexLen = 40 const fingerprintHexLen = 40
var ( var (
-45
View File
@@ -1368,51 +1368,6 @@ func TestGenerateSeveralPathsDefaultOutput(t *testing.T) {
} }
} }
// testLink is the name of the symlink to a tree that the
// DirectoryNamedThroughSymlink tests make in a temp dir.
const testLink = "link"
// TestGenerateDirectoryNamedThroughSymlink runs gen on a directory named
// through a symlink, given as the argument or as the working directory: the
// manifest lists the files in the directory the symlink points to, and
// leaves out a symlink inside it, as gen does without --follow-symlinks.
//
//nolint:paralleltest // changes the process-global working directory
func TestGenerateDirectoryNamedThroughSymlink(t *testing.T) {
// Paths are relative to a temp dir holding data and link, a symlink to
// data.
for name, tc := range map[string]struct {
workDir string
args []string
}{
"argument": {".", []string{testLink}},
"working directory": {testLink, nil},
} {
t.Run(name, func(t *testing.T) {
root := t.TempDir()
data := filepath.Join(root, "data")
fs := afero.NewOsFs()
writeTestTree(t, fs, data)
require.NoError(t,
os.Symlink(testFileTxt, filepath.Join(data, "alias.txt")))
require.NoError(t, os.Symlink(data, filepath.Join(root, testLink)))
// t.Chdir sets PWD to the path it is given, as a shell does, and
// os.Getwd returns PWD when it names the working directory.
t.Chdir(filepath.Join(root, tc.workDir))
opts := testOpts(slices.Concat(
[]string{testApp, cmdGenerate, "-q"}, tc.args,
), fs)
require.Equal(t, 0, runCLI(opts), "stderr: %s", testStderr(t, opts))
assert.ElementsMatch(t, []string{testFileTxt, "sub/nested.txt"},
manifestPaths(t, fs, filepath.Join(data, defaultManifestName)))
})
}
}
// TestGenerateBytesDoNotDependOnOutput runs gen --seed on one tree, each // TestGenerateBytesDoNotDependOnOutput runs gen --seed on one tree, each
// time writing to another file, over a file already there and beside an // time writing to another file, over a file already there and beside an
// earlier run's temp file: neither is listed, and what is listed depends // earlier run's temp file: neither is listed, and what is listed depends
+6 -12
View File
@@ -128,19 +128,13 @@ func TestSignerMismatchMessage(t *testing.T) {
// testSecretKey returns a new OpenPGP key with its secret key, armored, as // testSecretKey returns a new OpenPGP key with its secret key, armored, as
// gpg --export-secret-keys --armor writes it, and the key's fingerprint. // gpg --export-secret-keys --armor writes it, and the key's fingerprint.
// The key is protected by passphrase unless that is nil. config sets how // The key is protected by passphrase unless that is nil. It is an Ed25519
// the key is made; without one it is an Ed25519 key, which is quick to // key, which is quick to make.
// make. func testSecretKey(t *testing.T, passphrase []byte) ([]byte, string) {
func testSecretKey(
t *testing.T, passphrase []byte, config *packet.Config,
) ([]byte, string) {
t.Helper() t.Helper()
if config == nil { key, err := openpgp.NewEntity("MFER Test Key", "", "test@mfer.test",
config = &packet.Config{Algorithm: packet.PubKeyAlgoEdDSA} &packet.Config{Algorithm: packet.PubKeyAlgoEdDSA})
}
key, err := openpgp.NewEntity("MFER Test Key", "", "test@mfer.test", config)
require.NoError(t, err) require.NoError(t, err)
if passphrase != nil { if passphrase != nil {
@@ -161,7 +155,7 @@ func testSecretKey(
func signedManifest(t *testing.T, files map[string][]byte) []byte { func signedManifest(t *testing.T, files map[string][]byte) []byte {
t.Helper() t.Helper()
secretKey, _ := testSecretKey(t, nil, nil) secretKey, _ := testSecretKey(t, nil)
b := mfer.NewBuilder() b := mfer.NewBuilder()
b.SetSigningOptions(&mfer.SigningOptions{SecretKey: secretKey}) b.SetSigningOptions(&mfer.SigningOptions{SecretKey: secretKey})
+1 -9
View File
@@ -381,14 +381,6 @@ func (mfa *CLIApp) freshenScan(
} }
} }
// The walk does not follow a symlink at its top, so a base directory
// named through one is resolved first. If that fails, the base is
// walked as named and the walk reports the problem.
resolved, err := filepath.EvalSymlinks(absBase)
if err == nil {
absBase = resolved
}
scanner := &freshenScanner{ scanner := &freshenScanner{
fs: mfa.Fs, fs: mfa.Fs,
absBase: absBase, absBase: absBase,
@@ -400,7 +392,7 @@ func (mfa *CLIApp) freshenScan(
existingByPath: existingByPath, existingByPath: existingByPath,
} }
err = afero.Walk(mfa.Fs, absBase, scanner.walk) err := afero.Walk(mfa.Fs, absBase, scanner.walk)
if showProgress { if showProgress {
log.ProgressDone() log.ProgressDone()
-43
View File
@@ -336,49 +336,6 @@ func TestFreshenResolvesEntriesAgainstManifestDirectory(t *testing.T) {
} }
} }
// TestFreshenDirectoryNamedThroughSymlink adds a file to a tree after gen
// made its manifest, then freshens it with the tree named through a symlink,
// given as the argument or as the working directory: the manifest lists the
// files in the tree, and leaves out a symlink inside it, as freshen does
// without --follow-symlinks.
//
//nolint:paralleltest // changes the process-global working directory
func TestFreshenDirectoryNamedThroughSymlink(t *testing.T) {
// Paths are relative to a temp dir holding link, a symlink to the tree.
for name, tc := range map[string]struct {
workDir string
args []string
}{
"argument": {".", []string{testLink}},
"working directory": {testLink, nil},
} {
t.Run(name, func(t *testing.T) {
fs := afero.NewOsFs()
tree, manifestPath := setupFreshenDir(t, fs,
map[string]string{testFileTxt: "in the tree"})
writeTestFile(t, fs, filepath.Join(tree, "later.txt"), "added later")
require.NoError(t,
os.Symlink(testFileTxt, filepath.Join(tree, "alias.txt")))
root := t.TempDir()
require.NoError(t, os.Symlink(tree, filepath.Join(root, testLink)))
// t.Chdir sets PWD to the path it is given, as a shell does, and
// os.Getwd returns PWD when it names the working directory.
t.Chdir(filepath.Join(root, tc.workDir))
opts := testOpts(slices.Concat(
[]string{testApp, cmdFreshen, "-q"}, tc.args,
), fs)
require.Equal(t, 0, runCLI(opts), "stderr: %s", testStderr(t, opts))
assertManifestLists(t, fs, tree, manifestPath, map[string]string{
testFileTxt: "in the tree", "later.txt": "added later",
})
})
}
}
// TestFreshenRecordEntryMtimePresence pins the behavior of recordEntry // TestFreshenRecordEntryMtimePresence pins the behavior of recordEntry
// with respect to MFFilePath.Mtime, which is a message pointer with // with respect to MFFilePath.Mtime, which is a message pointer with
// proto3 field presence and may legitimately be absent. // proto3 field presence and may legitimately be absent.
+9 -8
View File
@@ -23,9 +23,9 @@ var errNoPassphrase = errors.New(
"signing key is protected: set " + envSignKeyPassphrase + " to its passphrase") "signing key is protected: set " + envSignKeyPassphrase + " to its passphrase")
// signingOptions returns the signing options for the OpenPGP secret key in // signingOptions returns the signing options for the OpenPGP secret key in
// the file path, which must be able to sign. The passphrase of a protected // the file path. The passphrase of a protected key comes from
// key comes from MFER_SIGN_KEY_PASSPHRASE, or else from the terminal on // MFER_SIGN_KEY_PASSPHRASE, or else from the terminal on stdin, and must
// stdin, and must unlock the key. // unlock the key.
func (mfa *CLIApp) signingOptions(path string) (*mfer.SigningOptions, error) { func (mfa *CLIApp) signingOptions(path string) (*mfer.SigningOptions, error) {
secretKey, err := afero.ReadFile(mfa.Fs, path) secretKey, err := afero.ReadFile(mfa.Fs, path)
if err != nil { if err != nil {
@@ -40,16 +40,17 @@ func (mfa *CLIApp) signingOptions(path string) (*mfer.SigningOptions, error) {
log.Infof("signing manifest with the OpenPGP key in %s", path) log.Infof("signing manifest with the OpenPGP key in %s", path)
opts := &mfer.SigningOptions{SecretKey: secretKey} opts := &mfer.SigningOptions{SecretKey: secretKey}
if protected { if !protected {
return opts, nil
}
opts.Passphrase, err = mfa.readPassphrase(path) opts.Passphrase, err = mfa.readPassphrase(path)
if err != nil { if err != nil {
return nil, err return nil, err
} }
}
// gen and freshen read the signing options before any file, so a key // gen and freshen read the signing options before any file, so a
// that cannot sign, or a wrong passphrase, stops them before they hash // wrong passphrase stops them before they hash anything.
// anything.
err = mfer.CheckSigningKey(opts) err = mfer.CheckSigningKey(opts)
if err != nil { if err != nil {
return nil, fmt.Errorf("%s: %w", path, err) return nil, fmt.Errorf("%s: %w", path, err)
+12 -33
View File
@@ -7,9 +7,7 @@ import (
"path/filepath" "path/filepath"
"strings" "strings"
"testing" "testing"
"time"
"github.com/ProtonMail/go-crypto/openpgp/packet"
"github.com/creack/pty" "github.com/creack/pty"
"github.com/spf13/afero" "github.com/spf13/afero"
"github.com/stretchr/testify/assert" "github.com/stretchr/testify/assert"
@@ -35,7 +33,7 @@ func TestGenAndFreshenSignWithKeyFile(t *testing.T) {
t.Run(name, func(t *testing.T) { t.Run(name, func(t *testing.T) {
t.Setenv(envSignKeyPassphrase, string(passphrase)) t.Setenv(envSignKeyPassphrase, string(passphrase))
secretKey, fingerprint := testSecretKey(t, passphrase, nil) secretKey, fingerprint := testSecretKey(t, passphrase)
fs := afero.NewOsFs() fs := afero.NewOsFs()
keyFile := filepath.Join(t.TempDir(), "key.asc") keyFile := filepath.Join(t.TempDir(), "key.asc")
@@ -79,7 +77,7 @@ func TestGenAndFreshenSignWithKeyFile(t *testing.T) {
func TestSignWithProtectedKeyNeedsPassphrase(t *testing.T) { func TestSignWithProtectedKeyNeedsPassphrase(t *testing.T) {
t.Setenv(envSignKeyPassphrase, "") t.Setenv(envSignKeyPassphrase, "")
secretKey, _ := testSecretKey(t, []byte("secret"), nil) secretKey, _ := testSecretKey(t, []byte("secret"))
fs := afero.NewMemMapFs() fs := afero.NewMemMapFs()
require.NoError(t, afero.WriteFile(fs, testKeyFile, secretKey, 0o600)) require.NoError(t, afero.WriteFile(fs, testKeyFile, secretKey, 0o600))
@@ -99,34 +97,15 @@ func TestSignWithProtectedKeyNeedsPassphrase(t *testing.T) {
assert.False(t, exists) assert.False(t, exists)
} }
// TestSignWithKeyThatCannotSignFailsFirst runs gen on a directory and // TestSignWithWrongPassphraseFailsFirst runs gen on a directory and
// freshen on a manifest, neither of which exists, with keys that cannot // freshen on a manifest, neither of which exists, with a protected key and
// sign: a protected key with a wrong MFER_SIGN_KEY_PASSPHRASE, a key that // a wrong MFER_SIGN_KEY_PASSPHRASE. Each must fail to unlock the key: it
// expired in 2020, and a version 6 key. Each run must fail on the key: it // does that before it reads any file, so a missing file goes unnoticed.
// checks the key before it reads any file, so a missing file goes func TestSignWithWrongPassphraseFailsFirst(t *testing.T) {
// unnoticed.
func TestSignWithKeyThatCannotSignFailsFirst(t *testing.T) {
t.Setenv(envSignKeyPassphrase, "wrong") t.Setenv(envSignKeyPassphrase, "wrong")
wrongPassphrase, _ := testSecretKey(t, []byte("right"), nil) secretKey, _ := testSecretKey(t, []byte("right"))
made := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC)
expired, _ := testSecretKey(t, nil, &packet.Config{
Algorithm: packet.PubKeyAlgoEdDSA,
Time: func() time.Time { return made },
KeyLifetimeSecs: uint32((24 * time.Hour).Seconds()),
})
version6, _ := testSecretKey(t, nil, &packet.Config{
Algorithm: packet.PubKeyAlgoEd25519,
V6Keys: true,
})
for want, secretKey := range map[string][]byte{
"unlock signing key": wrongPassphrase,
"signing key cannot sign": expired,
"signing key must be an OpenPGP version 4 key": version6,
} {
fs := afero.NewMemMapFs() fs := afero.NewMemMapFs()
require.NoError(t, afero.WriteFile(fs, testKeyFile, secretKey, 0o600)) require.NoError(t, afero.WriteFile(fs, testKeyFile, secretKey, 0o600))
@@ -138,9 +117,9 @@ func TestSignWithKeyThatCannotSignFailsFirst(t *testing.T) {
{testApp, cmdFreshen, "-q", testFlagSignKey, testKeyFile, "/missing.mf"}, {testApp, cmdFreshen, "-q", testFlagSignKey, testKeyFile, "/missing.mf"},
} { } {
opts := testOpts(args, fs) opts := testOpts(args, fs)
assert.Equal(t, 1, runCLI(opts), args[1], want) assert.Equal(t, 1, runCLI(opts), args[1])
assert.Contains(t, testStderr(t, opts), testKeyFile+": "+want, args[1]) assert.Contains(t, testStderr(t, opts),
} testKeyFile+": unlock signing key", args[1])
} }
} }
@@ -151,7 +130,7 @@ func TestSignWithKeyThatCannotSignFailsFirst(t *testing.T) {
func TestGenAsksForPassphraseOnTerminal(t *testing.T) { func TestGenAsksForPassphraseOnTerminal(t *testing.T) {
t.Setenv(envSignKeyPassphrase, "") t.Setenv(envSignKeyPassphrase, "")
secretKey, fingerprint := testSecretKey(t, []byte("passphrase"), nil) secretKey, fingerprint := testSecretKey(t, []byte("passphrase"))
fs := afero.NewOsFs() fs := afero.NewOsFs()
keyFile := filepath.Join(t.TempDir(), "key.asc") keyFile := filepath.Join(t.TempDir(), "key.asc")
+17 -120
View File
@@ -16,26 +16,12 @@ import (
) )
const ( const (
// The tags of OpenPGP signature, key and subkey packets (RFC 9580, // The tags of OpenPGP signature, secret key and public key packets
// section 5). Subkeys have tags of their own, so each secret or public // (RFC 9580, section 5). Subkeys have tags of their own, so each
// key packet is one primary key. // secret or public key packet is one primary key.
signaturePacketTag = 2 signaturePacketTag = 2
secretKeyPacketTag = 5 secretKeyPacketTag = 5
publicKeyPacketTag = 6 publicKeyPacketTag = 6
secretSubkeyPacketTag = 7
publicSubkeyPacketTag = 14
// In the body of a key or subkey packet the algorithm octet follows
// the version octet and the four-octet creation time, and from version
// 5 on a four-octet length as well (RFC 9580, section 5.5.2).
keyAlgorithmOffset = 5
firstKeyVersionWithLength = 5
keyAlgorithmOffsetAfterLength = 9
// signingKeyVersion is the only OpenPGP key version mfer signs with.
// Its fingerprints are 40 hex characters, the length
// --require-signature takes.
signingKeyVersion = 4
// armorBegin and armorEnd start the lines that begin and end an // armorBegin and armorEnd start the lines that begin and end an
// armored block. // armored block.
@@ -45,18 +31,13 @@ const (
var ( var (
errKeyCount = errors.New("must hold exactly one key") errKeyCount = errors.New("must hold exactly one key")
errDSAKey = errors.New("must not hold a DSA key")
errSecretKey = errors.New("must not hold a secret key")
errNoSecretKey = errors.New("signing key file holds no secret key") errNoSecretKey = errors.New("signing key file holds no secret key")
errNotV4Key = errors.New("signing key must be an OpenPGP version 4 key, " +
"the only kind whose fingerprint --require-signature takes")
errNoPassphrase = errors.New( errNoPassphrase = errors.New(
"signing key is protected and no passphrase was given") "signing key is protected and no passphrase was given")
errNotOneSignature = errors.New( errNotOneSignature = errors.New(
"signature must hold exactly one signature") "signature must hold exactly one signature")
errNotOneArmoredBlock = errors.New( errNotOneArmoredBlock = errors.New(
"must be exactly one armored block and nothing else") "must be exactly one armored block and nothing else")
errMalformedArmor = errors.New("armor is malformed")
) )
// SigningOptions holds the key a manifest is signed with. // SigningOptions holds the key a manifest is signed with.
@@ -70,7 +51,7 @@ type SigningOptions struct {
// SecretKeyIsProtected reports whether the OpenPGP secret key secretKey, // SecretKeyIsProtected reports whether the OpenPGP secret key secretKey,
// armored or binary, needs a passphrase to sign. It fails unless // armored or binary, needs a passphrase to sign. It fails unless
// secretKey holds one version 4 primary key with its secret key. // secretKey holds one primary key with its secret key.
func SecretKeyIsProtected(secretKey []byte) (bool, error) { func SecretKeyIsProtected(secretKey []byte) (bool, error) {
key, err := readSecretKey(secretKey) key, err := readSecretKey(secretKey)
if err != nil { if err != nil {
@@ -80,26 +61,16 @@ func SecretKeyIsProtected(secretKey []byte) (bool, error) {
return isProtected(key), nil return isProtected(key), nil
} }
// CheckSigningKey fails unless opts can sign now: opts.SecretKey must hold // CheckSigningKey fails unless opts can sign: opts.SecretKey must hold one
// one version 4 primary key with a secret key that may sign and has not // primary key with its secret key, and opts.Passphrase must unlock it when
// expired or been revoked, and opts.Passphrase must unlock it when it is // it is protected. It lets a caller find a wrong passphrase before it
// protected. It lets a caller find a key that cannot sign before it builds // builds a manifest.
// a manifest.
func CheckSigningKey(opts *SigningOptions) error { func CheckSigningKey(opts *SigningOptions) error {
key, err := readSigningKey(opts) _, err := readSigningKey(opts)
if err != nil {
return err return err
} }
// Signing nothing fails wherever signing the manifest would.
err = openpgp.DetachSign(io.Discard, key, bytes.NewReader(nil), nil)
if err != nil {
return fmt.Errorf("signing key cannot sign: %w", err)
}
return nil
}
// readSigningKey returns the key in opts.SecretKey, unlocked with // readSigningKey returns the key in opts.SecretKey, unlocked with
// opts.Passphrase if it is protected. // opts.Passphrase if it is protected.
func readSigningKey(opts *SigningOptions) (*openpgp.Entity, error) { func readSigningKey(opts *SigningOptions) (*openpgp.Entity, error) {
@@ -125,18 +96,13 @@ func readSigningKey(opts *SigningOptions) (*openpgp.Entity, error) {
} }
// readSecretKey returns the one key in secretKey, armored or binary, // readSecretKey returns the one key in secretKey, armored or binary,
// which must be a version 4 key and include its secret key. // which must include its secret key.
func readSecretKey(secretKey []byte) (*openpgp.Entity, error) { func readSecretKey(secretKey []byte) (*openpgp.Entity, error) {
key, err := readOneKey(secretKey, "signing key file", false) key, err := readOneKey(secretKey, "signing key file")
if err != nil { if err != nil {
return nil, err return nil, err
} }
if key.PrimaryKey.Version != signingKeyVersion {
return nil, fmt.Errorf("%w; this key is version %d",
errNotV4Key, key.PrimaryKey.Version)
}
if key.PrivateKey == nil { if key.PrivateKey == nil {
return nil, errNoSecretKey return nil, errNoSecretKey
} }
@@ -145,9 +111,8 @@ func readSecretKey(secretKey []byte) (*openpgp.Entity, error) {
} }
// readOneKey returns the key in data, armored or binary, which must hold // readOneKey returns the key in data, armored or binary, which must hold
// exactly one primary key and no DSA key or subkey, and when publicOnly no // exactly one primary key. what names data in errors.
// secret key or subkey either. what names data in errors. func readOneKey(data []byte, what string) (*openpgp.Entity, error) {
func readOneKey(data []byte, what string, publicOnly bool) (*openpgp.Entity, error) {
packets, err := dearmor(data) packets, err := dearmor(data)
if err != nil { if err != nil {
return nil, fmt.Errorf("read %s: %w", what, err) return nil, fmt.Errorf("read %s: %w", what, err)
@@ -162,29 +127,6 @@ func readOneKey(data []byte, what string, publicOnly bool) (*openpgp.Entity, err
return nil, fmt.Errorf("%s %w, found %d", what, errKeyCount, keys) return nil, fmt.Errorf("%s %w, found %d", what, errKeyCount, keys)
} }
// openpgp.ReadKeyRing checks the numbers of every secret key it reads,
// and an ElGamal secret subkey with a very large prime makes that take
// minutes.
secretKeys, err := countPackets(packets, secretKeyPacketTag, secretSubkeyPacketTag)
if err != nil {
return nil, fmt.Errorf("read %s: %w", what, err)
}
if publicOnly && secretKeys != 0 {
return nil, fmt.Errorf("%s %w", what, errSecretKey)
}
// openpgp.ReadKeyRing also checks every self-signature, and a DSA key
// with very large numbers makes each check take seconds to minutes.
dsa, err := holdsDSAKey(packets)
if err != nil {
return nil, fmt.Errorf("read %s: %w", what, err)
}
if dsa {
return nil, fmt.Errorf("%s %w", what, errDSAKey)
}
keyring, err := openpgp.ReadKeyRing(bytes.NewReader(packets)) keyring, err := openpgp.ReadKeyRing(bytes.NewReader(packets))
if err != nil { if err != nil {
return nil, fmt.Errorf("read %s: %w", what, err) return nil, fmt.Errorf("read %s: %w", what, err)
@@ -247,7 +189,7 @@ func fingerprint(key *openpgp.Entity) string {
// and returns that primary key's fingerprint. signature and pubKey may each // and returns that primary key's fingerprint. signature and pubKey may each
// be armored or binary. // 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")
if err != nil { if err != nil {
return "", err return "", err
} }
@@ -298,20 +240,12 @@ func dearmor(data []byte) ([]byte, error) {
return nil, errNotOneArmoredBlock return nil, errNotOneArmoredBlock
} }
// armor.Decode passes over a block it cannot read, such as one with a
// header line that has no colon, and returns io.EOF on finding no
// other.
block, err := armor.Decode(bytes.NewReader(text)) block, err := armor.Decode(bytes.NewReader(text))
if err != nil { if err != nil {
return nil, errMalformedArmor return nil, err
} }
body, err := io.ReadAll(block.Body) return io.ReadAll(block.Body)
if err != nil {
return nil, fmt.Errorf("%w: %w", errMalformedArmor, err)
}
return body, nil
} }
// countPackets returns how many packets in the binary OpenPGP data have // countPackets returns how many packets in the binary OpenPGP data have
@@ -337,40 +271,3 @@ func countPackets(data []byte, tags ...uint8) (int, error) {
} }
} }
} }
// holdsDSAKey reports whether any key or subkey packet in the binary
// OpenPGP data holds a DSA key. It reads each packet's algorithm octet
// rather than parsing the packet, since parsing a secret key packet checks
// its numbers, which for a DSA key with very large numbers is as slow as
// checking a self-signature.
func holdsDSAKey(data []byte) (bool, error) {
packets := packet.NewOpaqueReader(bytes.NewReader(data))
for {
p, err := packets.Next()
if errors.Is(err, io.EOF) {
return false, nil
}
if err != nil {
return false, err
}
if !slices.Contains([]uint8{
secretKeyPacketTag, publicKeyPacketTag,
secretSubkeyPacketTag, publicSubkeyPacketTag,
}, p.Tag) {
continue
}
offset := keyAlgorithmOffset
if len(p.Contents) > 0 && p.Contents[0] >= firstKeyVersionWithLength {
offset = keyAlgorithmOffsetAfterLength
}
if len(p.Contents) > offset &&
packet.PublicKeyAlgorithm(p.Contents[offset]) == packet.PubKeyAlgoDSA {
return true, nil
}
}
}
-193
View File
@@ -4,9 +4,7 @@ package mfer
import ( import (
"bytes" "bytes"
"context" "context"
"crypto/dsa" //nolint:staticcheck // SA1019: tests need a DSA key to refuse
"io" "io"
"math/big"
"os" "os"
"path/filepath" "path/filepath"
"slices" "slices"
@@ -17,7 +15,6 @@ 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/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"
@@ -287,97 +284,6 @@ func TestSigningKeyFileWithoutSecretKey(t *testing.T) {
require.ErrorIs(t, b.Build(context.Background(), io.Discard), errNoSecretKey) require.ErrorIs(t, b.Build(context.Background(), io.Discard), errNoSecretKey)
} }
// TestCheckSigningKeyRefusesKeyThatCannotSign checks a key that can sign,
// and keys that read and need no passphrase but cannot sign now: one that
// expired in 2020 and one that has been revoked. CheckSigningKey must
// refuse each of the two, as signing a manifest with it would fail.
func TestCheckSigningKeyRefusesKeyThatCannotSign(t *testing.T) {
t.Parallel()
require.NoError(t, CheckSigningKey(testSigningOptions(t)))
made := time.Date(2020, 1, 1, 0, 0, 0, 0, time.UTC)
expired := newTestKey(t, &packet.Config{
Time: func() time.Time { return made },
KeyLifetimeSecs: uint32((24 * time.Hour).Seconds()),
})
revoked := newTestKey(t, nil)
require.NoError(t, revoked.RevokeKey(packet.KeyRetired, "", nil))
for name, key := range map[string]*openpgp.Entity{
"expired": expired,
"revoked": revoked,
} {
t.Run(name, func(t *testing.T) {
t.Parallel()
assert.ErrorContains(t, CheckSigningKey(
&SigningOptions{SecretKey: armoredSecretKeys(t, key)}),
"signing key cannot sign")
})
}
}
// TestSigningRefusesVersion6Key signs with an OpenPGP version 6 key, whose
// fingerprint is 64 hex characters. mfer signs only with version 4 keys.
func TestSigningRefusesVersion6Key(t *testing.T) {
t.Parallel()
key, err := openpgp.NewEntity("MFER Test Key", "", "test@mfer.test",
&packet.Config{V6Keys: true, Algorithm: packet.PubKeyAlgoEd25519})
require.NoError(t, err)
secretKey := armoredSecretKeys(t, key)
_, err = SecretKeyIsProtected(secretKey)
require.ErrorIs(t, err, errNotV4Key)
b := NewBuilder()
b.SetSigningOptions(&SigningOptions{SecretKey: secretKey})
require.ErrorIs(t, b.Build(context.Background(), io.Discard), errNotV4Key)
}
// TestMalformedArmorIsNamed reads a signing key file, a signature and an
// embedded public key block whose armor is malformed: a header line with
// no colon, or no blank line after the BEGIN line. Each must fail saying
// the armor is malformed.
func TestMalformedArmorIsNamed(t *testing.T) {
t.Parallel()
opts := testSigningOptions(t)
manifest := signedTestManifest(t, opts)
for name, change := range map[string]func([]byte) []byte{
"header line with no colon": func(block []byte) []byte {
return bytes.Replace(block,
[]byte("-----\n"), []byte("-----\nno colon\n"), 1)
},
"no blank line after the BEGIN line": func(block []byte) []byte {
return bytes.Replace(block, []byte("-----\n\n"), []byte("-----\n"), 1)
},
} {
t.Run(name, func(t *testing.T) {
t.Parallel()
_, err := SecretKeyIsProtected(change(opts.SecretKey))
require.ErrorIs(t, err, errMalformedArmor)
for _, changed := range [][]byte{
rewriteOuter(t, manifest, func(outer *MFFileOuter) {
outer.Signature = change(outer.GetSignature())
}),
rewriteOuter(t, manifest, func(outer *MFFileOuter) {
outer.SigningPubKey = change(outer.GetSigningPubKey())
}),
} {
_, err = NewManifestFromReader(bytes.NewReader(changed))
require.ErrorIs(t, err, errMalformedArmor)
}
})
}
}
func TestVerifySignature(t *testing.T) { func TestVerifySignature(t *testing.T) {
t.Parallel() t.Parallel()
@@ -557,105 +463,6 @@ func TestManifestRefusesSecondEmbeddedKeyWithoutUserID(t *testing.T) {
require.ErrorIs(t, err, errKeyCount) require.ErrorIs(t, err, errKeyCount)
} }
// dsaKeyPacket returns a public key packet holding a DSA key, or a public
// subkey packet when isSubkey. Its numbers are not a working key: loading
// must refuse the packet before it uses them.
func dsaKeyPacket(t *testing.T, isSubkey bool) []byte {
t.Helper()
key := packet.NewDSAPublicKey(time.Now(), &dsa.PublicKey{
P: big.NewInt(23), Q: big.NewInt(11), G: big.NewInt(4), Y: big.NewInt(8),
})
key.IsSubkey = isSubkey
var buf bytes.Buffer
require.NoError(t, key.Serialize(&buf))
return buf.Bytes()
}
// TestManifestRefusesDSAKey loads manifests whose embedded public key
// block holds a DSA key: alone, or as a subkey after the key that signed
// the manifest. openpgp.ReadKeyRing checks a key's self-signatures, which
// for a DSA key with very large numbers takes minutes each. Loading must
// refuse each block before that.
func TestManifestRefusesDSAKey(t *testing.T) {
t.Parallel()
signer := newTestKey(t, nil)
manifest := signedTestManifest(t,
&SigningOptions{SecretKey: armoredSecretKeys(t, signer)})
var signerKey bytes.Buffer
require.NoError(t, signer.Serialize(&signerKey))
for name, block := range map[string][]byte{
"DSA key": dsaKeyPacket(t, false),
"DSA subkey": slices.Concat(signerKey.Bytes(), dsaKeyPacket(t, true)),
} {
t.Run(name, func(t *testing.T) {
t.Parallel()
embedded := rewriteOuter(t, manifest, func(outer *MFFileOuter) {
outer.SigningPubKey = block
})
_, err := NewManifestFromReader(bytes.NewReader(embedded))
require.ErrorIs(t, err, errDSAKey)
})
}
}
// elGamalSecretSubkeyPacket returns a secret subkey packet holding an
// ElGamal key. Its numbers are not a working key: loading must refuse the
// packet before it uses them.
func elGamalSecretSubkeyPacket(t *testing.T) []byte {
t.Helper()
key := packet.NewElGamalPrivateKey(time.Now(), &elgamal.PrivateKey{
P: big.NewInt(23), G: big.NewInt(4), Y: big.NewInt(8), X: big.NewInt(3),
})
key.IsSubkey = true
var buf bytes.Buffer
require.NoError(t, key.Serialize(&buf))
return buf.Bytes()
}
// TestManifestRefusesSecretKey loads manifests whose embedded public key
// block holds a secret key: the key that signed the manifest with its
// secret key, or its public key followed by an ElGamal secret subkey.
// openpgp.ReadKeyRing checks the numbers of every secret key it reads,
// which for an ElGamal key with a very large prime takes minutes. Loading
// must refuse each block before that.
func TestManifestRefusesSecretKey(t *testing.T) {
t.Parallel()
signer := newTestKey(t, nil)
manifest := signedTestManifest(t,
&SigningOptions{SecretKey: armoredSecretKeys(t, signer)})
var signerKey bytes.Buffer
require.NoError(t, signer.Serialize(&signerKey))
for _, block := range [][]byte{
armoredSecretKeys(t, signer),
slices.Concat(signerKey.Bytes(), elGamalSecretSubkeyPacket(t)),
} {
embedded := rewriteOuter(t, manifest, func(outer *MFFileOuter) {
outer.SigningPubKey = block
})
_, err := NewManifestFromReader(bytes.NewReader(embedded))
require.ErrorIs(t, err, errSecretKey)
}
}
// TestManifestRefusesTwoSignatures loads a manifest whose signature field // TestManifestRefusesTwoSignatures loads a manifest whose signature field
// holds its good signature twice, not armored. Loading must refuse it. // holds its good signature twice, not armored. Loading must refuse it.
func TestManifestRefusesTwoSignatures(t *testing.T) { func TestManifestRefusesTwoSignatures(t *testing.T) {
+13 -11
View File
@@ -139,15 +139,25 @@ func (s *Scanner) EnumerateFile(filePath string) error {
return s.enumerateFileWithInfo(filepath.Base(abs), basePath, info, nil) return s.enumerateFileWithInfo(filepath.Base(abs), basePath, info, nil)
} }
// EnumeratePath adds inputPath, a directory or a file, to the scanner as // EnumeratePath walks a directory path and adds all files to the scanner.
// EnumeratePaths adds each of its paths.
// If progress is non-nil, status updates are sent as files are discovered. // If progress is non-nil, status updates are sent as files are discovered.
// The progress channel is closed when the method returns. // The progress channel is closed when the method returns.
func (s *Scanner) EnumeratePath( func (s *Scanner) EnumeratePath(
inputPath string, inputPath string,
progress chan<- EnumerateStatus, progress chan<- EnumerateStatus,
) error { ) error {
return s.EnumeratePaths(progress, inputPath) if progress != nil {
defer close(progress)
}
abs, err := filepath.Abs(inputPath)
if err != nil {
return err
}
afs := afero.NewReadOnlyFs(afero.NewBasePathFs(s.fs, abs))
return s.enumerateFS(afs, abs, progress)
} }
// EnumeratePaths adds to the scanner the files under each directory path, // EnumeratePaths adds to the scanner the files under each directory path,
@@ -175,14 +185,6 @@ func (s *Scanner) EnumeratePaths(
} }
if info.IsDir() { if info.IsDir() {
// The walk does not follow a symlink at its top, so a directory
// named through one is resolved first. If that fails, the
// directory is walked as named and the walk reports the problem.
resolved, evalErr := filepath.EvalSymlinks(abs)
if evalErr == nil {
abs = resolved
}
afs := afero.NewReadOnlyFs(afero.NewBasePathFs(s.fs, abs)) afs := afero.NewReadOnlyFs(afero.NewBasePathFs(s.fs, abs))
err = s.enumerateFS(afs, abs, progress) err = s.enumerateFS(afs, abs, progress)
} else { } else {
-21
View File
@@ -118,27 +118,6 @@ func TestScannerEnumeratePathWithProgress(t *testing.T) {
assert.Equal(t, FileSize(6), final.BytesFound) assert.Equal(t, FileSize(6), final.BytesFound)
} }
// TestScannerEnumeratePathFile gives EnumeratePath a file: it is listed
// by its name, as EnumerateFile lists it, and the manifest can be built.
func TestScannerEnumeratePathFile(t *testing.T) {
t.Parallel()
fs := afero.NewMemMapFs()
require.NoError(t, fs.MkdirAll("/dir", 0o755))
require.NoError(t, afero.WriteFile(fs, "/dir/one.txt", []byte("1"), 0o644))
s := NewScannerWithOptions(&ScannerOptions{Fs: fs})
require.NoError(t, s.EnumeratePath("/dir/one.txt", nil))
var buf bytes.Buffer
require.NoError(t, s.ToManifest(context.Background(), &buf, nil))
m, err := NewManifestFromReader(&buf)
require.NoError(t, err)
require.Len(t, m.Files(), 1)
assert.Equal(t, "one.txt", m.Files()[0].GetPath())
}
func TestScannerEnumeratePaths(t *testing.T) { func TestScannerEnumeratePaths(t *testing.T) {
t.Parallel() t.Parallel()