open-vault/sdk/database/helper/connutil/sql_test.go
Robert 15bd5fd6b6
secrets/database: Add parameter to disable escaping username and password chars for DB connections (#13414)
* Add a parameter that disables escaping characters in the username or password fields for secrets engines database connections

* Always disallow template variables inside the username or password
2022-01-10 12:05:17 -06:00

139 lines
4.2 KiB
Go

package connutil
import (
"context"
"net/url"
"strings"
"testing"
"github.com/stretchr/testify/assert"
)
func TestSQLPasswordChars(t *testing.T) {
testCases := []struct {
Username string
Password string
}{
{"postgres", "password{0}"},
{"postgres", "pass:word"},
{"postgres", "pass/word"},
{"postgres", "p@ssword"},
{"postgres", "pass\"word\""},
}
for _, tc := range testCases {
t.Logf("username %q password %q", tc.Username, tc.Password)
sql := &SQLConnectionProducer{}
ctx := context.Background()
conf := map[string]interface{}{
"connection_url": "postgres://{{username}}:{{password}}@localhost:5432/mydb",
"username": tc.Username,
"password": tc.Password,
"disable_escaping": false,
}
_, err := sql.Init(ctx, conf, false)
if err != nil {
t.Errorf("Init error on %q %q: %+v", tc.Username, tc.Password, err)
} else {
// This jumps down a few layers...
// Connection() uses sql.Open uses lib/pq uses net/url.Parse
u, err := url.Parse(sql.ConnectionURL)
if err != nil {
t.Errorf("URL parse error on %q %q: %+v", tc.Username, tc.Password, err)
} else {
username := u.User.Username()
password, pPresent := u.User.Password()
if username != tc.Username {
t.Errorf("Parsed username %q != original username %q", username, tc.Username)
}
if !pPresent {
t.Errorf("Password %q not present", tc.Password)
} else if password != tc.Password {
t.Errorf("Parsed password %q != original password %q", password, tc.Password)
}
}
}
}
}
func TestSQLDisableEscaping(t *testing.T) {
testCases := []struct {
Username string
Password string
DisableEscaping bool
}{
{"mssql{0}", "password{0}", true},
{"mssql{0}", "password{0}", false},
{"ms\"sql\"", "pass\"word\"", true},
{"ms\"sql\"", "pass\"word\"", false},
{"ms'sq;l", "pass'wor;d", true},
{"ms'sq;l", "pass'wor;d", false},
}
for _, tc := range testCases {
t.Logf("username %q password %q disable_escaling %t", tc.Username, tc.Password, tc.DisableEscaping)
sql := &SQLConnectionProducer{}
ctx := context.Background()
conf := map[string]interface{}{
"connection_url": "server=localhost;port=1433;user id={{username}};password={{password}};database=mydb;",
"username": tc.Username,
"password": tc.Password,
"disable_escaping": tc.DisableEscaping,
}
_, err := sql.Init(ctx, conf, false)
if err != nil {
t.Errorf("Init error on %q %q: %+v", tc.Username, tc.Password, err)
} else {
if tc.DisableEscaping {
if !strings.Contains(sql.ConnectionURL, tc.Username) || !strings.Contains(sql.ConnectionURL, tc.Password) {
t.Errorf("Raw username and/or password missing from ConnectionURL")
}
} else {
if strings.Contains(sql.ConnectionURL, tc.Username) || strings.Contains(sql.ConnectionURL, tc.Password) {
t.Errorf("Raw username and/or password was present in ConnectionURL")
}
}
}
}
}
func TestSQLDisallowTemplates(t *testing.T) {
testCases := []struct {
Username string
Password string
}{
{"{{username}}", "pass"},
{"{{password}}", "pass"},
{"user", "{{username}}"},
{"user", "{{password}}"},
{"{{username}}", "{{password}}"},
{"abc{username}xyz", "123{password}789"},
{"abc{{username}}xyz", "123{{password}}789"},
{"abc{{{username}}}xyz", "123{{{password}}}789"},
}
for _, disableEscaping := range []bool{true, false} {
for _, tc := range testCases {
t.Logf("username %q password %q disable_escaping %t", tc.Username, tc.Password, disableEscaping)
sql := &SQLConnectionProducer{}
ctx := context.Background()
conf := map[string]interface{}{
"connection_url": "server=localhost;port=1433;user id={{username}};password={{password}};database=mydb;",
"username": tc.Username,
"password": tc.Password,
"disable_escaping": disableEscaping,
}
_, err := sql.Init(ctx, conf, false)
if disableEscaping {
if err != nil {
if !assert.EqualError(t, err, "username and/or password cannot contain the template variables") {
t.Errorf("Init error on %q %q: %+v", tc.Username, tc.Password, err)
}
} else {
assert.Equal(t, sql.ConnectionURL, "server=localhost;port=1433;user id=abc{username}xyz;password=123{password}789;database=mydb;")
}
}
}
}
}