shadowaead

package

v1.2.0 Latest Latest Go to latest Published: Nov 11, 2023 License: Apache-2.0 Imports: 13 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/wsrf16/swiss

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func NewConn(c net.Conn, cipher Cipher) net.Conn
func NewPacketConn(c net.PacketConn, ciph Cipher) net.PacketConn
func Pack(dst, plaintext []byte, ciph Cipher) ([]byte, error)
func Unpack(dst, pkt []byte, ciph Cipher) ([]byte, error)
type Cipher
- func AESGCM(key []byte) (Cipher, error)
- func Chacha20Poly1305(key []byte) (Cipher, error)
type KeySizeError
- func (e KeySizeError) Error() string

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrRepeatedSalt = errors.New("repeated salt detected")

ErrRepeatedSalt means detected a reused salt

View Source

var ErrShortPacket = errors.New("short packet")

ErrShortPacket means that the packet is too short for a valid encrypted packet.

Functions ¶

func NewConn ¶

func NewConn(c net.Conn, cipher Cipher) net.Conn

NewConn wraps a stream-oriented net.Conn with cipher.

func NewPacketConn ¶

func NewPacketConn(c net.PacketConn, ciph Cipher) net.PacketConn

NewPacketConn wraps a net.PacketConn with cipher

func Pack ¶

func Pack(dst, plaintext []byte, ciph Cipher) ([]byte, error)

Pack encrypts plaintext using Cipher with a randomly generated salt and returns a slice of dst containing the encrypted packet and any error occurred. Ensure len(dst) >= ciph.SaltSize() + len(plaintext) + aead.Overhead().

func Unpack ¶

func Unpack(dst, pkt []byte, ciph Cipher) ([]byte, error)

Unpack decrypts pkt using Cipher and returns a slice of dst containing the decrypted payload and any error occurred. Ensure len(dst) >= len(pkt) - aead.SaltSize() - aead.Overhead().

Types ¶

type Cipher ¶

type Cipher interface {
	KeySize() int
	SaltSize() int
	Encrypter(salt []byte) (cipher.AEAD, error)
	Decrypter(salt []byte) (cipher.AEAD, error)
}

func AESGCM ¶

func AESGCM(key []byte) (Cipher, error)

AESGCM creates a new Cipher with a pre-shared key. len(key) must be one of 16, 24, or 32 to select AES-128/196/256-GCM.

func Chacha20Poly1305 ¶

func Chacha20Poly1305(key []byte) (Cipher, error)

Chacha20Poly1305 creates a new Cipher with a pre-shared key. len(key) must be 32.

type KeySizeError ¶

type KeySizeError int

func (KeySizeError) Error ¶

func (e KeySizeError) Error() string

Source Files ¶

View all Source files

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