https://github.com/lucasepe/locker
Store secrets on your local file system.
https://github.com/lucasepe/locker
golang keyrings localstorage secrets-manager standalone
Last synced: 2 months ago
JSON representation
Store secrets on your local file system.
- Host: GitHub
- URL: https://github.com/lucasepe/locker
- Owner: lucasepe
- License: mit
- Created: 2023-03-07T20:46:58.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-04-16T08:05:46.000Z (about 2 years ago)
- Last Synced: 2025-01-23T16:46:55.762Z (4 months ago)
- Topics: golang, keyrings, localstorage, secrets-manager, standalone
- Language: Go
- Homepage:
- Size: 76.2 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Locker
```txt
┬ ┌─┐┌─┐┬┌─┌─┐┬─┐
│ │ ││ ├┴┐├┤ ├┬┘
┴─┘└─┘└─┘┴ ┴└─┘┴└─
Store secrets on your local file system.
> specify a master password setting the env var: LOCKER_SECRET
Usage:
locker
Commands:
delete Delete one or all secrets from a namespace.
get Get one, some or all secrets from a namespace.
help Show a list of all commands or describe a specific command.
import Import secrets.
info Print build information and list all existing lockers.
list List all namespaces or all keys in a namespace.
put Put a secret into a namespace.
totp Generate a time-based OTP from a 'totp' key into a namespace.
```
A Locker is a store on your file system (built on top of the amazing [bbolt](https://github.com/etcd-io/bbolt)).
- create as many lockers as you need
## Secret
Secrets are credentials, tokens, secure notes, credit cards, and any info you want.
- a secret has a key and a value
- create unlimited number of secrets
- organize secrets into namespaces
- secrets are encrypted and decrypted automatically
- using the environment variable `LOCKER_SECRET` with your master secret phrase
- encryption will be done using [AES-256-CFB](https://it.wikipedia.org/wiki/Advanced_Encryption_Standard)
### Using Keyring for master secret
Locker can read your master secret phrase `LOCKER_SECRET` from the system keyring thanks to the [go keyring library](https://github.com/zalando/go-keyring).
#### On macOs
1. Open the Keychain Access app on your Mac.
2. Create the password `LOCKER_SECRET` in the Keychain, save it.
3. Double-click the `LOCKER_SECRET` password in the Keychain window under the Kind column, then click Access Control.
4. To give `locker` commandline tool access to this password: click the "Add" button, then navigate to the _/path/where/you/saved/locker/binary_ and click "Save Changes"
- if you installed `locker` using brew, the binary will be located at _/opt/homebrew/Cellar/locker/x.y.z./bin/_ (where x.y.z. is the release version).
## Namespaces
Namespaces are used to group and organize your secrets.
## TOTP
Locker can generate [Time Based OTP](https://en.wikipedia.org/wiki/Time-based_one-time_password) codes parsing [TOTP urls](https://github.com/google/google-authenticator/wiki/Key-Uri-Format) stored under a special key named `totp`.
If you store a [TOTP url](https://github.com/google/google-authenticator/wiki/Key-Uri-Format) like this:
```sh
locker put -n acme -k totp "otpauth://totp/Acme?secret=IRXW4J3UEBKGK3DMEBAW46KPNZSSC"
```
then whenever you need you can generate the totp code using this command:
```sh
locker totp -n acme
```
# How To Install
## MacOs
```sh
brew tap lucasepe/locker
brew install locker
```
or if you have already installed memo using brew, you can upgrade it by running:
```sh
brew upgrade locker
```
## From [binary releases](https://github.com/lucasepe/locker/releases) (macOS, Windows, Linux)
memo currently provides pre-built binaries for the following:
- macOS (Darwin)
- Windows
- Linux
1. Download the appropriate version for your platform from [locker releases](https://github.com/lucasepe/locker/releases).
2. Once downloaded unpack the archive (zip for Windows; tarball for Linux and macOS) to extract the executable binary.
3. If you want to use from any location you must put the binary executable to your `Path` or add the directory where is it to the environment variables.
## Using [`Go`](https://go.dev/dl/) toolchain
```sh
go install github.com/lucasepe/locker@latest
```