mysql

Documentation

Index

• Variables
• func New(displayNameLen, roleNameLen, usernameLen int) func() (interface{}, error)
• func Run(apiTLSConfig *api.TLSConfig) error
• func RunLegacy(apiTLSConfig *api.TLSConfig) error
• type MySQL
  • func (c MySQL) Close() error
  • func (c MySQL) Connection(ctx context.Context) (interface{}, error)
  • func (m *MySQL) CreateUser(ctx context.Context, statements dbplugin.Statements, ...) (username string, password string, err error)
  • func (c MySQL) Init(ctx context.Context, conf map[string]interface{}, verifyConnection bool) (map[string]interface{}, error)
  • func (c MySQL) Initialize(ctx context.Context, conf map[string]interface{}, verifyConnection bool) error
  • func (m *MySQL) RenewUser(ctx context.Context, statements dbplugin.Statements, username string, ...) error
  • func (m *MySQL) RevokeUser(ctx context.Context, statements dbplugin.Statements, username string) error
  • func (m *MySQL) RotateRootCredentials(ctx context.Context, statements []string) (map[string]interface{}, error)
  • func (c MySQL) SecretValues() map[string]interface{}
  • func (m *MySQL) SetCredentials(ctx context.Context, statements dbplugin.Statements, ...) (username, password string, err error)
  • func (m *MySQL) Type() (string, error)

Variables

var (
	MetadataLen       int = 10
	LegacyMetadataLen int = 4
	UsernameLen       int = 32
	LegacyUsernameLen int = 16
)

Functions

func New

func New(displayNameLen, roleNameLen, usernameLen int) func() (interface{}, error)

New implements builtinplugins.BuiltinFactory

func Run

func Run(apiTLSConfig *api.TLSConfig) error

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

func RunLegacy

func RunLegacy(apiTLSConfig *api.TLSConfig) error

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

Types

type MySQL

type MySQL struct {
	credsutil.CredentialsProducer
	// contains filtered or unexported fields
}

func (MySQL) Close

func (c MySQL) Close() error

Close attempts to close the connection

func (MySQL) Connection

func (c MySQL) Connection(ctx context.Context) (interface{}, error)

func (*MySQL) CreateUser

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

func (MySQL) Init

func (c MySQL) Init(ctx context.Context, conf map[string]interface{}, verifyConnection bool) (map[string]interface{}, error)

func (MySQL) Initialize

func (c MySQL) Initialize(ctx context.Context, conf map[string]interface{}, verifyConnection bool) error

func (*MySQL) RenewUser

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

NOOP

func (*MySQL) RevokeUser

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

func (*MySQL) RotateRootCredentials

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

func (MySQL) SecretValues

func (c MySQL) SecretValues() map[string]interface{}

func (*MySQL) SetCredentials

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

SetCredentials uses provided information to set the password to 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 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 (*MySQL) Type

func (m *MySQL) Type() (string, error)