mirror of
https://github.com/hashicorp/vault.git
synced 2026-05-28 04:10:44 -04:00
postgres: connection_url fix
This commit is contained in:
parent
2be9a34a83
commit
046d7f87b4
7 changed files with 128 additions and 32 deletions
|
|
@ -74,9 +74,9 @@ func (b *backend) DB(s logical.Storage) (*sql.DB, error) {
|
|||
return nil, err
|
||||
}
|
||||
|
||||
conn := connConfig.ConnectionString
|
||||
conn := connConfig.ConnectionURL
|
||||
if len(conn) == 0 {
|
||||
conn = connConfig.ConnectionURL
|
||||
conn = connConfig.ConnectionString
|
||||
}
|
||||
|
||||
b.db, err = sql.Open("mysql", conn)
|
||||
|
|
|
|||
|
|
@ -33,6 +33,7 @@ func TestBackend_basic(t *testing.T) {
|
|||
},
|
||||
})
|
||||
}
|
||||
|
||||
func TestBackend_configConnection(t *testing.T) {
|
||||
b := Backend()
|
||||
d1 := map[string]interface{}{
|
||||
|
|
@ -58,6 +59,7 @@ func TestBackend_configConnection(t *testing.T) {
|
|||
},
|
||||
})
|
||||
}
|
||||
|
||||
func TestBackend_roleCrud(t *testing.T) {
|
||||
b := Backend()
|
||||
|
||||
|
|
@ -108,7 +110,6 @@ func testAccStepConfig(t *testing.T, d map[string]interface{}, expectError bool)
|
|||
Data: d,
|
||||
ErrorOk: true,
|
||||
Check: func(resp *logical.Response) error {
|
||||
log.Printf("vishal: testAccStepConfig: resp: %#v\n", resp)
|
||||
if expectError {
|
||||
if resp.Data == nil {
|
||||
return fmt.Errorf("data is nil")
|
||||
|
|
|
|||
|
|
@ -8,7 +8,6 @@ import (
|
|||
|
||||
"github.com/hashicorp/vault/logical"
|
||||
"github.com/hashicorp/vault/logical/framework"
|
||||
"github.com/lib/pq"
|
||||
)
|
||||
|
||||
func Factory(conf *logical.BackendConfig) (logical.Backend, error) {
|
||||
|
|
@ -76,20 +75,21 @@ func (b *backend) DB(s logical.Storage) (*sql.DB, error) {
|
|||
return nil, err
|
||||
}
|
||||
|
||||
conn := connConfig.ConnectionString
|
||||
conn := connConfig.ConnectionURL
|
||||
if len(conn) == 0 {
|
||||
conn = connConfig.ConnectionURL
|
||||
conn = connConfig.ConnectionString
|
||||
}
|
||||
|
||||
// Ensure timezone is set to UTC for all the conenctions
|
||||
if strings.HasPrefix(conn, "postgres://") || strings.HasPrefix(conn, "postgresql://") {
|
||||
var err error
|
||||
conn, err = pq.ParseURL(conn)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
if strings.Contains(conn, "?") {
|
||||
conn += "&timezone=utc"
|
||||
} else {
|
||||
conn += "?timezone=utc"
|
||||
}
|
||||
} else {
|
||||
conn += " timezone=utc"
|
||||
}
|
||||
conn += " timezone=utc"
|
||||
|
||||
b.db, err = sql.Open("postgres", conn)
|
||||
if err != nil {
|
||||
|
|
|
|||
|
|
@ -16,11 +16,21 @@ import (
|
|||
func TestBackend_basic(t *testing.T) {
|
||||
b, _ := Factory(logical.TestBackendConfig())
|
||||
|
||||
d1 := map[string]interface{}{
|
||||
"connection_url": os.Getenv("PG_URL"),
|
||||
}
|
||||
d2 := map[string]interface{}{
|
||||
"value": os.Getenv("PG_URL"),
|
||||
}
|
||||
|
||||
logicaltest.Test(t, logicaltest.TestCase{
|
||||
PreCheck: func() { testAccPreCheck(t) },
|
||||
Backend: b,
|
||||
Steps: []logicaltest.TestStep{
|
||||
testAccStepConfig(t),
|
||||
testAccStepConfig(t, d1, false),
|
||||
testAccStepRole(t),
|
||||
testAccStepReadCreds(t, b, "web"),
|
||||
testAccStepConfig(t, d2, false),
|
||||
testAccStepRole(t),
|
||||
testAccStepReadCreds(t, b, "web"),
|
||||
},
|
||||
|
|
@ -30,12 +40,15 @@ func TestBackend_basic(t *testing.T) {
|
|||
|
||||
func TestBackend_roleCrud(t *testing.T) {
|
||||
b, _ := Factory(logical.TestBackendConfig())
|
||||
d := map[string]interface{}{
|
||||
"connection_url": os.Getenv("PG_URL"),
|
||||
}
|
||||
|
||||
logicaltest.Test(t, logicaltest.TestCase{
|
||||
PreCheck: func() { testAccPreCheck(t) },
|
||||
Backend: b,
|
||||
Steps: []logicaltest.TestStep{
|
||||
testAccStepConfig(t),
|
||||
testAccStepConfig(t, d, false),
|
||||
testAccStepRole(t),
|
||||
testAccStepReadRole(t, "web", testRole),
|
||||
testAccStepDeleteRole(t, "web"),
|
||||
|
|
@ -44,18 +57,63 @@ func TestBackend_roleCrud(t *testing.T) {
|
|||
})
|
||||
}
|
||||
|
||||
func TestBackend_configConnection(t *testing.T) {
|
||||
b := Backend()
|
||||
d1 := map[string]interface{}{
|
||||
"value": os.Getenv("PG_URL"),
|
||||
}
|
||||
d2 := map[string]interface{}{
|
||||
"connection_url": os.Getenv("PG_URL"),
|
||||
}
|
||||
d3 := map[string]interface{}{
|
||||
"value": os.Getenv("PG_URL"),
|
||||
"connection_url": os.Getenv("PG_URL"),
|
||||
}
|
||||
d4 := map[string]interface{}{}
|
||||
|
||||
logicaltest.Test(t, logicaltest.TestCase{
|
||||
PreCheck: func() { testAccPreCheck(t) },
|
||||
Backend: b,
|
||||
Steps: []logicaltest.TestStep{
|
||||
testAccStepConfig(t, d1, false),
|
||||
testAccStepConfig(t, d2, false),
|
||||
testAccStepConfig(t, d3, false),
|
||||
testAccStepConfig(t, d4, true),
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
func testAccPreCheck(t *testing.T) {
|
||||
if v := os.Getenv("PG_URL"); v == "" {
|
||||
t.Fatal("PG_URL must be set for acceptance tests")
|
||||
}
|
||||
}
|
||||
|
||||
func testAccStepConfig(t *testing.T) logicaltest.TestStep {
|
||||
func testAccStepConfig(t *testing.T, d map[string]interface{}, expectError bool) logicaltest.TestStep {
|
||||
return logicaltest.TestStep{
|
||||
Operation: logical.UpdateOperation,
|
||||
Path: "config/connection",
|
||||
Data: map[string]interface{}{
|
||||
"value": os.Getenv("PG_URL"),
|
||||
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 {
|
||||
return fmt.Errorf("response should be nil")
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -22,6 +22,11 @@ func pathConfigConnection(b *backend) *framework.Path {
|
|||
Description: `DB connection string. Use 'connection_url' instead.
|
||||
This will be deprecated.`,
|
||||
},
|
||||
"verify_connection": &framework.FieldSchema{
|
||||
Type: framework.TypeBool,
|
||||
Default: true,
|
||||
Description: `If set, connection_url is verified by actually connecting to the database`,
|
||||
},
|
||||
"max_open_connections": &framework.FieldSchema{
|
||||
Type: framework.TypeInt,
|
||||
Description: `Maximum number of open connections to the database;
|
||||
|
|
@ -51,8 +56,15 @@ reduced to the same size.`,
|
|||
|
||||
func (b *backend) pathConnectionWrite(
|
||||
req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
|
||||
connString := data.Get("value").(string)
|
||||
connValue := data.Get("value").(string)
|
||||
connURL := data.Get("connection_url").(string)
|
||||
if connURL == "" {
|
||||
if connValue == "" {
|
||||
return logical.ErrorResponse("connection_url parameter must be supplied"), nil
|
||||
} else {
|
||||
connURL = connValue
|
||||
}
|
||||
}
|
||||
|
||||
maxOpenConns := data.Get("max_open_connections").(int)
|
||||
if maxOpenConns == 0 {
|
||||
|
|
@ -67,21 +79,25 @@ func (b *backend) pathConnectionWrite(
|
|||
maxIdleConns = maxOpenConns
|
||||
}
|
||||
|
||||
// Verify the string
|
||||
db, err := sql.Open("postgres", connString)
|
||||
if err != nil {
|
||||
return logical.ErrorResponse(fmt.Sprintf(
|
||||
"Error validating connection info: %s", err)), nil
|
||||
}
|
||||
defer db.Close()
|
||||
if err := db.Ping(); err != nil {
|
||||
return logical.ErrorResponse(fmt.Sprintf(
|
||||
"Error validating connection info: %s", err)), nil
|
||||
// Don't check the connection_url if verification is disabled
|
||||
verifyConnection := data.Get("verify_connection").(bool)
|
||||
if verifyConnection {
|
||||
// Verify the string
|
||||
db, err := sql.Open("postgres", connURL)
|
||||
if err != nil {
|
||||
return logical.ErrorResponse(fmt.Sprintf(
|
||||
"Error validating connection info: %s", err)), nil
|
||||
}
|
||||
defer db.Close()
|
||||
if err := db.Ping(); err != nil {
|
||||
return logical.ErrorResponse(fmt.Sprintf(
|
||||
"Error validating connection info: %s", err)), nil
|
||||
}
|
||||
}
|
||||
|
||||
// Store it
|
||||
entry, err := logical.StorageEntryJSON("config/connection", connectionConfig{
|
||||
ConnectionString: connString,
|
||||
ConnectionString: connValue,
|
||||
ConnectionURL: connURL,
|
||||
MaxOpenConnections: maxOpenConns,
|
||||
MaxIdleConnections: maxIdleConns,
|
||||
|
|
|
|||
|
|
@ -137,7 +137,7 @@ allowed to read.
|
|||
<ul>
|
||||
<li>
|
||||
<span class="param">value</span>
|
||||
<span class="param-flags">optionsl</span>
|
||||
<span class="param-flags">optional</span>
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
|
|
@ -156,7 +156,7 @@ allowed to read.
|
|||
<li>
|
||||
<span class="param">verify-connection</span>
|
||||
<span class="param-flags">optional</span>
|
||||
If set, connection_url is verified by actually connecting to the database
|
||||
If set, connection_url is verified by actually connecting to the database.
|
||||
Defaults to true.
|
||||
</li>
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ writing either a PostgreSQL URL or PG connection string:
|
|||
|
||||
```text
|
||||
$ vault write postgresql/config/connection \
|
||||
value="postgresql://root:vaulttest@vaulttest.ciuvljjni7uo.us-west-1.rds.amazonaws.com:5432/postgres"
|
||||
connection_url="postgresql://root:vaulttest@vaulttest.ciuvljjni7uo.us-west-1.rds.amazonaws.com:5432/postgres"
|
||||
```
|
||||
|
||||
In this case, we've configured Vault with the user "root" and password "vaulttest",
|
||||
|
|
@ -129,12 +129,21 @@ subpath for interactive help output.
|
|||
<dd>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="param">value</span>
|
||||
<span class="param">connection_url</span>
|
||||
<span class="param-flags">required</span>
|
||||
The PostgreSQL connection URL or PG style string. e.g. "user=foo host=bar"
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dd>
|
||||
<ul>
|
||||
<li>
|
||||
<span class="param">value</span>
|
||||
<span class="param-flags">optional</span>
|
||||
The PostgreSQL connection URL or PG style string. e.g. "user=foo host=bar". Use `connection_url` instead.
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dd>
|
||||
<ul>
|
||||
<li>
|
||||
|
|
@ -143,6 +152,10 @@ subpath for interactive help output.
|
|||
Maximum number of open connections to the database. A zero uses the
|
||||
default value of 2 and a negative value means unlimited.
|
||||
</li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dd>
|
||||
<ul>
|
||||
<span class="param">max_idle_connections</span>
|
||||
<span class="param-flags">optional</span>
|
||||
Maximum number of idle connections to the database. A zero uses the
|
||||
|
|
@ -151,6 +164,14 @@ subpath for interactive help output.
|
|||
to be equal.
|
||||
</ul>
|
||||
</dd>
|
||||
<dd>
|
||||
<ul>
|
||||
<span class="param">verify_connection</span>
|
||||
<span class="param-flags">optional</span>
|
||||
If set, connection_url is verified by actually connecting to the database.
|
||||
Defaults to true.
|
||||
</ul>
|
||||
</dd>
|
||||
|
||||
<dt>Returns</dt>
|
||||
<dd>
|
||||
|
|
|
|||
Loading…
Reference in a new issue