h2streamcipher

Documentation

Index

• Variables
• func FromParams(params string, algs Algs) (KeyStream, MAC, error)
• type Algs
• type AlgsMap
  • func NewAlgsMap() *AlgsMap
  • func (m *AlgsMap) Get(id string) (Builder, bool)
  • func (m *AlgsMap) Register(b Builder)
• type Builder
• type DecStreamReader
  • func NewDecStreamReader(s KeyStream, mac MAC, ciphertext io.Reader) *DecStreamReader
  • func NewDecStreamReaderFromParams(params string, algs Algs, ciphertext io.Reader) (*DecStreamReader, error)
  • func (r *DecStreamReader) Close() error
  • func (r *DecStreamReader) Read(dst []byte) (int, error)
  • func (r *DecStreamReader) Verify(tag string) (bool, error)
• type EncStreamReader
  • func NewEncStreamReader(s KeyStream, mac MAC, plaintext io.Reader) *EncStreamReader
  • func (r *EncStreamReader) Close() error
  • func (r *EncStreamReader) Read(dst []byte) (int, error)
  • func (r *EncStreamReader) Tag() string
• type KeyStream
• type MAC

Variables

var (
	// ErrNotSupported is returned when the cipher is not supported
	ErrNotSupported errNotSupported
	// ErrClosed is returned when writing after the cipher is closed
	ErrClosed errClosed
	// ErrNotClosed is returned when performing computations prior to closing
	ErrNotClosed errNotClosed
	// ErrKeyInvalid is returned when the cipher key config is invalid
	ErrKeyInvalid errKeyInvalid
	// ErrAuthInvalid is returned when the cipher auth tag is invalid
	ErrAuthInvalid errAuthInvalid
)

Functions

func FromParams

func FromParams(params string, algs Algs) (KeyStream, MAC, error)

FromParams creates a cipher from params

Types

type Algs

type Algs interface {
	Register(b Builder)
	Get(id string) (Builder, bool)
}

Algs are a map of valid cipher algorithms

type AlgsMap

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

func NewAlgsMap

func NewAlgsMap() *AlgsMap

func (*AlgsMap) Get

func (m *AlgsMap) Get(id string) (Builder, bool)

func (*AlgsMap) Register

func (m *AlgsMap) Register(b Builder)

type Builder

type Builder interface {
	ID() string
	Build(params string) (KeyStream, MAC, error)
}

Builder constructs a new cipher from params

type DecStreamReader

type DecStreamReader struct {
	Stream     KeyStream
	MAC        MAC
	Ciphertext io.Reader
	// contains filtered or unexported fields
}

func NewDecStreamReader

func NewDecStreamReader(s KeyStream, mac MAC, ciphertext io.Reader) *DecStreamReader

func NewDecStreamReaderFromParams

func NewDecStreamReaderFromParams(params string, algs Algs, ciphertext io.Reader) (*DecStreamReader, error)

NewDecStreamReaderFromParams creates a dec stream reader from params

func (*DecStreamReader) Close

func (r *DecStreamReader) Close() error

func (*DecStreamReader) Read

func (r *DecStreamReader) Read(dst []byte) (int, error)

func (*DecStreamReader) Verify

func (r *DecStreamReader) Verify(tag string) (bool, error)

type EncStreamReader

type EncStreamReader struct {
	Stream    KeyStream
	MAC       MAC
	Plaintext io.Reader
}

func NewEncStreamReader

func NewEncStreamReader(s KeyStream, mac MAC, plaintext io.Reader) *EncStreamReader

func (*EncStreamReader) Close

func (r *EncStreamReader) Close() error

func (*EncStreamReader) Read

func (r *EncStreamReader) Read(dst []byte) (int, error)

func (*EncStreamReader) Tag

func (r *EncStreamReader) Tag() string

type KeyStream

type KeyStream interface {
	XORKeyStream(dst, src []byte)
}

type MAC

type MAC interface {
	io.WriteCloser
	Tag() string
	Verify(tag string) (bool, error)
}