boxbuf

package module

v0.0.0-...-f595491 Latest Latest Go to latest Published: Oct 31, 2017 License: MIT Imports: 5 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

Repository

github.com/avahowell/boxbuf

Links

Open Source Insights

README ¶

boxbuf

boxbuf is a library which enables support for asymmetric encryption with Reader and Writer streams, using NACL/box.

LICENSE

The MIT License (MIT)

Documentation ¶

Index ¶

type DecReader
- func NewReader(secretKey [32]byte, in io.Reader) (*DecReader, error)
- func (b *DecReader) Read(p []byte) (int, error)
type EncWriter
- func NewWriter(peersPublicKey [32]byte, out io.Writer) (*EncWriter, error)
- func (w *EncWriter) Write(p []byte) (int, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DecReader ¶

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

DecReader is an io.Reader that can be used to decrypt data using a secret key. DecWriter uses golang.org/x/crypto/nacl/box to perform asymmetric decryption.

func NewReader ¶

func NewReader(secretKey [32]byte, in io.Reader) (*DecReader, error)

NewReader creates a new DecReader using secretKey to decrypt the data as needed from in.

func (*DecReader) Read ¶

func (b *DecReader) Read(p []byte) (int, error)

Read reads from the underlying io.Reader, decrypting bytes as needed, until len(p) byte have been read or the underlying stream is exhausted.

type EncWriter ¶

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

EncWriter is an io.Writer that can be used to encrypt data with a peer's public key. EncWriter uses golang.org/x/crypto/nacl/box to perform asymmetric encryption.

func NewWriter ¶

func NewWriter(peersPublicKey [32]byte, out io.Writer) (*EncWriter, error)

NewWriter intializes a new EncWriter using peersPublicKey to encrypt all data, writing the result to `out`.

func (*EncWriter) Write ¶

func (w *EncWriter) Write(p []byte) (int, error)

Write writes the entirety of p to the underlying io.Writer, encrypting the data with the public key and chunking as needed.

Source Files ¶

View all Source files

boxbuf.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL