postgresql

Documentation

Index

• func New() (interface{}, error)
• func Run(apiTLSConfig *api.TLSConfig) error
• type PostgreSQL
  • func (p *PostgreSQL) CreateUser(ctx context.Context, statements dbplugin.Statements, ...) (username string, password string, err error)
  • func (p *PostgreSQL) GenerateCredentials(ctx context.Context) (string, error)
  • func (p *PostgreSQL) RenewUser(ctx context.Context, statements dbplugin.Statements, username string, ...) error
  • func (p *PostgreSQL) RevokeUser(ctx context.Context, statements dbplugin.Statements, username string) error
  • func (p *PostgreSQL) RotateRootCredentials(ctx context.Context, statements []string) (map[string]interface{}, error)
  • func (p *PostgreSQL) SetCredentials(ctx context.Context, statements dbplugin.Statements, ...) (username, password string, err error)
  • func (p *PostgreSQL) Type() (string, error)

Functions

func New

func New() (interface{}, error)

New implements builtinplugins.BuiltinFactory

func Run

func Run(apiTLSConfig *api.TLSConfig) error

Run instantiates a PostgreSQL object, and runs the RPC server for the plugin

Types

type PostgreSQL

type PostgreSQL struct {
	*connutil.SQLConnectionProducer
	credsutil.CredentialsProducer
}

func (*PostgreSQL) CreateUser

func (p *PostgreSQL) CreateUser(ctx context.Context, statements dbplugin.Statements, usernameConfig dbplugin.UsernameConfig, expiration time.Time) (username string, password string, err error)

func (*PostgreSQL) GenerateCredentials

func (p *PostgreSQL) GenerateCredentials(ctx context.Context) (string, error)

GenerateCredentials returns a generated password

func (*PostgreSQL) RenewUser

func (p *PostgreSQL) RenewUser(ctx context.Context, statements dbplugin.Statements, username string, expiration time.Time) error

func (*PostgreSQL) RevokeUser

func (p *PostgreSQL) RevokeUser(ctx context.Context, statements dbplugin.Statements, username string) error

func (*PostgreSQL) RotateRootCredentials

func (p *PostgreSQL) RotateRootCredentials(ctx context.Context, statements []string) (map[string]interface{}, error)

func (*PostgreSQL) SetCredentials

func (p *PostgreSQL) SetCredentials(ctx context.Context, statements dbplugin.Statements, staticUser dbplugin.StaticUserConfig) (username, password string, err error)

SetCredentials uses provided information to set/create a user in the database. Unlike CreateUser, this method requires a username be provided and uses the name given, instead of generating a name. This is used for creating and setting the password of static accounts, as well as rolling back passwords in the database in the event an updated database fails to save in Vault's storage.

func (*PostgreSQL) Type

func (p *PostgreSQL) Type() (string, error)