-
Notifications
You must be signed in to change notification settings - Fork 0
/
docs.go
20 lines (20 loc) · 1.21 KB
/
docs.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// Package e2eenc provides functionality for end-to-end encryption using different encryption methods such as AES and ECDH.
//
// The package provides an interface 'Encryptor' which is implemented by different types of encryptors.
// Each encryptor must provide methods to Encrypt and Decrypt data, and return its Type.
//
// Currently, the package supports the following types of encryptors:
//
// - AES Encryptor: This encryptor uses AES (Advanced Encryption Standard) for encryption and decryption.
// It requires a 256-bit key which can be generated using the GenerateAESKey function.
// An instance of the AES Encryptor can be created using the NewAESEncryptor function.
//
// - ECDH Encryptor: This encryptor uses ECDH (Elliptic Curve Diffie-Hellman) for encryption and decryption.
// It can be configured with a public and/or private key using the WithPublicKey and WithPrivateKey options respectively.
// If no private key is provided, a new one will be generated.
// An instance of the ECDH Encryptor can be created using the NewECDHEncryptor function.
//
// The package also provides test functions to test the encryption and decryption functionality of each encryptor.
//
//nolint:lll
package e2eenc