crypt

Documentation

Overview

Taken and adapted from: - https://github.com/schollz/croc/blob/8dc5bd6e046194d0c5b1dc34b0fd1602f8f6c7ad/src/crypt/crypt.go#L1 - https://github.com/blend/go-sdk/blob/29e67762ae016aba504d9de96bd99cd4b23728f7/crypto/stream.go#L23

Index

• Constants
• func Decrypt(key []byte, data []byte) ([]byte, error)
• func DeriveKey(pw []byte, salt []byte) ([]byte, error)
• func Encrypt(key []byte, data []byte) ([]byte, error)
• type StreamDecrypter
  • func NewStreamDecrypter(key []byte, iv []byte, src io.Reader) (*StreamDecrypter, error)
  • func (s *StreamDecrypter) Authenticate(hash []byte) error
  • func (s *StreamDecrypter) Read(p []byte) (int, error)
• type StreamEncrypter
  • func NewStreamEncrypter(key []byte, dest io.Writer) (*StreamEncrypter, error)
  • func (s *StreamEncrypter) Hash() []byte
  • func (s *StreamEncrypter) InitializationVector() []byte
  • func (s *StreamEncrypter) Write(p []byte) (int, error)

Constants

const NonceLength = 12

Functions

func Decrypt

func Decrypt(key []byte, data []byte) ([]byte, error)

Decrypt uses key to decrypt the given data.

func DeriveKey

func DeriveKey(pw []byte, salt []byte) ([]byte, error)

DeriveKey uses scrypt to generated a fixed size key for further encryption/decryption steps aka. to initialise the block cipher. After minimal research I chose scrypt over pbkdf2 as apparently scrypt contains pbkdf2? Which is a good thing I guess. The parameters below are taken from example test in the scrypt package.

func Encrypt

func Encrypt(key []byte, data []byte) ([]byte, error)

Encrypt will encrypt the data with the given key.

Types

type StreamDecrypter

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

StreamDecrypter is a decrypter for a stream of data with authentication

func NewStreamDecrypter

func NewStreamDecrypter(key []byte, iv []byte, src io.Reader) (*StreamDecrypter, error)

NewStreamDecrypter creates a new stream decrypter

func (*StreamDecrypter) Authenticate

func (s *StreamDecrypter) Authenticate(hash []byte) error

Authenticate verifies that the hash of the stream is correct. This should only be called after processing is finished

func (*StreamDecrypter) Read

func (s *StreamDecrypter) Read(p []byte) (int, error)

Read reads bytes from the underlying reader and then decrypts them.

type StreamEncrypter

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

StreamEncrypter implements the Reader interface to be used in streaming scenarios.

func NewStreamEncrypter

func NewStreamEncrypter(key []byte, dest io.Writer) (*StreamEncrypter, error)

NewStreamEncrypter initializes a stream encrypter.

func (*StreamEncrypter) Hash

func (s *StreamEncrypter) Hash() []byte

Hash should be called after the whole payload was read. It returns the SHA-256 hash of the payload.

func (*StreamEncrypter) InitializationVector

func (s *StreamEncrypter) InitializationVector() []byte

func (*StreamEncrypter) Write

func (s *StreamEncrypter) Write(p []byte) (int, error)

Write writes bytes encrypted to the writer interface.