locker

command module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 16, 2023 License: MIT Imports: 3 Imported by: 0

README

Locker

┬  ┌─┐┌─┐┬┌─┌─┐┬─┐
│  │ ││  ├┴┐├┤ ├┬┘
┴─┘└─┘└─┘┴ ┴└─┘┴└─
Store secrets on your local file system.

> specify a master password setting the env var: LOCKER_SECRET

Usage:
   locker <command>

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).

  • 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

Note

Locker can read your master secret phrase LOCKER_SECRET from the system keyring thanks to the go keyring library.

Namespaces

Namespaces are used to group and organize your secrets.

TOTP

Locker can generate Time Based OTP codes parsing TOTP urls stored under a special key named totp.

If you store a TOTP url like this:

locker put -n acme -k totp "otpauth://totp/Acme?secret=IRXW4J3UEBKGK3DMEBAW46KPNZSSC"

then whenever you need you can generate the totp code using this command:

locker totp -n acme

How To Install

MacOs

brew tap lucasepe/locker
brew install locker

or if you have already installed memo using brew, you can upgrade it by running:

brew upgrade locker

From binary 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.

  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 toolchain

go install github.com/lucasepe/locker@latest

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
internal
kv
secrets
Package secrets provides simple utilities for encrypting and decrypting data.
Package secrets provides simple utilities for encrypting and decrypting data.
stripansi
This Go package removes ANSI escape codes from strings.
This Go package removes ANSI escape codes from strings.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL