pit
Owner: IIIlllIIIllI URL: git@github.com:nyangkosense/pit.git
Update readme.md
Commit 49cbbb917fa89e3e4f3f0bd6c3e57bb37bf54bae by nyangkosense <102849993+nyangkosense@users.noreply.github.com> on 2024-12-03 12:36:51 +0100
diff --git a/readme.md b/readme.md
index 4a53ada..4ca0a01 100644
--- a/readme.md
+++ b/readme.md
@@ -1,6 +1,7 @@
-# pit - minimal encrypted container manager
+# pit - create and manage encrypted containers
-Need a simple way to keep your stuff private? `pit` is a minimalist encrypted container manager written in C. Think of it as a digital safe: create encrypted containers, toss your files in, and lock them up. It's like `tomb` but way more minimal - about ~1000 lines of C code.
+Need a simple way to keep your data private? `pit` is a minimalist encrypted container manager written in C.
+Create encrypted containers, toss your files in, and lock them up. It's like `tomb` but way more minimal - about ~1000 lines of C code.
## Why would you want this?
@@ -10,9 +11,9 @@ Ever needed to:
- Have a secure place for your none of your business stuff?
- Just want a simple, trustworthy way to encrypt files?
-`pit` gives you encrypted containers without the complexity. No fancy features, no bloat - just secure storage that you can actually understand and audit. If you're the kind of person who appreciates simple, well-written tools and cares about security without going full paranoid, this might be for you.
+`pit` gives you encrypted containers without the complexity. No fancy features, no bloat, no Qt and the like - just secure storage that you can actually understand and audit. If you're the kind of person who appreciates simple, well-written tools and cares about security without going full paranoid, this might be for you.
-Think of it as a minimal, no-nonsense approach to file encryption. It won't protect you from three-letter agencies, as that might require hw locked keys etc. but it'll keep your sensitive files secure from most threats while being simple enough that you can read and understand the entire code in one sitting.
+Think of it as a minimal, no-nonsense approach to file encryption. It won't protect you from three-letter agencies, as that might require hw locked keys etc. but it'll keep your sensitive files secure from most threats while being simple enough that you can read and understand the entire code.
## Overview
@@ -59,34 +60,6 @@ Think of it as a minimal, no-nonsense approach to file encryption. It won't prot
- No key backup mechanism
- No filesystem integrity verification
-## Requirements
-- libsodium
-- libcryptsetup
-- sudo or doas
-
-### Debian/Ubuntu-based
-sudo apt update && sudo apt install libsodium-dev libcryptsetup-dev sudo doas
-
-### Red Hat/CentOS/Fedora-based
-sudo dnf install libsodium-devel cryptsetup-devel sudo doas
-
-### Arch Linux-based
-sudo pacman -S libsodium cryptsetup sudo doas
-
-### OpenSUSE-based
-sudo zypper install libsodium-devel cryptsetup-devel sudo doas
-
-### Gentoo
-sudo emerge libsodium cryptsetup sudo doas
-
-### Alpine Linux
-sudo apk add libsodium-dev cryptsetup-dev sudo doas
-
-## Installation
-```bash
-make
-sudo make install
-```
## Usage
```bash
@@ -104,6 +77,26 @@ pit close container.pit
pit panic
```
+## Requirements
+- libsodium
+- libcryptsetup
+- sudo or doas
+
+#### Debian/Ubuntu
+```sudo apt update && sudo apt install libsodium-dev libcryptsetup-dev```
+
+#### Red Hat/CentOS/Fedora
+```sudo dnf install libsodium-devel cryptsetup-devel```
+
+#### Arch Linux
+```sudo pacman -S libsodium cryptsetup```
+
+#### Gentoo
+```sudo emerge libsodium cryptsetup```
+
+#### Alpine Linux
+```sudo apk add libsodium-dev cryptsetup-dev```
+
## Security Considerations
1. your system should have:
@@ -117,16 +110,28 @@ pit panic
- Hardware keyloggers
3. key files are protected but:
- - Need secure storage
+ - Eventually need secure storage
- No backup mechanism
- No recovery option if lost
-## Comparison to other software
+## Comparison to other tools
- Pure C implementation vs shell scripts
-- More minimal (~1000 LOC vs ~4000 or more LOC)
+- More minimal (~1000 LOC vs ~4000 or more, no GUI dependencies)
- Fewer features but more auditable
- No steganography or advanced features
- Focus on core container operations
+## Installation
+```bash
+make
+sudo make install
+```
+
+## To do
+- Make pit for the truly paranoid
+- Add swap space verification
+- Perhaps add backing up keys
+- Fs integrity checks
+
## License
MIT