https://github.com/zyedidia/crypt
A tool for making password-protected files
https://github.com/zyedidia/crypt
Last synced: 9 months ago
JSON representation
A tool for making password-protected files
- Host: GitHub
- URL: https://github.com/zyedidia/crypt
- Owner: zyedidia
- License: mit
- Created: 2022-06-13T11:08:41.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-07-06T20:30:17.000Z (over 2 years ago)
- Last Synced: 2024-06-19T19:48:09.947Z (over 1 year ago)
- Language: Go
- Size: 20.5 KB
- Stars: 9
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Crypt: create password-protected files
Crypt is a simple tool to encrypt/decrypt files and directories and lock them
behind a password. There are three commands:
## Lock
Creates a secure `.crypt` archive from a set of files.
```
$ crypt lock file.txt
```
```
lock [OPTS] FILES:
Archive and encrypt files or directories.
-o string
output crypt file name
```
## Unlock
Extracts a `.crypt` archive.
```
$ crypt unlock file.txt.crypt
```
```
unlock [OPTS] FILE:
Decrypt and extract crypt archives.
-o string
directory to place extracted files
```
## Op
Operates in-place on a `.crypt` archive. The `op` command lets you run an
arbitrary command on the decrypted archive, available in the temporary file
system. Once complete, the files will be re-locked, including any modifications
made, and the temporarily decrypted files will be removed. For example, you can
edit an encrypted file:
```
$ crypt op file.txt.crypt micro file.txt
```
Or open an interactive shell and view/edit the files from there:
```
$ crypt op file.txt.crypt bash
```
The `-pipe` option will tell crypt to send the decrypted file contents to the
op command's stdin via a pipe rather than via the temporary file system. The
command's stdout will be written back to the file. This only works for
single-file crypt archives. The benefit of this approach is that the
decrypted file is only ever in process memory, rather than available in the
file system, which makes it more secure. For example to edit a file with micro and `-pipe`:
```
$ crypt op -pipe file.txt.crypt micro
```
```
op FILE COMMAND:
Operate on a crypt file.
-pipe
pipe encrypted file instead of using temp files
```
# Install
Prebuilt binary (see releases):
```
eget zyedidia/crypt
```
From source:
```
go install github.com/zyedidia/crypt@latest
```