security

Documentation

Index

• Variables
• func ForbiddenHTTPError(description string) error
• func UnauthorizedHTTPError(description string) error
• type AESEncrypter
  • func (e *AESEncrypter) Decrypt(_ context.Context, ciphertext []byte, key []byte) ([]byte, error)
  • func (e *AESEncrypter) Encrypt(_ context.Context, plaintext []byte, key []byte) ([]byte, error)
• type Encrypter
• type HashingIntegrityProcessor
  • func (h *HashingIntegrityProcessor) CalculateIntegrity(integral IntegralObject) ([]byte, error)
  • func (h *HashingIntegrityProcessor) ValidateIntegrity(integral IntegralObject) bool
• type IntegralObject
• type IntegrityProcessor

Variables

var ErrUserNotFound = errors.New("user identity must be provided when allowing authentication")

ErrUserNotFound error when authentication passed but no user found

Functions

func ForbiddenHTTPError

func ForbiddenHTTPError(description string) error

ForbiddenHTTPError returns HTTPError 403 with some description

func UnauthorizedHTTPError

func UnauthorizedHTTPError(description string) error

UnauthorizedHTTPError returns HTTPError 401 with some description

Types

type AESEncrypter

type AESEncrypter struct {
}

AESEncrypter is an encrypter that fetches the encryption key from a remote location

func (*AESEncrypter) Decrypt

func (e *AESEncrypter) Decrypt(_ context.Context, ciphertext []byte, key []byte) ([]byte, error)

Decrypt decrypts the cipher text with the provided key using AES

func (*AESEncrypter) Encrypt

func (e *AESEncrypter) Encrypt(_ context.Context, plaintext []byte, key []byte) ([]byte, error)

Encrypt encrypts the plaintext with the provided key using AES

type Encrypter

type Encrypter interface {
	Encrypt(ctx context.Context, plaintext, key []byte) ([]byte, error)
	Decrypt(ctx context.Context, ciphertext, key []byte) ([]byte, error)
}

Encrypter provides functionality to encrypt and decrypt data

type HashingIntegrityProcessor

type HashingIntegrityProcessor struct {
	HashingFunc func(data []byte) []byte
}

HashingIntegrityProcessor is an integrity processor that uses a hashing func to calculate the integrity

func (*HashingIntegrityProcessor) CalculateIntegrity

func (h *HashingIntegrityProcessor) CalculateIntegrity(integral IntegralObject) ([]byte, error)

CalculateIntegrity calculates the integrity of an integral object using a hashing func

func (*HashingIntegrityProcessor) ValidateIntegrity

func (h *HashingIntegrityProcessor) ValidateIntegrity(integral IntegralObject) bool

ValidateIntegrity validates the integrity of an integral object using a hashing func

type IntegralObject

type IntegralObject interface {
	IntegralData() []byte
	SetIntegrity([]byte)
	GetIntegrity() []byte
}

IntegralObject interface indicates that an objects needs to be processed with regards to its integrity

type IntegrityProcessor

type IntegrityProcessor interface {
	ValidateIntegrity(integral IntegralObject) bool
	CalculateIntegrity(integral IntegralObject) ([]byte, error)
}

IntegrityProcessor provides functionality to validate and calculate the integrity of an integral object