encrypt

package

v1.2.35 Latest Latest Go to latest Published: Apr 5, 2026 License: Apache-2.0 Imports: 12 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/capsohq/bifrost

Links

Open Source Insights

Documentation ¶

Overview ¶

Package encrypt provides reversible AES-256-GCM encryption and decryption utilities for securing sensitive data like API keys and credentials.

Index ¶

Variables
func CompareHash(hash string, password string) (bool, error)
func Decrypt(ciphertext string) (string, error)
func Encrypt(plaintext string) (string, error)
func Hash(password string) (string, error)
func HashSHA256(value string) string
func Init(key string, _logger schemas.Logger)
func IsEnabled() bool

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrEncryptionKeyNotInitialized = errors.New("encryption key is not initialized")

Functions ¶

func CompareHash ¶

func CompareHash(hash string, password string) (bool, error)

CompareHash compares a hash and a password

func Decrypt ¶

func Decrypt(ciphertext string) (string, error)

Decrypt decrypts a base64-encoded ciphertext using AES-256-GCM and returns the plaintext

func Encrypt ¶

func Encrypt(plaintext string) (string, error)

Encrypt encrypts a plaintext string using AES-256-GCM and returns a base64-encoded ciphertext

func HashSHA256 ¶

func HashSHA256(value string) string

HashSHA256 returns a deterministic hex-encoded SHA-256 hash of the input. Used for hash-based lookups on encrypted columns (e.g., virtual key value, session token).

func Init ¶

func Init(key string, _logger schemas.Logger)

Init initializes the encryption key using Argon2id KDF to derive a secure 32-byte key from the provided passphrase. This ensures strong entropy regardless of passphrase length. The function accepts any passphrase but warns if it's too short (< 16 bytes).

func IsEnabled ¶

func IsEnabled() bool

IsEnabled returns true if the encryption key has been initialized

Types ¶