-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsnowflake_test.go
More file actions
928 lines (792 loc) · 24.3 KB
/
snowflake_test.go
File metadata and controls
928 lines (792 loc) · 24.3 KB
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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
// Copyright 2026 Snowflake Inc.
// SPDX-License-Identifier: MPL-2.0
package snowflake
import (
"context"
"crypto/rand"
"crypto/rsa"
"crypto/x509"
"database/sql"
"encoding/base64"
"encoding/pem"
"fmt"
"log"
"os"
"reflect"
"strings"
"testing"
"time"
"github.com/hashicorp/go-multierror"
"github.com/hashicorp/vault/sdk/database/dbplugin/v5"
dbtesting "github.com/hashicorp/vault/sdk/database/dbplugin/v5/testing"
"github.com/snowflakedb/gosnowflake"
"github.com/stretchr/testify/require"
)
const (
envVarSnowflakeAccount = "SNOWFLAKE_ACCOUNT"
envVarSnowflakeUser = "SNOWFLAKE_USER"
envVarSnowflakePassword = "SNOWFLAKE_PASSWORD"
envVarSnowflakeDatabase = "SNOWFLAKE_DATABASE"
envVarSnowflakeSchema = "SNOWFLAKE_SCHEMA"
envVarSnowflakePrivateKey = "SNOWFLAKE_PRIVATE_KEY"
envVarRunAccTests = "VAULT_ACC"
)
var runAcceptanceTests = os.Getenv(envVarRunAccTests) != ""
func connUrl(t *testing.T) string {
connURL, err := dsnString()
if err != nil {
t.Fatalf("failed to retrieve connection DSN: %s", err)
}
return connURL
}
func skipIfNoPassword(t *testing.T) {
t.Helper()
if os.Getenv(envVarSnowflakePassword) == "" {
t.Skip("skipping because SNOWFLAKE_PASSWORD is not set")
}
}
func skipIfNoKeyPair(t *testing.T) {
t.Helper()
if os.Getenv(envVarSnowflakePrivateKey) == "" {
t.Skip("skipping because SNOWFLAKE_PRIVATE_KEY is not set")
}
}
// connUrlKeyPair returns the connection URL, admin username, and decoded private key bytes
// for key-pair authenticated admin operations. It skips the test if required env vars are missing.
func connUrlKeyPair(t *testing.T) (connURL, username string, privateKeyBytes []byte) {
t.Helper()
connURL, rawBase64PrivateKey, username, err := getKeyPairAuthParameters("")
if err != nil {
t.Skipf("skipping key-pair test: %s", err)
}
privateKeyBytes, err = base64.StdEncoding.DecodeString(rawBase64PrivateKey)
if err != nil {
t.Fatalf("failed to decode base64 private key: %s", err)
}
return connURL, username, privateKeyBytes
}
// attemptDropUserKeyPair drops a user using key-pair authentication for the admin connection.
func attemptDropUserKeyPair(connURL, adminUser string, adminPrivateKey []byte, username string) {
db, err := openSnowflake(connURL, adminUser, adminPrivateKey)
if err != nil {
log.Printf("key-pair connection issue: %s", err)
return
}
defer db.Close()
_, err = db.Exec(fmt.Sprintf("DROP USER \"%s\"", username))
if err != nil {
log.Printf("query issue: %s", err)
}
}
// TestSnowflakeSQL_Initialize ensures initializing the Snowflake
// DB works as expected for both user-pass and keypair authentication
// scenarios
func TestSnowflakeSQL_Initialize(t *testing.T) {
if !runAcceptanceTests {
t.SkipNow()
}
t.Run("userpass auth", func(t *testing.T) {
skipIfNoPassword(t)
db := new()
defer dbtesting.AssertClose(t, db)
connURL, err := dsnString()
if err != nil {
t.Fatalf("failed to retrieve connection DSN: %s", err)
}
expectedConfig := map[string]interface{}{
"connection_url": connURL,
dbplugin.SupportedCredentialTypesKey: []interface{}{
dbplugin.CredentialTypePassword.String(),
dbplugin.CredentialTypeRSAPrivateKey.String(),
},
}
req := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
},
VerifyConnection: true,
}
resp := dbtesting.AssertInitialize(t, db, req)
if !reflect.DeepEqual(resp.Config, expectedConfig) {
t.Fatalf("Actual: %#v\nExpected: %#v", resp.Config, expectedConfig)
}
connProducer := db.snowflakeConnectionProducer
if !connProducer.Initialized {
t.Fatal("Database should be initialized")
}
})
// the environment variable SNOWFLAKE_PRIVATE_KEY in CI
// is a base64 encoded string. As such, this test expects the
// input for the variable to be base64 encoded
t.Run("keypair auth with raw private key", func(t *testing.T) {
db := new()
defer dbtesting.AssertClose(t, db)
connURL, rawBase64PrivateKey, user, err := getKeyPairAuthParameters("")
if err != nil {
t.Fatalf("failed to retrieve connection URL: %s", err)
}
// decode base64 encoded private key from environment
privateKey, err := base64.StdEncoding.DecodeString(rawBase64PrivateKey)
if err != nil {
t.Fatalf("failed to decode private key: %s", err)
}
expectedConfig := map[string]interface{}{
"connection_url": connURL,
"username": user,
"private_key": privateKey,
dbplugin.SupportedCredentialTypesKey: []interface{}{
dbplugin.CredentialTypePassword.String(),
dbplugin.CredentialTypeRSAPrivateKey.String(),
},
}
req := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
"username": user,
"private_key": privateKey,
},
VerifyConnection: true,
}
resp := dbtesting.AssertInitialize(t, db, req)
if !reflect.DeepEqual(resp.Config, expectedConfig) {
t.Fatalf("Actual: %#v\nExpected: %#v", resp.Config, expectedConfig)
}
connProducer := db.snowflakeConnectionProducer
if !connProducer.Initialized {
t.Fatal("Database should be initialized")
}
})
// the environment variable SNOWFLAKE_PRIVATE_KEY in CI
// is a base64 encoded string. As such, this test expects the
// input for the variable to be base64 encoded
t.Run("keypair auth with query params", func(t *testing.T) {
db := new()
defer dbtesting.AssertClose(t, db)
connURL, rawBase64PrivateKey, user, err := getKeyPairAuthParameters("disableOCSPChecks=true&maxRetryCount=5")
if err != nil {
t.Fatalf("failed to retrieve connection URL: %s", err)
}
// decode base64 encoded private key from environment
privateKey, err := base64.StdEncoding.DecodeString(rawBase64PrivateKey)
if err != nil {
t.Fatalf("failed to decode private key: %s", err)
}
expectedConfig := map[string]interface{}{
"connection_url": connURL,
"username": user,
"private_key": privateKey,
dbplugin.SupportedCredentialTypesKey: []interface{}{
dbplugin.CredentialTypePassword.String(),
dbplugin.CredentialTypeRSAPrivateKey.String(),
},
}
req := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
"username": user,
"private_key": privateKey,
},
VerifyConnection: true,
}
resp := dbtesting.AssertInitialize(t, db, req)
if !reflect.DeepEqual(resp.Config, expectedConfig) {
t.Fatalf("Actual: %#v\nExpected: %#v", resp.Config, expectedConfig)
}
connProducer := db.snowflakeConnectionProducer
if !connProducer.Initialized {
t.Fatal("Database should be initialized")
}
})
}
func TestSnowflake_NewUser(t *testing.T) {
if !runAcceptanceTests {
t.SkipNow()
}
type testCase struct {
creationStmts []string
credentialType dbplugin.CredentialType
keyBits int
password string
expectErr bool
}
passwordTests := map[string]testCase{
"new user with empty creation statements": {
credentialType: dbplugin.CredentialTypePassword,
creationStmts: []string{},
expectErr: true,
},
"new user with password credential using name": {
credentialType: dbplugin.CredentialTypePassword,
creationStmts: []string{
`
CREATE USER {{name}} PASSWORD = '{{password}}' DEFAULT_ROLE = public;
GRANT ROLE public TO USER {{name}};`,
},
password: "y8fva_sdVA3rasf",
},
"new user with password credential using username and split statements": {
credentialType: dbplugin.CredentialTypePassword,
creationStmts: []string{
"CREATE USER {{username}} PASSWORD = '{{password}}';",
"GRANT ROLE public TO USER {{username}};",
},
password: "secure_password",
},
}
keyPairTests := map[string]testCase{
"new user with 2048 bit rsa_private_key credential": {
credentialType: dbplugin.CredentialTypeRSAPrivateKey,
creationStmts: []string{
`
CREATE USER {{username}} RSA_PUBLIC_KEY='{{public_key}}';
GRANT ROLE public TO USER {{username}};`,
},
keyBits: 2048,
},
"new user with 3072 bit rsa_private_key credential": {
credentialType: dbplugin.CredentialTypeRSAPrivateKey,
creationStmts: []string{
"CREATE USER {{username}} RSA_PUBLIC_KEY='{{public_key}}';",
},
keyBits: 3072,
},
"new user with 4096 bit rsa_private_key credential and split statements": {
credentialType: dbplugin.CredentialTypeRSAPrivateKey,
creationStmts: []string{
"CREATE USER {{username}} RSA_PUBLIC_KEY='{{public_key}}';",
"GRANT ROLE public TO USER {{username}};",
},
keyBits: 4096,
},
}
for name, test := range passwordTests {
t.Run(name, func(t *testing.T) {
skipIfNoPassword(t)
connURL := connUrl(t)
db := new()
defer dbtesting.AssertClose(t, db)
initReq := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
},
VerifyConnection: true,
}
dbtesting.AssertInitialize(t, db, initReq)
createReq := dbplugin.NewUserRequest{
UsernameConfig: dbplugin.UsernameMetadata{
DisplayName: "test",
RoleName: "test",
},
Statements: dbplugin.Statements{
Commands: test.creationStmts,
},
CredentialType: test.credentialType,
Password: test.password,
Expiration: time.Now().Add(time.Hour),
}
ctx, cancel := context.WithTimeout(context.Background(), getRequestTimeout(t))
defer cancel()
createResp, err := db.NewUser(ctx, createReq)
if test.expectErr {
require.Error(t, err)
return
} else if err != nil {
t.Fatalf("failed to create user %s", err)
}
defer attemptDropUser(connURL, createResp.Username)
assertPasswordCredentialsExist(t, connURL, createResp.Username, test.password)
})
}
for name, test := range keyPairTests {
t.Run(name, func(t *testing.T) {
skipIfNoKeyPair(t)
connURL, adminUser, adminPrivateKey := connUrlKeyPair(t)
db := new()
defer dbtesting.AssertClose(t, db)
initReq := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
"username": adminUser,
"private_key": adminPrivateKey,
},
VerifyConnection: true,
}
dbtesting.AssertInitialize(t, db, initReq)
pub, priv := testGenerateRSAKeyPair(t, test.keyBits)
createReq := dbplugin.NewUserRequest{
UsernameConfig: dbplugin.UsernameMetadata{
DisplayName: "test",
RoleName: "test",
},
Statements: dbplugin.Statements{
Commands: test.creationStmts,
},
CredentialType: test.credentialType,
PublicKey: pub,
Expiration: time.Now().Add(time.Hour),
}
ctx, cancel := context.WithTimeout(context.Background(), getRequestTimeout(t))
defer cancel()
createResp, err := db.NewUser(ctx, createReq)
if test.expectErr {
require.Error(t, err)
return
} else if err != nil {
t.Fatalf("failed to create user %s", err)
}
defer attemptDropUserKeyPair(connURL, adminUser, adminPrivateKey, createResp.Username)
assertRSAKeyPairCredentialsExist(t, connURL, createResp.Username, priv)
})
}
}
func TestSnowflake_RenewUser(t *testing.T) {
if !runAcceptanceTests {
t.SkipNow()
}
skipIfNoPassword(t)
connURL := connUrl(t)
db := new()
defer dbtesting.AssertClose(t, db)
initReq := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
},
VerifyConnection: true,
}
dbtesting.AssertInitialize(t, db, initReq)
password := "y8fva_sdVA3rasf"
createReq := dbplugin.NewUserRequest{
UsernameConfig: dbplugin.UsernameMetadata{
DisplayName: "test",
RoleName: "test",
},
Statements: dbplugin.Statements{
Commands: []string{
`
CREATE USER {{name}} PASSWORD = '{{password}}';
GRANT ROLE public TO USER {{name}};`,
},
},
Password: password,
Expiration: time.Now().Add(time.Hour),
}
createResp := dbtesting.AssertNewUser(t, db, createReq)
defer attemptDropUser(connURL, createResp.Username)
assertPasswordCredentialsExist(t, connURL, createResp.Username, password)
renewReq := dbplugin.UpdateUserRequest{
Username: createResp.Username,
Expiration: &dbplugin.ChangeExpiration{
NewExpiration: time.Now().Add(time.Minute),
},
}
dbtesting.AssertUpdateUser(t, db, renewReq)
// Sleep longer than the initial expiration time
time.Sleep(2 * time.Second)
assertPasswordCredentialsExist(t, connURL, createResp.Username, password)
}
func TestSnowflake_RevokeUser(t *testing.T) {
if !runAcceptanceTests {
t.SkipNow()
}
skipIfNoPassword(t)
connURL := connUrl(t)
type testCase struct {
deleteStatements []string
}
tests := map[string]testCase{
"name revoke": {
deleteStatements: []string{
`
DROP USER {{name}};`,
},
},
"username revoke": {
deleteStatements: []string{
`
DROP USER {{username}};`,
},
},
"default revoke": {},
}
for name, test := range tests {
t.Run(name, func(t *testing.T) {
db := new()
defer dbtesting.AssertClose(t, db)
initReq := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
},
VerifyConnection: true,
}
dbtesting.AssertInitialize(t, db, initReq)
password := "y8fva_sdVA3rasf"
createReq := dbplugin.NewUserRequest{
UsernameConfig: dbplugin.UsernameMetadata{
DisplayName: "test",
RoleName: "test",
},
Statements: dbplugin.Statements{
Commands: []string{
`
CREATE USER {{name}} PASSWORD = '{{password}}';
GRANT ROLE public TO USER {{name}};`,
},
},
Password: password,
Expiration: time.Now().Add(time.Hour),
}
createResp := dbtesting.AssertNewUser(t, db, createReq)
assertPasswordCredentialsExist(t, connURL, createResp.Username, password)
deleteReq := dbplugin.DeleteUserRequest{
Username: createResp.Username,
Statements: dbplugin.Statements{
Commands: test.deleteStatements,
},
}
dbtesting.AssertDeleteUser(t, db, deleteReq)
assertPasswordCredentialsDoNotExist(t, connURL, createResp.Username, password)
})
}
}
func TestSnowflake_RenewUser_KeyPair(t *testing.T) {
if !runAcceptanceTests {
t.SkipNow()
}
skipIfNoKeyPair(t)
connURL, adminUser, adminPrivateKey := connUrlKeyPair(t)
db := new()
defer dbtesting.AssertClose(t, db)
initReq := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
"username": adminUser,
"private_key": adminPrivateKey,
},
VerifyConnection: true,
}
dbtesting.AssertInitialize(t, db, initReq)
pub, priv := testGenerateRSAKeyPair(t, 2048)
createReq := dbplugin.NewUserRequest{
UsernameConfig: dbplugin.UsernameMetadata{
DisplayName: "test",
RoleName: "test",
},
Statements: dbplugin.Statements{
Commands: []string{
`
CREATE USER {{username}} RSA_PUBLIC_KEY='{{public_key}}';
GRANT ROLE public TO USER {{username}};`,
},
},
CredentialType: dbplugin.CredentialTypeRSAPrivateKey,
PublicKey: pub,
Expiration: time.Now().Add(time.Hour),
}
createResp := dbtesting.AssertNewUser(t, db, createReq)
defer attemptDropUserKeyPair(connURL, adminUser, adminPrivateKey, createResp.Username)
assertRSAKeyPairCredentialsExist(t, connURL, createResp.Username, priv)
renewReq := dbplugin.UpdateUserRequest{
Username: createResp.Username,
Expiration: &dbplugin.ChangeExpiration{
NewExpiration: time.Now().Add(time.Minute),
},
}
dbtesting.AssertUpdateUser(t, db, renewReq)
// Sleep longer than the initial expiration time
time.Sleep(2 * time.Second)
assertRSAKeyPairCredentialsExist(t, connURL, createResp.Username, priv)
}
func TestSnowflake_RevokeUser_KeyPair(t *testing.T) {
if !runAcceptanceTests {
t.SkipNow()
}
skipIfNoKeyPair(t)
connURL, adminUser, adminPrivateKey := connUrlKeyPair(t)
db := new()
defer dbtesting.AssertClose(t, db)
initReq := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
"username": adminUser,
"private_key": adminPrivateKey,
},
VerifyConnection: true,
}
dbtesting.AssertInitialize(t, db, initReq)
pub, priv := testGenerateRSAKeyPair(t, 2048)
createReq := dbplugin.NewUserRequest{
UsernameConfig: dbplugin.UsernameMetadata{
DisplayName: "test",
RoleName: "test",
},
Statements: dbplugin.Statements{
Commands: []string{
`
CREATE USER {{username}} RSA_PUBLIC_KEY='{{public_key}}';
GRANT ROLE public TO USER {{username}};`,
},
},
CredentialType: dbplugin.CredentialTypeRSAPrivateKey,
PublicKey: pub,
Expiration: time.Now().Add(time.Hour),
}
createResp := dbtesting.AssertNewUser(t, db, createReq)
assertRSAKeyPairCredentialsExist(t, connURL, createResp.Username, priv)
deleteReq := dbplugin.DeleteUserRequest{
Username: createResp.Username,
Statements: dbplugin.Statements{
Commands: []string{
"DROP USER {{username}};",
},
},
}
dbtesting.AssertDeleteUser(t, db, deleteReq)
assertRSAKeyPairCredentialsDoNotExist(t, connURL, createResp.Username, priv)
}
func TestSnowflake_DefaultUsernameTemplate(t *testing.T) {
if !runAcceptanceTests {
t.SkipNow()
}
skipIfNoPassword(t)
connURL := connUrl(t)
db := new()
defer dbtesting.AssertClose(t, db)
initReq := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
},
VerifyConnection: true,
}
dbtesting.AssertInitialize(t, db, initReq)
password := "y8fva_sdVA3rasf"
createReq := dbplugin.NewUserRequest{
UsernameConfig: dbplugin.UsernameMetadata{
DisplayName: "test",
RoleName: "test",
},
Statements: dbplugin.Statements{
Commands: []string{
`
CREATE USER {{name}} PASSWORD = '{{password}}';
GRANT ROLE public TO USER {{name}};`,
},
},
Password: password,
Expiration: time.Now().Add(time.Hour),
}
createResp := dbtesting.AssertNewUser(t, db, createReq)
defer attemptDropUser(connURL, createResp.Username)
if createResp.Username == "" {
t.Fatalf("Missing username")
}
assertPasswordCredentialsExist(t, connURL, createResp.Username, password)
require.Regexp(t, `^v_test_test_[a-zA-Z0-9]{20}_[0-9]{10}$`, createResp.Username)
}
func TestSnowflake_CustomUsernameTemplate(t *testing.T) {
if !runAcceptanceTests {
t.SkipNow()
}
skipIfNoPassword(t)
connURL := connUrl(t)
db := new()
defer dbtesting.AssertClose(t, db)
initReq := dbplugin.InitializeRequest{
Config: map[string]interface{}{
"connection_url": connURL,
"username_template": "{{.DisplayName}}_{{random 10}}",
},
VerifyConnection: true,
}
dbtesting.AssertInitialize(t, db, initReq)
password := "y8fva_sdVA3rasf"
createReq := dbplugin.NewUserRequest{
UsernameConfig: dbplugin.UsernameMetadata{
DisplayName: "test",
RoleName: "test",
},
Statements: dbplugin.Statements{
Commands: []string{
`
CREATE USER {{name}} PASSWORD = '{{password}}';
GRANT ROLE public TO USER {{name}};`,
},
},
Password: password,
Expiration: time.Now().Add(time.Hour),
}
createResp := dbtesting.AssertNewUser(t, db, createReq)
defer attemptDropUser(connURL, createResp.Username)
if createResp.Username == "" {
t.Fatalf("Missing username")
}
assertPasswordCredentialsExist(t, connURL, createResp.Username, password)
require.Regexp(t, `^test_[a-zA-Z0-9]{10}$`, createResp.Username)
}
func dsnString() (string, error) {
user := os.Getenv(envVarSnowflakeUser)
password := os.Getenv(envVarSnowflakePassword)
account := os.Getenv(envVarSnowflakeAccount)
var err error
if user == "" {
err = multierror.Append(err, fmt.Errorf("SNOWFLAKE_USER not set"))
}
if password == "" {
err = multierror.Append(err, fmt.Errorf("SNOWFLAKE_PASSWORD not set"))
}
if account == "" {
err = multierror.Append(err, fmt.Errorf("SNOWFLAKE_ACCOUNT not set"))
}
if err != nil {
return "", err
}
dsnString := fmt.Sprintf("%s:%s@%s", user, password, account)
return dsnString, nil
}
func getKeyPairAuthParameters(optionalQueryParams string) (connURL string, pKey string, user string, err error) {
user = os.Getenv(envVarSnowflakeUser)
pKey = os.Getenv(envVarSnowflakePrivateKey)
account := os.Getenv(envVarSnowflakeAccount)
database := os.Getenv(envVarSnowflakeDatabase)
if user == "" {
err = multierror.Append(err, fmt.Errorf("SNOWFLAKE_USER not set"))
}
if pKey == "" {
err = multierror.Append(err, fmt.Errorf("SNOWFLAKE_PRIVATE_KEY not set"))
}
if account == "" {
err = multierror.Append(err, fmt.Errorf("SNOWFLAKE_ACCOUNT not set"))
}
if database == "" {
err = multierror.Append(err, fmt.Errorf("SNOWFLAKE_DATABASE not set"))
}
connURL = fmt.Sprintf("%s.snowflakecomputing.com/%s", account, database)
if optionalQueryParams != "" {
connURL = fmt.Sprintf("%s?%s", connURL, optionalQueryParams)
}
return connURL, pKey, user, err
}
func verifyConnWithKeyPairCredential(connString, username string, private *rsa.PrivateKey) error {
var config gosnowflake.Config
if strings.Contains(connString, "@") {
// Password-style DSN: user:pass@account
conf, err := gosnowflake.ParseDSN(connString)
if err != nil {
return err
}
config = gosnowflake.Config{
Account: conf.Account,
Region: conf.Region,
Database: conf.Database,
Schema: conf.Schema,
}
} else {
// Key-pair style URL: account.snowflakecomputing.com/db
// ParseDSN rejects empty passwords, so extract account manually.
// Don't set the database — the newly created user may not have access to it.
parts := accountAndDBNameFromConnURLRegex.FindStringSubmatch(connString)
if len(parts) != 3 {
return fmt.Errorf("invalid key-pair connection URL format: %s", connString)
}
config = gosnowflake.Config{
Account: parts[1],
}
}
config.Authenticator = gosnowflake.AuthTypeJwt
config.User = username
config.PrivateKey = private
connector := gosnowflake.NewConnector(gosnowflake.SnowflakeDriver{}, config)
db := sql.OpenDB(connector)
defer db.Close()
return db.Ping()
}
func verifyConnWithPasswordCredential(connString, username, password string) error {
conf, err := gosnowflake.ParseDSN(connString)
if err != nil {
return err
}
config := &gosnowflake.Config{
Authenticator: gosnowflake.AuthTypeSnowflake,
Account: conf.Account,
Region: conf.Region,
Database: conf.Database,
Schema: conf.Schema,
User: username,
Password: password,
}
dsn, err := gosnowflake.DSN(config)
if err != nil {
return err
}
db, err := sql.Open("snowflake", dsn)
if err != nil {
return err
}
defer db.Close()
return db.Ping()
}
func assertPasswordCredentialsExist(t *testing.T, connString, username, password string) {
t.Helper()
err := verifyConnWithPasswordCredential(connString, username, password)
if err != nil {
t.Fatalf("failed to log in with password credential: %s", err)
}
}
// assertPasswordCredentialsDoNotExist is a helper to assert db creds were
// properly removed. A successful assertion will result in the gosnowflake
// default logger to output `msg="Authentication FAILED"` in the test logs.
func assertPasswordCredentialsDoNotExist(t *testing.T, connString, username, password string) {
t.Helper()
err := verifyConnWithPasswordCredential(connString, username, password)
if err == nil {
t.Fatalf("logged in when it shouldn't have been able to")
}
}
func assertRSAKeyPairCredentialsExist(t *testing.T, connString, username string, private *rsa.PrivateKey) {
t.Helper()
err := verifyConnWithKeyPairCredential(connString, username, private)
if err != nil {
t.Fatalf("failed to log in with RSA key pair credential: %s", err)
}
}
func assertRSAKeyPairCredentialsDoNotExist(t *testing.T, connString, username string, private *rsa.PrivateKey) {
t.Helper()
err := verifyConnWithKeyPairCredential(connString, username, private)
if err == nil {
t.Fatalf("logged in when it shouldn't have been able to")
}
}
// Needed to not clutter the shared instance with testing artifacts
func attemptDropUser(connString, username string) {
db, err := sql.Open("snowflake", connString)
if err != nil {
log.Printf("connection issue: %s", err)
}
defer db.Close()
_, err = db.Exec(fmt.Sprintf("DROP USER \"%s\"", username))
if err != nil {
log.Printf("query issue: %s", err)
}
}
func getRequestTimeout(t *testing.T) time.Duration {
rawDur := os.Getenv("VAULT_TEST_DATABASE_REQUEST_TIMEOUT")
if rawDur == "" {
return 1 * time.Minute
}
dur, err := time.ParseDuration(rawDur)
if err != nil {
t.Fatalf("Failed to parse custom request timeout %q: %s", rawDur, err)
}
return dur
}
func testGenerateRSAKeyPair(t *testing.T, bits int) ([]byte, *rsa.PrivateKey) {
t.Helper()
key, err := rsa.GenerateKey(rand.Reader, bits)
require.NoError(t, err)
public, err := x509.MarshalPKIXPublicKey(key.Public())
require.NoError(t, err)
publicBlock := &pem.Block{
Type: "PUBLIC KEY",
Bytes: public,
}
return pem.EncodeToMemory(publicBlock), key
}