b55303eddb
* Add priority queue to sdk * fix issue of storing pointers and now copy * update to use copy structure * Remove file, put Item struct def. into other file * add link * clean up docs * refactor internal data structure to hide heap method implementations. Other cleanup after feedback * rename PushItem and PopItem to just Push/Pop, after encapsulating the heap methods * updates after feedback * refactoring/renaming * guard against pushing a nil item * minor updates after feedback * Add SetCredentials, GenerateCredentials gRPC methods to combined database backend gPRC * Initial Combined database backend implementation of static accounts and automatic rotation * vendor updates * initial implementation of static accounts with Combined database backend, starting with PostgreSQL implementation * add lock and setup of rotation queue * vendor the queue * rebase on new method signature of queue * remove mongo tests for now * update default role sql * gofmt after rebase * cleanup after rebasing to remove checks for ErrNotFound error * rebase cdcr-priority-queue * vendor dependencies with 'go mod vendor' * website database docs for Static Role support * document the rotate-role API endpoint * postgres specific static role docs * use constants for paths * updates from review * remove dead code * combine and clarify error message for older plugins * Update builtin/logical/database/backend.go Co-Authored-By: Jim Kalafut <jim@kalafut.net> * cleanups from feedback * code and comment cleanups * move db.RLock higher to protect db.GenerateCredentials call * Return output with WALID if we failed to delete the WAL * Update builtin/logical/database/path_creds_create.go Co-Authored-By: Jim Kalafut <jim@kalafut.net> * updates after running 'make fmt' * update after running 'make proto' * Update builtin/logical/database/path_roles.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * Update builtin/logical/database/path_roles.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * update comment and remove and rearrange some dead code * Update website/source/api/secret/databases/index.html.md Co-Authored-By: Jim Kalafut <jim@kalafut.net> * cleanups after review * Update sdk/database/dbplugin/grpc_transport.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * code cleanup after feedback * remove PasswordLastSet; it's not used * document GenerateCredentials and SetCredentials * Update builtin/logical/database/path_rotate_credentials.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * wrap pop and popbykey in backend methods to protect against nil cred rotation queue * use strings.HasPrefix instead of direct equality check for path * Forgot to commit this * updates after feedback * re-purpose an outdated test to now check that static and dynamic roles cannot share a name * check for unique name across dynamic and static roles * refactor loadStaticWALs to return a map of name/setCredentialsWAL struct to consolidate where we're calling set credentials * remove commented out code * refactor to have loadstaticwals filter out wals for roles that no longer exist * return error if nil input given * add nil check for input into setStaticAccount * Update builtin/logical/database/path_roles.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * add constant for queue tick time in seconds, used for comparrison in updates * Update builtin/logical/database/path_roles.go Co-Authored-By: Jim Kalafut <jim@kalafut.net> * code cleanup after review * remove misplaced code comment * remove commented out code * create a queue in the Factory method, even if it's never used * update path_roles to use a common set of fields, with specific overrides for dynamic/static roles by type * document new method * move rotation things into a specific file * rename test file and consolidate some static account tests * Update builtin/logical/database/path_roles.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * Update builtin/logical/database/rotation.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * Update builtin/logical/database/rotation.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * Update builtin/logical/database/rotation.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * Update builtin/logical/database/rotation.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * Update builtin/logical/database/rotation.go Co-Authored-By: Brian Kassouf <briankassouf@users.noreply.github.com> * update code comments, method names, and move more methods into rotation.go * update comments to be capitalized * remove the item from the queue before we try to destroy it * findStaticWAL returns an error * use lowercase keys when encoding WAL entries * small cleanups * remove vestigial static account check * remove redundant DeleteWAL call in populate queue * if we error on loading role, push back to queue with 10 second backoff * poll in initqueue to make sure the backend is setup and can write/delete data * add revoke_user_on_delete flag to allow users to opt-in to revoking the static database user on delete of the Vault role. Default false * add code comments on read-only loop * code comment updates * re-push if error returned from find static wal * add locksutil and acquire locks when pop'ing from the queue * grab exclusive locks for updating static roles * Add SetCredentials and GenerateCredentials stubs to mockPlugin * add a switch in initQueue to listen for cancelation * remove guard on zero time, it should have no affect * create a new context in Factory to pass on and use for closing the backend queue * restore master copy of vendor dir
359 lines
8.3 KiB
Go
359 lines
8.3 KiB
Go
package dbplugin
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"errors"
|
|
"time"
|
|
|
|
"google.golang.org/grpc"
|
|
"google.golang.org/grpc/codes"
|
|
"google.golang.org/grpc/status"
|
|
|
|
"github.com/golang/protobuf/ptypes"
|
|
"github.com/hashicorp/vault/sdk/helper/pluginutil"
|
|
)
|
|
|
|
var (
|
|
ErrPluginShutdown = errors.New("plugin shutdown")
|
|
ErrPluginStaticUnsupported = errors.New("database plugin does not support Static Accounts")
|
|
)
|
|
|
|
// ---- gRPC Server domain ----
|
|
|
|
type gRPCServer struct {
|
|
impl Database
|
|
}
|
|
|
|
func (s *gRPCServer) Type(context.Context, *Empty) (*TypeResponse, error) {
|
|
t, err := s.impl.Type()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &TypeResponse{
|
|
Type: t,
|
|
}, nil
|
|
}
|
|
|
|
func (s *gRPCServer) CreateUser(ctx context.Context, req *CreateUserRequest) (*CreateUserResponse, error) {
|
|
e, err := ptypes.Timestamp(req.Expiration)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
u, p, err := s.impl.CreateUser(ctx, *req.Statements, *req.UsernameConfig, e)
|
|
|
|
return &CreateUserResponse{
|
|
Username: u,
|
|
Password: p,
|
|
}, err
|
|
}
|
|
|
|
func (s *gRPCServer) RenewUser(ctx context.Context, req *RenewUserRequest) (*Empty, error) {
|
|
e, err := ptypes.Timestamp(req.Expiration)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
err = s.impl.RenewUser(ctx, *req.Statements, req.Username, e)
|
|
return &Empty{}, err
|
|
}
|
|
|
|
func (s *gRPCServer) RevokeUser(ctx context.Context, req *RevokeUserRequest) (*Empty, error) {
|
|
err := s.impl.RevokeUser(ctx, *req.Statements, req.Username)
|
|
return &Empty{}, err
|
|
}
|
|
|
|
func (s *gRPCServer) RotateRootCredentials(ctx context.Context, req *RotateRootCredentialsRequest) (*RotateRootCredentialsResponse, error) {
|
|
|
|
resp, err := s.impl.RotateRootCredentials(ctx, req.Statements)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
respConfig, err := json.Marshal(resp)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &RotateRootCredentialsResponse{
|
|
Config: respConfig,
|
|
}, err
|
|
}
|
|
|
|
func (s *gRPCServer) Initialize(ctx context.Context, req *InitializeRequest) (*Empty, error) {
|
|
_, err := s.Init(ctx, &InitRequest{
|
|
Config: req.Config,
|
|
VerifyConnection: req.VerifyConnection,
|
|
})
|
|
return &Empty{}, err
|
|
}
|
|
|
|
func (s *gRPCServer) Init(ctx context.Context, req *InitRequest) (*InitResponse, error) {
|
|
config := map[string]interface{}{}
|
|
err := json.Unmarshal(req.Config, &config)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
resp, err := s.impl.Init(ctx, config, req.VerifyConnection)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
respConfig, err := json.Marshal(resp)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &InitResponse{
|
|
Config: respConfig,
|
|
}, err
|
|
}
|
|
|
|
func (s *gRPCServer) Close(_ context.Context, _ *Empty) (*Empty, error) {
|
|
s.impl.Close()
|
|
return &Empty{}, nil
|
|
}
|
|
|
|
func (s *gRPCServer) GenerateCredentials(ctx context.Context, _ *Empty) (*GenerateCredentialsResponse, error) {
|
|
p, err := s.impl.GenerateCredentials(ctx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &GenerateCredentialsResponse{
|
|
Password: p,
|
|
}, nil
|
|
}
|
|
|
|
func (s *gRPCServer) SetCredentials(ctx context.Context, req *SetCredentialsRequest) (*SetCredentialsResponse, error) {
|
|
|
|
username, password, err := s.impl.SetCredentials(ctx, *req.Statements, *req.StaticUserConfig)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &SetCredentialsResponse{
|
|
Username: username,
|
|
Password: password,
|
|
}, err
|
|
}
|
|
|
|
// ---- gRPC client domain ----
|
|
|
|
type gRPCClient struct {
|
|
client DatabaseClient
|
|
clientConn *grpc.ClientConn
|
|
|
|
doneCtx context.Context
|
|
}
|
|
|
|
func (c *gRPCClient) Type() (string, error) {
|
|
resp, err := c.client.Type(c.doneCtx, &Empty{})
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
|
|
return resp.Type, err
|
|
}
|
|
|
|
func (c *gRPCClient) CreateUser(ctx context.Context, statements Statements, usernameConfig UsernameConfig, expiration time.Time) (username string, password string, err error) {
|
|
t, err := ptypes.TimestampProto(expiration)
|
|
if err != nil {
|
|
return "", "", err
|
|
}
|
|
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
quitCh := pluginutil.CtxCancelIfCanceled(cancel, c.doneCtx)
|
|
defer close(quitCh)
|
|
defer cancel()
|
|
|
|
resp, err := c.client.CreateUser(ctx, &CreateUserRequest{
|
|
Statements: &statements,
|
|
UsernameConfig: &usernameConfig,
|
|
Expiration: t,
|
|
})
|
|
if err != nil {
|
|
if c.doneCtx.Err() != nil {
|
|
return "", "", ErrPluginShutdown
|
|
}
|
|
|
|
return "", "", err
|
|
}
|
|
|
|
return resp.Username, resp.Password, err
|
|
}
|
|
|
|
func (c *gRPCClient) RenewUser(ctx context.Context, statements Statements, username string, expiration time.Time) error {
|
|
t, err := ptypes.TimestampProto(expiration)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
quitCh := pluginutil.CtxCancelIfCanceled(cancel, c.doneCtx)
|
|
defer close(quitCh)
|
|
defer cancel()
|
|
|
|
_, err = c.client.RenewUser(ctx, &RenewUserRequest{
|
|
Statements: &statements,
|
|
Username: username,
|
|
Expiration: t,
|
|
})
|
|
if err != nil {
|
|
if c.doneCtx.Err() != nil {
|
|
return ErrPluginShutdown
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (c *gRPCClient) RevokeUser(ctx context.Context, statements Statements, username string) error {
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
quitCh := pluginutil.CtxCancelIfCanceled(cancel, c.doneCtx)
|
|
defer close(quitCh)
|
|
defer cancel()
|
|
|
|
_, err := c.client.RevokeUser(ctx, &RevokeUserRequest{
|
|
Statements: &statements,
|
|
Username: username,
|
|
})
|
|
|
|
if err != nil {
|
|
if c.doneCtx.Err() != nil {
|
|
return ErrPluginShutdown
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (c *gRPCClient) RotateRootCredentials(ctx context.Context, statements []string) (conf map[string]interface{}, err error) {
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
quitCh := pluginutil.CtxCancelIfCanceled(cancel, c.doneCtx)
|
|
defer close(quitCh)
|
|
defer cancel()
|
|
|
|
resp, err := c.client.RotateRootCredentials(ctx, &RotateRootCredentialsRequest{
|
|
Statements: statements,
|
|
})
|
|
|
|
if err != nil {
|
|
if c.doneCtx.Err() != nil {
|
|
return nil, ErrPluginShutdown
|
|
}
|
|
|
|
return nil, err
|
|
}
|
|
|
|
if err := json.Unmarshal(resp.Config, &conf); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return conf, nil
|
|
}
|
|
|
|
func (c *gRPCClient) Initialize(ctx context.Context, conf map[string]interface{}, verifyConnection bool) error {
|
|
_, err := c.Init(ctx, conf, verifyConnection)
|
|
return err
|
|
}
|
|
|
|
func (c *gRPCClient) Init(ctx context.Context, conf map[string]interface{}, verifyConnection bool) (map[string]interface{}, error) {
|
|
configRaw, err := json.Marshal(conf)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
quitCh := pluginutil.CtxCancelIfCanceled(cancel, c.doneCtx)
|
|
defer close(quitCh)
|
|
defer cancel()
|
|
|
|
resp, err := c.client.Init(ctx, &InitRequest{
|
|
Config: configRaw,
|
|
VerifyConnection: verifyConnection,
|
|
})
|
|
if err != nil {
|
|
// Fall back to old call if not implemented
|
|
grpcStatus, ok := status.FromError(err)
|
|
if ok && grpcStatus.Code() == codes.Unimplemented {
|
|
_, err = c.client.Initialize(ctx, &InitializeRequest{
|
|
Config: configRaw,
|
|
VerifyConnection: verifyConnection,
|
|
})
|
|
if err == nil {
|
|
return conf, nil
|
|
}
|
|
}
|
|
|
|
if c.doneCtx.Err() != nil {
|
|
return nil, ErrPluginShutdown
|
|
}
|
|
return nil, err
|
|
}
|
|
|
|
if err := json.Unmarshal(resp.Config, &conf); err != nil {
|
|
return nil, err
|
|
}
|
|
return conf, nil
|
|
}
|
|
|
|
func (c *gRPCClient) Close() error {
|
|
_, err := c.client.Close(c.doneCtx, &Empty{})
|
|
return err
|
|
}
|
|
|
|
func (c *gRPCClient) GenerateCredentials(ctx context.Context) (string, error) {
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
quitCh := pluginutil.CtxCancelIfCanceled(cancel, c.doneCtx)
|
|
defer close(quitCh)
|
|
defer cancel()
|
|
|
|
resp, err := c.client.GenerateCredentials(ctx, &Empty{})
|
|
if err != nil {
|
|
grpcStatus, ok := status.FromError(err)
|
|
if ok && grpcStatus.Code() == codes.Unimplemented {
|
|
return "", ErrPluginStaticUnsupported
|
|
}
|
|
|
|
if c.doneCtx.Err() != nil {
|
|
return "", ErrPluginShutdown
|
|
}
|
|
return "", err
|
|
}
|
|
|
|
return resp.Password, nil
|
|
}
|
|
func (c *gRPCClient) SetCredentials(ctx context.Context, statements Statements, staticUser StaticUserConfig) (username, password string, err error) {
|
|
ctx, cancel := context.WithCancel(ctx)
|
|
quitCh := pluginutil.CtxCancelIfCanceled(cancel, c.doneCtx)
|
|
defer close(quitCh)
|
|
defer cancel()
|
|
|
|
resp, err := c.client.SetCredentials(ctx, &SetCredentialsRequest{
|
|
StaticUserConfig: &staticUser,
|
|
Statements: &statements,
|
|
})
|
|
|
|
if err != nil {
|
|
// Fall back to old call if not implemented
|
|
grpcStatus, ok := status.FromError(err)
|
|
if ok && grpcStatus.Code() == codes.Unimplemented {
|
|
return "", "", ErrPluginStaticUnsupported
|
|
}
|
|
|
|
if c.doneCtx.Err() != nil {
|
|
return "", "", ErrPluginShutdown
|
|
}
|
|
return "", "", err
|
|
}
|
|
|
|
return resp.Username, resp.Password, err
|
|
}
|