2015-11-18 16:25:42 +00:00
|
|
|
package rabbitmq
|
|
|
|
|
|
|
|
import (
|
|
|
|
"fmt"
|
|
|
|
"strings"
|
|
|
|
"sync"
|
|
|
|
|
2016-06-08 14:46:46 +00:00
|
|
|
"github.com/hashicorp/go-cleanhttp"
|
2015-11-18 16:25:42 +00:00
|
|
|
"github.com/hashicorp/vault/logical"
|
|
|
|
"github.com/hashicorp/vault/logical/framework"
|
|
|
|
"github.com/michaelklishin/rabbit-hole"
|
|
|
|
)
|
|
|
|
|
2016-06-08 07:18:26 +00:00
|
|
|
// Factory creates and configures the backend
|
2015-11-18 16:25:42 +00:00
|
|
|
func Factory(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(conf); err != nil {
|
|
|
|
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),
|
|
|
|
|
2017-11-03 15:43:31 +00:00
|
|
|
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),
|
|
|
|
},
|
|
|
|
|
2017-07-28 18:04:46 +00:00
|
|
|
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(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
|
|
|
|
entry, err := s.Get("config/connection")
|
|
|
|
if err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
if entry == nil {
|
2016-06-08 07:18:26 +00:00
|
|
|
return nil, fmt.Errorf("configure the client connection with config/connection first")
|
2015-11-18 16:25:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
var connConfig connectionConfig
|
|
|
|
if err := entry.DecodeJSON(&connConfig); err != nil {
|
|
|
|
return nil, err
|
|
|
|
}
|
|
|
|
|
2016-06-08 07:18:26 +00:00
|
|
|
b.lock.Lock()
|
|
|
|
defer b.lock.Unlock()
|
|
|
|
|
|
|
|
// If the client was creted during the lock switch, return it
|
|
|
|
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
|
|
|
|
}
|
2016-06-08 14:46:46 +00:00
|
|
|
// 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() {
|
2015-11-18 16:25:42 +00:00
|
|
|
b.lock.Lock()
|
|
|
|
defer b.lock.Unlock()
|
|
|
|
|
|
|
|
b.client = nil
|
|
|
|
}
|
|
|
|
|
2017-02-16 21:29:30 +00:00
|
|
|
func (b *backend) invalidate(key string) {
|
|
|
|
switch key {
|
|
|
|
case "config/connection":
|
|
|
|
b.resetClient()
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-11-18 16:25:42 +00:00
|
|
|
// Lease returns the lease information
|
|
|
|
func (b *backend) Lease(s logical.Storage) (*configLease, error) {
|
2016-06-08 07:18:26 +00:00
|
|
|
entry, err := s.Get("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.
|
|
|
|
`
|