incypher
v0.10.0
Published
An encrypted keystore intended to store crypto keys, seed phrases, passwords, files and other sensitive data
Downloads
24
Maintainers
Readme
Incypher
An encrypted keystore intended to store crypto keys, seed phrases, passwords, files and other sensitive data
Install with NodeJS
If you use NodeJS you can install the npm package for command line use:
npm install incypher --global
Install pre-built binaries
Don't know what NodeJS is? You can use the pre-built binaries instead! Download the executables from the latest release
Usage
Interactive mode
incypher
Command line mode
Store seed phrase or keys
incypher store bitcoin
incypher store seed/bitcoin
View seed phrase or key in console
incypher view bitcoin
incypher view seed/bitcoin
Open seed phrase or key with file system default
incypher open bitcoin
incypher open seed/bitcoin
List stores
incypher list
Delete store(s)
incypher delete bitcoin
incypher delete seed/bitcoin
incypher delete seed
Import file
incypher import ./bitcoin.txt
incypher import ./bitcoin.txt seed/bitcoin
Export file
incypher export bitcoin
incypher export seed/bitcoin ./bitcoin.txt
Change password
incypher password
Secure erase
incypher erase ./bitcoin.txt
incypher nuke
Edit config
incypher config
Cloud sync
Incypher supports syncing your encrypted keystore to the cloud making it easy to use across multiple platforms!
The config contains commands to init
, upload
and download
using rclone by default. We recommend using rclone as it can connect to many different cloud providers as well as virtual backends that can add additional encryption, chunking and compression.
Enabling cloud sync
Follow the steps below to enable cloud sync:
- Install and configure rclone
- Add
rclone
to yourPATH
- Run
incypher config
to edit the config file - Update
sync
.enabled
: totrue
Optionally you can customize the init
, upload
and download
commands in the config file to suit your needs.
Build
If you prefer you can build the binaries yourself:
- Install NodeJS
cd
to the code directorynpm install
npm run build
Binaries will be output to the build
directory
Encryption Details
Incypher creates an archive then encrypts the data using AES-256-GCM as follows
- A 12-byte initial IV (Initialization Vector) is generated via a cryptographically secure random bytes generator and is written to the file header
- A 32-bit currentIncrement value starts at random (0-65535) and increments once each time we encrypt and is written to the file header
- A deterministic IV is constructed via the starting IV, a fixed value and the currentIncrement value
- The deterministic IV function follows NIST SP-800-38D: 8.2.1 Deterministic Construction
- This ensures that we do not reuse the same IV and it cannot be predicted per AES-GCM specifications
- A 16-byte random salt is generated via a cryptographically secure random bytes generator and is written to the file header
- The random salt is then combined with the user passphrase and hashed via scrypt to generate the 256-bit encryption key
- Encryption takes place using AES-256-GCM and the resulting GCM integrity tag is appended to the end of the ciphertext
Notes
- You can override the default config directory location by creating an environment variable called
INCYPHER_HOME
- You can optionally drag-and-drop file(s) on the executable to import them directly
- You can disable encryption by passing an empty passphrase (not recommended). With encryption disabled you can open the store.incypher file with your favorite zip archiver
Portable mode
Create a directory called ".incypher" in the same directory as the executable. Doing so will use this directory for the config and keystore instead of the default location. Useful for running from a USB drive.