xor

Documentation

Index

• type Cipher
  • func New(key []byte, opts ...Option) (c Cipher)
  • func (c Cipher) Decrypt(input []byte) ([]byte, error)
  • func (c Cipher) DecryptString(input string) (output string, err error)
  • func (c Cipher) Encrypt(input []byte) ([]byte, error)
  • func (c Cipher) EncryptString(input string) (output string, err error)
• type Option
  • func WithInputEncoder(e cipher.StringEncoder) Option
  • func WithOutputEncoder(e cipher.StringEncoder) Option

Types

type Cipher

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

Cipher defines resenje.org/cipher.StringCipher interface.

func New

func New(key []byte, opts ...Option) (c Cipher)

New returns a new Cipher instance with a given key.

func (Cipher) Decrypt

func (c Cipher) Decrypt(input []byte) ([]byte, error)

Decrypt decrypts input data produced by Encrypt. It performs a basic XOR encryption and validates Adler32 checksum.

func (Cipher) DecryptString

func (c Cipher) DecryptString(input string) (output string, err error)

DecryptString decrypts input string produced by EncryptString. It performs a basic XOR encryption and validates Adler32 checksum.

func (Cipher) Encrypt

func (c Cipher) Encrypt(input []byte) ([]byte, error)

Encrypt encrypts input data using XOR and Adler32 checksum for data validation.

func (Cipher) EncryptString

func (c Cipher) EncryptString(input string) (output string, err error)

EncryptString encrypts input string using XOR and Adler32 checksum for data validation.

type Option

type Option func(*Cipher)

Option is used to specify optional parameters to the New constructor.

func WithInputEncoder

func WithInputEncoder(e cipher.StringEncoder) Option

WithInputEncoder sets the EncryptString input data encoding. By default, no input data decoding of input data is performed. If the input data is always with the same encoding, encrypted strings can be reduced in size, buy specifying this option.

func WithOutputEncoder

func WithOutputEncoder(e cipher.StringEncoder) Option

WithOutputEncoder sets the EncryptString returned data encoding. By default, resenje.org/cipher.DefaultEncoder is used.