zeolite

package module

v0.0.0-...-4dbc28d Latest Latest Go to latest Published: Oct 12, 2022 License: AGPL-3.0 Imports: 7 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/42LoCo42/go-zeolite

Links

Open Source Insights

README ¶

go-zeolite

Zeolite: simple & secure communications based on libsodium with perfect forward secrecy, XChaCha20-Poly1305 and a mirrored protocol (no distinction between client & server).

Protocol design

The protocol is completely identical for server & client.

Handshake (performed in lockstep by both participants)

Protocol version (currently zeolite1, so 8 bytes)
Public key (32 bytes)
Ephemeral key (for PFS) signed with public key (96 bytes)
Symmetric key (for communication) encrypted with ephemeral key (72 bytes)
Stream header (24 bytes)

Total: 232 bytes

Data Transmission

Message size (4 bytes)
Encrypted message (17 bytes + message size)

Total: 21 bytes + message size

Documentation ¶

Index ¶

Constants
Variables
func Base64Dec(b64 string) ([]byte, error)
func Base64Enc(data []byte) string
func BlockCopy(dst io.Writer, src BlockReader) (written int64, err error)
func Init() error
type BlockReader
type EphPK
type EphSK
type Identity
- func NewIdentity() (ret Identity, err error)
- func (identity Identity) NewStream(conn io.ReadWriter, cb TrustCB) (ret *Stream, err error)
type SignPK
type SignSK
type Stream
type SymK
type TrustCB

Constants ¶

View Source

const Protocol = "zeolite1"

Variables ¶

View Source

var (
	ErrInit    = errors.New("could not initialize libsodium")
	ErrEOS     = errors.New("end of stream reached")
	ErrRecv    = errors.New("could not receive")
	ErrSend    = errors.New("could not send")
	ErrProto   = errors.New("protocol violation")
	ErrKeygen  = errors.New("key generation failed")
	ErrTrust   = errors.New("no trust")
	ErrSign    = errors.New("could not sign")
	ErrVerify  = errors.New("could not verify")
	ErrEncrypt = errors.New("could not encrypt")
	ErrDecrypt = errors.New("could not decrypt")
)

Functions ¶

func Base64Dec ¶

func Base64Dec(b64 string) ([]byte, error)

func Base64Enc ¶

func Base64Enc(data []byte) string

func BlockCopy ¶

func BlockCopy(dst io.Writer, src BlockReader) (written int64, err error)

func Init ¶

func Init() error

Types ¶

type BlockReader ¶

type BlockReader interface {
	BlockRead() (p []byte, err error)
}

type EphPK ¶

type EphPK [C.crypto_box_PUBLICKEYBYTES]byte

type EphSK ¶

type EphSK [C.crypto_box_SECRETKEYBYTES]byte

type Identity ¶

type Identity struct {
	Public SignPK
	Secret SignSK
}

func NewIdentity ¶

func NewIdentity() (ret Identity, err error)

func (Identity) NewStream ¶

func (identity Identity) NewStream(conn io.ReadWriter, cb TrustCB) (ret *Stream, err error)

type SignPK ¶

type SignPK [C.crypto_sign_PUBLICKEYBYTES]byte

type SignSK ¶

type SignSK [C.crypto_sign_SECRETKEYBYTES]byte

type Stream ¶

type Stream struct {
	Conn      io.ReadWriter
	OtherPK   SignPK
	SendState C.crypto_secretstream_xchacha20poly1305_state
	RecvState C.crypto_secretstream_xchacha20poly1305_state
}

func (*Stream) BlockRead ¶

func (stream *Stream) BlockRead() (p []byte, err error)

func (*Stream) Recv ¶

func (stream *Stream) Recv() (ret []byte, err error)

func (*Stream) Send ¶

func (stream *Stream) Send(msg []byte) error

func (*Stream) Write ¶

func (stream *Stream) Write(msg []byte) (n int, err error)

type SymK ¶

type SymK [C.crypto_secretstream_xchacha20poly1305_KEYBYTES]byte

type TrustCB ¶

type TrustCB func(otherPK SignPK) (bool, error)

Source Files ¶

View all Source files

zeolite.go

Directories ¶

Path	Synopsis
cmd

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