s3

Documentation

Index

• Variables
• func CLIFlags(envPrefix, category string) []cli.Flag
• type Config
  • func ReadConfig(ctx *cli.Context) Config
  • func (c Config) MarshalJSON() ([]byte, error)
• type CredentialType
  • func StringToCredentialType(s string) CredentialType
• type Store
  • func NewStore(cfg Config) (*Store, error)
  • func (s *Store) BackendType() common.BackendType
  • func (s *Store) Get(ctx context.Context, key []byte) ([]byte, error)
  • func (s *Store) Put(ctx context.Context, key []byte, value []byte) error
  • func (s *Store) Verify(_ context.Context, key []byte, value []byte) error

Variables

var (
	EndpointFlagName        = withFlagPrefix("endpoint")
	EnableTLSFlagName       = withFlagPrefix("enable-tls")
	CredentialTypeFlagName  = withFlagPrefix("credential-type")
	AccessKeyIDFlagName     = withFlagPrefix("access-key-id")     // #nosec G101
	AccessKeySecretFlagName = withFlagPrefix("access-key-secret") // #nosec G101
	BucketFlagName          = withFlagPrefix("bucket")
	PathFlagName            = withFlagPrefix("path")
	TimeoutFlagName         = withFlagPrefix("timeout")
)

Functions

func CLIFlags

func CLIFlags(envPrefix, category string) []cli.Flag

CLIFlags ... used for S3 backend configuration category is used to group the flags in the help output (see https://cli.urfave.org/v2/examples/flags/#grouping)

Types

type Config

type Config struct {
	CredentialType  CredentialType
	Endpoint        string
	EnableTLS       bool
	AccessKeyID     string
	AccessKeySecret string
	Bucket          string
	Path            string
}

func ReadConfig

func ReadConfig(ctx *cli.Context) Config

func (Config) MarshalJSON

func (c Config) MarshalJSON() ([]byte, error)

Custom MarshalJSON function to control what gets included in the JSON output TODO: Probably best would be to separate config from secrets everywhere. Then we could just log the config and not worry about secrets.

type CredentialType

type CredentialType string

const (
	CredentialTypeStatic  CredentialType = "static"
	CredentialTypeIAM     CredentialType = "iam"
	CredentialTypeUnknown CredentialType = "unknown"
)

func StringToCredentialType

func StringToCredentialType(s string) CredentialType

type Store

type Store struct {
	// contains filtered or unexported fields
}

Store ... S3 store client safe for concurrent use: https://github.com/minio/minio-go/issues/598#issuecomment-569457863

func NewStore

func NewStore(cfg Config) (*Store, error)

func (*Store) BackendType

func (s *Store) BackendType() common.BackendType

func (*Store) Get

func (s *Store) Get(ctx context.Context, key []byte) ([]byte, error)

func (*Store) Put

func (s *Store) Put(ctx context.Context, key []byte, value []byte) error

func (*Store) Verify

func (s *Store) Verify(_ context.Context, key []byte, value []byte) error