open-vault/builtin/logical/rabbitmq/backend.go

137 lines
2.8 KiB
Go
Raw Normal View History

2015-11-18 16:25:42 +00:00
package rabbitmq
import (
"context"
2015-11-18 16:25:42 +00:00
"strings"
"sync"
cleanhttp "github.com/hashicorp/go-cleanhttp"
"github.com/hashicorp/vault/sdk/framework"
"github.com/hashicorp/vault/sdk/logical"
rabbithole "github.com/michaelklishin/rabbit-hole"
2015-11-18 16:25:42 +00:00
)
2016-06-08 07:18:26 +00:00
// Factory creates and configures the backend
func Factory(ctx context.Context, conf *logical.BackendConfig) (logical.Backend, error) {
Backend plugin system (#2874) * Add backend plugin changes * Fix totp backend plugin tests * Fix logical/plugin InvalidateKey test * Fix plugin catalog CRUD test, fix NoopBackend * Clean up commented code block * Fix system backend mount test * Set plugin_name to omitempty, fix handleMountTable config parsing * Clean up comments, keep shim connections alive until cleanup * Include pluginClient, disallow LookupPlugin call from within a plugin * Add wrapper around backendPluginClient for proper cleanup * Add logger shim tests * Add logger, storage, and system shim tests * Use pointer receivers for system view shim * Use plugin name if no path is provided on mount * Enable plugins for auth backends * Add backend type attribute, move builtin/plugin/package * Fix merge conflict * Fix missing plugin name in mount config * Add integration tests on enabling auth backend plugins * Remove dependency cycle on mock-plugin * Add passthrough backend plugin, use logical.BackendType to determine lease generation * Remove vault package dependency on passthrough package * Add basic impl test for passthrough plugin * Incorporate feedback; set b.backend after shims creation on backendPluginServer * Fix totp plugin test * Add plugin backends docs * Fix tests * Fix builtin/plugin tests * Remove flatten from PluginRunner fields * Move mock plugin to logical/plugin, remove totp and passthrough plugins * Move pluginMap into newPluginClient * Do not create storage RPC connection on HandleRequest and HandleExistenceCheck * Change shim logger's Fatal to no-op * Change BackendType to uint32, match UX backend types * Change framework.Backend Setup signature * Add Setup func to logical.Backend interface * Move OptionallyEnableMlock call into plugin.Serve, update docs and comments * Remove commented var in plugin package * RegisterLicense on logical.Backend interface (#3017) * Add RegisterLicense to logical.Backend interface * Update RegisterLicense to use callback func on framework.Backend * Refactor framework.Backend.RegisterLicense * plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs * plugin: Revert BackendType to remove TypePassthrough and related references * Fix typo in plugin backends docs
2017-07-20 17:28:40 +00:00
b := Backend()
if err := b.Setup(ctx, conf); err != nil {
Backend plugin system (#2874) * Add backend plugin changes * Fix totp backend plugin tests * Fix logical/plugin InvalidateKey test * Fix plugin catalog CRUD test, fix NoopBackend * Clean up commented code block * Fix system backend mount test * Set plugin_name to omitempty, fix handleMountTable config parsing * Clean up comments, keep shim connections alive until cleanup * Include pluginClient, disallow LookupPlugin call from within a plugin * Add wrapper around backendPluginClient for proper cleanup * Add logger shim tests * Add logger, storage, and system shim tests * Use pointer receivers for system view shim * Use plugin name if no path is provided on mount * Enable plugins for auth backends * Add backend type attribute, move builtin/plugin/package * Fix merge conflict * Fix missing plugin name in mount config * Add integration tests on enabling auth backend plugins * Remove dependency cycle on mock-plugin * Add passthrough backend plugin, use logical.BackendType to determine lease generation * Remove vault package dependency on passthrough package * Add basic impl test for passthrough plugin * Incorporate feedback; set b.backend after shims creation on backendPluginServer * Fix totp plugin test * Add plugin backends docs * Fix tests * Fix builtin/plugin tests * Remove flatten from PluginRunner fields * Move mock plugin to logical/plugin, remove totp and passthrough plugins * Move pluginMap into newPluginClient * Do not create storage RPC connection on HandleRequest and HandleExistenceCheck * Change shim logger's Fatal to no-op * Change BackendType to uint32, match UX backend types * Change framework.Backend Setup signature * Add Setup func to logical.Backend interface * Move OptionallyEnableMlock call into plugin.Serve, update docs and comments * Remove commented var in plugin package * RegisterLicense on logical.Backend interface (#3017) * Add RegisterLicense to logical.Backend interface * Update RegisterLicense to use callback func on framework.Backend * Refactor framework.Backend.RegisterLicense * plugin: Prevent plugin.SystemViewClient.ResponseWrapData from getting JWTs * plugin: Revert BackendType to remove TypePassthrough and related references * Fix typo in plugin backends docs
2017-07-20 17:28:40 +00:00
return nil, err
}
return b, nil
2015-11-18 16:25:42 +00:00
}
2016-06-08 07:18:26 +00:00
// Creates a new backend with all the paths and secrets belonging to it
func Backend() *backend {
2015-11-18 16:25:42 +00:00
var b backend
b.Backend = &framework.Backend{
Help: strings.TrimSpace(backendHelp),
PathsSpecial: &logical.Paths{
SealWrapStorage: []string{
"config/connection",
},
},
2015-11-18 16:25:42 +00:00
Paths: []*framework.Path{
pathConfigConnection(&b),
pathConfigLease(&b),
2016-04-08 16:46:25 +00:00
pathListRoles(&b),
2016-06-08 07:18:26 +00:00
pathCreds(&b),
2016-05-21 05:51:09 +00:00
pathRoles(&b),
2015-11-18 16:25:42 +00:00
},
Secrets: []*framework.Secret{
secretCreds(&b),
},
Clean: b.resetClient,
Invalidate: b.invalidate,
BackendType: logical.TypeLogical,
2015-11-18 16:25:42 +00:00
}
2016-06-08 07:18:26 +00:00
return &b
2015-11-18 16:25:42 +00:00
}
type backend struct {
*framework.Backend
client *rabbithole.Client
2016-06-08 07:18:26 +00:00
lock sync.RWMutex
2015-11-18 16:25:42 +00:00
}
// DB returns the database connection.
func (b *backend) Client(ctx context.Context, s logical.Storage) (*rabbithole.Client, error) {
2016-06-08 07:18:26 +00:00
b.lock.RLock()
2015-11-18 16:25:42 +00:00
2016-06-08 07:18:26 +00:00
// If we already have a client, return it
2015-11-18 16:25:42 +00:00
if b.client != nil {
2016-06-08 07:18:26 +00:00
b.lock.RUnlock()
2015-11-18 16:25:42 +00:00
return b.client, nil
}
2016-06-08 07:18:26 +00:00
b.lock.RUnlock()
2015-11-18 16:25:42 +00:00
// Otherwise, attempt to make connection
connConfig, err := readConfig(ctx, s)
2015-11-18 16:25:42 +00:00
if err != nil {
return nil, err
}
2016-06-08 07:18:26 +00:00
b.lock.Lock()
defer b.lock.Unlock()
2018-03-20 18:54:10 +00:00
// If the client was created during the lock switch, return it
2016-06-08 07:18:26 +00:00
if b.client != nil {
return b.client, nil
}
2015-11-18 16:25:42 +00:00
b.client, err = rabbithole.NewClient(connConfig.URI, connConfig.Username, connConfig.Password)
if err != nil {
return nil, err
}
// Use a default pooled transport so there would be no leaked file descriptors
b.client.SetTransport(cleanhttp.DefaultPooledTransport())
2015-11-18 16:25:42 +00:00
return b.client, nil
}
2016-06-08 07:18:26 +00:00
// resetClient forces a connection next time Client() is called.
func (b *backend) resetClient(_ context.Context) {
2015-11-18 16:25:42 +00:00
b.lock.Lock()
defer b.lock.Unlock()
b.client = nil
}
func (b *backend) invalidate(ctx context.Context, key string) {
switch key {
case "config/connection":
b.resetClient(ctx)
}
}
2015-11-18 16:25:42 +00:00
// Lease returns the lease information
func (b *backend) Lease(ctx context.Context, s logical.Storage) (*configLease, error) {
entry, err := s.Get(ctx, "config/lease")
2015-11-18 16:25:42 +00:00
if err != nil {
return nil, err
}
if entry == nil {
return nil, nil
}
var result configLease
if err := entry.DecodeJSON(&result); err != nil {
return nil, err
}
return &result, nil
}
const backendHelp = `
The RabbitMQ backend dynamically generates RabbitMQ users.
After mounting this backend, configure it using the endpoints within
the "config/" path.
`