-
-
Notifications
You must be signed in to change notification settings - Fork 485
/
gunit.go
197 lines (160 loc) · 4.61 KB
/
gunit.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
package gptest
import (
"fmt"
"os"
"path/filepath"
"strings"
"testing"
"time"
"github.com/ProtonMail/go-crypto/openpgp"
"github.com/ProtonMail/go-crypto/openpgp/armor"
"github.com/ProtonMail/go-crypto/openpgp/packet"
aclip "github.com/atotto/clipboard"
"github.com/gopasspw/gopass/tests/can"
"github.com/stretchr/testify/require"
)
var gpgDefaultRecipients = []string{"BE73F104"}
// GUnit is a gopass unit test helper.
type GUnit struct {
t *testing.T
Entries []string
Recipients []string
Dir string
env map[string]string
}
// GPConfig returns the gopass config location.
func (u GUnit) GPConfig() string {
return filepath.Join(u.Dir, ".config", "gopass", "config")
}
// GPGHome returns the GnuPG homedir.
func (u GUnit) GPGHome() string {
return filepath.Join(u.Dir, ".gnupg")
}
// NewGUnitTester creates a new unit test helper.
func NewGUnitTester(t *testing.T) *GUnit {
t.Helper()
aclip.Unsupported = true
td := t.TempDir()
u := &GUnit{
t: t,
Entries: defaultEntries,
Recipients: gpgDefaultRecipients,
Dir: td,
}
u.env = map[string]string{
"CHECKPOINT_DISABLE": "true",
"GNUPGHOME": u.GPGHome(),
"GOPASS_CONFIG_NOSYSTEM": "true",
"GOPASS_CONFIG_NO_MIGRATE": "true",
"GOPASS_HOMEDIR": u.Dir,
"NO_COLOR": "true",
"GOPASS_NO_NOTIFY": "true",
"PAGER": "",
"GIT_AUTHOR_NAME": "gopass-tests",
"GIT_AUTHOR_EMAIL": "tests@gopass.pw",
}
setupEnv(t, u.env)
require.NoError(t, os.Mkdir(u.GPGHome(), 0o700))
require.NoError(t, u.initConfig())
require.NoError(t, u.InitStore(""))
return u
}
func (u GUnit) initConfig() error {
if err := os.MkdirAll(filepath.Dir(u.GPConfig()), 0o755); err != nil {
return err
}
err := os.WriteFile(
u.GPConfig(),
[]byte(gopassConfig+"\texportkeys = false\n[mounts]\npath = "+u.StoreDir("")+"\n"),
0o600,
)
if err != nil {
return fmt.Errorf("failed to write config: %w", err)
}
return nil
}
// StoreDir returns the password store dir.
func (u GUnit) StoreDir(mount string) string {
if mount != "" {
mount = "-" + mount
}
return filepath.Join(u.Dir, "password-store"+mount)
}
func (u GUnit) recipients() []byte {
return []byte(strings.Join(u.Recipients, "\n"))
}
func (u GUnit) writeRecipients(name string) error {
dir := u.StoreDir(name)
if err := os.MkdirAll(dir, 0o700); err != nil {
return fmt.Errorf("failed to create store dir %s: %w", dir, err)
}
fn := filepath.Join(dir, ".gpg-id") // gpgcli.IDFile
_ = os.Remove(fn)
if err := os.WriteFile(fn, u.recipients(), 0o600); err != nil {
return fmt.Errorf("failed to write IDFile %s: %w", fn, err)
}
return nil
}
// InitStore initializes the test store.
func (u GUnit) InitStore(name string) error {
if err := u.writeRecipients(name); err != nil {
return fmt.Errorf("failed to write recipients: %w", err)
}
if err := can.WriteTo(u.GPGHome()); err != nil {
return err
}
dir := u.StoreDir(name)
// write embedded public keys to the store so we can import them
el := can.EmbeddedKeyRing()
for _, e := range el {
tfn := filepath.Join(dir, ".public-keys", e.PrimaryKey.KeyIdShortString())
if err := os.MkdirAll(filepath.Dir(tfn), 0o700); err != nil {
return fmt.Errorf("failed to create public-keys dir %s: %w", filepath.Dir(tfn), err)
}
fh, err := os.Create(tfn)
if err != nil {
return fmt.Errorf("failed to create public-keys file %s: %w", tfn, err)
}
defer fh.Close() //nolint:errcheck
wc, err := armor.Encode(fh, openpgp.PublicKeyType, nil)
if err != nil {
return err
}
if err := e.Serialize(wc); err != nil {
return err
}
if err := wc.Close(); err != nil {
return err
}
}
return nil
}
func (u *GUnit) AddExpiredRecipient() string {
u.t.Helper()
e, err := openpgp.NewEntity("Expired", "", "expired@example.com", &packet.Config{
RSABits: 4096,
})
require.NoError(u.t, err)
for _, id := range e.Identities {
err := id.SelfSignature.SignUserId(id.UserId.Id, e.PrimaryKey, e.PrivateKey, &packet.Config{
SigLifetimeSecs: 1, // we can not use negative or zero here
})
require.NoError(u.t, err)
}
el := can.EmbeddedKeyRing()
el = append(el, e)
fn := filepath.Join(u.GPGHome(), "pubring.gpg")
fh, err := os.Create(fn)
require.NoError(u.t, err)
for _, e := range el {
require.NoError(u.t, e.Serialize(fh))
// u.t.Logf("wrote %X to %s", e.PrimaryKey.Fingerprint, fn)
}
require.NoError(u.t, fh.Close())
// wait for the key to expire
time.Sleep(time.Second)
id := fmt.Sprintf("%X", e.PrimaryKey.Fingerprint)
u.Recipients = append(u.Recipients, id)
require.NoError(u.t, u.writeRecipients(""))
return id
}