client

package

v0.12.0 Latest Latest Go to latest Published: Nov 22, 2023 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/AirHelp/treasury

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Client
- func New(options *Options) (*Client, error)
type Options
type Secret

Constants ¶

View Source

const (
	// DefaultDestinationFilePerms are the default file permissions for destination file rendered into
	// disk when a specific file permission has not already been specified.
	DefaultDestinationFilePerms = 0644
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {

	// Backend interface
	Backend backend.BackendAPI
	// contains filtered or unexported fields
}

Client is the client that performs all operations against a treasury backend

func New ¶

func New(options *Options) (*Client, error)

New initializes a new client for the given AWS account with S3 bucket

func (*Client) Delete ¶ added in v0.12.0

func (c *Client) Delete(key string) error

Delete removeds specified secret for given key

func (*Client) Export ¶

func (c *Client) Export(key, singleKeyExportFormat string, appendMap map[string]string) (string, error)

Export returns secrets in given format format should be provided in singleKeyExportFormat e.g.: singleKeyExportFormat = "export %s='%s'\n"

func (*Client) ExportMap ¶

func (c *Client) ExportMap(key string) (map[string]string, error)

ExportMap returns map of Key=Value secrets (Key is without full path)

func (*Client) ExportToTemplate ¶

func (c *Client) ExportToTemplate(key string, appendMap map[string]string) (string, error)

func (*Client) Import ¶

func (c *Client) Import(prefix, secretsFilePath string, force bool) error

Import imports secrets from file into treasury store, if value does not change it is not overridden

func (*Client) Read ¶

func (c *Client) Read(key string) (*Secret, error)

Read returns decrypted secret for given key

func (*Client) ReadFromEnv ¶ added in v0.8.0

func (c *Client) ReadFromEnv(env, key string) (string, error)

ReadFromEnv returns value of given key in specified env.

func (*Client) ReadGroup ¶

func (c *Client) ReadGroup(keyPrefix string) ([]*Secret, error)

ReadGroup returns list of secrets for given key prefix

func (*Client) ReadValue ¶

func (c *Client) ReadValue(key string) (string, error)

ReadValue returns secret as a string for given key.

func (*Client) Template ¶

func (c *Client) Template(sourceFilePath, destinationFilePath string, perms os.FileMode, appendMap, envMap map[string]string) error

Template generates a file with secrets from given template

func (*Client) Write ¶

func (c *Client) Write(key, secret string, force bool) error

Write secret to Treasure

func (*Client) WriteFile ¶

func (c *Client) WriteFile(key, file string, force bool) error

type Options ¶

type Options struct {
	Version string
	// backend region where we keep secrets
	Region       string
	S3BucketName string
	Backend      backend.BackendAPI
	AWSConfig    aws.Config
}

Options for client

type Secret ¶

type Secret struct {
	Key         string
	Value       string
	BucketName  string
	Application string
	Environment string
}

Secret struct

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL