symmcipher

package

v0.3.0 Latest Latest Go to latest Published: Jan 1, 2024 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	KeyLength           = chacha20poly1305.KeySize
	CipherTextMinLength = chacha20poly1305.NonceSize + chacha20poly1305.Overhead
)

This section is empty.

This section is empty.

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

Cipher is a wrapper around the AEAD interface from the golang.org/x/crypto/chacha20poly1305 package.

func New(key []byte) (*Cipher, error)

New returns a new Cipher instance. If a Cipher instance with the same key has already been created, it will be returned instead.

func (cipher *Cipher) NewDecryptingReader(src io.Reader) (io.ReadCloser, error)

NewDecryptingReader returns a new io.ReadCloser that decrypts src with the cipher

func (cipher *Cipher) NewEncryptingWriter(dst io.Writer, compression bool) (io.WriteCloser, error)

NewEncryptingWriter returns a new io.WriteCloser that encrypts data with the cipher and writes to dst.

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

func (r *Reader) Read(p []byte) (int, error)

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

func (w *Writer) Close() error

Close flushes the last chunk. It does not close the underlying Writer.

func (w *Writer) Write(p []byte) (n int, err error)