boxstream

package

v1.2.10 Latest Latest Go to latest Published: Oct 13, 2021 License: MIT Imports: 6 Imported by: 1

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/cryptoscope/secretstream

Links

Open Source Insights

Documentation ¶

Overview ¶

Package boxstream implements npm:pull-box-stream in Go (without the pull)

https://github.com/dominictarr/pull-box-stream

Index ¶

Constants
type Boxer
- func NewBoxer(w io.Writer, nonce *[24]byte, secret *[32]byte) *Boxer
- func (b *Boxer) WriteGoodbye() error
- func (b *Boxer) WriteMessage(msg []byte) error
type Unboxer
- func NewUnboxer(r io.Reader, nonce *[24]byte, secret *[32]byte) *Unboxer
- func (u *Unboxer) ReadMessage() ([]byte, error)

Constants ¶

View Source

const (
	// HeaderLength defines the length of the header packet before the body
	HeaderLength = 2 + 16 + 16

	// MaxSegmentSize is the maximum body size for boxstream packets
	MaxSegmentSize = 4 * 1024
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Boxer ¶

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

Boxer encrypts everything that is written to it

func NewBoxer ¶

func NewBoxer(w io.Writer, nonce *[24]byte, secret *[32]byte) *Boxer

NewBoxer returns a Boxer that writes encrypted messages to w.

func (*Boxer) WriteGoodbye ¶ added in v1.2.1

func (b *Boxer) WriteGoodbye() error

WriteGoodbye writes the 'goodbye' protocol message to the underlying writer.

func (*Boxer) WriteMessage ¶ added in v1.2.1

func (b *Boxer) WriteMessage(msg []byte) error

WriteMessage writes a boxstream packet to the underlying writer. len(msg) must not exceed MaxSegmentSize.

type Unboxer ¶

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

Unboxer decrypts everything that is read from it

func NewUnboxer ¶

func NewUnboxer(r io.Reader, nonce *[24]byte, secret *[32]byte) *Unboxer

NewUnboxer wraps the passed Reader into an Unboxer.

func (*Unboxer) ReadMessage ¶ added in v1.2.1

func (u *Unboxer) ReadMessage() ([]byte, error)

ReadMessage reads the next message from the underlying stream. If the next message was a 'goodbye', it returns io.EOF.

Source Files ¶

View all Source files

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