core

Documentation

Index

• Variables
• func ListCipher() []string
• type Cipher
  • func PickCipher(name string, key []byte, password string) (Cipher, error)
• type CipherBuilder
• type PacketConnCipher
• type StreamConnCipher

Variables

var ErrCipherNotSupported = errors.New("cipher not supported")

ErrCipherNotSupported occurs when a cipher is not supported (likely because of security concerns).

Functions

func ListCipher

func ListCipher() []string

ListCipher returns a list of available cipher names sorted alphabetically.

Types

type Cipher

type Cipher interface {
	StreamConnCipher
	PacketConnCipher
}

func PickCipher

func PickCipher(name string, key []byte, password string) (Cipher, error)

PickCipher returns a Cipher of the given name. Derive key from password if given key is empty.

type CipherBuilder

type CipherBuilder struct {
	KeySize int
	New     func(key []byte) (shadowaead.Cipher, error)
}

type PacketConnCipher

type PacketConnCipher interface {
	PacketConn(net.PacketConn) net.PacketConn
}

type StreamConnCipher

type StreamConnCipher interface {
	StreamConn(net.Conn) net.Conn
}