Documentation
¶
Index ¶
- Constants
- Variables
- func MakeTestPayload(size int) []byte
- func MakeTestSecrets(n int) []string
- func Pack(dst, plaintext []byte, cipher shadowaead.Cipher) ([]byte, error)
- func Unpack(dst, pkt []byte, cipher shadowaead.Cipher) ([]byte, error)
- type ChunkReader
- type Reader
- type SaltGenerator
- type Writer
Constants ¶
const TestCipher = "chacha20-ietf-poly1305"
TestCipher is a preferred cipher to use in testing.
Variables ¶
var ErrShortPacket = errors.New("short packet")
ErrShortPacket is identical to shadowaead.ErrShortPacket
Functions ¶
func MakeTestPayload ¶ added in v1.0.3
MakeTestPayload returns a slice of `size` arbitrary bytes.
func MakeTestSecrets ¶ added in v1.1.1
MakeTestSecrets returns a slice of `n` test passwords. Not secure!
func Pack ¶ added in v1.3.0
func Pack(dst, plaintext []byte, cipher shadowaead.Cipher) ([]byte, error)
Pack encrypts a Shadowsocks-UDP packet and returns a slice containing the encrypted packet. dst must be big enough to hold the encrypted packet. If plaintext and dst overlap but are not aligned for in-place encryption, this function will panic.
func Unpack ¶ added in v1.3.0
func Unpack(dst, pkt []byte, cipher shadowaead.Cipher) ([]byte, error)
Unpack decrypts a Shadowsocks-UDP packet and returns a slice containing the decrypted payload or an error. If dst is present, it is used to store the plaintext, and must have enough capacity. If dst is nil, decryption proceeds in-place. This function is needed because shadowaead.Unpack() embeds its own replay detection, which we do not always want, especially on memory-constrained clients.
Types ¶
type ChunkReader ¶ added in v1.1.5
type ChunkReader interface {
// ReadChunk reads the next chunk and returns its payload. The caller must
// complete its use of the returned buffer before the next call.
// The buffer is nil iff there is an error. io.EOF indicates a close.
ReadChunk() ([]byte, error)
}
ChunkReader is similar to io.Reader, except that it controls its own buffer granularity.
type Reader ¶ added in v1.1.0
Reader is an io.Reader that also implements io.WriterTo to allow for piping the data without extra allocations and copies.
func NewShadowsocksReader ¶
func NewShadowsocksReader(reader io.Reader, ssCipher shadowaead.Cipher) Reader
NewShadowsocksReader creates a Reader that decrypts the given Reader using the shadowsocks protocol with the given shadowsocks cipher.
type SaltGenerator ¶ added in v1.2.0
SaltGenerator generates unique salts to use in Shadowsocks connections.
var RandomSaltGenerator SaltGenerator = randomSaltGenerator{}
RandomSaltGenerator is a basic SaltGenerator.
type Writer ¶ added in v1.1.0
type Writer struct {
// contains filtered or unexported fields
}
Writer is an io.Writer that also implements io.ReaderFrom to allow for piping the data without extra allocations and copies. The LazyWrite and Flush methods allow a header to be added but delayed until the first write, for concatenation. All methods except Flush must be called from a single thread.
func NewShadowsocksWriter ¶
func NewShadowsocksWriter(writer io.Writer, ssCipher shadowaead.Cipher) *Writer
NewShadowsocksWriter creates a Writer that encrypts the given Writer using the shadowsocks protocol with the given shadowsocks cipher.
func (*Writer) Flush ¶ added in v1.1.8
Flush sends the pending data, if any. This method is thread-safe.
func (*Writer) LazyWrite ¶ added in v1.1.8
LazyWrite queues p to be written, but doesn't send it until Flush() is called, a non-lazy write is made, or the buffer is filled.
func (*Writer) SetSaltGenerator ¶ added in v1.2.0
func (sw *Writer) SetSaltGenerator(saltGenerator SaltGenerator)
SetSaltGenerator sets the salt generator to be used. Must be called before the first write.
Source Files