From 07d2c5fd043fbbed6ebc9726a2309a273d95fd44 Mon Sep 17 00:00:00 2001 From: Randall Winkhart Date: Fri, 19 Jul 2024 03:17:30 -0400 Subject: [PATCH] Update README.md --- README.md | 56 +++++++++++++++++++++++++++++-------------------------- docs/man | 2 +- 2 files changed, 31 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index dd7d36e..3912a67 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,45 @@ # MUTN Password Manager Pronounced as: "mutton", "muh·tn" -MUTN is a simple, self-hosted, SSH-synchronized password manager based on libmutton. It is the successor to [sshyp](https://github.com/rwinkhart/sshyp). +MUTN is a simple, self-hosted, SSH-synchronized password and note manager based on libmutton. It is the successor to [sshyp](https://github.com/rwinkhart/sshyp). > [!WARNING] >It is your responsibility to assess the security and stability of MUTN and to ensure it meets your needs before using it. >I am not responsible for any data loss or breaches of your information resulting from the use of MUTN. >MUTN is a new project that is constantly being updated, and though safety and security are priorities, they cannot be guaranteed. +# Demo +![mutn-demo.webp](https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/extra/mutn-vhs/mutn-demo.webp) + # Mission Statement -MUTN aims to make it as simple as possible to manage passwords and notes via CLI across multiple devices in a secure, self-hosted fashion. +MUTN aims to make it as easy as possible to manage passwords and notes via CLI across multiple devices in a secure, self-hosted fashion. # Building See the [building guide](https://github.com/rwinkhart/MUTN/blob/main/wiki/MUTN/build.md). # Roadmap -#### Release v0.2.0 - Make repo public - No binaries -- Add fail-specific error codes -- Address most TODOs -- Hunt and fix bugs in preparation for public debut -#### Release v0.2.1 - No binaries -- Replace init with interactive ttyPod-based menu -#### Release v0.3.0 - x86_64_v1 binary -- Swap to native encryption, remove GPG support -#### Release v0.4.0 - x86_64_v1 binary -- Password aging support - - Add password aging info to entry names - - Make constant character count to easily trim for user interaction -#### Release v1.0.0 - Distribution packages (from here on out) -- Perform extensive testing, fixing, and optimizing -- Create artwork -- Create manpage -- Create packaging script -#### Release v1.1.0 -- Cascading encryption support -#### Release v1.2.0 -- Custom color scheme support -#### Release v1.3.0 -- Add build option for breaking markdown support and menus into separate binaries - - Greatly reduces startup time \ No newline at end of file +#### Release v0.2.1 +- [ ] Only run getSSHClient once to prevent being asked for keyfile password multiple times + - [ ] After this, handle all errors in client.go +- [ ] Ensure all config files and entry files are created with 0600 permissions +- [ ] Add fail-specific error codes +- [ ] Split into separate repos + 1. libmutton + 2. libmutton-server + 3. MUTN +#### Release v0.3.0 +- [ ] Replace Glamour with a more minimal Markdown renderer (likely custom) +#### Release v0.4.0 +- [ ] Swap to native (cascade) encryption (custom) +- [ ] Implement "netpin" (quick-unlock) with new encryption +#### Release v0.5.0 +- [ ] Password aging support + - [ ] Append UNIX timestamp to entry names + - [ ] Add yellow/red dot indicators to entry list readout for when passwords should be changed +#### Release v0.6.0 +- [ ] Re-implement init menu +- [ ] Implement tweak menu +- [ ] Add refresh/re-encrypt functionality +#### Release v1.0.0 - Distribution packages +- [ ] Create packaging scripts +- Perform extensive testing diff --git a/docs/man b/docs/man index eaf9573..6539698 100644 --- a/docs/man +++ b/docs/man @@ -1,7 +1,7 @@ .TH MUTN 1 "16 July 2024" "v0.2.A" "MUTN man page" .SH NAME -\fBmutn\fR - Simple, self-hosted, SSH-synchronized password management based on libmutton. It is the successor to sshyp. +\fBmutn\fR - Simple, self-hosted, SSH-synchronized password and note management based on libmutton. It is the successor to sshyp. .SH SYNOPSIS Usage: mutn [/ [argument] [option]] | [argument]