crypto

Documentation

Index

• Constants
• func Decrypt(bytes []byte) ([]byte, error)
• func Encrypt(bytes []byte) ([]byte, error)
• func InitializeGlobalCodec(codec Codec) error
• type Codec
• type Config
  • func GetConfigFromEnvironment() (Config, error)
  • func NewConfigWithDefaults() Config

Constants

const (
	// NOOP represents no crypto
	NOOP = "NOOP"
	// AES256 represents AES256 encryption
	AES256 = "AES256"
)

Functions

func Decrypt

func Decrypt(bytes []byte) ([]byte, error)

Decrypt decrypts the provided bytes using the globally configured codec

func Encrypt

func Encrypt(bytes []byte) ([]byte, error)

Encrypt encrypts the provided bytes using the globally configured codec

func InitializeGlobalCodec

func InitializeGlobalCodec(codec Codec) error

InitializeGlobalCodec may be called once and only once to inject an object that implements the Codec interface into a "global" (package-scoped) variable. Additional invocations of this function will return an error.

Types

type Codec

type Codec interface {
	Encrypt([]byte) ([]byte, error)
	Decrypt([]byte) ([]byte, error)
}

Codec is an interface to be implemented by any type that can encrypt and decrypt values

type Config

type Config struct {
	EncryptionScheme string `envconfig:"ENCRYPTION_SCHEME" default:"AES256"`
}

Config represents configuration options for the global codec

func GetConfigFromEnvironment

func GetConfigFromEnvironment() (Config, error)

GetConfigFromEnvironment returns configuration derived from environment variables

func NewConfigWithDefaults

func NewConfigWithDefaults() Config

NewConfigWithDefaults returns a Config object with default values already applied. Callers are then free to set custom values for the remaining fields and/or override default values.