mssql

README

Testing

To run these tests, first start MSSQL in Docker. Please do make sure to view the EULA before accepting it as it includes limits on the number of users per company who can be using the image, and how it can be used in testing.

sudo docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=<YourStrong!Passw0rd>' \
   -p 1433:1433 --name sql1 \
   -d mcr.microsoft.com/mssql/server:2017-latest

Then use the following env variables for testing:

export VAULT_ACC=1
export MSSQL_URL="sqlserver://SA:%3CYourStrong%21Passw0rd%3E@localhost:1433"

Note that the SA password passed into the Docker container differs from the one passed into the tests. It's the same password, but Go's libraries require it to be percent encoded.

Running all the tests at once against one Docker container will likely fail because they interact with each other. Consider running one test at a time.

Documentation

Index

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

Functions

func New

func New() (interface{}, error)

func Run

func Run(apiTLSConfig *api.TLSConfig) error

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

Types

type MSSQL

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

MSSQL is an implementation of Database interface

func (*MSSQL) CreateUser

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

CreateUser generates the username/password on the underlying MSSQL secret backend as instructed by the CreationStatement provided.

func (*MSSQL) RenewUser

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

RenewUser is not supported on MSSQL, so this is a no-op.

func (*MSSQL) RevokeUser

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

RevokeUser attempts to drop the specified user. It will first attempt to disable login, then kill pending connections from that user, and finally drop the user and login from the database instance.

func (*MSSQL) RotateRootCredentials

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

func (*MSSQL) SetCredentials

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

func (*MSSQL) Type

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

Type returns the TypeName for this backend