vault

Documentation

Overview

Package vault utilizes age package for secure data encryption and decryption.

Index

• Constants
• Variables
• func Decode(file, pass string) ([]byte, error)
• func Encode(file, pass string, value interface{}) error
• func IsVaultExist() (string, bool)
• func NewVault(pass string, value interface{}) (string, error)

Constants

const (
	Perm600 = 0o600 // For secret files.
	Perm700 = 0o700 // For sensitive files or directories.
)

Variables

var (
	File = "vault"  // Default vault file name.
	Dir  = ".skunk" // Default vault directory.
)

Functions

func Decode

func Decode(file, pass string) ([]byte, error)

Decode decrypts the specified file using the given passphrase. It returns the decrypted data as a byte slice. It returns error if the decryption or file operations fail.

func Encode

func Encode(file, pass string, value interface{}) error

Encode encrypts given value and writes it to the specified file using the given passphrase. It returns an error if the encryption or file operations fail.

func IsVaultExist

func IsVaultExist() (string, bool)

IsVaultExist checks if the vault file exists and returns the path.

func NewVault

func NewVault(pass string, value interface{}) (string, error)

NewVault creates a new vault file with the provided password and initial value. It return the vault file path.