Documentation
¶
Overview ¶
Package twofish implements Twofish encryption and decryption with streaming support. It provides Twofish encryption and decryption operations using the Twofish algorithm with support for 128-bit, 192-bit, and 256-bit keys.
Index ¶
- func NewStreamDecrypter(r io.Reader, c *cipher.TwofishCipher) io.Reader
- func NewStreamEncrypter(w io.Writer, c *cipher.TwofishCipher) io.WriteCloser
- type BufferError
- type DecryptError
- type EncryptError
- type KeySizeError
- type ReadError
- type StdDecrypter
- type StdEncrypter
- type StreamDecrypter
- type StreamEncrypter
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewStreamDecrypter ¶
NewStreamDecrypter creates a new streaming Twofish decrypter that reads encrypted data from the provided io.Reader. The decrypter uses the specified cipher interface and validates the key length for proper Twofish decryption.
func NewStreamEncrypter ¶
func NewStreamEncrypter(w io.Writer, c *cipher.TwofishCipher) io.WriteCloser
NewStreamEncrypter creates a new streaming Twofish encrypter that writes encrypted data to the provided io.Writer. The encrypter uses the specified cipher interface and validates the key length for proper Twofish encryption.
Types ¶
type BufferError ¶
type BufferError struct {
// contains filtered or unexported fields
}
BufferError represents an error when the buffer size is too small. This error occurs when the provided buffer is too small to hold the decrypted data. The error includes both buffer size and data size for detailed debugging.
func (BufferError) Error ¶
func (e BufferError) Error() string
Error returns a formatted error message describing the buffer size issue. The message includes both buffer size and data size for debugging.
type DecryptError ¶
type DecryptError struct {
Err error // The underlying error that caused the failure
}
DecryptError represents an error when Twofish decryption operation fails. This error occurs when the decryption process fails due to various reasons. The error includes the underlying error for detailed debugging.
func (DecryptError) Error ¶
func (e DecryptError) Error() string
Error returns a formatted error message describing the decryption failure. The message includes the underlying error for debugging.
type EncryptError ¶
type EncryptError struct {
Err error
}
EncryptError represents an error when Twofish encryption operation fails. This error occurs when the encryption process fails due to various reasons.
func (EncryptError) Error ¶
func (e EncryptError) Error() string
type KeySizeError ¶
type KeySizeError int
KeySizeError represents an error when the Twofish key size is invalid. Twofish keys must be exactly 16, 24, or 32 bytes for 128-bit, 192-bit, or 256-bit keys respectively. This error occurs when the provided key does not meet these size requirements.
func (KeySizeError) Error ¶
func (k KeySizeError) Error() string
Error returns a formatted error message describing the invalid key size. The message includes the actual key size and the required sizes for debugging.
type ReadError ¶
type ReadError struct {
Err error // The underlying error that caused the failure
}
ReadError represents an error when reading encrypted data fails. This error occurs when reading encrypted data from the underlying reader fails. The error includes the underlying error for detailed debugging.
type StdDecrypter ¶
type StdDecrypter struct {
Error error // Error field for storing decryption errors
// contains filtered or unexported fields
}
StdDecrypter represents a Twofish decrypter for standard decryption operations. It implements Twofish decryption using the Twofish algorithm with support for different key sizes and various cipher modes.
func NewStdDecrypter ¶
func NewStdDecrypter(c *cipher.TwofishCipher) *StdDecrypter
NewStdDecrypter creates a new Twofish decrypter with the specified cipher and key. Validates the key length and initializes the decrypter for Twofish decryption operations. The key must be 16, 24, or 32 bytes for 128-bit, 192-bit, or 256-bit keys respectively.
func (*StdDecrypter) Decrypt ¶
func (d *StdDecrypter) Decrypt(src []byte) (dst []byte, err error)
Decrypt decrypts the given byte slice using Twofish decryption. Creates a Twofish cipher block and uses the configured cipher interface to perform the decryption operation with proper error handling. Returns empty data when input is empty.
type StdEncrypter ¶
type StdEncrypter struct {
Error error // Error field for storing encryption errors
// contains filtered or unexported fields
}
StdEncrypter represents a Twofish encrypter for standard encryption operations. It implements Twofish encryption using the Twofish algorithm with support for different key sizes and various cipher modes.
func NewStdEncrypter ¶
func NewStdEncrypter(c *cipher.TwofishCipher) *StdEncrypter
NewStdEncrypter creates a new Twofish encrypter with the specified cipher and key. Validates the key length and initializes the encrypter for Twofish encryption operations. The key must be 16, 24, or 32 bytes for 128-bit, 192-bit, or 256-bit keys respectively.
func (*StdEncrypter) Encrypt ¶
func (e *StdEncrypter) Encrypt(src []byte) (dst []byte, err error)
Encrypt encrypts the given byte slice using Twofish encryption. Creates a Twofish cipher block and uses the configured cipher interface to perform the encryption operation with proper error handling. Returns empty data when input is empty.
type StreamDecrypter ¶
type StreamDecrypter struct {
Error error // Error field for storing decryption errors
// contains filtered or unexported fields
}
StreamDecrypter represents a streaming Twofish decrypter that implements io.Reader. It provides efficient decryption for large data streams by processing data in chunks and reading decrypted output from the underlying reader with proper state management.
func (*StreamDecrypter) Read ¶
func (d *StreamDecrypter) Read(p []byte) (n int, err error)
Read implements the io.Reader interface for streaming Twofish decryption. On the first call, reads all encrypted data from the underlying reader and decrypts it. Subsequent calls return chunks of the decrypted data to maintain streaming interface.
type StreamEncrypter ¶
type StreamEncrypter struct {
Error error // Error field for storing encryption errors
// contains filtered or unexported fields
}
StreamEncrypter represents a streaming Twofish encrypter that implements io.WriteCloser. It provides efficient encryption for large data streams by processing data in chunks and writing encrypted output to the underlying writer with true streaming support.
func (*StreamEncrypter) Close ¶
func (e *StreamEncrypter) Close() error
Close implements the io.Closer interface for the streaming Twofish encrypter. Closes the underlying writer if it implements io.Closer. Note: All data is processed in Write method for compatibility with cipher interface.
func (*StreamEncrypter) Write ¶
func (e *StreamEncrypter) Write(p []byte) (n int, err error)
Write implements the io.Writer interface for streaming Twofish encryption. Provides improved performance through cipher block reuse while maintaining compatibility. Accumulates data and processes it using the cipher interface for consistency.
Source Files
¶
- errors.go
- twofish.go