encryption

Documentation

Overview

Package encryption exposes functionalities needed for encryption and decryption operations in Bee.

Index

• Constants
• type ChunkEncrypter
  • func NewChunkEncrypter() ChunkEncrypter
• type Decrypter
• type Encrypter
• type Encryption
  • func (e *Encryption) Decrypt(data []byte) ([]byte, error)
  • func (e *Encryption) Encrypt(data []byte) ([]byte, error)
  • func (e *Encryption) Key() Key
  • func (e *Encryption) Reset()
  • func (e *Encryption) Transcrypt(i int, in, out []byte) error
• type Interface
  • func New(key Key, padding int, initCtr uint32, hashFunc func() hash.Hash) Interface
  • func NewDataEncryption(key Key) Interface
  • func NewSpanEncryption(key Key) Interface
• type Key
  • func GenerateRandomKey(l int) Key

Constants

const (
	KeyLength     = 32
	ReferenceSize = 64
)

Types

type ChunkEncrypter

type ChunkEncrypter interface {
	EncryptChunk([]byte) (key Key, encryptedSpan, encryptedData []byte, err error)
}

ChunkEncrypter encrypts chunk data.

func NewChunkEncrypter

func NewChunkEncrypter() ChunkEncrypter

type Decrypter

type Decrypter interface {
	Key() Key
	Decrypt(data []byte) ([]byte, error)
}

type Encrypter

type Encrypter interface {
	Key() Key
	Encrypt(data []byte) ([]byte, error)
}

type Encryption

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

func (*Encryption) Decrypt

func (e *Encryption) Decrypt(data []byte) ([]byte, error)

Decrypt decrypts the data, if padding was used caller must know original length and truncate

func (*Encryption) Encrypt

func (e *Encryption) Encrypt(data []byte) ([]byte, error)

Encrypt encrypts the data and does padding if specified

func (*Encryption) Key

func (e *Encryption) Key() Key

Key returns the base key

func (*Encryption) Reset

func (e *Encryption) Reset()

Reset resets the counter. It is only safe to call after an encryption operation is completed After Reset is called, the Encryption object can be reused for other data

func (*Encryption) Transcrypt

func (e *Encryption) Transcrypt(i int, in, out []byte) error

used for segmentwise transformation if in is shorter than out, padding is used

type Interface

type Interface interface {
	Encrypter
	Decrypter
	Reset()
}

func New

func New(key Key, padding int, initCtr uint32, hashFunc func() hash.Hash) Interface

New constructs a new encrypter/decrypter

func NewDataEncryption

func NewDataEncryption(key Key) Interface

func NewSpanEncryption

func NewSpanEncryption(key Key) Interface

type Key

type Key []byte

func GenerateRandomKey

func GenerateRandomKey(l int) Key

GenerateRandomKey generates a random key of length l