pasta

Documentation

Index

• Variables
• func GenerateSecret(length int) []byte
• func HashByteSecret(secret []byte) []byte
• func HashStringSecret(secret string) []byte
• type CompletedConfig
  • func (c CompletedConfig) New() *Pasta
  • func (c CompletedConfig) Validate() error
• type Config
  • func NewConfig() *Config
  • func NewViperConfig(getViper func() *viper.Viper) *Config
  • func (o *Config) Complete() CompletedConfig
• type KeyProvider
• type Pasta
  • func New(c KeyProvider) *Pasta
  • func NewFromKey(systemSecret []byte, rotatedSystemSecrets [][]byte) *Pasta
  • func (c *Pasta) Decrypt(ciphertext string) (p []byte, err error)
  • func (c *Pasta) Encrypt(plaintext []byte) (string, error)
• type Secret
  • func (*Secret) Descriptor() ([]byte, []int)
  • func (x *Secret) GetRotatedSystemSecrets() []string
  • func (x *Secret) GetSystemSecret() string
  • func (*Secret) ProtoMessage()
  • func (x *Secret) ProtoReflect() protoreflect.Message
  • func (x *Secret) Reset()
  • func (x *Secret) String() string

Variables

var File_pasta_proto protoreflect.FileDescriptor

Functions

func GenerateSecret

func GenerateSecret(length int) []byte

GenerateSecret generates random bytes with CharsetAlphaNum

func HashByteSecret

func HashByteSecret(secret []byte) []byte

HashByteSecret hashes the secret for consumption by the AEAD encryption algorithm which expects exactly 32 bytes.

The system secret is being hashed to always match exactly the 32 bytes required by AEAD, even if the secret is long or shorter.

func HashStringSecret

func HashStringSecret(secret string) []byte

HashStringSecret hashes the secret for consumption by the AEAD encryption algorithm which expects exactly 32 bytes.

The system secret is being hashed to always match exactly the 32 bytes required by AEAD, even if the secret is long or shorter.

Types

type CompletedConfig

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

func (CompletedConfig) New

func (c CompletedConfig) New() *Pasta

New creates a new server which logically combines the handling chain with the passed server. name is used to differentiate for logging. The handler chain in particular can be difficult as it starts delgating. New usually called after Complete

func (CompletedConfig) Validate

func (c CompletedConfig) Validate() error

Validate checks Config.

type Config

type Config struct {
	GetViper  func() *viper.Viper // If set, overrides params below
	Proto     Secret
	Validator *validator.Validate
}

func NewConfig

func NewConfig() *Config

NewConfig returns a Config struct with the default values

func NewViperConfig

func NewViperConfig(getViper func() *viper.Viper) *Config

NewViperConfig returns a Config struct with the global viper instance key representing a sub tree of this instance. NewViperConfig is case-insensitive for a key.

func (*Config) Complete

func (o *Config) Complete() CompletedConfig

Complete fills in any fields not set that are required to have valid data and can be derived from other fields. If you're going to ApplyOptions, do that first. It's mutating the receiver. ApplyOptions is called inside.

type KeyProvider

type KeyProvider interface {
	GetSystemSecret() []byte           // primary key
	GetRotatedSystemSecrets() [][]byte // multi keys for multi encrypt|decrypt
}

type Pasta

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

copy & paste-friendly golang crypto

func New

func New(c KeyProvider) *Pasta

func NewFromKey

func NewFromKey(systemSecret []byte, rotatedSystemSecrets [][]byte) *Pasta

func (*Pasta) Decrypt

func (c *Pasta) Decrypt(ciphertext string) (p []byte, err error)

func (*Pasta) Encrypt

func (c *Pasta) Encrypt(plaintext []byte) (string, error)

type Secret

type Secret struct {
	SystemSecret         string   `protobuf:"bytes,1,opt,name=system_secret,json=systemSecret,proto3" json:"system_secret,omitempty"`                           // new
	RotatedSystemSecrets []string `protobuf:"bytes,2,rep,name=rotated_system_secrets,json=rotatedSystemSecrets,proto3" json:"rotated_system_secrets,omitempty"` // old, older,..., oldest
	// contains filtered or unexported fields
}

func (*Secret) Descriptor

func (*Secret) Descriptor() ([]byte, []int)

Deprecated: Use Secret.ProtoReflect.Descriptor instead.

func (*Secret) GetRotatedSystemSecrets

func (x *Secret) GetRotatedSystemSecrets() []string

func (*Secret) GetSystemSecret

func (x *Secret) GetSystemSecret() string

func (*Secret) ProtoMessage

func (*Secret) ProtoMessage()

func (*Secret) ProtoReflect

func (x *Secret) ProtoReflect() protoreflect.Message

func (*Secret) Reset

func (x *Secret) Reset()

func (*Secret) String

func (x *Secret) String() string