turbocrypt README

The project's README from github.com/jedisct1/turbocrypt. As one markdown file: README.md.

TurboCrypt Logo

TurboCrypt

A universal file encryption tool.

TurboCrypt encrypts anything from a single document to a whole directory of backups. You can also use it to open encrypted folders as local volumes or keep private files in a public Git repository.

Install TurboCrypt

On macOS, install the signed universal binary with Homebrew. Trust the tap first, then install:

brew trust jedisct1/turbocrypt
brew install jedisct1/turbocrypt/turbocrypt

You can also download the archive for your system from the releases page, extract it, and put turbocrypt somewhere on your PATH.

If you'd rather build it yourself, install the master version of Zig, then run:

git clone https://github.com/jedisct1/turbocrypt.git
cd turbocrypt
zig build --release=fast

You'll find the program in zig-out/bin/. The getting started guide walks you through installation and your first encrypted files.

Encrypt your first folder

First, create a key and save it as your default:

turbocrypt keygen secret.key
turbocrypt config set-key secret.key

Keep a backup of secret.key somewhere separate from your encrypted files. You'll need that key to get them back, and anyone who has it can read them.

Now encrypt a folder, check the encrypted copy, and restore it to a new folder:

turbocrypt encrypt my-documents/ encrypted-documents/
turbocrypt verify encrypted-documents/
turbocrypt decrypt encrypted-documents/ restored-documents/

Your original files stay where they are. The same commands work on individual files, too.

Open an encrypted folder

On Linux and macOS, you can work with encrypted files through a normal folder:

mkdir -p ~/Volumes/documents
turbocrypt mount --daemon encrypted-documents/ ~/Volumes/documents

Open ~/Volumes/documents in your editor or file manager. When you're done, close the files and unmount it:

turbocrypt unmount ~/Volumes/documents

This uses FUSE and needs a one-time installation of fuse3 on Linux or fuse-t on macOS. After setup, you can mount your files without running TurboCrypt as root. On macOS, no kernel extension is needed.

For large files that change often, turbocrypt init creates a container made for random access. Files in it are read and written in encrypted chunks, so the mount keeps nothing in memory and has no file-size limit:

turbocrypt init encrypted-container/
turbocrypt mount --daemon encrypted-container/ ~/Volumes/documents

See Work with an encrypted folder for setup, remote folders, file-size limits, and containers.

Keep maintainer files in Git

From an existing checkout with a default key set, choose the files that should stay private:

turbocrypt git init
turbocrypt git add NOTES.md ops/
git commit -m "Add maintainer files"

You keep editing the files at their usual paths, while Git stores encrypted copies. Other maintainers can restore them with the key; everyone else sees the public project.

The Git guide covers setup, everyday commits, and restoring private files in another clone.

More things you can do

turbocrypt (jedisct1/turbocrypt)

Searching Database…

129 ·GitHub
Turbocrypt
Что это такое?TurboCrypt — это быстрая и простая утилита для командной строки, которая шифрует и расшифровывает файлы, Git-репозитории и деревья каталогов — от одного документа до целого каталога с резервными копиями.
Это утилита для командной строки или у неё есть графический интерфейс?Это чисто утилита для командной строки: вы создаёте ключ, затем шифруете и расшифровываете файлы одной командой. О графическом интерфейсе в README ничего не говорится.
Нужно ли устанавливать что-то ещё, кроме самого TurboCrypt?Для базового шифрования и расшифровки — ничего. Для монтирования зашифрованных папок используется FUSE — достаточно один раз установить fuse3 на Linux или fuse-t на macOS; после этого монтировать можно без прав root, а на macOS расширение ядра не требуется.
Что будет, если я потеряю ключ шифрования?Файлы восстановить будет невозможно — в README советуют хранить резервную копию secret.key в отдельном месте и предупреждают, что любой, у кого он есть, сможет прочитать ваши файлы. Монтирование папок описано только для Linux и macOS.
На каких операционных системах он работает?Linux, macOS, Windows и BSD. Написан на Zig и представляет собой небольшой переносимый бинарник.
Мои файлы остаются на моём компьютере или куда-то отправляются?Всё происходит на вашем собственном компьютере: зашифрованные папки могут лежать на вашем диске или в подключённом вами удалённом хранилище, а аккаунты и облачные сервисы нигде не упоминаются.
Можно ли с его помощью хранить приватные файлы в публичном Git-репозитории?Да. Находясь в checkout с ключом по умолчанию, вы выбираете файлы, которые должны остаться приватными, и продолжаете редактировать их по привычным путям, а Git хранит их в зашифрованном виде. Другие мейнтейнеры с ключом могут их восстановить; все остальные видят только публичную часть проекта.
Что даёт монтирование зашифрованной папки?Вы открываете зашифрованную папку в привычном редакторе или файловом менеджере и читаете и редактируете файлы как обычно, при этом они остаются зашифрованными. Для больших файлов, которые часто меняются, turbocrypt init создаёт контейнер с произвольным доступом, записываемый зашифрованными блоками, без ограничения на размер файла и без хранения данных в памяти.
Какие криптографические примитивы он использует?Argon2, AEGIS, HCTR2 и TurboSHAKE — современные конструкции, и в README говорится, что небезопасных вариантов «на всякий случай» в запасе нет.
Что в документации рассказано про повседневное использование?Скрытие имён файлов, исключение файлов, проверку резервных копий, отправку файла, восстановление из копии, выбор ключа по умолчанию и резервное копирование ключей, чтобы ваши данные оставались восстановимыми.
What are similar projects?cryptomator, eza, diff-so-fancy, cz-cli, lane, nullclaw, hexyl, autojump
Which topics is it in?file, fuse, turbo, zig, parallel, portable, filesystem, version-control, cryptography, foss, lightweight, backup
Creator
jedisct1
Size
1 MB
Stars
129
Updated
CommitOct 05Release0.9.8Oct 05
Age
11mo
Commits · 90 Days