envelope

package

v0.3.0 Latest Latest Go to latest Published: Jul 13, 2026 License: MPL-2.0 Imports: 9 Imported by: 0

Details

Package envelope provides PBKDF2-SHA256 + AES-256-GCM password-based encryption in a versioned JSON format compatible with the Web UI crypto.js.

Empty password is accepted and produces a valid envelope — callers that want to skip encryption should check the password before calling Seal.

This section is empty.

View Source

var ErrWrongPassword = errors.New("envelope: wrong password")

ErrWrongPassword is returned by Open when decryption fails due to a bad password.

func IsEnvelope(s string) bool

IsEnvelope reports whether s looks like a sealed envelope JSON.

func Open(envelopeJSON string, password string) ([]byte, error)

Open decrypts a JSON envelope string. Returns ErrWrongPassword when the password is incorrect (AES-GCM authentication failure).

func Seal(plaintext []byte, password string) (string, error)

Seal encrypts plaintext with password and returns a JSON envelope string.

This section is empty.