package mongodb import ( "context" "crypto/tls" "crypto/x509" "fmt" "net/url" "reflect" "strings" "testing" "time" "github.com/hashicorp/vault/helper/testhelpers/mongodb" "github.com/hashicorp/vault/sdk/database/dbplugin" "go.mongodb.org/mongo-driver/mongo" "go.mongodb.org/mongo-driver/mongo/options" "go.mongodb.org/mongo-driver/mongo/readpref" ) const testMongoDBRole = `{ "db": "admin", "roles": [ { "role": "readWrite" } ] }` const testMongoDBWriteConcern = `{ "wmode": "majority", "wtimeout": 5000 }` func TestMongoDB_Initialize(t *testing.T) { cleanup, connURL := mongodb.PrepareTestContainer(t, "latest") defer cleanup() connectionDetails := map[string]interface{}{ "connection_url": connURL, } db := new() _, err := db.Init(context.Background(), connectionDetails, true) if err != nil { t.Fatalf("err: %s", err) } if !db.Initialized { t.Fatal("Database should be initialized") } err = db.Close() if err != nil { t.Fatalf("err: %s", err) } } func TestMongoDB_CreateUser(t *testing.T) { cleanup, connURL := mongodb.PrepareTestContainer(t, "latest") defer cleanup() connectionDetails := map[string]interface{}{ "connection_url": connURL, } db := new() _, err := db.Init(context.Background(), connectionDetails, true) if err != nil { t.Fatalf("err: %s", err) } statements := dbplugin.Statements{ Creation: []string{testMongoDBRole}, } usernameConfig := dbplugin.UsernameConfig{ DisplayName: "test", RoleName: "test", } username, password, err := db.CreateUser(context.Background(), statements, usernameConfig, time.Now().Add(time.Minute)) if err != nil { t.Fatalf("err: %s", err) } if err := testCredsExist(t, connURL, username, password); err != nil { t.Fatalf("Could not connect with new credentials: %s", err) } } func TestMongoDB_CreateUser_writeConcern(t *testing.T) { cleanup, connURL := mongodb.PrepareTestContainer(t, "latest") defer cleanup() connectionDetails := map[string]interface{}{ "connection_url": connURL, "write_concern": testMongoDBWriteConcern, } db := new() _, err := db.Init(context.Background(), connectionDetails, true) if err != nil { t.Fatalf("err: %s", err) } statements := dbplugin.Statements{ Creation: []string{testMongoDBRole}, } usernameConfig := dbplugin.UsernameConfig{ DisplayName: "test", RoleName: "test", } username, password, err := db.CreateUser(context.Background(), statements, usernameConfig, time.Now().Add(time.Minute)) if err != nil { t.Fatalf("err: %s", err) } if err := testCredsExist(t, connURL, username, password); err != nil { t.Fatalf("Could not connect with new credentials: %s", err) } } func TestMongoDB_RevokeUser(t *testing.T) { cleanup, connURL := mongodb.PrepareTestContainer(t, "latest") defer cleanup() connectionDetails := map[string]interface{}{ "connection_url": connURL, } db := new() _, err := db.Init(context.Background(), connectionDetails, true) if err != nil { t.Fatalf("err: %s", err) } statements := dbplugin.Statements{ Creation: []string{testMongoDBRole}, } usernameConfig := dbplugin.UsernameConfig{ DisplayName: "test", RoleName: "test", } username, password, err := db.CreateUser(context.Background(), statements, usernameConfig, time.Now().Add(time.Minute)) if err != nil { t.Fatalf("err: %s", err) } if err := testCredsExist(t, connURL, username, password); err != nil { t.Fatalf("Could not connect with new credentials: %s", err) } // Test default revocation statement err = db.RevokeUser(context.Background(), statements, username) if err != nil { t.Fatalf("err: %s", err) } if err = testCredsExist(t, connURL, username, password); err == nil { t.Fatal("Credentials were not revoked") } } func testCredsExist(t testing.TB, connURL, username, password string) error { connURL = strings.Replace(connURL, "mongodb://", fmt.Sprintf("mongodb://%s:%s@", username, password), 1) ctx, _ := context.WithTimeout(context.Background(), 10*time.Second) client, err := mongo.Connect(ctx, options.Client().ApplyURI(connURL)) if err != nil { return err } return client.Ping(ctx, readpref.Primary()) } func TestMongoDB_SetCredentials(t *testing.T) { cleanup, connURL := mongodb.PrepareTestContainer(t, "latest") defer cleanup() // The docker test method PrepareTestContainer defaults to a database "test" // if none is provided connURL = connURL + "/test" connectionDetails := map[string]interface{}{ "connection_url": connURL, } db := new() _, err := db.Init(context.Background(), connectionDetails, true) if err != nil { t.Fatalf("err: %s", err) } // create the database user in advance, and test the connection dbUser := "testmongouser" startingPassword := "password" testCreateDBUser(t, connURL, "test", dbUser, startingPassword) if err := testCredsExist(t, connURL, dbUser, startingPassword); err != nil { t.Fatalf("Could not connect with new credentials: %s", err) } newPassword, err := db.GenerateCredentials(context.Background()) if err != nil { t.Fatal(err) } usernameConfig := dbplugin.StaticUserConfig{ Username: dbUser, Password: newPassword, } username, password, err := db.SetCredentials(context.Background(), dbplugin.Statements{}, usernameConfig) if err != nil { t.Fatalf("err: %s", err) } if err := testCredsExist(t, connURL, username, password); err != nil { t.Fatalf("Could not connect with new credentials: %s", err) } // confirm the original creds used to set still work (should be the same) if err := testCredsExist(t, connURL, dbUser, newPassword); err != nil { t.Fatalf("Could not connect with new credentials: %s", err) } if (dbUser != username) || (newPassword != password) { t.Fatalf("username/password mismatch: (%s)/(%s) vs (%s)/(%s)", dbUser, username, newPassword, password) } } func testCreateDBUser(t testing.TB, connURL, db, username, password string) { ctx, _ := context.WithTimeout(context.Background(), 10*time.Second) client, err := mongo.Connect(ctx, options.Client().ApplyURI(connURL)) if err != nil { t.Fatal(err) } createUserCmd := &createUserCommand{ Username: username, Password: password, Roles: []interface{}{}, } result := client.Database(db).RunCommand(ctx, createUserCmd, nil) if result.Err() != nil { t.Fatal(result.Err()) } } func TestGetTLSAuth(t *testing.T) { ca := newCert(t, commonName("certificate authority"), isCA(true), selfSign(), ) cert := newCert(t, commonName("test cert"), parent(ca), ) type testCase struct { username string tlsCAData []byte tlsKeyData []byte expectOpts *options.ClientOptions expectErr bool } tests := map[string]testCase{ "no TLS data set": { expectOpts: nil, expectErr: false, }, "bad CA": { tlsCAData: []byte("foobar"), expectOpts: nil, expectErr: true, }, "bad key": { tlsKeyData: []byte("foobar"), expectOpts: nil, expectErr: true, }, "good ca": { tlsCAData: cert.pem, expectOpts: options.Client(). SetTLSConfig( &tls.Config{ RootCAs: appendToCertPool(t, x509.NewCertPool(), cert.pem), }, ), expectErr: false, }, "good key": { username: "unittest", tlsKeyData: cert.CombinedPEM(), expectOpts: options.Client(). SetTLSConfig( &tls.Config{ Certificates: []tls.Certificate{cert.tlsCert}, }, ). SetAuth(options.Credential{ AuthMechanism: "MONGODB-X509", Username: "unittest", }), expectErr: false, }, } for name, test := range tests { t.Run(name, func(t *testing.T) { c := new() c.Username = test.username c.TLSCAData = test.tlsCAData c.TLSCertificateKeyData = test.tlsKeyData actual, err := c.getTLSAuth() if test.expectErr && err == nil { t.Fatalf("err expected, got nil") } if !test.expectErr && err != nil { t.Fatalf("no error expected, got: %s", err) } if !reflect.DeepEqual(actual, test.expectOpts) { t.Fatalf("Actual:\n%#v\nExpected:\n%#v", actual, test.expectOpts) } }) } } func appendToCertPool(t *testing.T, pool *x509.CertPool, caPem []byte) *x509.CertPool { t.Helper() ok := pool.AppendCertsFromPEM(caPem) if !ok { t.Fatalf("Unable to append cert to cert pool") } return pool } func TestMongoDB_RotateRootCredentials(t *testing.T) { cleanup, connURL := mongodb.PrepareTestContainer(t, "latest") defer cleanup() // Test to ensure that we can't rotate the root creds if no username has been specified testCtx, cancel := context.WithTimeout(context.Background(), 10*time.Second) defer cancel() db := new() connDetailsWithoutUsername := map[string]interface{}{ "connection_url": connURL, } _, err := db.Init(testCtx, connDetailsWithoutUsername, true) if err != nil { t.Fatalf("err: %s", err) } // Rotate credentials should fail because no username is specified cfg, err := db.RotateRootCredentials(testCtx, nil) if err == nil { t.Fatalf("successfully rotated root credentials when no username was present") } if !reflect.DeepEqual(cfg, connDetailsWithoutUsername) { t.Fatalf("expected connection details: %#v but were %#v", connDetailsWithoutUsername, cfg) } db.Close() // Reset the database object with new connection details username := "vault-test-admin" initialPassword := "myreallysecurepassword" db = new() connDetailsWithUsername := map[string]interface{}{ "connection_url": connURL, "username": username, "password": initialPassword, } _, err = db.Init(testCtx, connDetailsWithUsername, true) if err != nil { t.Fatalf("err: %s", err) } // Create root user createUser(t, connURL, username, initialPassword) initialURL := setUserPassOnURL(t, connURL, username, initialPassword) // Ensure the initial root user can connect err = assertConnection(testCtx, initialURL) if err != nil { t.Fatalf("%s", err) } // Rotate credentials newCfg, err := db.RotateRootCredentials(testCtx, nil) if err != nil { t.Fatalf("unexpected err rotating root credentials: %s", err) } // Ensure the initial root user can no longer connect err = assertConnection(testCtx, initialURL) if err == nil { t.Fatalf("connection with initial credentials succeeded when it shouldn't have") } // Ensure the new password can connect newURL := setUserPassOnURL(t, connURL, username, newCfg["password"].(string)) err = assertConnection(testCtx, newURL) if err != nil { t.Fatalf("unexpected error pinging client with new credentials: %s", err) } } func createUser(t *testing.T, connURL, username, password string) { t.Helper() ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second) defer cancel() client, err := createClient(ctx, connURL, nil) if err != nil { t.Fatalf("Unable to make initial connection: %s", err) } createUserCmd := createUserCommand{ Username: username, Password: password, Roles: []interface{}{ "userAdminAnyDatabase", "dbAdminAnyDatabase", "readWriteAnyDatabase", }, } result := client.Database("admin").RunCommand(ctx, createUserCmd, nil) err = result.Err() if err != nil { t.Fatalf("Unable to create admin user: %s", err) } } func assertConnection(testCtx context.Context, connURL string) error { // Connect as initial root user and ensure the connection is successful client, err := createClient(testCtx, connURL, nil) if err != nil { return fmt.Errorf("unable to create client connection with initial root user: %w", err) } err = client.Ping(testCtx, nil) if err != nil { return fmt.Errorf("failed to ping server with initial root user: %w", err) } client.Disconnect(testCtx) return nil } func setUserPassOnURL(t *testing.T, connURL, username, password string) string { t.Helper() uri, err := url.Parse(connURL) if err != nil { t.Fatalf("unable to parse connection URL: %s", err) } uri.User = url.UserPassword(username, password) return uri.String() }