mirror of
				https://github.com/optim-enterprises-bv/vault.git
				synced 2025-11-04 04:28:08 +00:00 
			
		
		
		
	
		
			
				
	
	
		
			353 lines
		
	
	
		
			8.2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			353 lines
		
	
	
		
			8.2 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
package mysql
 | 
						|
 | 
						|
import (
 | 
						|
	"context"
 | 
						|
	"database/sql"
 | 
						|
	"fmt"
 | 
						|
	"log"
 | 
						|
	"os"
 | 
						|
	"reflect"
 | 
						|
	"testing"
 | 
						|
 | 
						|
	"github.com/hashicorp/vault/logical"
 | 
						|
	logicaltest "github.com/hashicorp/vault/logical/testing"
 | 
						|
	"github.com/mitchellh/mapstructure"
 | 
						|
	"github.com/ory/dockertest"
 | 
						|
)
 | 
						|
 | 
						|
func prepareTestContainer(t *testing.T) (func(), string) {
 | 
						|
	if os.Getenv("MYSQL_URL") != "" {
 | 
						|
		return func() {}, os.Getenv("MYSQL_URL")
 | 
						|
	}
 | 
						|
 | 
						|
	pool, err := dockertest.NewPool("")
 | 
						|
	if err != nil {
 | 
						|
		t.Fatalf("Failed to connect to docker: %s", err)
 | 
						|
	}
 | 
						|
 | 
						|
	resource, err := pool.Run("mysql", "5.7", []string{"MYSQL_ROOT_PASSWORD=secret"})
 | 
						|
	if err != nil {
 | 
						|
		t.Fatalf("Could not start local MySQL docker container: %s", err)
 | 
						|
	}
 | 
						|
 | 
						|
	cleanup := func() {
 | 
						|
		err := pool.Purge(resource)
 | 
						|
		if err != nil {
 | 
						|
			t.Fatalf("Failed to cleanup local container: %s", err)
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	retURL := fmt.Sprintf("root:secret@(localhost:%s)/mysql?parseTime=true", resource.GetPort("3306/tcp"))
 | 
						|
 | 
						|
	// exponential backoff-retry
 | 
						|
	if err = pool.Retry(func() error {
 | 
						|
		var err error
 | 
						|
		var db *sql.DB
 | 
						|
		db, err = sql.Open("mysql", retURL)
 | 
						|
		if err != nil {
 | 
						|
			return err
 | 
						|
		}
 | 
						|
		defer db.Close()
 | 
						|
		return db.Ping()
 | 
						|
	}); err != nil {
 | 
						|
		cleanup()
 | 
						|
		t.Fatalf("Could not connect to MySQL docker container: %s", err)
 | 
						|
	}
 | 
						|
 | 
						|
	return cleanup, retURL
 | 
						|
}
 | 
						|
 | 
						|
func TestBackend_config_connection(t *testing.T) {
 | 
						|
	var resp *logical.Response
 | 
						|
	var err error
 | 
						|
	config := logical.TestBackendConfig()
 | 
						|
	config.StorageView = &logical.InmemStorage{}
 | 
						|
	b, err := Factory(context.Background(), config)
 | 
						|
	if err != nil {
 | 
						|
		t.Fatal(err)
 | 
						|
	}
 | 
						|
 | 
						|
	configData := map[string]interface{}{
 | 
						|
		"connection_url":       "sample_connection_url",
 | 
						|
		"max_open_connections": 9,
 | 
						|
		"max_idle_connections": 7,
 | 
						|
		"verify_connection":    false,
 | 
						|
	}
 | 
						|
 | 
						|
	configReq := &logical.Request{
 | 
						|
		Operation: logical.UpdateOperation,
 | 
						|
		Path:      "config/connection",
 | 
						|
		Storage:   config.StorageView,
 | 
						|
		Data:      configData,
 | 
						|
	}
 | 
						|
	resp, err = b.HandleRequest(context.Background(), configReq)
 | 
						|
	if err != nil || (resp != nil && resp.IsError()) {
 | 
						|
		t.Fatalf("err:%s resp:%#v\n", err, resp)
 | 
						|
	}
 | 
						|
 | 
						|
	configReq.Operation = logical.ReadOperation
 | 
						|
	resp, err = b.HandleRequest(context.Background(), configReq)
 | 
						|
	if err != nil || (resp != nil && resp.IsError()) {
 | 
						|
		t.Fatalf("err:%s resp:%#v\n", err, resp)
 | 
						|
	}
 | 
						|
 | 
						|
	delete(configData, "verify_connection")
 | 
						|
	delete(configData, "connection_url")
 | 
						|
	if !reflect.DeepEqual(configData, resp.Data) {
 | 
						|
		t.Fatalf("bad: expected:%#v\nactual:%#v\n", configData, resp.Data)
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func TestBackend_basic(t *testing.T) {
 | 
						|
	config := logical.TestBackendConfig()
 | 
						|
	config.StorageView = &logical.InmemStorage{}
 | 
						|
	b, err := Factory(context.Background(), config)
 | 
						|
	if err != nil {
 | 
						|
		t.Fatal(err)
 | 
						|
	}
 | 
						|
 | 
						|
	cleanup, connURL := prepareTestContainer(t)
 | 
						|
	defer cleanup()
 | 
						|
 | 
						|
	connData := map[string]interface{}{
 | 
						|
		"connection_url": connURL,
 | 
						|
	}
 | 
						|
 | 
						|
	// for wildcard based mysql user
 | 
						|
	logicaltest.Test(t, logicaltest.TestCase{
 | 
						|
		Backend: b,
 | 
						|
		Steps: []logicaltest.TestStep{
 | 
						|
			testAccStepConfig(t, connData, false),
 | 
						|
			testAccStepRole(t, true),
 | 
						|
			testAccStepReadCreds(t, "web"),
 | 
						|
		},
 | 
						|
	})
 | 
						|
}
 | 
						|
 | 
						|
func TestBackend_basicHostRevoke(t *testing.T) {
 | 
						|
	config := logical.TestBackendConfig()
 | 
						|
	config.StorageView = &logical.InmemStorage{}
 | 
						|
	b, err := Factory(context.Background(), config)
 | 
						|
	if err != nil {
 | 
						|
		t.Fatal(err)
 | 
						|
	}
 | 
						|
 | 
						|
	cleanup, connURL := prepareTestContainer(t)
 | 
						|
	defer cleanup()
 | 
						|
 | 
						|
	connData := map[string]interface{}{
 | 
						|
		"connection_url": connURL,
 | 
						|
	}
 | 
						|
 | 
						|
	// for host based mysql user
 | 
						|
	logicaltest.Test(t, logicaltest.TestCase{
 | 
						|
		Backend: b,
 | 
						|
		Steps: []logicaltest.TestStep{
 | 
						|
			testAccStepConfig(t, connData, false),
 | 
						|
			testAccStepRole(t, false),
 | 
						|
			testAccStepReadCreds(t, "web"),
 | 
						|
		},
 | 
						|
	})
 | 
						|
}
 | 
						|
 | 
						|
func TestBackend_roleCrud(t *testing.T) {
 | 
						|
	config := logical.TestBackendConfig()
 | 
						|
	config.StorageView = &logical.InmemStorage{}
 | 
						|
	b, err := Factory(context.Background(), config)
 | 
						|
	if err != nil {
 | 
						|
		t.Fatal(err)
 | 
						|
	}
 | 
						|
 | 
						|
	cleanup, connURL := prepareTestContainer(t)
 | 
						|
	defer cleanup()
 | 
						|
 | 
						|
	connData := map[string]interface{}{
 | 
						|
		"connection_url": connURL,
 | 
						|
	}
 | 
						|
 | 
						|
	logicaltest.Test(t, logicaltest.TestCase{
 | 
						|
		Backend: b,
 | 
						|
		Steps: []logicaltest.TestStep{
 | 
						|
			testAccStepConfig(t, connData, false),
 | 
						|
			// test SQL with wildcard based user
 | 
						|
			testAccStepRole(t, true),
 | 
						|
			testAccStepReadRole(t, "web", testRoleWildCard),
 | 
						|
			testAccStepDeleteRole(t, "web"),
 | 
						|
			// test SQL with host  based user
 | 
						|
			testAccStepRole(t, false),
 | 
						|
			testAccStepReadRole(t, "web", testRoleHost),
 | 
						|
			testAccStepDeleteRole(t, "web"),
 | 
						|
		},
 | 
						|
	})
 | 
						|
}
 | 
						|
 | 
						|
func TestBackend_leaseWriteRead(t *testing.T) {
 | 
						|
	config := logical.TestBackendConfig()
 | 
						|
	config.StorageView = &logical.InmemStorage{}
 | 
						|
	b, err := Factory(context.Background(), config)
 | 
						|
	if err != nil {
 | 
						|
		t.Fatal(err)
 | 
						|
	}
 | 
						|
 | 
						|
	cleanup, connURL := prepareTestContainer(t)
 | 
						|
	defer cleanup()
 | 
						|
 | 
						|
	connData := map[string]interface{}{
 | 
						|
		"connection_url": connURL,
 | 
						|
	}
 | 
						|
 | 
						|
	logicaltest.Test(t, logicaltest.TestCase{
 | 
						|
		Backend: b,
 | 
						|
		Steps: []logicaltest.TestStep{
 | 
						|
			testAccStepConfig(t, connData, false),
 | 
						|
			testAccStepWriteLease(t),
 | 
						|
			testAccStepReadLease(t),
 | 
						|
		},
 | 
						|
	})
 | 
						|
 | 
						|
}
 | 
						|
 | 
						|
func testAccStepConfig(t *testing.T, d map[string]interface{}, expectError bool) logicaltest.TestStep {
 | 
						|
	return logicaltest.TestStep{
 | 
						|
		Operation: logical.UpdateOperation,
 | 
						|
		Path:      "config/connection",
 | 
						|
		Data:      d,
 | 
						|
		ErrorOk:   true,
 | 
						|
		Check: func(resp *logical.Response) error {
 | 
						|
			if expectError {
 | 
						|
				if resp.Data == nil {
 | 
						|
					return fmt.Errorf("data is nil")
 | 
						|
				}
 | 
						|
				var e struct {
 | 
						|
					Error string `mapstructure:"error"`
 | 
						|
				}
 | 
						|
				if err := mapstructure.Decode(resp.Data, &e); err != nil {
 | 
						|
					return err
 | 
						|
				}
 | 
						|
				if len(e.Error) == 0 {
 | 
						|
					return fmt.Errorf("expected error, but write succeeded")
 | 
						|
				}
 | 
						|
				return nil
 | 
						|
			} else if resp != nil && resp.IsError() {
 | 
						|
				return fmt.Errorf("got an error response: %v", resp.Error())
 | 
						|
			}
 | 
						|
			return nil
 | 
						|
		},
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func testAccStepRole(t *testing.T, wildCard bool) logicaltest.TestStep {
 | 
						|
 | 
						|
	pathData := make(map[string]interface{})
 | 
						|
	if wildCard == true {
 | 
						|
		pathData = map[string]interface{}{
 | 
						|
			"sql": testRoleWildCard,
 | 
						|
		}
 | 
						|
	} else {
 | 
						|
		pathData = map[string]interface{}{
 | 
						|
			"sql":            testRoleHost,
 | 
						|
			"revocation_sql": testRevocationSQL,
 | 
						|
		}
 | 
						|
	}
 | 
						|
 | 
						|
	return logicaltest.TestStep{
 | 
						|
		Operation: logical.UpdateOperation,
 | 
						|
		Path:      "roles/web",
 | 
						|
		Data:      pathData,
 | 
						|
	}
 | 
						|
 | 
						|
}
 | 
						|
 | 
						|
func testAccStepDeleteRole(t *testing.T, n string) logicaltest.TestStep {
 | 
						|
	return logicaltest.TestStep{
 | 
						|
		Operation: logical.DeleteOperation,
 | 
						|
		Path:      "roles/" + n,
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func testAccStepReadCreds(t *testing.T, name string) logicaltest.TestStep {
 | 
						|
	return logicaltest.TestStep{
 | 
						|
		Operation: logical.ReadOperation,
 | 
						|
		Path:      "creds/" + name,
 | 
						|
		Check: func(resp *logical.Response) error {
 | 
						|
			var d struct {
 | 
						|
				Username string `mapstructure:"username"`
 | 
						|
				Password string `mapstructure:"password"`
 | 
						|
			}
 | 
						|
			if err := mapstructure.Decode(resp.Data, &d); err != nil {
 | 
						|
				return err
 | 
						|
			}
 | 
						|
			log.Printf("[WARN] Generated credentials: %v", d)
 | 
						|
 | 
						|
			return nil
 | 
						|
		},
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func testAccStepReadRole(t *testing.T, name string, sql string) logicaltest.TestStep {
 | 
						|
	return logicaltest.TestStep{
 | 
						|
		Operation: logical.ReadOperation,
 | 
						|
		Path:      "roles/" + name,
 | 
						|
		Check: func(resp *logical.Response) error {
 | 
						|
			if resp == nil {
 | 
						|
				if sql == "" {
 | 
						|
					return nil
 | 
						|
				}
 | 
						|
 | 
						|
				return fmt.Errorf("bad: %#v", resp)
 | 
						|
			}
 | 
						|
 | 
						|
			var d struct {
 | 
						|
				SQL string `mapstructure:"sql"`
 | 
						|
			}
 | 
						|
			if err := mapstructure.Decode(resp.Data, &d); err != nil {
 | 
						|
				return err
 | 
						|
			}
 | 
						|
 | 
						|
			if d.SQL != sql {
 | 
						|
				return fmt.Errorf("bad: %#v", resp)
 | 
						|
			}
 | 
						|
 | 
						|
			return nil
 | 
						|
		},
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func testAccStepWriteLease(t *testing.T) logicaltest.TestStep {
 | 
						|
	return logicaltest.TestStep{
 | 
						|
		Operation: logical.UpdateOperation,
 | 
						|
		Path:      "config/lease",
 | 
						|
		Data: map[string]interface{}{
 | 
						|
			"lease":     "1h5m",
 | 
						|
			"lease_max": "24h",
 | 
						|
		},
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
func testAccStepReadLease(t *testing.T) logicaltest.TestStep {
 | 
						|
	return logicaltest.TestStep{
 | 
						|
		Operation: logical.ReadOperation,
 | 
						|
		Path:      "config/lease",
 | 
						|
		Check: func(resp *logical.Response) error {
 | 
						|
			if resp.Data["lease"] != "1h5m0s" || resp.Data["lease_max"] != "24h0m0s" {
 | 
						|
				return fmt.Errorf("bad: %#v", resp)
 | 
						|
			}
 | 
						|
 | 
						|
			return nil
 | 
						|
		},
 | 
						|
	}
 | 
						|
}
 | 
						|
 | 
						|
const testRoleWildCard = `
 | 
						|
CREATE USER '{{name}}'@'%' IDENTIFIED BY '{{password}}';
 | 
						|
GRANT SELECT ON *.* TO '{{name}}'@'%';
 | 
						|
`
 | 
						|
const testRoleHost = `
 | 
						|
CREATE USER '{{name}}'@'10.1.1.2' IDENTIFIED BY '{{password}}';
 | 
						|
GRANT SELECT ON *.* TO '{{name}}'@'10.1.1.2';
 | 
						|
`
 | 
						|
const testRevocationSQL = `
 | 
						|
REVOKE ALL PRIVILEGES, GRANT OPTION FROM '{{name}}'@'10.1.1.2'; 
 | 
						|
DROP USER '{{name}}'@'10.1.1.2';
 | 
						|
`
 |