-
Notifications
You must be signed in to change notification settings - Fork 132
/
Copy pathsecure_storage_manager_test.go
226 lines (202 loc) · 7.61 KB
/
secure_storage_manager_test.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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
// Copyright (c) 2023 Snowflake Computing Inc. All rights reserved.
package gosnowflake
import (
"os"
"path/filepath"
"testing"
"time"
)
func TestBuildCredCacheDirPath(t *testing.T) {
skipOnWindows(t, "permission model is different")
testRoot1, err := os.MkdirTemp("", "")
assertNilF(t, err)
defer os.RemoveAll(testRoot1)
testRoot2, err := os.MkdirTemp("", "")
assertNilF(t, err)
defer os.RemoveAll(testRoot2)
assertNilF(t, os.Setenv("CACHE_DIR_TEST_NOT_EXISTING", "/tmp/not_existing_dir"))
assertNilF(t, os.Setenv("CACHE_DIR_TEST_1", testRoot1))
assertNilF(t, os.Setenv("CACHE_DIR_TEST_2", testRoot2))
t.Run("cannot find any dir", func(t *testing.T) {
_, err := buildCredCacheDirPath([]cacheDirConf{
{envVar: "CACHE_DIR_TEST_NOT_EXISTING"},
})
assertEqualE(t, err.Error(), "no credentials cache directory found")
_, err = os.Stat("/tmp/not_existing_dir")
assertStringContainsE(t, err.Error(), "no such file or directory")
})
t.Run("should use first dir that exists", func(t *testing.T) {
path, err := buildCredCacheDirPath([]cacheDirConf{
{envVar: "CACHE_DIR_TEST_NOT_EXISTING"},
{envVar: "CACHE_DIR_TEST_1"},
})
assertNilF(t, err)
assertEqualE(t, path, testRoot1)
stat, err := os.Stat(testRoot1)
assertNilF(t, err)
assertEqualE(t, stat.Mode(), 0700|os.ModeDir)
})
t.Run("should use first dir that exists and append segments", func(t *testing.T) {
path, err := buildCredCacheDirPath([]cacheDirConf{
{envVar: "CACHE_DIR_TEST_NOT_EXISTING"},
{envVar: "CACHE_DIR_TEST_2", pathSegments: []string{"sub1", "sub2"}},
})
assertNilF(t, err)
assertEqualE(t, path, filepath.Join(testRoot2, "sub1", "sub2"))
stat, err := os.Stat(testRoot2)
assertNilF(t, err)
assertEqualE(t, stat.Mode(), 0700|os.ModeDir)
})
}
func TestSnowflakeFileBasedSecureStorageManager(t *testing.T) {
skipOnWindows(t, "file system permission is different")
credCacheDir, err := os.MkdirTemp("", "")
assertNilF(t, err)
assertNilF(t, os.MkdirAll(credCacheDir, os.ModePerm))
credCacheDirEnvOverride := overrideEnv(credCacheDirEnv, credCacheDir)
defer credCacheDirEnvOverride.rollback()
ssm, err := newFileBasedSecureStorageManager()
assertNilF(t, err)
t.Run("store single token", func(t *testing.T) {
tokenSpec := newMfaTokenSpec("host.com", "johndoe")
cred := "token123"
ssm.setCredential(tokenSpec, cred)
assertEqualE(t, ssm.getCredential(tokenSpec), cred)
ssm.deleteCredential(tokenSpec)
assertEqualE(t, ssm.getCredential(tokenSpec), "")
})
t.Run("store tokens of different types, hosts and users", func(t *testing.T) {
mfaTokenSpec := newMfaTokenSpec("host.com", "johndoe")
mfaCred := "token12"
idTokenSpec := newIDTokenSpec("host.com", "johndoe")
idCred := "token34"
idTokenSpec2 := newIDTokenSpec("host.org", "johndoe")
idCred2 := "token56"
idTokenSpec3 := newIDTokenSpec("host.com", "someoneelse")
idCred3 := "token78"
ssm.setCredential(mfaTokenSpec, mfaCred)
ssm.setCredential(idTokenSpec, idCred)
ssm.setCredential(idTokenSpec2, idCred2)
ssm.setCredential(idTokenSpec3, idCred3)
assertEqualE(t, ssm.getCredential(mfaTokenSpec), mfaCred)
assertEqualE(t, ssm.getCredential(idTokenSpec), idCred)
assertEqualE(t, ssm.getCredential(idTokenSpec2), idCred2)
assertEqualE(t, ssm.getCredential(idTokenSpec3), idCred3)
ssm.deleteCredential(mfaTokenSpec)
assertEqualE(t, ssm.getCredential(mfaTokenSpec), "")
assertEqualE(t, ssm.getCredential(idTokenSpec), idCred)
assertEqualE(t, ssm.getCredential(idTokenSpec2), idCred2)
assertEqualE(t, ssm.getCredential(idTokenSpec3), idCred3)
})
t.Run("override single token", func(t *testing.T) {
mfaTokenSpec := newMfaTokenSpec("host.com", "johndoe")
mfaCred := "token123"
idTokenSpec := newIDTokenSpec("host.com", "johndoe")
idCred := "token456"
ssm.setCredential(mfaTokenSpec, mfaCred)
ssm.setCredential(idTokenSpec, idCred)
assertEqualE(t, ssm.getCredential(mfaTokenSpec), mfaCred)
mfaCredOverride := "token789"
ssm.setCredential(mfaTokenSpec, mfaCredOverride)
assertEqualE(t, ssm.getCredential(mfaTokenSpec), mfaCredOverride)
ssm.setCredential(idTokenSpec, idCred)
})
t.Run("unlock stale cache", func(t *testing.T) {
startTime := time.Now()
assertNilF(t, os.Mkdir(ssm.lockPath(), 0o700))
ssm.getCredential(newMfaTokenSpec("ignored", "ignored"))
assertTrueE(t, time.Since(startTime).Milliseconds() > 1000)
})
t.Run("should not modify keys other than tokens", func(t *testing.T) {
content := []byte(`{
"otherKey": "otherValue"
}`)
err = os.WriteFile(ssm.credFilePath(), content, 0o600)
assertNilF(t, err)
ssm.setCredential(newMfaTokenSpec("somehost.com", "someUser"), "someToken")
result, err := os.ReadFile(ssm.credFilePath())
assertNilF(t, err)
assertStringContainsE(t, string(result), `"otherKey":"otherValue"`)
})
}
func TestSetAndGetCredentialMfa(t *testing.T) {
for _, tokenSpec := range []*secureTokenSpec{
newMfaTokenSpec("testhost", "testuser"),
newIDTokenSpec("testhost", "testuser"),
} {
t.Run(string(tokenSpec.tokenType), func(t *testing.T) {
skipOnMac(t, "keyring asks for password")
fakeMfaToken := "test token"
tokenSpec := newMfaTokenSpec("testHost", "testUser")
credentialsStorage.setCredential(tokenSpec, fakeMfaToken)
assertEqualE(t, credentialsStorage.getCredential(tokenSpec), fakeMfaToken)
// delete credential and check it no longer exists
credentialsStorage.deleteCredential(tokenSpec)
assertEqualE(t, credentialsStorage.getCredential(tokenSpec), "")
})
}
}
func TestSkipStoringCredentialIfUserIsEmpty(t *testing.T) {
tokenSpecs := []*secureTokenSpec{
newMfaTokenSpec("mfaHost.com", ""),
newIDTokenSpec("idHost.com", ""),
}
for _, tokenSpec := range tokenSpecs {
t.Run(tokenSpec.host, func(t *testing.T) {
credentialsStorage.setCredential(tokenSpec, "non-empty-value")
assertEqualE(t, credentialsStorage.getCredential(tokenSpec), "")
})
}
}
func TestSkipStoringCredentialIfHostIsEmpty(t *testing.T) {
tokenSpecs := []*secureTokenSpec{
newMfaTokenSpec("", "mfaUser"),
newIDTokenSpec("", "idUser"),
}
for _, tokenSpec := range tokenSpecs {
t.Run(tokenSpec.user, func(t *testing.T) {
credentialsStorage.setCredential(tokenSpec, "non-empty-value")
assertEqualE(t, credentialsStorage.getCredential(tokenSpec), "")
})
}
}
func TestStoreTemporaryCredental(t *testing.T) {
if runningOnGithubAction() {
t.Skip("cannot write to github file system")
}
testcases := []struct {
tokenSpec *secureTokenSpec
value string
}{
{newMfaTokenSpec("testhost", "testuser"), "598ghFnjfh8BBgmf45mmhgkfRR45mgkt5"},
{newIDTokenSpec("testhost", "testuser"), "090Arftf54Jk3gh57ggrVvf09lJa3DD"},
}
ssm, err := newFileBasedSecureStorageManager()
assertNilF(t, err)
for _, test := range testcases {
t.Run(test.value, func(t *testing.T) {
ssm.setCredential(test.tokenSpec, test.value)
assertEqualE(t, ssm.getCredential(test.tokenSpec), test.value)
ssm.deleteCredential(test.tokenSpec)
assertEqualE(t, ssm.getCredential(test.tokenSpec), "")
})
}
}
func TestBuildCredentialsKey(t *testing.T) {
testcases := []struct {
host string
user string
credType tokenType
out string
}{
{"testaccount.snowflakecomputing.com", "testuser", "mfaToken", "c4e781475e7a5e74aca87cd462afafa8cc48ebff6f6ccb5054b894dae5eb6345"}, // pragma: allowlist secret
{"testaccount.snowflakecomputing.com", "testuser", "IdToken", "5014e26489992b6ea56b50e936ba85764dc51338f60441bdd4a69eac7e15bada"}, // pragma: allowlist secret
}
for _, test := range testcases {
target, err := buildCredentialsKey(test.host, test.user, test.credType)
assertNilF(t, err)
if target != test.out {
t.Fatalf("failed to convert target. expected: %v, but got: %v", test.out, target)
}
}
}