README
¶
vault-plugin-database-snowflake
A Vault plugin for Snowflake. It is one of the supported plugins for the HashiCorp Vault Database Secrets Engine and allows for the programmatic generation of unique, ephemeral Snowflake Database User credentials in a Snowflake account.
This project uses the database plugin interface introduced in Vault version 1.6.0.
This plugin is included in Vault version 1.7+.
Bugs and Feature Requests
Bugs should be filed under the Issues section of this repo.
Feature requests can be submitted in the Issues section as well.
Quick Links
- Database Secrets Engine for Snowflake - Docs
- Database Secrets Engine for Snowflake - API Docs
- Snowflake Website
- Vault Website
Please note: HashiCorp takes Vault's security and their users' trust very seriously.
If you believe you have found a security issue in Vault or with this plugin, please responsibly disclose by contacting HashiCorp at security@hashicorp.com.
Acceptance Testing
In order to perform acceptance testing, you need to set the environment variable VAULT_ACC=1
as well as provide all the necessary information to connect to a Snowflake Project. All
SNOWFLAKE_* environment variables must be provided in order for the acceptance tests to
run properly. A cluster must be available during the test. A 30-day trial account
can be provisioned manually to test.
| Environment Variable | Description |
|---|---|
| SNOWFLAKE_ACCOUNT | The account string for your snowflake instance. If you are using a non-AWS provider, or a region that isn't us-west-1 for AWS, region and provider should be included here. (example: ec#####.east-us-2.azure) |
| SNOWFLAKE_USER | The accountadmin level user that you are using with Vault |
| SNOWFLAKE_PASSWORD | The password associated with the provided user |
| SNOWFLAKE_DB | optional: The DB you are restricting the connection to |
| SNOWFLAKE_SCHEMA | optional: The schema you are restricting the connection to |
| SNOWFLAKE_WAREHOUSE | optional: The warehouse you are restricting the connection to |
To run the acceptance tests, invoke make testacc:
$ make testacc
Documentation
¶
Index ¶
- func New() (interface{}, error)
- type SnowflakeSQL
- func (s *SnowflakeSQL) DeleteUser(ctx context.Context, req dbplugin.DeleteUserRequest) (dbplugin.DeleteUserResponse, error)
- func (s *SnowflakeSQL) Initialize(ctx context.Context, req dbplugin.InitializeRequest) (dbplugin.InitializeResponse, error)
- func (s *SnowflakeSQL) NewUser(ctx context.Context, req dbplugin.NewUserRequest) (dbplugin.NewUserResponse, error)
- func (s *SnowflakeSQL) Type() (string, error)
- func (s *SnowflakeSQL) UpdateUser(ctx context.Context, req dbplugin.UpdateUserRequest) (dbplugin.UpdateUserResponse, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type SnowflakeSQL ¶
type SnowflakeSQL struct {
*connutil.SQLConnectionProducer
sync.RWMutex
// contains filtered or unexported fields
}
func (*SnowflakeSQL) DeleteUser ¶
func (s *SnowflakeSQL) DeleteUser(ctx context.Context, req dbplugin.DeleteUserRequest) (dbplugin.DeleteUserResponse, error)
func (*SnowflakeSQL) Initialize ¶
func (s *SnowflakeSQL) Initialize(ctx context.Context, req dbplugin.InitializeRequest) (dbplugin.InitializeResponse, error)
func (*SnowflakeSQL) NewUser ¶
func (s *SnowflakeSQL) NewUser(ctx context.Context, req dbplugin.NewUserRequest) (dbplugin.NewUserResponse, error)
func (*SnowflakeSQL) Type ¶
func (s *SnowflakeSQL) Type() (string, error)
func (*SnowflakeSQL) UpdateUser ¶
func (s *SnowflakeSQL) UpdateUser(ctx context.Context, req dbplugin.UpdateUserRequest) (dbplugin.UpdateUserResponse, error)
Source Files
Directories