README
¶
Secretly
Secretly is a golang package that allows you to store and retrieve secrets such as api keys on your local machine in an encrypted file.
Basic Use
- Open a vault (a file where your secrets are stored)
v, err := FileVault("test4.json", FileVaultOptions{CreateNew: true})
if err != nil {
log.Fatal(err)
}
- Store your secret
err = v.Set("password", "jghdbsh878yrjr98fni", "Gbola") //keyname, keyvalue, encryption key
if err != nil {
log.Fatal(err)
}
- Retrieve your secret
value, err := v.Get("password", "Gbola") //keyname, encryption key
if err != nil {
log.Fatal(err)
}
fmt.Println(value) //jghdbsh878yrjr98fni
Contributing
This package is open to contributions. Just create and issue and make a pull request!
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type FileVaultOptions ¶
type FileVaultOptions struct {
CreateNew bool
}
FileVaultOptions defines options for the FileVault function
type Vault ¶
type Vault struct {
FilePath string
// contains filtered or unexported fields
}
Vault represents a vault where api keys and similar sensitive information can be stored and retrieved. To open a vault, use FileVault
func FileVault ¶
func FileVault(filePath string, options FileVaultOptions) (Vault, error)
FileVault takes in an encoding key(similar to a password) and file path to the vault. If both parameters are correct and valid, a vault is returned.
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.