Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrInvalidKeyLength = errors.New("encryption key must be 16, 24, or 32 bytes") ErrInvalidEncryptedValue = errors.New("encrypted value is not valid") )
View Source
var ConfigDefault = Config{ Next: nil, Except: []string{}, Key: "", Encryptor: EncryptCookie, Decryptor: DecryptCookie, }
ConfigDefault is the default config
Functions ¶
func DecryptCookie ¶
DecryptCookie Decrypts a cookie value with specific encryption key
func EncryptCookie ¶
EncryptCookie Encrypts a cookie value with specific encryption key
func GenerateKey ¶
GenerateKey returns a random string of 16, 24, or 32 bytes. The length of the key determines the AES encryption algorithm used: 16 bytes for AES-128, 24 bytes for AES-192, and 32 bytes for AES-256-GCM.
Types ¶
type Config ¶
type Config struct {
// Next defines a function to skip this middleware when returned true.
//
// Optional. Default: nil
Next func(c fiber.Ctx) bool
// Custom function to encrypt cookies.
//
// Optional. Default: EncryptCookie (using AES-GCM)
Encryptor func(name, decryptedString, key string) (string, error)
// Custom function to decrypt cookies.
//
// Optional. Default: DecryptCookie (using AES-GCM)
Decryptor func(name, encryptedString, key string) (string, error)
// Base64 encoded unique key to encode & decode cookies.
//
// Required. Key length should be 16, 24, or 32 bytes when decoded
// if using the default EncryptCookie and DecryptCookie functions.
// You may use `encryptcookie.GenerateKey(length)` to generate a new key.
Key string
// Array of cookie keys that should not be encrypted.
//
// Optional. Default: []
Except []string
}
Config defines the config for middleware.
Source Files
Click to show internal directories.
Click to hide internal directories.