Update documentation for release v1.5.1

Former-commit-id: d9721cfcc36cc53f2719f0c57c3c5c58578e3eb1
Former-commit-id: 9e3bba69e4d4e8d074b3882b56f2221aa7edd6ad

.gitignore

@@ -0,0 +1 @@
+*

README.md

@@ -1,7 +1,7 @@
 ![sshyp](https://github.com/rwinkhart/sshyp-labs/blob/main/extra/artwork/sshyp-banner.png)
 
 [![release](https://img.shields.io/github/v/release/rwinkhart/sshyp)](https://github.com/rwinkhart/sshyp/releases)
-![python](https://img.shields.io/badge/python-3.7--3.11-yellow)
+![python](https://img.shields.io/badge/python-3.7--3.12-yellow)
 [![downloads](https://img.shields.io/github/downloads/rwinkhart/sshyp/total)](https://github.com/rwinkhart/sshyp/releases)
 
 [![CodeQL](https://github.com/rwinkhart/sshyp/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/rwinkhart/sshyp/actions/workflows/codeql-analysis.yml)
@@ -12,8 +12,6 @@ sshyp is a very simple self-hosted, synchronized password manager for UNIX(-like
 
 sshyp is compatible with entries created by pass/password-store, as its original goal was to be like pass/password-store, but far more user-friendly to synchronize with a self-hosted server.
 
-sshyp is (as of writing) the only password-store compatible CLI password manager available for Haiku.
-
 sshyp makes use of a custom sftp wrapper, called sshync (ssh+sync), to reliably sync user entries with a local or remote server.
 
 The name "sshyp" is a combination of its syncing library, "sshync", and "passwords".
@@ -23,6 +21,8 @@ It is your responsibility to assess the security and stability of "sshyp" before
 I am not responsible for any data loss or breaches of your information resulting from the use of "sshyp".
 "sshyp" is a new project that is constantly being updated, and though safety and security are priorities, they cannot be guaranteed.
 
+Always check the [known bugs](https://github.com/rwinkhart/sshyp/wiki/Known-Bugs) list before updating or installing sshyp.
+
 # Mission Statement
 sshyp aims to make it as simple as possible to manage passwords and notes via CLI across multiple devices in a secure, self-hosted fashion.
 
@@ -33,26 +33,22 @@ What sshyp can do:
 - securely sync said passwords and notes seamlessly between devices (or just manage them offline)
 - utilize [extensions](https://github.com/rwinkhart/sshyp-labs) to interact with your entries is additional ways (such as generating TOTP keys or managing your entries in a GUI)
 - everything above with entries created by pass/password-store!
-- everything above on Haiku, FreeBSD, Linux, and Termux (an Android terminal emulator)!
-
-What sshyp definitely won't do:
-
-- Non-UNIX(-like) support, e.g. Windows (I'd be happy to link to third-party ports, if someone were to make them)
+- everything above on Haiku, FreeBSD, Linux, and Termux!
 
 # Installation
+**Important:** *Shell completions (both Bash and ZSH) may require additional configuration on some distributions - please see [this page](https://github.com/rwinkhart/sshyp/wiki/Completions) of the wiki for support.*
+
 Please see the [installation guide](https://github.com/rwinkhart/sshyp/wiki/Installation) in the sshyp wiki for directions specific to your distribution/OS.
 
-Pre-built packages exist for Haiku, FreeBSD, Alpine Linux, Arch Linux, Debian/Ubuntu Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
+Pre-built packages exist for Haiku, FreeBSD, Alpine Linux, Debian/Ubuntu Linux, Fedora Linux, Termux, and WSL. These can be downloaded from the releases page.
 
-Requests for additional distribution/OS support can be filed as issues.
+Additionally, sshyp is distributed on the AUR.
 
-Extensions are available in the [sshyp-labs](https://github.com/rwinkhart/sshyp-labs) repository.
+Extensions can be installed from the `sshyp tweak` menu on most supported platforms.
 
-Bash completions can be enabled by installing your distribution's "bash-completion" package and restarting your terminal.
+For Haiku and Termux, extensions must instead be installed through the [system package manager](https://github.com/rwinkhart/sshyp-labs/releases).
 
 # Building
-Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation.
-
 A packaging script is included in the root directory of the repo in order to package sshyp for your distribution. To package sshyp from source, simply run:
 
 ```
@@ -61,44 +57,30 @@ cd sshyp
 ./package.sh [target] <revision>
 ```
 
-The packaging script has been tested on Arch Linux with "dpkg" as a dependency for Debian/Ubuntu and Termux packaging and "freebsd-pkg" as a dependency for FreeBSD packaging.
+The packaging script has been tested on Arch Linux with "dpkg" as a dependency for Debian/Ubuntu/Termux packaging and "freebsd-pkg" as a dependency for FreeBSD packaging.
 
 Haiku and Fedora packaging must be done on their own respective distributions.
 
-The AUR version and the packages attatched to the release tags were already packaged using this script.
+The AUR version and the packages attached to the release tags were already packaged using this script.
 
-Currently, the script can create packages for Haiku, FreeBSD, Alpine Linux (APKBUILD), Arch Linux (PKGBUILD), Debian/Ubuntu Linux, Fedora Linux, Termux, and generic.
+Currently, the script can create packages for Haiku, FreeBSD, Alpine Linux (APKBUILD), Arch Linux (PKGBUILD), Debian/Ubuntu Linux, Fedora Linux, Termux, and WSL.
 
 # Usage
-Upon initial installation (on both the server and client devices), be sure to run:
+Upon initial installation (on both the server and client devices), run `sshyp init` to configure the settings necessary for sshyp to function.
 
-```
-sshyp tweak
-```
+In order to configure optional settings or change already configured settings, run `sshyp tweak`.
 
-This command will allow you to configure the settings necessary for sshyp to function. To ensure configuration compatibility, it is a good idea to run 'sshyp tweak' after each major update.
+Please note that decrypting and reading entries is disabled on server devices for security reasons. Only devices configured as clients can use the GPG key to decrypt entries.
 
-Please note that decrypting and reading entries is disabled on server devices for security reasons. Only devices configured as clients can use the gpg key to decrypt entries.
-
-All available options can be found with:
-
-```
-sshyp --help
-```
-
-Or alternatively, in the manpage:
-
-```
-man sshyp
-```
+All available options can be found with `sshyp help`, or alternatively, in the man page.
 
 # Roadmap
 Short-term Goals:
 
-- a minimal GUI app - being made as an [extension](https://github.com/rwinkhart/sshyp-labs)
-- improved extension integration (allow extensions to add new arguments)
+- implement a method for tracking how long it has been since a password has been changed (password aging)
+- find and fix more bugs
 
 Long-term Goals:
 
-- a fun surprise
+- migrate from gpg to a better-suited utility focused on symmetric cipher encryption
 - seize the thrones, shear the humans

commit.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+git add -f extra lib/sshyp.py lib/sshync.py lib/stweak.py lib/clipclear.py port-jobs share LICENSE README.md package.sh commit.sh .gitignore
+git commit -m "$1"
+git push

extra/changelog-archive/2021

@@ -0,0 +1,460 @@
+sshyp 2021.12.01.fr2.2
+
+The Lighter Update - Patch 2
+
+This release is a hotfix for 2021.12.01.fr2.1.
+
+Changes:
+
+- a major fix for "/var/lib/sshync_database" needing to already exist server-side
+- a major fix for syncing functionality  (it should actually work now)
+- silenced some sftp output
+
+An fr2.3 patch is planned for this version. It will include the following:
+
+- fixes for any new bugs that may be discovered in the new sshyp and sshync code
+- the gen command in sshyp will be updated to use the newer notetaking system
+- printing functions in sshyp will be combined into one function (arguments will determine section to print)
+- file not found exceptions will be re-implemented
+- when syncing, a check will be made to see if any folders are not on all devices and this will be corrected
+
+Planned for next major update (The Fluffier Update):
+
+- new visual features
+    ^ this includes the new file list and thematic text art. sshyp will be
+    getting a retro computing theme.
+- packages for more environments
+    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
+    Debian/Ubuntu and Fedora packaging will come later.
+- imporove password generator to guarantee more secure results
+
+Planned for next, next major update (The Shears Update Pt. 1):
+
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- allow for multi-client deletion... somehow
+- detatch sshync and make it a separate package
+- manpage
+
+Planned for next, next, next major update (The Shears Update Pt. 2):
+
+- ability to pass entries as arguments for more functions
+- auto-completion on tab (currently unsure of best way to make this work)
+
+Backlog:
+
+- package for more Linux distributions, such as Debian and Fedora
+- create separate gui frontend targetting mobile and desktop Linux
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2021.12.01.fr2.1
+
+The Lighter Update - Patch 1
+
+This release is a hotfix for 2021.12.01.fr2.
+
+Changes:
+
+- fixed a bug where "sshyp tweak" would not function on new installations
+- moved the argument parser to the global process
+- running "sshyp version" or "sshyp -v" no longer triggers syncing
+- folders are now created natively with Python, rather than through system commands
+
+An fr2.2 patch is planned for this version. It will include the following:
+
+- fixes for any new bugs that may be discovered in the new sshyp and sshync code
+- the gen command in sshyp will be updated to use the newer notetaking system
+- printing functions in sshyp will be combined into one function (arguments will determine section to print)
+- file not found exceptions will be re-implemented
+
+Planned for next major update (The Fluffier Update):
+
+- new visual features
+    ^ this includes the new file list and thematic text art. sshyp will be
+    getting a retro computing theme.
+- packages for more environments
+    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
+    Debian/Ubuntu and Fedora packaging will come later.
+- imporove password generator to guarantee more secure results
+
+Planned for next, next major update (The Shears Update Pt. 1):
+
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- allow for multi-client deletion... somehow
+- detatch sshync and make it a separate package
+- manpage
+
+Planned for next, next, next major update (The Shears Update Pt. 2):
+
+- ability to pass entries as arguments for more functions
+- auto-completion on tab (currently unsure of best way to make this work)
+
+Backlog:
+
+- package for more Linux distributions, such as Debian and Fedora
+- create separate gui frontend targetting mobile and desktop Linux
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2021.12.01.fr2
+
+The Lighter Update
+
+This release features a major re-write of old "rpass" code.
+sshyp is now more reliable and better documented.
+
+New features:
+
+- a full re-write of the old "rpass" code used in the last release
+    ^ includes more reliable argument parsing and various optimizations
+- a full re-write of "sshync", many issues fixed
+    ^fixed many instances where sshync would refuse to upload/download
+    ^fixed errors that were being thrown despite sshync working as intended
+- new folders are now also created on the server
+
+Changes:
+
+- nested folders actually work now
+- multi-word entry and folder titles are fixed
+
+An fr2.1 patch is planned for this version. It will include the following:
+
+- fixes for any new bugs that may be discovered in the new sshyp and sshync code
+- the gen command in sshyp will be updated to use the newer notetaking system
+- printing functions in sshyp will be combined into one function (arguments will determine section to print)
+- file not found exceptions will be re-implemented
+- the argument parser will be moved to the global process (no need for it to be in a function)
+- folders will be created natively in python
+
+Planned for next major update (The Fluffier Update):
+
+- new visual features
+    ^ this includes the new file list and thematic text art. sshyp will be
+    getting a retro computing theme.
+- packages for more environments
+    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
+    Debian/Ubuntu and Fedora packaging will come later.
+- imporove password generator to guarantee more secure results
+
+Planned for next, next major update (The Shears Update Pt. 1):
+
+- allow for copying entire notes (not just first line)
+- allow for multi-client deletion... somehow
+- detatch sshync and make it a separate package
+- manpage
+
+Planned for next, next, next major update (The Shears Update Pt. 2):
+
+- ability to pass entries as arguments for more functions
+- auto-completion on tab (currently unsure of best way to make this work)
+
+Backlog:
+
+- package for more Linux distributions, such as Debian and Fedora
+- create separate gui frontend targetting mobile and desktop Linux
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2021.11.05.fr1
+
+First public release of sshyp.
+
+This release fixes major bugs from rpass and rebrands the project.
+
+New features:
+
+- an entirely new syncing back-end called sshync (custom Python wrapper around sftp)
+    ^ in thoery, all syncing-related data loss should now be fixed, however, this new
+    system has just been created and is still under testing. Maybe wait for a few patches
+    before trusting this system.
+
+Changes:
+
+- branding has been updated to reflect new project name and goals
+- custom directories, custom ssh keys, and offline only mode are removed (may be temporary)
+    ^ the configuration wizard is being re-written in the next major update
+
+Planned for next update (The Fluffy Update):
+
+- modularized and optimized code
+    ^ some older, bad code from "rpass" will be re-written.
+- new visual features
+    ^ this includes the new file list and thematic text art. sshyp will be
+    getting a retro computing theme.
+- packages for more environments
+    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
+    Debian/Ubuntu and Fedora packaging will come later.
+
+Planned for next update (The Sheep w/Shears Update):
+
+- allow for copying entire notes (not just first line)
+- allow for multi-client deletion... somehow
+- ability to pass entries as arguments for more functions
+- detatch sshync and make it a separate package
+- manpage
+
+Planned, no timeline:
+
+- create separate gui frontend targetting mobile devices (Android + Linux phones)
+    ^ the gui will also function on desktop linux
+- package for more Linux distributions, such as Debian and Fedora)
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass 2021.11.01.mr5.1
+
+The Notetaker Update - Patch 1
+
+This is the FINAL release of "rpass".
+After this release, the project will be rebranded as "sshyp".
+
+rpass's syncing system is fundamentally broken, hence the need for "sshyp"
+and its new syncing system. I would highly advise against using this release.
+
+New features:
+
+- none
+
+Changes:
+
+- fixed an issue with copying notes (currently only copies first line, will be changed in the future)
+- rpass is validated to work with Python 3.10 (no changes were needed)
+
+Planned for next update (sshyp fr1)
+
+- full project rebrand ("sshyp")
+- new syncing back-end
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass 2021.10.07.mr5
+
+The Notetaker Update - Fifth main release of rpass
+
+This release overhauls the note-taking system and provides general improvements
+to overall code quality, including optimizations, bug fixes, and security improvements.
+
+New features:
+
+- notes are now edited in nano and can be split across multiple lines
+- password confirmation has been added for entry deletion
+
+Changes:
+
+- fixed issues with copying passwords with certain special characters, e.g. '"()|
+- auto-generated ssh key now uses ed25519, rather than rsa-3072
+- entry format modified to include a blank line before the notes field (old format still mostly compatible)
+- rpass is now much better at catching bad arguments
+- some general code cleanup
+
+Planned for next update (The Housekeeping Update Pt. 2):
+
+- add new file list w/color and w/o extensions + proper displaying of nested folders
+- ability to pass entries as arguments for more functions
+- manpage
+- add more comments to code
+- validate for Python 3.10
+
+Planned for next update (The cryptpass Update):
+
+- initial implementation of a data store for other applications (libsecret alt.)
+- modularize code in preparation for GUI frontends
+
+Planned, no timeline:
+
+- create separate gui frontend targetting mobile devices (first Linux phones, maybe Android at a later date - official iOS client not likely)
+    ^ the gui will also function on desktop linux
+- make platform agnostic (add Windows support and package for more Linux distributions, such as Alpine and Debian)
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass 2021.09.15.mr4.2
+
+The Housekeeping Update (Pt. 1) - Hotfix 2
+
+Changes:
+
+- sync support is fixed
+- files with spaces in their names can now be properly deleted from remote servers
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass 2021.09.15.mr4.1
+
+The Housekeeping Update (Pt. 1) - Hotfix
+
+Changes:
+
+- the user is once again properly presented with a prompt to enter a gpg key when pressing enter through the config dialog
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass-2021.09.15.mr4
+
+The Housekeeping Update (Pt. 1) - Fourth main release of rpass
+
+This release focuses primarily on polishing rpass and tying up loose ends before
+making any major changes in the future.
+
+New features:
+
+- added clipboard support for copying entry information
+- many common errors are now handled with proper exceptions
+- offline support (sync no longer needs to be configured for rpass to function)
+
+Changes:
+
+- fixed gpg decryption warnings
+- added version info argument
+- re-ordered config wizard to make more sense
+- entry deletion can now be done client-side
+- removed rsyncup/rsyncdown/username/ip/port/directoryssh files,
+    ^ replaced with one file that holds usernamessh, ip, port, directoryssh, and devicetype
+- files should no longer be left in /dev/shm when an error is encountered
+- fixed issues relating to using a non-default entry directory
+- lots of optimizations have been made to reduce the size of rpass
+
+Planned for next update (The Housekeeping Update Pt. 2):
+
+- a clean, colorful entry list w/o file extensions
+- manpage
+- multi-line notes
+- commented the code
+- ability to pass entries as arguments for more functions
+- improve exceptions for unknown arguments
+
+Planned, no timeline:
+
+- possible libsecret integration
+- create separate gui frontend targetting mobile devices (first Linux phones, maybe Android at a later date - official iOS client not likely)
+    ^ the gui will also function on desktop linux
+- make platform agnostic (add Windows support and package for more Linux distributions)
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass 2021.09.07.pr3.1
+
+The Sync and Foundations Update - Hotfix
+
+Changes:
+
+- gpg configuration now prompts for expiration, rather than defaulting to two years
+- rsync is now configured to not delete anything from any remote device when uploading
+    ^ this behavior may be modified in the future - this is a quick fix to prevent data loss
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass 2021.09.07.pr3
+
+The Sync and Foundations Update - Third public release of rpass.
+
+As of this version, rpass has its intended base set of features and is considered usable.
+It will now primarily recieve bug fixes and polish updates to prepare it to go
+cross-platform and to make it compatible with GUI frontends.
+
+New features:
+
+- rsync support!
+- new entry format with URL field (for future use)
+- the temporary directory (/dev/shm) for editing entries has been somewhat secured
+
+Changes:
+
+- 'rpass edit relocate' is now properly bound
+- dropped the use of 'echo'
+- added 'rsync' and 'openssh' as dependencies
+- fixed a bug with deleting entries from folders
+- entry directory now has more secure permissions
+        ^ these permissions are re-enforced every time rpass is used
+- fixed some small typos and potential bugs, made some small optimizations
+
+Planned for next update (The Housekeeping Update):
+
+- move to github
+- get rid of gpg decryption warnings
+- proper error messages using 'except'
+- add exceptions for unknown arguments
+- cleanup file list by exporting to document and removing .gpg, adding color
+- add a manpage
+- allow notes to be multiple lines long (break lines after so many characters)
+- validate for Python 3.10
+- properly comment the code
+
+Planned, no timeline:
+
+- allow to function as alternative to gnome keyring (libsecret integration)
+- create separate gui frontend targetting mobile devices (first linux phones, maybe android at a later date - official iOS client not likely)
+    ^ the gui will also function on desktop linux
+- make platform agnostic (add windows support and package for more Linux distributions)
+- ability to pass entries as arguments for more functions
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass 2021.09.02.pr2
+
+The Folder Update - Second public release of rpass.
+
+New features:
+
+- entry and folder titles can now have spaces and be as long as you want
+- entires and folders can now be deleted with 'rpass remove' or 'rpass -rm'
+- entries now properly save to folders via 'rpass add' and should no longer throw errors
+- entries saved in folders are now readable
+- existing entries can now be moved to, from, and between folders
+- previews are now shown after creating or editing an entry
+
+Changes:
+
+- every pre-existing function of rpass has been updated to work with the new folder system
+- dropped awk as a dependency
+- removed 'argument' file in /var/lib/rpass
+- reduced unneccessary characters in argument parsing to decrease compatibility issues
+- ensured all user input is handled correctly as a string or an integer
+- lots of miscellaneous optimizations
+
+Expected for next update (The rsync Update):
+
+- rsync (over ssh) support!
+    ^ including any fixes, changes, or optimizations necessary to make that happen
+- new file formatting with support for URLs
+    ^all entries created in new format should be compatible with future versions of rpass
+- secure /dev/shm with random text generator
+
+Expected for the next (next) update (The Housekeeping Update)
+
+- get rid of gpg decryption warnings
+- proper error messages using 'except'
+- add exceptions for unknown arguments
+- cleanup file list by exporting to document and removing .gpg, adding color
+
+Planned, no timeline:
+
+- make platform agnostic (basically, add windows support)
+- create separate gui frontend targetting mobile devices (first linux phones, android at a later date)
+    ^ the gui will also function on desktop linux
+- ability to pass entries as arguments for more functions
+- auto-completion on tab
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+rpass 2021.09.01.pr1.1
+
+First public release of rpass.
+
+Early build, missing critical features (e.g. sync support and the ability to have spaces in filenames).
+
+What is currently functional:
+
+- guided configuration wizard
+- generate passwords
+- add existing passwords
+- make notes
+- sort notes and passwords into folders
+- gpg encryption
+- edit password/note entries

extra/changelog-archive/2022

@@ -703,7 +703,7 @@ Changes:
 
 - sshyp now uses a symlink to the temporary storage directory, allowing for easy implementation of different temporary directories on different platforms
     ^ the first usage of this is enabling the use of temporary storage on Termux
-- sshync now properly auto-generates its config directory 
+- sshync now properly auto-generates its config directory
 
 Additions planned for minor releases:
 
@@ -897,466 +897,3 @@ Backlog:
 
 - package for more Linux distributions, such as Debian and Fedora
 - create separate gui frontend targetting mobile and desktop Linux
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-sshyp 2021.12.01.fr2.2
-
-The Lighter Update - Patch 2
-
-This release is a hotfix for 2021.12.01.fr2.1.
-
-Changes:
-
-- a major fix for "/var/lib/sshync_database" needing to already exist server-side
-- a major fix for syncing functionality  (it should actually work now)
-- silenced some sftp output
-
-An fr2.3 patch is planned for this version. It will include the following:
-
-- fixes for any new bugs that may be discovered in the new sshyp and sshync code
-- the gen command in sshyp will be updated to use the newer notetaking system
-- printing functions in sshyp will be combined into one function (arguments will determine section to print)
-- file not found exceptions will be re-implemented
-- when syncing, a check will be made to see if any folders are not on all devices and this will be corrected
-
-Planned for next major update (The Fluffier Update):
-
-- new visual features
-    ^ this includes the new file list and thematic text art. sshyp will be
-    getting a retro computing theme.
-- packages for more environments
-    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
-    Debian/Ubuntu and Fedora packaging will come later.
-- imporove password generator to guarantee more secure results
-
-Planned for next, next major update (The Shears Update Pt. 1):
-
-- enforce permissions on the server-side
-- allow for copying entire notes (not just first line)
-- allow for multi-client deletion... somehow
-- detatch sshync and make it a separate package
-- manpage
-
-Planned for next, next, next major update (The Shears Update Pt. 2):
-
-- ability to pass entries as arguments for more functions
-- auto-completion on tab (currently unsure of best way to make this work)
-
-Backlog:
-
-- package for more Linux distributions, such as Debian and Fedora
-- create separate gui frontend targetting mobile and desktop Linux
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-sshyp 2021.12.01.fr2.1
-
-The Lighter Update - Patch 1
-
-This release is a hotfix for 2021.12.01.fr2.
-
-Changes:
-
-- fixed a bug where "sshyp tweak" would not function on new installations
-- moved the argument parser to the global process
-- running "sshyp version" or "sshyp -v" no longer triggers syncing
-- folders are now created natively with Python, rather than through system commands
-
-An fr2.2 patch is planned for this version. It will include the following:
-
-- fixes for any new bugs that may be discovered in the new sshyp and sshync code
-- the gen command in sshyp will be updated to use the newer notetaking system
-- printing functions in sshyp will be combined into one function (arguments will determine section to print)
-- file not found exceptions will be re-implemented
-
-Planned for next major update (The Fluffier Update):
-
-- new visual features
-    ^ this includes the new file list and thematic text art. sshyp will be
-    getting a retro computing theme.
-- packages for more environments
-    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
-    Debian/Ubuntu and Fedora packaging will come later.
-- imporove password generator to guarantee more secure results
-
-Planned for next, next major update (The Shears Update Pt. 1):
-
-- enforce permissions on the server-side
-- allow for copying entire notes (not just first line)
-- allow for multi-client deletion... somehow
-- detatch sshync and make it a separate package
-- manpage
-
-Planned for next, next, next major update (The Shears Update Pt. 2):
-
-- ability to pass entries as arguments for more functions
-- auto-completion on tab (currently unsure of best way to make this work)
-
-Backlog:
-
-- package for more Linux distributions, such as Debian and Fedora
-- create separate gui frontend targetting mobile and desktop Linux
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-sshyp 2021.12.01.fr2
-
-The Lighter Update
-
-This release features a major re-write of old "rpass" code.
-sshyp is now more reliable and better documented.
-
-New features:
-
-- a full re-write of the old "rpass" code used in the last release
-    ^ includes more reliable argument parsing and various optimizations
-- a full re-write of "sshync", many issues fixed
-    ^fixed many instances where sshync would refuse to upload/download
-    ^fixed errors that were being thrown despite sshync working as intended
-- new folders are now also created on the server
-
-Changes:
-
-- nested folders actually work now
-- multi-word entry and folder titles are fixed
-
-An fr2.1 patch is planned for this version. It will include the following:
-
-- fixes for any new bugs that may be discovered in the new sshyp and sshync code
-- the gen command in sshyp will be updated to use the newer notetaking system
-- printing functions in sshyp will be combined into one function (arguments will determine section to print)
-- file not found exceptions will be re-implemented
-- the argument parser will be moved to the global process (no need for it to be in a function)
-- folders will be created natively in python
-
-Planned for next major update (The Fluffier Update):
-
-- new visual features
-    ^ this includes the new file list and thematic text art. sshyp will be
-    getting a retro computing theme.
-- packages for more environments
-    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
-    Debian/Ubuntu and Fedora packaging will come later.
-- imporove password generator to guarantee more secure results
-
-Planned for next, next major update (The Shears Update Pt. 1):
-
-- allow for copying entire notes (not just first line)
-- allow for multi-client deletion... somehow
-- detatch sshync and make it a separate package
-- manpage
-
-Planned for next, next, next major update (The Shears Update Pt. 2):
-
-- ability to pass entries as arguments for more functions
-- auto-completion on tab (currently unsure of best way to make this work)
-
-Backlog:
-
-- package for more Linux distributions, such as Debian and Fedora
-- create separate gui frontend targetting mobile and desktop Linux
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-sshyp 2021.11.05.fr1
-
-First public release of sshyp.
-
-This release fixes major bugs from rpass and rebrands the project.
-
-New features:
-
-- an entirely new syncing back-end called sshync (custom Python wrapper around sftp)
-    ^ in thoery, all syncing-related data loss should now be fixed, however, this new
-    system has just been created and is still under testing. Maybe wait for a few patches
-    before trusting this system.
-
-Changes:
-
-- branding has been updated to reflect new project name and goals
-- custom directories, custom ssh keys, and offline only mode are removed (may be temporary)
-    ^ the configuration wizard is being re-written in the next major update
-
-Planned for next update (The Fluffy Update):
-
-- modularized and optimized code
-    ^ some older, bad code from "rpass" will be re-written.
-- new visual features
-    ^ this includes the new file list and thematic text art. sshyp will be
-    getting a retro computing theme.
-- packages for more environments
-    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
-    Debian/Ubuntu and Fedora packaging will come later.
-
-Planned for next update (The Sheep w/Shears Update):
-
-- allow for copying entire notes (not just first line)
-- allow for multi-client deletion... somehow
-- ability to pass entries as arguments for more functions
-- detatch sshync and make it a separate package
-- manpage
-
-Planned, no timeline:
-
-- create separate gui frontend targetting mobile devices (Android + Linux phones)
-    ^ the gui will also function on desktop linux
-- package for more Linux distributions, such as Debian and Fedora)
-- auto-completion on tab (currently unsure of best way to make this work)
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.11.01.mr5.1
-
-The Notetaker Update - Patch 1
-
-This is the FINAL release of "rpass".
-After this release, the project will be rebranded as "sshyp".
-
-rpass's syncing system is fundamentally broken, hence the need for "sshyp"
-and its new syncing system. I would highly advise against using this release.
-
-New features:
-
-- none
-
-Changes:
-
-- fixed an issue with copying notes (currently only copies first line, will be changed in the future)
-- rpass is validated to work with Python 3.10 (no changes were needed)
-
-Planned for next update (sshyp fr1)
-
-- full project rebrand ("sshyp")
-- new syncing back-end
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.10.07.mr5
-
-The Notetaker Update - Fifth main release of rpass
-
-This release overhauls the note-taking system and provides general improvements
-to overall code quality, including optimizations, bug fixes, and security improvements.
-
-New features:
-
-- notes are now edited in nano and can be split across multiple lines
-- password confirmation has been added for entry deletion
-
-Changes:
-
-- fixed issues with copying passwords with certain special characters, e.g. '"()|
-- auto-generated ssh key now uses ed25519, rather than rsa-3072
-- entry format modified to include a blank line before the notes field (old format still mostly compatible)
-- rpass is now much better at catching bad arguments
-- some general code cleanup
-
-Planned for next update (The Housekeeping Update Pt. 2):
-
-- add new file list w/color and w/o extensions + proper displaying of nested folders
-- ability to pass entries as arguments for more functions
-- manpage
-- add more comments to code
-- validate for Python 3.10
-
-Planned for next update (The cryptpass Update):
-
-- initial implementation of a data store for other applications (libsecret alt.)
-- modularize code in preparation for GUI frontends 
-
-Planned, no timeline:
-
-- create separate gui frontend targetting mobile devices (first Linux phones, maybe Android at a later date - official iOS client not likely)
-    ^ the gui will also function on desktop linux
-- make platform agnostic (add Windows support and package for more Linux distributions, such as Alpine and Debian)
-- auto-completion on tab (currently unsure of best way to make this work)
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.15.mr4.2
-
-The Housekeeping Update (Pt. 1) - Hotfix 2
-
-Changes:
-
-- sync support is fixed
-- files with spaces in their names can now be properly deleted from remote servers
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.15.mr4.1
-
-The Housekeeping Update (Pt. 1) - Hotfix
-
-Changes:
-
-- the user is once again properly presented with a prompt to enter a gpg key when pressing enter through the config dialog
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass-2021.09.15.mr4
-
-The Housekeeping Update (Pt. 1) - Fourth main release of rpass
-
-This release focuses primarily on polishing rpass and tying up loose ends before
-making any major changes in the future.
-
-New features:
-
-- added clipboard support for copying entry information
-- many common errors are now handled with proper exceptions
-- offline support (sync no longer needs to be configured for rpass to function)
-
-Changes:
-
-- fixed gpg decryption warnings
-- added version info argument
-- re-ordered config wizard to make more sense
-- entry deletion can now be done client-side
-- removed rsyncup/rsyncdown/username/ip/port/directoryssh files,
-    ^ replaced with one file that holds usernamessh, ip, port, directoryssh, and devicetype
-- files should no longer be left in /dev/shm when an error is encountered
-- fixed issues relating to using a non-default entry directory
-- lots of optimizations have been made to reduce the size of rpass
-
-Planned for next update (The Housekeeping Update Pt. 2):
-
-- a clean, colorful entry list w/o file extensions
-- manpage
-- multi-line notes
-- commented the code
-- ability to pass entries as arguments for more functions
-- improve exceptions for unknown arguments
-
-Planned, no timeline:
-
-- possible libsecret integration
-- create separate gui frontend targetting mobile devices (first Linux phones, maybe Android at a later date - official iOS client not likely)
-    ^ the gui will also function on desktop linux
-- make platform agnostic (add Windows support and package for more Linux distributions)
-- auto-completion on tab (currently unsure of best way to make this work)
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.07.pr3.1
-
-The Sync and Foundations Update - Hotfix
-
-Changes:
-
-- gpg configuration now prompts for expiration, rather than defaulting to two years
-- rsync is now configured to not delete anything from any remote device when uploading
-    ^ this behavior may be modified in the future - this is a quick fix to prevent data loss
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.07.pr3
-
-The Sync and Foundations Update - Third public release of rpass.
-
-As of this version, rpass has its intended base set of features and is considered usable.
-It will now primarily recieve bug fixes and polish updates to prepare it to go
-cross-platform and to make it compatible with GUI frontends.
-
-New features:
-
-- rsync support!
-- new entry format with URL field (for future use)
-- the temporary directory (/dev/shm) for editing entries has been somewhat secured
-
-Changes:
-
-- 'rpass edit relocate' is now properly bound
-- dropped the use of 'echo'
-- added 'rsync' and 'openssh' as dependencies
-- fixed a bug with deleting entries from folders
-- entry directory now has more secure permissions
-        ^ these permissions are re-enforced every time rpass is used
-- fixed some small typos and potential bugs, made some small optimizations
-
-Planned for next update (The Housekeeping Update):
-
-- move to github
-- get rid of gpg decryption warnings
-- proper error messages using 'except'
-- add exceptions for unknown arguments
-- cleanup file list by exporting to document and removing .gpg, adding color
-- add a manpage
-- allow notes to be multiple lines long (break lines after so many characters)
-- validate for Python 3.10
-- properly comment the code
-
-Planned, no timeline:
-
-- allow to function as alternative to gnome keyring (libsecret integration)
-- create separate gui frontend targetting mobile devices (first linux phones, maybe android at a later date - official iOS client not likely)
-    ^ the gui will also function on desktop linux
-- make platform agnostic (add windows support and package for more Linux distributions)
-- ability to pass entries as arguments for more functions
-- auto-completion on tab (currently unsure of best way to make this work)
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.02.pr2
-
-The Folder Update - Second public release of rpass.
-
-New features:
-
-- entry and folder titles can now have spaces and be as long as you want
-- entires and folders can now be deleted with 'rpass remove' or 'rpass -rm'
-- entries now properly save to folders via 'rpass add' and should no longer throw errors
-- entries saved in folders are now readable
-- existing entries can now be moved to, from, and between folders
-- previews are now shown after creating or editing an entry
-
-Changes:
-
-- every pre-existing function of rpass has been updated to work with the new folder system
-- dropped awk as a dependency
-- removed 'argument' file in /var/lib/rpass
-- reduced unneccessary characters in argument parsing to decrease compatibility issues
-- ensured all user input is handled correctly as a string or an integer
-- lots of miscellaneous optimizations
-
-Expected for next update (The rsync Update):
-
-- rsync (over ssh) support!
-    ^ including any fixes, changes, or optimizations necessary to make that happen
-- new file formatting with support for URLs
-    ^all entries created in new format should be compatible with future versions of rpass
-- secure /dev/shm with random text generator
-
-Expected for the next (next) update (The Housekeeping Update)
-
-- get rid of gpg decryption warnings
-- proper error messages using 'except'
-- add exceptions for unknown arguments
-- cleanup file list by exporting to document and removing .gpg, adding color
-
-Planned, no timeline:
-
-- make platform agnostic (basically, add windows support)
-- create separate gui frontend targetting mobile devices (first linux phones, android at a later date)
-    ^ the gui will also function on desktop linux
-- ability to pass entries as arguments for more functions
-- auto-completion on tab
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.01.pr1.1
-
-First public release of rpass.
-
-Early build, missing critical features (e.g. sync support and the ability to have spaces in filenames).
-
-What is currently functional:
-
-- guided configuration wizard
-- generate passwords
-- add existing passwords
-- make notes
-- sort notes and passwords into folders
-- gpg encryption
-- edit password/note entries

extra/changelog-archive/2023

@@ -0,0 +1,242 @@
+sshyp v1.5.1
+10/24/2023
+
+the fortified flock update - patch one
+
+this release fixes both long and short-standing bugs that managed to escape discovery in testing;
+it also addresses some issues that first-time users may be put-off by upon encountering
+
+user-facing features:
+
+- the clipboard is now only cleared if the contents of the clipboard still match what was placed onto it by sshyp
+    ^ this means that sshyp will no longer remove data from the clipboard that it did not place there
+- a warning/explanation is now provided when the user attempts to sync in offline mode
+- a readable error is now provided if the user attempts to edit a note and the specified text editor cannot be found
+- the optional configuration menu is now explained when encountered during "sshyp init"
+- the man page now includes common troubleshooting information
+
+fixes/optimizations:
+
+- custom, user-provided ssh keyfiles are now properly utilized in all cases
+    ^ previously, using custom ssh keyfiles would break various features
+- clipboard contents are no longer leaked via the process list on Wayland
+- interpolation has been disabled for ConfigParser, allowing "%" to be stored in configuration files
+- gpg keys with ":" or "\" in their names are now properly written to the configuration file
+- copy_id_check() and whitelist_verify() are now safely callable from extensions
+- the ssh key selection will no longer see "known_hosts.old" as a valid keyfile
+- when possible, data from the configuration file is now read as boolean values
+- the Haiku package has been updated to use Python 3.11
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.5.0
+07/12/2023
+
+the fortified flock update
+
+this release implements new curses-based TUI configuration menus and improves the security of sshyp
+
+compatibility-breaking changes:
+
+- a completely new configuration system calls for a new configuration file
+    ^ before using sshyp v1.5.0 for the first time, 'sshyp init' will need to be ran to create the
+    new configuration file - the old configuration files can be safely deleted
+    ^ 'sshyp tweak' has been repurposed as the configuration menu for changing individual options,
+    rather than re-doing setup entirely - after initialization, this is the one you want to use
+- the new extension manager is replacing the old method of installing extensions as system packages
+    ^ any older extensions you have installed should be uninstalled to prevent conflicts
+    ^ extensions are now installed and removed through the 'sshyp tweak' menu's extension manager
+    ^ this does not yet apply to Haiku and Termux, which will continue to install extensions using
+    the previous method
+- all clients and servers must be updated to this release for the folder renaming bug fix to work
+    ^ failure to update all devices will result in errors and/or potential data loss
+- various packaging changes
+    ^ x-clip and wl-clipboard are now marked as optional dependencies, so the correct tool will
+    need to be installed as needed - a warning has been added for this if neither package is installed
+    ^ the changelog no longer ships with sshyp - it is still available on GitHub
+
+user-facing features:
+
+- the old configuration menu, 'sshyp tweak', has been split into two new curses-based TUI menus
+    ^ 'sshyp init' is for first-time setup/initialization
+    ^ 'sshyp tweak' can be used at any time to quickly adjust individual settings
+    ^ whitelist management tools have been moved to the new 'sshyp tweak' menu
+    ^ clients and servers now each have their own dedicated 'sshyp tweak' menu
+    ^ the new config file is in .INI format, making it easier to edit the config without sshyp
+- added a 'sshyp tweak' option for re-encrypting all entries with a new gpg key
+- added a security advisory when enabling quick-unlock to ensure the user understands potential risks
+- the user is now warned if the clipboard tool relevant to their platform is not installed
+- passwords are now hidden by default in the entry reader
+    ^ they can be displayed by appending '--show' or '-s' to the end of the command
+- input is now hidden when adding/editing a password in an entry
+- entries are no longer re-encrypted and synced if the note editor is quit without saving
+
+
+fixes/optimizations:
+
+- a tmpfs is no longer used for decrypting entries unless editing notes
+    ^ data is now decrypted directly into sshyp and written to entries pre-encrypted
+    ^ this makes reading entries much more secure
+    ^ editing entries is similarly secure to before - greater improvements coming in a future update
+- folder renaming has been re-enabled and now functions as intended
+- some unnecessarily verbose outputs were silenced and/or made to appear more cleanly
+- FreeBSD packaging fixes
+    ^ no longer incorrectly includes and uses the logic for the Termux clipboard
+    ^ now specifies 'python3' dependency instead of 'python'
+- many lists provided to the subprocess module have been swapped with tuples
+- more correct and clear language is used to describe options and arguments in the help menus
+- properly display an error when attempting to copy blank fields from entries
+- shebangs have been removed from libraries not meant to be run directly
+
+other factors of note:
+
+- with the release of Debian 12 Bookworm, sshyp is once again fully supported on vanilla Debian
+    ^ previously, it was only working correctly in offline mode due to Debian 11's old OpenSSH package
+- this is the biggest release of sshyp ever
+    ^ it includes LOTS of minor changes and optimizations not included in the patch notes summary
+    ^ as such, keep an eye out for new bugs!
+- the next major release of sshyp may be even larger...
+    ^ but it is also likely very far away
+    ^ GnuPG is great, but it is inherently incompatible with sshyp's future security model
+    ^ if all goes according to plan, GnuPG will be replaced in the next release
+    ^ assuming this happens, this next release will be crowned v2.0.0
+    ^ sshyp v1.5.X is expected to be the latest stable release for a longer amount of time than usual
+    ^ sshyp v1.5.X may receive security/bug fix patches after the release of v2.0.0, as needed
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.4.3
+06/08/2023
+
+the argumentative agronomist update - patch three
+
+IMPORTANT: the next major release of sshyp, v1.5.0, will make breaking changes that will require
+running through 'sshyp tweak' again - also starting with v1.5.0, a copy of the changelog will no
+longer be packaged with sshyp (it will still be available on GitHub) and clipboard tools
+(x-clip and wl-clipboard) will be set to optional dependencies ('sshyp tweak' will warn of this)
+
+this is a highly unconventional release featuring backports to fix critical bugs found during the
+development of the upcoming v1.5.0
+
+fixes:
+
+- folder renaming has been disabled to prevent a severe data loss bug from occuring
+    ^ this has been properly fixed for v1.5.0, but the fix requires all clients and servers
+    to be updated - to avoid breaking compatibility with 1.4.X, folder renaming was simply disabled
+    for the time being
+- backported fix for syncing over IPv6
+- backported fix for multiple versions of Powershell being called under WSL
+- backported fix for checking /lib/sshyp instead of /usr/lib/sshyp
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.4.2
+04/30/2023
+
+the argumentative agronomist update - patch two
+
+IMPORTANT: the next major release of sshyp, v1.5.0, will make breaking changes that will require
+running through 'sshyp tweak' again - also starting with v1.5.0, a copy of the changelog will no
+longer be packaged with sshyp (it will still be available on GitHub) and clipboard tools
+(x-clip and wl-clipboard) will be set to optional dependencies ('sshyp tweak' will warn of this)
+
+this release makes use of a new ports framework to make sshyp even smaller and faster than before
+
+user-facing features:
+
+- full WSL (Windows Subsystem for Linux) support
+- partial MacOS support
+    ^ fully functional; packaging support has not yet been added
+- dedicated help screen for 'gen'
+    ^ this was previously not included due to 'sshyp gen' being a valid command prior to v1.4.0
+- removed interactive input for whitelist management
+    ^ this is to be consistent with the removal of interactive input on clients in v1.4.0
+
+fixes/optimizations:
+
+- leading and following spaces are no longer stripped when printing entry contents
+- properly display an error when trying to remove a device from the whitelist that is not whitelisted
+- ports framework to remove unneeded code for each platform
+    ^ BLANKS.py removes all blank lines
+    ^ CLIPBOARD.py removes non-platform-critical clipboard code
+    ^ COMMENTS.py removes all comments
+    ^ RMSERVER.py removes server-only code for creating client-only packages
+        ^ the Haiku package, which was already unsupported as a server, now only includes client code
+    ^ SHEBANG.sh sets the shebang to what is required by the platform
+    ^ TABS.sh converts all groups of spaces to tabs for space efficiency
+    ^ UNAME.py removes all instances of platform detection and leaves only the platform-required code
+    ^ THESE SCRIPTS ARE ONLY USED FOR PACKAGING AND DO NOT AFFECT THE SOURCE FILES IN THE GIT REPO
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.4.1
+
+the argumentative agronomist update - patch one
+
+this release improves sshyp's shell completions by adding zsh support and significantly optimizing and improving Bash support
+
+user-facing features:
+
+- zsh completion support
+    ^ ensure modern completions are enabled in your ~/.zshrc
+
+fixes/optimizations:
+
+- Bash completions are now much faster due to the use of recursive globbing
+- Bash completions have been modified to be functionally similar to the new zsh completions
+
+other notable changes:
+
+- some official packages now use more space-efficient compression
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.4.0
+
+the argumentative agronomist update
+
+this release overhauls sshyp's argument system and further streamlines
+the experience with optimizations and the removal of legacy features
+
+compatibility-breaking changes:
+
+- there are no technical breaking changes, but the UX has changed significantly due to the new argument system (detailed below)
+
+user-facing features:
+
+- when typing an entry/folder name, it is now always the FIRST argument
+    ^ e.g. instead of "sshyp copy -p /example/test", it would now be "sshyp /example/test copy -p"
+    ^ this allows more easily editing the previous command to copy/edit a different field
+- better extension integration
+    ^ extensions can now ship with a config file that sshyp can use to call them from standard sshyp arguments
+    ^ the first extension supporting this is sshyp-mfa
+    ^ if sshyp-mfa v1.4.0.1+ is installed, "sshyp /example/test copy -m" will copy MFA keys to your clipboard
+- entry/folder names now MUST be specified as arguments
+    ^ there is no longer a separate input prompt if the entry/folder name is not provided as an argument
+    ^ the input prompt was a legacy feature from before arguments could specify entrys/folders with shell completion
+    ^ the entry list generated by entry_list_gen() is still present and can be viewed by running "sshyp" with no arguments
+- better Bash completions
+    ^ now correctly places backslashes to escape spaces in entry/folder names
+    ^ slightly faster than the previous iteration
+- IPv6 configuration support
+
+fixes/optimizations:
+
+- replaced "+=" with ".append" when extending lists to prevent creating an additional list
+- optimized usage of "str.split()" and replaced it with "str.splitlines()" where applicable
+- more concise "if... in ()" syntax replaces long "if" statement chains
+- lists have been substituted with tuples where applicable
+- entry_list_gen() has been re-written to be much smaller and faster
+- os.path is now used in place of pathlib.Path in areas where it is faster
+- the user's home directory is saved to a variable to prevent running expanduser() every time it is needed
+
+other notable changes:
+
+- removed some uncommonly used, redundant arguments
+    ^ e.g. "-rm", "-s", "delete"
+    ^ their functionality was NOT removed, just their redundant arguments, since "shear", "sync", and "del" are the accepted syntax
+- errors containing entry/folder names reinforce correct syntax by adding leading/following slashes where necessary
+- thanks to pull request #25, there are new error messages for the read shortcut
+    ^ includes when no entry name is provided or the entry name only refers to a directory
+- directories provided in user input are no longer denoted by a following slash
+    ^ instead, os.path is used to determine if the user is referring to a file or directory

extra/completion.bash

@@ -0,0 +1,41 @@
+# sshyp(1) completion
+
+_path_gen() {
+    local sshyp_path="$HOME/.local/share/sshyp"
+    local glob_status=$(shopt -p globstar)
+    [ -z "${glob_status##*u*}" ] && shopt -s globstar  # if recursive globbing is disabled, enable it
+    local full_paths=("$sshyp_path"/**/*.gpg)
+    $glob_status  # set recursive globbing to user default
+    for scan_path in "${full_paths[@]}"; do
+      trimmed_paths+=("${scan_path:${#sshyp_path}:-4}")
+    done
+    if [ "${trimmed_paths[0]}" == '/**/*' ]; then trimmed_paths[0]=help; fi
+} &&
+
+_sshyp_completions() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+  local prev=${COMP_WORDS[COMP_CWORD-1]}
+
+  case $prev in
+    sshyp )
+      while read -r; do ITEM=${REPLY// /\\ }; COMPREPLY+=( "$ITEM" ); done < <( compgen -W "$(printf "'%s' " "${trimmed_paths[@]}")" -- "$cur" )
+      ;;
+    /* )
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "add gen edit copy shear" -- "$cur" )
+      ;;
+    add )
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "password note folder" -- "$cur" )
+      ;;
+    copy )
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "password username url note" -- "$cur" )
+      ;;
+    edit )
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "password username url note relocate" -- "$cur" )
+      ;;
+    gen )
+      while read -r; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "update" -- "$cur" )
+      ;;
+  esac
+
+} &&
+_path_gen && complete -F _sshyp_completions sshyp

extra/completion.zsh

@@ -0,0 +1,30 @@
+#compdef sshyp
+
+sshyp_path="$HOME/.local/share/sshyp"
+full_paths=("$sshyp_path"/**/*.gpg)
+trimmed_paths=()
+for scan_path in "${full_paths[@]}"; do
+    trimmed_paths+=("${${scan_path#$sshyp_path}%????}")
+done
+[[ -z $trimmed_paths ]] && trimmed_paths=(help)
+
+case ${words[-2]} in
+  sshyp )
+    compadd $trimmed_paths
+    ;;
+  /* )
+    compadd {add,gen,edit,copy,shear}
+    ;;
+  add )
+    compadd {password,note,folder}
+    ;;
+  copy )
+    compadd {password,username,url,note}
+    ;;
+  edit )
+    compadd {password,username,url,note,relocate}
+    ;;
+  gen )
+    compadd update
+    ;;
+esac

extra/manpage

@@ -1,128 +1,143 @@
-.TH sshyp 1 "14 December 2022" "v1.3.0" "sshyp man page"
+.TH sshyp 1 "24 October 2023" "v1.5.1" "sshyp man page"
 .SH NAME
-sshyp \- A very simple self-hosted, synchronized password manager for UNIX(-like) systems. Alternative to (and compatible with) pass/password-store.
+\fBsshyp\fR - Simple, self-hosted, synchronized password management for UNIX(-like) systems. Alternative to (and compatible with) pass/password-store.
 .SH SYNOPSIS
-Client Usage: sshyp [option [flag] [<entry name>]] | [/<entry name>]
+Client Usage: sshyp [/<entry name> [argument] [option]] | [argument]
 
-Server Usage: sshyp [option [flag] [<device id>]]
+Server Usage: sshyp <argument>
 .SH DESCRIPTION
 sshyp is a lightweight password and note management program written in Python. sshyp is used via CLI and is self-hosted with a client-server model. sshyp expects that you have access to a personal server with a properly configured ssh server, ideally accepting remote connections.
 .SH EXAMPLES (CLIENT)
-Setting up sshyp for the first time or altering its configuration (also recommended after major updates):
+Setting up sshyp for the first time:
+    sshyp init
+
+Altering the existing sshyp configuration:
     sshyp tweak
 
 Viewing the entry database:
     sshyp
 
-Reading an existing entry saved as ~/.local/share/sshyp/development/github.gpg:
+Reading an existing entry saved as '~/.local/share/sshyp/development/github.gpg':
     sshyp /development/github
 
-Copying the password of an existing entry saved as ~/.local/share/sshyp/financial/bank.gpg:
-    sshyp copy -p /financial/bank
+Removing an existing folder saved as '~/.local/share/sshyp/social':
+    sshyp /social shear
 
-Editing the username of an existing entry saved as ~/.local/share/sshyp/game.gpg:
-    sshyp edit -u game
+Reading the same entry without hiding the password:
+    sshyp /development/github --show
 
-Making a new entry saved as ~/.local/share/sshyp/school/university.gpg using the built-in password generator:
-    sshyp gen /school/university
+Copying the password of an existing entry saved as '~/.local/share/sshyp/financial/bank.gpg':
+    sshyp /financial/bank copy -p
 
-Creating a note-only entry saved as ~/.local/share/sshyp/notes/testNote.gpg:
-    sshyp add -n /notes/testNote
+Editing the username of an existing entry saved as '~/.local/share/sshyp/game.gpg':
+    sshyp /game edit -u
+
+Making a new entry saved as '~/.local/share/sshyp/school/university.gpg' using the built-in password generator:
+    sshyp /school/university gen
+
+Creating a note-only entry saved as '~/.local/share/sshyp/notes/test note.gpg':
+    sshyp /notes/test\ note add -n
 
 Manually syncing entries with the server:
     sshyp sync
-
-Removing an existing folder saved as ~/.local/share/sshyp/social:
-    sshyp shear social/
-.SH EXAMPLES (SERVER)
-Setting up the quick-unlock whitelist:
-    sshyp whitelist setup
-
-Checking the quick-unlock whitelist status of all registered client devices:
-    sshyp whitelist list
-
-Adding a device with the id "laptop-im|lAoa;&;r&o:ez((g/Dz;EVb.nO_" to the quick-unlock whitelist:
-    sshyp whitelist add 'laptop-im|lAoa;&;r&o:ez((g/Dz;EVb.nO_'
-
-Removing a device with the id "laptop-im|lAoa;&;r&o:ez((g/Dz;EVb.nO_" from the quick-unlock whitelist:
-    sshyp whitelist del 'laptop-im|lAoa;&;r&o:ez((g/Dz;EVb.nO_'
+.SH ARGUMENTS (CLIENT)
+ help/-h                 bring up the help menu
+ version/-v              display sshyp version info
+ init                    set up sshyp
+ tweak                   change configuration options/manage extensions and updates
+ add                     add an entry
+ gen                     generate a new password
+ edit                    edit an existing entry
+ copy                    copy details of an entry to your clipboard
+ shear                   delete an existing entry
+ sync                    manually sync the entry directory via sshync
 .SH OPTIONS (CLIENT)
- help/--help/-h           bring up the help menu
- version/-v               display sshyp version info
- tweak                    configure sshyp
- add                      add an entry
- gen                      generate a new password
- edit                     edit an existing entry
- copy                     copy details of an entry to your clipboard
- shear/-rm                delete an existing entry
- sync/-s                  manually sync the entry directory via sshync
-.SH FLAGS (CLIENT)
 add:
- password/-p              add a password entry
- note/-n                  add a note entry
- folder/-f                add a new folder for entries
+ password/-p             add a password entry
+ note/-n                 add a note entry
+ folder/-f               add a new folder for entries
 
 edit:
- rename/relocate/-r       rename or relocate an entry
- username/-u              change the username of an entry
- password/-p              change the password of an entry
- note/-n                  change the note attached to an entry
- url/-l                   change the url attached to an entry
+ rename/relocate/-r      rename or relocate an entry
+ username/-u             change the username of an entry
+ password/-p             change the password of an entry
+ note/-n                 change the note attached to an entry
+ url/-l                  change the url attached to an entry
 
 copy:
- username/-u              copy the username of an entry to your clipboard
- password/-p              copy the password of an entry to your clipboard
- url/-l                   copy the URL of an entry to your clipboard
- note/-n                  copy the note of an entry to your clipboard
+ username/-u             copy the username of an entry to your clipboard
+ password/-p             copy the password of an entry to your clipboard
+ url/-l                  copy the URL of an entry to your clipboard
+ note/-n                 copy the note of an entry to your clipboard
 
 gen:
- update/-u                generate a password for an existing entry
-.SH OPTIONS (SERVER)
- help/--help/-h           bring up this menu
- version/-v               display sshyp version info
- tweak                    configure sshyp
- whitelist                manage the quick-unlock whitelist
-.SH FLAGS (SERVER)
-whitelist:
- setup                    set up the quick-unlock whitelist
- list/-l                  view all registered device ids and their quick-unlock whitelist status
- add                      whitelist a device id for quick-unlock
- delete/del               remove a device id from the quick-unlock whitelist
+ update/-u               generate a password for an existing entry
+.SH ARGUMENTS (SERVER)
+ help/-h                 bring up this menu
+ version/-v              display sshyp version info
+ init                    set up sshyp
+ tweak                   change configuration options/manage extensions and updates
 .SH SETUP
 sshyp operates on a client-server model, and thus requires you to have access to your own server (whether it be a physical home server or a cloud rental) with remote access via SSH.
 
-The sshyp package includes modes for operating on both client and server devices, so only one package is necessary.
+The sshyp package (on fully supported platforms) includes modes for operating on both client and server devices, so only one package is necessary.
 
 Server setup:
     Configure an OpenSSH server (if sshyp was installed from the Debian package, openssh-server and openssh-sftp-server must be installed manually - if sshyp was installed from the Fedora package, openssh-server must be installed manually)
     Allow remote access to the SSH server w/public key authentication (disabling password-only authentication recommended)
     Install sshyp
-    Run "sshyp tweak" and set the device type as server
-    Optionally, run "sshyp whitelist setup" and configure quick-unlock
+    Run "sshyp init" and set the device type as server
+    Optionally, configure a quick-unlock pin from the tweak menu
     Done!
 
 Client setup:
     Install sshyp
-    Run "sshyp tweak" and follow the prompts
+    Run "sshyp init" and follow the prompts
     Copy the generated public SSH key (located at ~/.ssh/sshyp.pub) to the server using preferred method (manually adding to authorized_keys, ssh-copy-id, etc.)
     If you already have entries on the server, sync them using "sshyp sync"
-    Optionally, Bash completions can be enabled by installing your distribution's "bash-completion" package and restarting your terminal
+    Optionally, shell completions (both Bash and ZSH) can be enabled with your shell's respective method
     Done!
 
 Please note that the server setup intentionally does not allow the reading of entries (it does not allow adding a gpg decryption key). For security purposes, only clients can read entries.
+.SH TROUBLESHOOTING
+.B Clipboard not clearing:
+
+    The intended way for sshyp to interact with the system clipboard is for it to clear it 30 seconds after copying a field. Unfortunately, this does not work by default on all systems due to the prevalence of clipboard managers.
+
+    Clipboard managers save a history of what has been copied to the clipboard, which is already a big enough issue on its own for people who copy sensitive information to their clipboard. Some clipboard managers simply will not allow the clipboard to be empty and will replace its contents with the last copied item if you attempt to clear it. One such naughty clipboard manager is KDE Klipper, which comes packaged into KDE Plasma and is typically enabled by default on most distributions. Due to this behavior, KDE Klipper breaks sshyp's clipboard clearing functionality and should not be left enabled.
+
+    It is likely other popular clipboard managers exhibit this behavior as well (Klipper is just the one I first noticed it with). Clipboard managers should not be enabled by default in any environment or distribution due to their potential security implications.
+
+.B Shell completions not working:
+    ZSH:
+        Make sure your ~/.zshrc contains the following:
+            autoload -Uz compinit && compinit
+        Restart your shell
+
+    Bash:
+        Install your distribution's 'bash-completion' package and restart your shell
+            OR
+        Source the completion script manually by adding the following to your ~/.bashrc (then restart your shell):
+                Linux:
+                    source /usr/share/bash-completion/completions/sshyp
+                FreeBSD:
+                    source /usr/local/share/bash-completion/completions/sshyp
+                Haiku:
+                    source /system/data/bash-completion/completions/sshyp
+
 .SH EXIT CODES
 0 - no error
 
-1 - argument error
+1 - configuration error
 
-2 - configuration error
+2 - data not found error
 
-3 - data not found error
+3 - data already exists error
 
-4 - data already exists error
+4 - decryption/encryption error
 
-5 - decryption/encryption error
+5 - server connection error
 
-6 - server connection error
+6 - other error
 .SH AUTHOR
 Randall Winkhart (https://github.com/rwinkhart)

extra/sshyp-completion.bash

@@ -1,50 +0,0 @@
-#!/usr/bin/env bash
-
-_path_gen() {
-    local sshyp_path="$HOME/.local/share/sshyp"
-    local sshyp_path_length="$(("${#sshyp_path}" + 1))"
-    readarray -t full_paths < <(find "$sshyp_path" -type f -exec ls {} \;)
-    for path in "${full_paths[@]}"; do
-        trimmed_path=$(echo ${path%????} | cut -c"$sshyp_path_length"-)
-        trimmed_path=$(echo ${trimmed_path// /\\ })
-        trimmed_paths+=("$trimmed_path")
-    done
-} &&
-
-# from this point, this completions script was partially generated by
-# completely (https://github.com/dannyben/completely)
-
-_sshyp_completions() {
-  if [ "${#COMP_WORDS[@]}" -gt "4" ]; then
-    return
-  fi
-  local cur=${COMP_WORDS[COMP_CWORD]}
-  local compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
-
-  case "$compline" in
-    'add password'* | 'add -p'* | 'add note'* | 'add -n'* | 'add folder'*| 'add -f'* | 'edit relocate'* | 'edit -r'* | 'edit username'* | 'edit -u'* | 'edit password'* | 'edit -p'* | 'edit url'* | 'edit -l'* | 'edit note'* | 'edit -n'* | 'copy username'* | 'copy -u'* | 'copy password'* | 'copy -p'* | 'copy note'* | 'copy -n'* | 'copy url'* | 'copy -l'* | 'gen update'* | 'gen -u'*)
-      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W  "$(printf "'%s' " "${trimmed_paths[@]}")" -- "$cur" )
-      ;;
-
-    'edit'*)
-      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "relocate username password note url" -- "$cur" )
-      ;;
-
-    'copy'*)
-      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "username password url note" -- "$cur" )
-      ;;
-
-    'add'*)
-      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "password note folder" -- "$cur" )
-      ;;
-
-    'gen'*)
-      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "update" -- "$cur" )
-      ;;
-    *)
-      while read; do COMPREPLY+=( "$REPLY" ); done < <( compgen -W "help version tweak add gen edit copy shear sync $(printf "'%s' " "${trimmed_paths[@]}")" -- "$cur" )
-      ;;
-
-  esac
-} &&
-_path_gen && complete -F _sshyp_completions sshyp

lib/clipclear.py

@@ -0,0 +1,42 @@
+#!/usr/bin/env python3
+from hashlib import sha512
+from subprocess import PIPE, run
+from sys import argv
+from time import sleep
+
+# set period of time to wait before attempting to clear clipboard
+sleep(30)
+# enable the storing of clipboard contents hash for later comparison
+hash_paste = sha512()
+
+# PORT START CLIPCLEAR
+if argv[2] == 'wsl':
+    hash_paste.update(run(('powershell.exe', '-c', 'Get-Clipboard'), stdout=PIPE).stdout.strip())
+    if argv[1] == hash_paste.hexdigest():
+        run(('powershell.exe', '-c', 'Set-Clipboard'))
+
+elif argv[2] == 'wayland':
+    hash_paste.update(run('wl-paste', stdout=PIPE).stdout.strip())
+    if argv[1] == hash_paste.hexdigest():
+        run(('wl-copy', '-c'))
+
+elif argv[2] == 'haiku':
+    hash_paste.update(run(('clipboard', '-p'), stdout=PIPE).stdout.strip())
+    if argv[1] == hash_paste.hexdigest():
+        run(('clipboard', '-r'))
+
+elif argv[2] == 'mac':
+    hash_paste.update(run('pbpaste', stdout=PIPE).stdout.strip())
+    if argv[1] == hash_paste.hexdigest():
+        run('pbcopy', input=b'')
+
+elif argv[2] == 'termux':
+    hash_paste.update(run('termux-clipboard-get', stdout=PIPE).stdout.strip())
+    if argv[1] == hash_paste.hexdigest():
+        run(("termux-clipboard-set", "''"))
+
+elif argv[2] == 'x11':
+    hash_paste.update(run(('xclip', '-o', '-sel', 'c'), stdout=PIPE).stdout.strip())
+    if argv[1] == hash_paste.hexdigest():
+        run(('xclip', '-i', '/dev/null', '-sel', 'c'))
+# PORT END CLIPCLEAR

lib/sshync.py

@@ -1,49 +1,55 @@
-#!/usr/bin/env python3
 from os import listdir, remove, walk
-from os.path import expanduser, getmtime, join
+from os.path import expanduser, isdir, isfile, getmtime, join
 from subprocess import CalledProcessError, PIPE, run
 from sys import exit as s_exit
+home = expanduser('~')
 
 
+# PORT START SSHYNC-REMOTE
 # REMOTE
-
-def remote_list_gen(_client_device_name, _remote_dir):  # prints all necessary remote data to stdout
+# prints all necessary remote data to stdout
+def remote_list_gen(_client_device_name, _remote_dir):
     # deletions
-    for _file in listdir(expanduser('~/.config/sshyp/deleted')):
+    for _file in listdir(f"{home}/.config/sshyp/deleted"):
         _file_path, _sep, _device = _file.partition('\x1f')
         _file_path = _file_path.replace('\x1e', '/')
         if _device == _client_device_name:
             print(_file_path)
             try:
-                remove(f"{expanduser('~/.config/sshyp/deleted/')}{_file}")
+                remove(f"{home}/.config/sshyp/deleted/{_file}")
             except FileNotFoundError:
                 pass
     print('\x1d')
     # folders
-    for _root, _directories, _files in walk(expanduser('~/.local/share/sshyp')):
+    for _root, _directories, _files in walk(f"{home}/.local/share/sshyp"):
         for _dir in _directories:
-            print(f"{_root.replace(expanduser('~'), '')}/{_dir}")
+            print(f"{_root.replace(home, '')}/{_dir}")
     print('\x1d')
-    get_local_data(_remote_dir, 'server')  # titles and mod times
+    # titles and mod times
+    get_local_data(_remote_dir, 'server')
+# PORT END SSHYNC-REMOTE
 
 
 # HYBRID
-
-def delete(_file_path, _target_database):  # deletes a file or folder and/or marks it for deletion upon syncing
+# deletes a file or folder and/or marks it for deletion upon syncing
+def delete(_file_path, _target_database, _silent):
     from shutil import rmtree
+    _directory = f"{home}/.local/share/sshyp/"
     try:
-        if _file_path.endswith('/'):
-            rmtree(f"{expanduser('~/.local/share/sshyp/')}{_file_path}")
+        if isdir(_directory + _file_path):
+            rmtree(_directory + _file_path)
         else:
-            remove(f"{expanduser('~/.local/share/sshyp/')}{_file_path}.gpg")
+            remove(f"{_directory}{_file_path}.gpg")
     except FileNotFoundError:
-        print(f"location does not exist {_target_database}")
+        if not _silent:
+            print(f"location does not exist {_target_database}")
     if _target_database == 'remotely':
-        for _device_name in listdir(expanduser('~/.config/sshyp/devices')):
-            open(expanduser('~/.config/sshyp/deleted/') + _file_path.replace('/', '\x1e') + '\x1f' + _device_name, 'w')
+        for _device_name in listdir(f"{home}/.config/sshyp/devices"):
+            open(f"{home}/.config/sshyp/deleted/" + _file_path.replace('/', '\x1e') + '\x1f' + _device_name, 'w')
 
 
-def get_local_data(_directory, _device):  # retrieves and returns titles and mod times from the local device
+# retrieves and returns titles and mod times from the local device
+def get_local_data(_directory, _device):
     _title_list, _mod_list = [], []
     for _root, _directories, _files in walk(_directory):
         for _filename in _files:
@@ -58,43 +64,49 @@ def get_local_data(_directory, _device):  # retrieves and returns titles and mod
 
 
 # LOCAL
-
-def remote_list_fetch(_user_data):  # captures and returns all necessary data from the remote server
+# captures and returns all necessary data from the remote server
+def remote_list_fetch(_user_data):
     try:
-        _remote_data = run(['ssh', '-i', _user_data[5], '-p', _user_data[2], f"{_user_data[0]}@{_user_data[1]}",
-                            f'cd /lib/sshyp; python3 -c \'from sshync import remote_list_gen; remote_list_gen'
-                            f'("{_user_data[6]}", "{_user_data[4]}")\''], stdout=PIPE, text=True, check=True
+        _remote_data = run(('ssh', '-i', _user_data[5], '-p', _user_data[2], f"{_user_data[0]}@{_user_data[1]}",
+                            f'cd /usr/lib/sshyp; python3 -c \'from sshync import remote_list_gen; remote_list_gen'
+                            f'("{_user_data[6]}", "{_user_data[4]}")\''), stdout=PIPE, text=True, check=True
                            ).stdout.split('\x1d')
     except CalledProcessError:
         print('\n\u001b[38;5;9merror: failed to connect to the remote server\u001b[0m\n')
         _remote_data = ''
-        s_exit(6)
-    _deletion_database = _remote_data[0].strip().split('\n')
-    _folder_database = _remote_data[1].strip().split('\n')
-    _titles_mods = _remote_data[2].strip().split('\n')
+        s_exit(5)
+    _deletion_database = _remote_data[0].strip().splitlines()
+    _folder_database = _remote_data[1].strip().splitlines()
+    _titles_mods = _remote_data[2].strip().splitlines()
     return _deletion_database, _folder_database, _titles_mods[:len(_titles_mods)//2], \
         _titles_mods[len(_titles_mods)//2:]
 
 
-def deletion_sync(_deletion_database, _silent):  # checks for and acts upon files and folders marked for deletion
+# checks for and acts upon files and folders marked for deletion
+def deletion_sync(_deletion_database, _silent):
+    _synced = False
     for _file in _deletion_database:
         if _file != '':
-            if _silent != 1:
+            if not _silent:
+                _synced = True
                 print(f"\u001b[38;5;208m{_file}\u001b[0m has been sheared, removing...")
-            delete(_file, 'locally')
+            delete(_file, 'locally', _silent)
+    if _synced:
+        print()
 
 
-def folder_sync(_folder_database):  # creates matches of remote folders on the local client
+# creates matches of remote folders on the local client
+def folder_sync(_folder_database):
     from pathlib import Path
     for _folder in _folder_database:
-        if _folder != '' and not Path(f"{expanduser('~')}{_folder}").is_dir():
+        if _folder != '' and not isdir(home + _folder):
             print(f"\u001b[38;5;2m{_folder.replace('/.local/share/sshyp/', '')}/\u001b[0m does not exist locally, "
                   f"creating...")
-            Path(f"{expanduser('~')}{_folder}").mkdir(mode=0o700, parents=True, exist_ok=True)
+            Path(home + _folder).mkdir(mode=0o700, parents=True, exist_ok=True)
 
 
-def sort_titles_mods(_list_1, _list_2):  # creates and returns two lists (of titles and mod times) generated by sorting
-    # information from two provided 2D lists
+# creates and returns two lists (of titles and mod times) generated by sorting information from two provided 2D lists
+def sort_titles_mods(_list_1, _list_2):
     _title_list_2_sorted, _mod_list_2_sorted = [], []
     # title sorting
     for _title in _list_1[0]:
@@ -109,29 +121,29 @@ def sort_titles_mods(_list_1, _list_2):  # creates and returns two lists (of tit
     return _title_list_2_sorted, _mod_list_2_sorted
 
 
-def make_profile(_profile_dir, _local_dir, _remote_dir, _identity, _ip, _port, _user):  # creates a sshync job profile
-    open(_profile_dir, 'w').write(f"{_user}\n{_ip}\n{_port}\n{_local_dir}\n{_remote_dir}\n{_identity}\n")
-
-
-def get_profile(_profile_dir):  # returns a list of data read from a sshync job profile
-    try:
-        _profile_data = open(_profile_dir).readlines()
-    except (FileNotFoundError, IndexError):
+# returns a list of data read from a sshync job profile
+def get_profile(_profile_dir):
+    from configparser import ConfigParser
+    _profile_data = ConfigParser(interpolation=None)
+    if isfile(_profile_dir):
+        _profile_data.read(_profile_dir)
+    else:
         print('\n\u001b[38;5;9merror: the profile does not exist or is corrupted\u001b[0m\n')
-        _profile_data = None
-        s_exit(3)
-    _user = _profile_data[0].rstrip()
-    _ip = _profile_data[1].rstrip()
-    _port = _profile_data[2].rstrip()
-    _local_dir = _profile_data[3].rstrip()
-    _remote_dir = _profile_data[4].rstrip()
-    _identity = _profile_data[5].rstrip()
-    _client_device_id = listdir(expanduser('~/.config/sshyp/devices'))[0].rstrip()
+        s_exit(2)
+    _user = _profile_data.get('SSHYNC', 'user')
+    _ip = _profile_data.get('SSHYNC', 'ip')
+    _port = _profile_data.get('SSHYNC', 'port')
+    _local_dir = _profile_data.get('SSHYNC', 'local_dir')
+    _remote_dir = _profile_data.get('SSHYNC', 'remote_dir')
+    _identity = _profile_data.get('SSHYNC', 'identity_file')
+    _client_device_id = listdir(f"{home}/.config/sshyp/devices")[0].rstrip()
     return _user, _ip, _port, _local_dir, _remote_dir, _identity, _client_device_id
 
 
-def run_profile(_profile_dir, _silent):  # runs a sshync job profile
-    _user_data = get_profile(_profile_dir)  # import profile data
+# runs a sshync job profile
+def run_profile(_profile_dir, _silent):
+    # import profile data
+    _user_data = get_profile(_profile_dir)
     # fetch remote lists
     _deletion_database, _folder_database, _remote_titles, _remote_mods = remote_list_fetch(_user_data)
     _remote_titles_mods = (_remote_titles, _remote_mods)
@@ -142,27 +154,31 @@ def run_profile(_profile_dir, _silent):  # runs a sshync job profile
     _index_local = sort_titles_mods(_remote_titles_mods, get_local_data(_user_data[3], 'client'))
     _index_remote = sort_titles_mods(_index_local, _remote_titles_mods)
     # sync new and updated files
-    _i = -1
+    _i, _synced = -1, False
     for _title in _index_local[0]:
         _i += 1
         if _title in _index_remote[0]:
             # compare mod times and sync
             if int(_index_local[1][_i]) > int(_index_remote[1][_i]):
+                _synced = True
                 print(f"\u001b[38;5;4m{_title[:-4]}\u001b[0m is newer locally, uploading...")
-                run(['scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5], _user_data[3] + _title,
-                     f"{_user_data[0]}@{_user_data[1]}:{_user_data[4]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
+                run(('scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5], _user_data[3] + _title,
+                     f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}"))
             elif int(_index_local[1][_i]) < int(_index_remote[1][_i]):
+                _synced = True
                 print(f"\u001b[38;5;2m{_title[:-4]}\u001b[0m is newer remotely, downloading...")
-                run(['scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5],
-                     f"{_user_data[0]}@{_user_data[1]}:{_user_data[4]}{_title}",
-                     f"{_user_data[3]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
+                run(('scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5],
+                     f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}", f"{_user_data[3]}{_title}"))
         else:
+            _synced = True
             print(f"\u001b[38;5;4m{_title[:-4]}\u001b[0m is not on remote server, uploading...")
-            run(['scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5], _user_data[3] + _title,
-                 f"{_user_data[0]}@{_user_data[1]}:{_user_data[4]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
+            run(('scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5], _user_data[3] + _title,
+                 f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}"))
     for _title in _index_remote[0]:
         if _title not in _index_local[0]:
+            _synced = True
             print(f"\u001b[38;5;2m{_title[:-4]}\u001b[0m is not in local directory, downloading...")
-            run(['scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5],
-                 f"{_user_data[0]}@{_user_data[1]}:{_user_data[4]}{_title}",
-                 f"{_user_data[3]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
+            run(('scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5],
+                 f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}", f"{_user_data[3]}{_title}"))
+    if _synced:
+        print()

lib/stweak.py

@@ -0,0 +1,616 @@
+from configparser import ConfigParser
+from curses import A_REVERSE, KEY_DOWN, KEY_UP, curs_set, newwin
+from curses.textpad import rectangle, Textbox
+from os import environ, listdir, remove
+from os.path import exists, expanduser, isfile
+from pathlib import Path
+from random import randint
+from shutil import get_terminal_size, which
+from subprocess import PIPE, run
+# PORT START UNAME-IMPORT-STWEAK
+from os import uname
+# PORT END UNAME-IMPORT-STWEAK
+home, sshyp_data, stdscr = expanduser('~'), ConfigParser(interpolation=None), None
+if isfile(f"{home}/.config/sshyp/sshyp.ini"):
+    _exists_flag = True
+    sshyp_data.read(f"{home}/.config/sshyp/sshyp.ini")
+else:
+    _exists_flag = False
+
+
+# writes data stored in ConfigParser to the correct config file
+def write_config(_sshyp_data=sshyp_data):
+    with open(f"{home}/.config/sshyp/sshyp.ini", 'w') as configfile:
+        _sshyp_data.write(configfile)
+
+
+# creates a radio selection between the provided options
+def curses_radio(_options, _pretext):
+    curs_set(0)
+    _selected = 0
+    while True:
+        stdscr.clear()
+        stdscr.addstr(0, 0, _pretext)
+        for _i, _option in enumerate(_options):
+            _y = _i + _pretext.count('\n') + 2
+            if _i == _selected:
+                stdscr.addstr(_y, 0, "[*] " + _option, A_REVERSE)
+            else:
+                stdscr.addstr(_y, 0, "[ ] " + _option)
+        stdscr.refresh()
+        _key = stdscr.getch()
+        # update _selected based on user input
+        if _key == KEY_UP:
+            _selected = (_selected-1) % len(_options)
+        elif _key == KEY_DOWN:
+            _selected = (_selected+1) % len(_options)
+        elif _key == ord('\n'):
+            break
+        stdscr.refresh()
+    curs_set(1)
+    return _selected
+
+
+# creates a text-box input
+def curses_text(_pretext):
+    stdscr.clear()
+    stdscr.addstr(0, 0, _pretext)
+    _term_columns = get_terminal_size()[0]
+    _editwin = newwin(1, _term_columns-2, 3, 1)
+    rectangle(stdscr, 2, 0, 4, _term_columns-1)
+    stdscr.refresh()
+    _box = Textbox(_editwin)
+    # let the user edit until ctrl+g/enter is struck
+    _box.edit()
+    # return resulting contents
+    return _box.gather().strip()
+
+
+# device+sync type selection
+def install_type():
+    _offline_mode = 'false'
+    # PORT START TWEAK-DEVTYPE
+    _install_type = curses_radio(('client (ssh-synchronized)', 'client (offline)', 'server'),
+                                 'device + sync type configuration')
+    # PORT END TWEAK-DEVTYPE
+    if _install_type == 2:
+        _dev_type = 'server'
+        Path(f"{home}/.config/sshyp/deleted").mkdir(mode=0o700, exist_ok=True)
+        Path(f"{home}/.config/sshyp/whitelist").mkdir(mode=0o700, exist_ok=True)
+        curses_radio(['okay'], 'make sure the ssh service is running and properly configured')
+    else:
+        _dev_type = 'client'
+        if _install_type == 1:
+            _offline_mode = 'true'
+        if not sshyp_data.has_section('CLIENT-GENERAL'):
+            sshyp_data.add_section('CLIENT-GENERAL')
+        sshyp_data.set('CLIENT-GENERAL', 'offline_mode_enabled', _offline_mode)
+    if not sshyp_data.has_section('GENERAL'):
+        sshyp_data.add_section('GENERAL')
+    sshyp_data.set('GENERAL', 'device_type', _dev_type)
+    write_config()
+    return _dev_type, _offline_mode
+
+
+# gpg configuration
+def gpg_config():
+    # gpg key selection
+    _uid_list = [_item for _item in run(('gpg', '-k', '--with-colons'),
+                                        stdout=PIPE, text=True).stdout.splitlines() if _item.startswith('uid')]
+    _named_uid_list = []
+    for _uid in _uid_list:
+        _named_uid_list.append(_uid.split(':')[9].replace('\\x3a', ':').replace('\\x5c', '\\'))
+    _named_uid_list.append('auto-generate')
+    _gpg_id_sel = curses_radio(_named_uid_list, 'gpg key selection')
+    if _gpg_id_sel == len(_named_uid_list)-1:
+        if not isfile(f"{home}/.config/sshyp/gpg-gen"):
+            open(f"{home}/.config/sshyp/gpg-gen", 'w').writelines([
+                'Key-Type: 1\n', 'Key-Length: 4096\n', 'Key-Usage: sign encrypt\n', 'Name-Real: sshyp\n',
+                'Name-Comment: gpg-sshyp\n', 'Name-Email: github.com/rwinkhart/sshyp\n',
+                'Expire-Date: 0'])
+        run(('gpg', '-q', '--batch', '--generate-key', f"{home}/.config/sshyp/gpg-gen"))
+        remove(f"{home}/.config/sshyp/gpg-gen")
+        _gpg_id = run(('gpg', '-k', '--with-colons'), stdout=PIPE, text=True).stdout.splitlines()[-1].split(':')[9]
+    else:
+        _gpg_id = _named_uid_list[_gpg_id_sel]
+
+    # lock file generation
+    if isfile(f"{home}/.config/sshyp/lock.gpg"):
+        remove(f"{home}/.config/sshyp/lock.gpg")
+    open(f"{home}/.config/sshyp/lock", 'w')
+    run(('gpg', '-qr', _gpg_id, '-e', f"{home}/.config/sshyp/lock"))
+    remove(f"{home}/.config/sshyp/lock")
+
+    if not sshyp_data.has_section('CLIENT-GENERAL'):
+        sshyp_data.add_section('CLIENT-GENERAL')
+    sshyp_data.set('CLIENT-GENERAL', 'gpg_id', _gpg_id)
+    write_config()
+
+
+# text editor configuration
+def editor_config(_env_mode):
+    if _env_mode:
+        # set default text editor to value of EDITOR environment variable, otherwise default to vi
+        if 'EDITOR' in environ:
+            _editor = environ['EDITOR']
+        else:
+            _editor = 'vi'
+    else:
+        _editor = curses_text('enter the name of your preferred text editor:\n\n\n\n\n(ctrl+g/enter to confirm)'
+                              '\n\nthis will be used for writing notes\n\nexample input: vim')
+    if not sshyp_data.has_section('CLIENT-GENERAL'):
+        sshyp_data.add_section('CLIENT-GENERAL')
+    sshyp_data.set('CLIENT-GENERAL', 'text_editor', _editor)
+    write_config()
+
+
+# ssh+sshync configuration
+def ssh_config():
+    # private key selection/generation
+    _keys = []
+    # ensure ~/.ssh directory exists
+    Path(f"{home}/.ssh").mkdir(mode=0o700, exist_ok=True)
+    for _file in listdir(f"{home}/.ssh"):
+        if not _file.startswith('.') and _file not in ('known_hosts', 'known_hosts.old', 'authorized_keys') \
+                and not _file.endswith('.pub') and isfile(f"{home}/.ssh/{_file}"):
+            _keys.append(f"{home}/.ssh/{_file}")
+    _keys.extend(['auto-generate', 'other (type the location)'])
+    _key_selected_num = curses_radio(_keys, 'which private ssh key would you like to use for sshyp?')
+    _gen_index = len(_keys)-2
+    if _key_selected_num >= _gen_index:
+        _ssh_key = expanduser(curses_text('enter the location for your private ssh key:\n\n\n\n\n(ctrl+g/enter to '
+                                          'confirm)\n\nexample input:\n\n~/.ssh/privkey'))
+        if _key_selected_num == _gen_index:
+            _passphrase = curses_text('enter your desired ssh keyfile passphrase:\n\n\n\n\n(ctrl+g/enter to confirm)'
+                                      '\n\ntip: you can leave this blank to use the keyfile without a passphrase')
+            run(('ssh-keygen', '-q', '-t', 'ed25519', '-N', _passphrase, '-f', _ssh_key))
+    else:
+        _ssh_key = _keys[_key_selected_num]
+    
+    # ssh+sshync configuration
+    _uiport = curses_text('enter the username, ip, and ssh port of your sshyp server:\n\n\n\n\n(ctrl+g/enter to '
+                          'confirm)\n\nexample inputs:\n\n ipv4: user@10.10.10.10:22\n ipv6: user@[2000:2000:2000:2000'
+                          ':2000:2000:2000:2000]:22\n domain: user@mydomain.com:22')
+    _uiport_split = _uiport.split('@')
+    _username_ssh = _uiport_split[0]
+    _iport = _uiport_split[1].lstrip('[').replace(']', '').rsplit(':', 1)
+
+    if not sshyp_data.has_section('SSHYNC'):
+        sshyp_data.add_section('SSHYNC')
+    sshyp_data.set('SSHYNC', 'user', _username_ssh)
+    sshyp_data.set('SSHYNC', 'ip', _iport[0])
+    sshyp_data.set('SSHYNC', 'port', _iport[1])
+    sshyp_data.set('SSHYNC', 'local_dir', f"{home}/.local/share/sshyp/")
+    sshyp_data.set('SSHYNC', 'remote_dir', f"/home/{_username_ssh}/.local/share/sshyp/")
+    sshyp_data.set('SSHYNC', 'identity_file', _ssh_key)
+    write_config()
+    return _iport[1], _username_ssh, _iport[0], _ssh_key
+
+
+# device id configuration
+def dev_id_config(_ip, _username_ssh, _port, _identity):
+    from sshyp import copy_id_check, string_gen
+    _device_id_prefix = curses_text('name this device:\n\n\n\n\n(ctrl+g/enter to confirm)\n\nimportant: this '
+                                    'id must be unique amongst your client devices\n\nthis is used to keep track of '
+                                    'database syncing and quick-unlock permissions\n')
+    _device_id_suffix = string_gen('f', randint(24, 48))
+    _device_id = _device_id_prefix + '-' + _device_id_suffix
+    # remove existing device ids
+    for _id in listdir(f"{home}/.config/sshyp/devices"):
+        remove(f"{home}/.config/sshyp/devices/{_id}")
+    open(f"{home}/.config/sshyp/devices/{_device_id}", 'w')
+    # test server connection and attempt to register device id
+    copy_id_check(_ip, _username_ssh, _port, _device_id, _identity, sshyp_data)
+
+
+# quick-unlock configuration
+def quick_unlock_config(_default):
+    if _default:
+        _enabled = 'false'
+    else:
+        _quick_unlock_sel = curses_radio(('no', 'yes'), 'WARNING: quick-unlock is only as secure as the environment you'
+                                                        ' use it in\n\nquick-unlock allows you to use a shorter version'
+                                                        ' of your gpg key passphrase and\nrequires a constant '
+                                                        'connection to your sshyp server to authenticate\n\na '
+                                                        'compromised program on your computer could scan the process '
+                                                        'list in the\nbrief period during decryption to retrieve the '
+                                                        'necessary information to decrypt your entries\n\nenable '
+                                                        'quick-unlock?')
+        if _quick_unlock_sel == 1:
+            _enabled = 'true'
+        else:
+            _enabled = 'false'
+    if not sshyp_data.has_section('CLIENT-ONLINE'):
+        sshyp_data.add_section('CLIENT-ONLINE')
+    sshyp_data.set('CLIENT-ONLINE', 'quick_unlock_enabled', _enabled)
+    write_config()
+    return _enabled
+
+
+# re-encrypt/optimize all entries
+def refresh_encryption():
+    _directory = f"{home}/.local/share/sshyp"
+
+    # warn the user of potential data loss and prompt to continue
+    _proceed = curses_radio(('no', 'yes'), "WARNING: proceeding with this action will remove/overwrite any directories"
+                                           f" matching the following:\n\n{home}/.local/share/sshyp.old\n{home}/.local/"
+                                           "share/sshyp.new\n\nare you sure you wish to re-encrypt all entries?")
+    if _proceed != 1:
+        return 3    
+
+    # set new gpg key
+    gpg_config()
+
+    from os import walk
+    from os.path import isdir
+    from shutil import move, rmtree
+    from sshyp import decrypt, encrypt
+
+    # prompt for unlock and display do not close warning
+    decrypt(None)
+    curses_radio(['okay'], 'entry optimization may take some time - select "okay" to start - '
+                           'do not terminate this process!')
+
+    # remove existing conflicts
+    for _extension in ('.new', '.old'):
+        if exists(f"{_directory}{_extension}"):
+            rmtree(f"{_directory}{_extension}")
+    
+    # decrypt, optimize, and re-encrypt each entry with the newly selected key
+    if isdir(_directory):
+        _gpg_id = sshyp_data.get('CLIENT-GENERAL', 'gpg_id')
+        for _root, _dirs, _files in sorted(walk(_directory, topdown=True)):
+            for _filename in _files:
+                Path(_root.replace(_directory, _directory + '.new', 1)).mkdir(0o700, parents=True, exist_ok=True)
+                encrypt(decrypt(f"{_root}/{_filename[:-4]}"),
+                        f"{_root.replace(_directory, _directory + '.new', 1)}/{_filename[:-4]}", _gpg_id)
+
+        # create a backup of the original version and activate the new version        
+        move(_directory, _directory + '.old')
+        move(_directory + '.new', _directory)
+        return 1
+    else:
+        return 2
+    
+
+# PORT START WHITELIST-SERVER
+# takes input from the user to set up quick-unlock pin
+def whitelist_setup():
+    _gpg_password_temp = str(curses_text('full gpg passphrase:\n\n\n\n\n(ctrl+g/enter to confirm)'))
+    _half_length = int(len(_gpg_password_temp)/2)
+    try:
+        _short_password_length = int(curses_text(f"quick unlock pin length ({_half_length}):\n\n\n\n\n(ctrl+g/enter "
+                                                 "to confirm)\n\npin must be half the length of the gpg passphrase "
+                                                 "or less\n\ncannot be a negative number"))
+        if not 0 <= _short_password_length <= _half_length:
+            _short_password_length = _half_length
+    except ValueError:
+        _short_password_length = _half_length
+    _i, _quick_unlock_password, _quick_unlock_password_excluded = 0, '', ''
+    for _char in _gpg_password_temp:
+        if _i % 2 == 1 and _i < _short_password_length*2:
+            _quick_unlock_password += _char
+        else:
+            _quick_unlock_password_excluded += _char
+        _i += 1
+
+    # create assembly key
+    open(f"{home}/.config/sshyp/gpg-gen", 'w').writelines([
+        'Key-Type: 1\n', 'Key-Length: 4096\n', 'Key-Usage: sign encrypt\n', 'Name-Real: sshyp\n',
+        'Name-Comment: gpg-sshyp-whitelist\n', 'Name-Email: github.com/rwinkhart/sshyp\n', 'Expire-Date: 0'])
+    run(('gpg', '-q', '--pinentry-mode', 'loopback', '--batch', '--generate-key', '--passphrase',
+         _quick_unlock_password, f"{home}/.config/sshyp/gpg-gen"))
+    remove(f"{home}/.config/sshyp/gpg-gen")
+    _gpg_id = run(('gpg', '-k', '--with-colons'), stdout=PIPE, text=True).stdout.splitlines()[-1].split(':')[9]
+
+    # encrypt excluded with the assembly key
+    from sshyp import encrypt
+    encrypt(_quick_unlock_password_excluded, f"{home}/.config/sshyp/excluded", _gpg_id)
+    curses_radio(['okay, I have it memorized'], f"your quick-unlock pin: {_quick_unlock_password}")
+
+
+# adds or removes quick-unlock whitelisted device ids
+def whitelist_manage(_action):
+    _whitelisted_ids = listdir(f"{home}/.config/sshyp/whitelist")
+    _device_ids = listdir(f"{home}/.config/sshyp/devices")
+
+    # a value of True indicates adding
+    if _action:
+        _unwhitelisted_ids = []    
+        for _id in _device_ids:
+            if _id not in _whitelisted_ids:
+                _unwhitelisted_ids.append(_id)
+        _unwhitelisted_ids.append('cancel')
+        _add_id = curses_radio(_unwhitelisted_ids, 'id to add to whitelist:')
+        if _add_id == len(_unwhitelisted_ids)-1:
+            return
+        open(f"{home}/.config/sshyp/whitelist/{_unwhitelisted_ids[_add_id]}", 'w').write('')
+    else:
+        _whitelisted_choices = _whitelisted_ids + ['cancel']
+        _del_id = curses_radio(_whitelisted_choices, 'id to remove from whitelist:')
+        if _del_id == len(_whitelisted_choices)-1:
+            return
+        remove(f"{home}/.config/sshyp/whitelist/{_whitelisted_ids[_del_id]}")
+
+    # prune deleted device ids from whitelist
+    for _id in _whitelisted_ids:
+        if _id not in _device_ids:
+            remove(f"{home}/.config/sshyp/whitelist/{_id}")
+
+
+# runs quick-unlock configuration menu
+def whitelist_menu():
+    while True:
+        _choice = curses_radio(('setup/create pin', 'add to whitelist', 'remove from whitelist', 
+                                'BACK'), 'quick-unlock/whitelist management')
+        if _choice == 0:
+            whitelist_setup()
+        elif _choice == 1:
+            whitelist_manage(True)
+        elif _choice == 2:
+            whitelist_manage(False)
+        else:
+            break
+# PORT END WHITELIST-SERVER
+
+
+# PORT START TWEAK-EXTEND-FUNCTIONS
+# downloads/updates extensions
+def extension_downloader():
+    from os import chmod
+    from tempfile import gettempdir
+    from urllib.request import urlopen, urlretrieve
+    _file_data = urlopen("https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/pointers/v1.5.1").read()
+    _pointer = ConfigParser(interpolation=None)
+    _pointer.read_string(_file_data.decode('utf-8'))
+    _extensions = _pointer.sections()
+    _extensions.append('CANCEL')
+    _choice = curses_radio(_extensions, 'select an extension for more info')
+    if _choice == len(_extensions)-1:
+        return False
+    _selected = _extensions[_choice]
+    _choice = curses_radio(('no', 'yes'), f"description: {_pointer.get(_selected, 'desc')}\n\nusage: "
+                                          f"{_pointer.get(_selected, 'usage')}\n\ninstall {_selected}?")
+    # if installing the extension...
+    if _choice == 1:
+        # download extension files to temporary directory
+        _exe_dir, _ini_dir = f"{gettempdir()}/sshyp_exe", f"{gettempdir()}/sshyp_ini"
+        _ext_exe = urlretrieve(_pointer.get(_selected, 'exe'), _exe_dir)
+        _ext_ini = urlretrieve(_pointer.get(_selected, 'ini'), _ini_dir)
+        # set permissions under active user
+        chmod(_exe_dir, 0o755)
+        chmod(_ini_dir, 0o644)
+        return _selected
+    return False
+
+
+# uninstalls/deletes selected extensions
+def extension_remover():
+    _installed = []
+    for _extension in listdir('/usr/lib/sshyp/extensions'):
+        _installed.append(_extension[:-4])
+    _installed.append('CANCEL')
+    _choice = curses_radio(_installed, 'select an extension to uninstall')
+    if _choice == len(_installed)-1:
+        return False
+    _sure = curses_radio(('no', 'yes'), f"are you sure you want to remove {_installed[_choice]}?")
+    if _sure == 0:
+        return False
+    return _installed[_choice]
+
+
+# provides options for managing extensions
+def extension_menu():
+    _ext_name, _action = False, False
+    # determine which of the supported privilege escalation utilities is installed
+    if which('doas') is not None:
+        _escalator = 'doas'
+    elif which('sudo') is not None:
+        _escalator = 'sudo'
+    else:
+        # throw an error if no supported privilege escalation utility is found
+        raise ChildProcessError
+    while True:
+        _choice = curses_radio(('download/update extensions', 'remove extensions', 'BACK'), 'extension management')
+        if _choice == 0:
+            _ext_name = extension_downloader()
+            if _ext_name:
+                # True represents installation
+                _action = True
+                break
+        elif _choice == 1:
+            _ext_name = extension_remover()
+            if _ext_name:
+                break
+        else:
+            break
+    return _ext_name, _escalator, _action
+# PORT END TWEAK-EXTEND-FUNCTIONS
+
+
+# runs secondary configuration menu
+def global_menu(_scr, _device_type, _top_message):
+    global stdscr
+    # only set global stdscr if running as entry point
+    if not isinstance(_scr, bool):
+        stdscr = _scr
+
+    while True:
+        _options, _choice, _exit_signal = ['change device/synchronization types'], 0, False
+        if _device_type == 'client':
+            _options.extend(['change gpg key', 're-configure ssh(ync)', 'change device name',
+                             '[OPTIONAL, RECOMMENDED] set custom text editor',
+                             '[OPTIONAL] enable/disable quick-unlock',
+                             '[OPTIONAL] re-encrypt/optimize entries',
+                             '[OPTIONAL] extension management'])
+        else:
+            _options.extend(['manage quick-unlock/whitelist'])
+        _options.extend(['EXIT/DONE'])
+        _choice += curses_radio(_options, _top_message)
+
+        if _choice == 0:
+            _dev_sync_types = install_type()
+            # if switching to client mode...
+            if _dev_sync_types[0] == 'client':
+                # ...and gpg settings are missing
+                if not sshyp_data.has_option('CLIENT-GENERAL', 'gpg_id'):
+                    gpg_config()
+                # ...and text editor settings are missing
+                if not sshyp_data.has_option('CLIENT-GENERAL', 'text_editor'):
+                    editor_config(True)
+                # ...and online (synced) mode is enabled...
+                if _dev_sync_types[1] == 'false':
+                    # ...and quick-unlock settings are missing
+                    if not sshyp_data.has_option('CLIENT-ONLINE', 'quick_unlock_enabled'):
+                        quick_unlock_config(True)
+                    # set to None to check if modified later
+                    _ip, _username_ssh, _port, _identity = None, None, None, None
+                    # ...and there is no sshync config present
+                    if not sshyp_data.has_section('SSHYNC'):
+                        _ip, _username_ssh, _port, _identity = ssh_config()
+                    # ...and there is no device ID present
+                    if not listdir(f"{home}/.config/sshyp/devices"):
+                        if None in (_ip, _username_ssh, _port):
+                            _ip, _username_ssh, _port, _identity = ssh_config()
+                        dev_id_config(_ip, _username_ssh, _port, _identity)
+                    # ...or ssh_error is missing
+                    elif not sshyp_data.has_option('CLIENT-ONLINE', 'ssh_error'):
+                        sshyp_data.set('CLIENT-ONLINE', 'ssh_error', '1')    
+                        write_config()
+            _device_type = _dev_sync_types[0]
+        elif _choice == 1:
+            if _device_type == 'client':
+                gpg_config()
+            else:
+                whitelist_menu()
+        elif _choice == 2:
+            if _device_type == 'client':
+                ssh_config()
+            else:
+                _exit_signal = True
+        elif _choice == 3:
+            if not sshyp_data.has_section('SSHYNC'):
+                ssh_config()
+            dev_id_config(sshyp_data.get('SSHYNC', 'ip'), sshyp_data.get('SSHYNC', 'user'),
+                          sshyp_data.get('SSHYNC', 'port'), sshyp_data.get('SSHYNC', 'identity_file'))
+        elif _choice == 4:
+            editor_config(False)
+        elif _choice == 5:
+            _enabled = quick_unlock_config(False)
+            if _enabled == 'true':
+                curses_radio(['okay'], 'quick-unlock has been enabled client-side - in order for this feature to '
+                                       'function,\nyou must first log in to the sshyp server and run:\n\nsshyp tweak\n'
+                                       '\nfrom there you can create a quick-unlock pin and add this device to the '
+                                       'whitelist')
+        elif _choice == 6:
+            _success = refresh_encryption()
+            if _success == 1:
+                curses_radio(['okay'], "a backup of your previous entry directory has been created:\n\n"
+                                       f"{home}/.local/share/sshyp.old")
+            elif _success == 2:
+                curses_radio(['okay'], '\u001b[38;5;9merror: re-encryption failed: entry directory not found\u001b[0m')
+        elif _choice == 7:
+            # PORT START TWEAK-EXTEND-OPTION
+            _ext_name, _escalator, _action = extension_menu()
+            # if root is needed for extension management...
+            if _ext_name:
+                return _ext_name, _escalator, _action
+            # PORT END TWEAK-EXTEND-OPTION
+        else:
+            _exit_signal = True
+        if _exit_signal:
+            break
+    return None, None, None
+
+
+# runs initial configuration wizard
+def initial_setup(_scr):
+    global stdscr
+    stdscr = _scr
+
+    # required directory creation
+    Path(f"{home}/.config/sshyp/devices").mkdir(mode=0o700, parents=True, exist_ok=True)
+    Path(f"{home}/.local/share/sshyp").mkdir(mode=0o700, parents=True, exist_ok=True)
+
+    # removal of old config files
+    if _exists_flag:
+        sshyp_data.clear()
+
+    # curses menu tree
+    # device+sync type selection
+    _dev_sync_types = install_type()
+
+    if _dev_sync_types[0] == 'client':
+
+        # gpg configuration
+        gpg_config()
+
+        # text editor configuration (automated)
+        editor_config(True)
+
+        # quick-unlock configuration (disabled by default)
+        quick_unlock_config(True)
+
+        # online (synchronized mode) configuration
+        if _dev_sync_types[1] != 'true':
+
+            # ssh+sshync configuration
+            _ip, _username_ssh, _port, _identity = ssh_config()
+
+            # device id configuration
+            dev_id_config(_ip, _username_ssh, _port, _identity)
+
+        # PORT START CLIPTOOL
+        # check for clipboard tool and display warning if missing
+        if uname()[0] in ('Linux', 'FreeBSD') and 'WSL_DISTRO_NAME' not in environ \
+                and not exists("/data/data/com.termux"):
+            _display_server, _clipboard_tool, _clipboard_package = None, None, None
+            if 'WAYLAND_DISPLAY' in environ:
+                _display_server, _clipboard_tool, _clipboard_package = 'Wayland', 'wl-copy', 'wl-clipboard'
+            elif 'DISPLAY' in environ:
+                _display_server, _clipboard_tool, _clipboard_package = 'X11', 'xclip', 'xclip'
+            if _display_server is not None and which(_clipboard_tool) is None:
+                curses_radio(['okay'], f'WARNING: you are using {_display_server} and "{_clipboard_tool}" is not '
+                                       'present - \ncopying entry fields will not function until '
+                                       f'"{_clipboard_package}" is installed')
+        # PORT END CLIPTOOL
+
+    # run optional configuration menu
+    curses_radio(['okay'], 'required configuration complete\n\na menu for additional (optional) configuration will be '
+                           'displayed\n\nthis menu can be safely exited at any time')
+    wrapped_entry(_dev_sync_types[0], 'additional configuration options:')
+
+
+# runs the specified entry function (menu start point) within a curses wrapper
+def wrapped_entry(_gm_device_type, _gm_top_message='configuration options:'):
+    from curses import wrapper, use_default_colors
+    # a boolean value represents init
+    if isinstance(_gm_device_type, bool):
+        wrapper(lambda _wrap_stdscr: (use_default_colors(), initial_setup(_wrap_stdscr)))
+    # any other value will be provided as the global menu device type
+    else:
+        _repeat = True
+        while _repeat:
+            try:
+                _ext_name, _escalator, _action = \
+                    wrapper(lambda _wrap_stdscr: (use_default_colors(),
+                                                  global_menu(_wrap_stdscr, _gm_device_type, _gm_top_message)))[1]
+            except ChildProcessError:
+                print("\n\u001b[38;5;9merror: privilege escalation required\n\nneither 'doas' nor 'sudo' were found in "
+                      "the system's $PATH\u001b[0m\n")
+                return
+            # only run if privilege escalation is needed
+            if _action is not None:
+                if _action:
+                    # install with privilege escalation (outside of curses)
+                    from tempfile import gettempdir
+                    _exe_dir, _ini_dir = f"{gettempdir()}/sshyp_exe", f"{gettempdir()}/sshyp_ini"
+                    run((_escalator, 'chown', 'root:root', _exe_dir, _ini_dir))
+                    run((_escalator, 'mv', _exe_dir, f"/usr/lib/sshyp/{_ext_name}"))
+                    run((_escalator, 'mv', _ini_dir, f"/usr/lib/sshyp/extensions/{_ext_name}.ini"))
+                else:
+                    # uninstall with privilege escalation (outside of curses)
+                    run((_escalator, 'rm', '-I', f"/usr/lib/sshyp/{_ext_name}",
+                         f"/usr/lib/sshyp/extensions/{_ext_name}.ini"))
+            else:
+                _repeat = False

package.sh

@@ -1,32 +1,55 @@
-#!/usr/bin/env bash
+#!/bin/sh
 
-version=$(sed -n '1{p;q}' share/doc/sshyp/changelog | cut -c8-)
+version=$(head -n1 extra/changelog-archive/2023 | cut -c8-)
 if [ -z "$2" ]; then
     revision=1
 else
     revision="$2"
 fi
 
-_create_generic() {
-    echo -e '\npackaging as generic...\n'
-    mkdir -p output/generictemp/usr/{bin,lib/sshyp,share/{man/man1,bash-completion/completions}}
-    cp -r lib/. output/generictemp/usr/lib/sshyp/
-    ln -s /usr/lib/sshyp/sshyp.py output/generictemp/usr/bin/sshyp
-    cp -r share output/generictemp/usr/
-    cp extra/sshyp-completion.bash output/generictemp/usr/share/bash-completion/completions/sshyp
-    cp extra/manpage output/generictemp/usr/share/man/man1/sshyp.1
-    gzip output/generictemp/usr/share/man/man1/sshyp.1
-    tar -C output/generictemp -cvJf output/sshyp-"$version".tar.xz usr/
-    rm -rf output/generictemp
-    sha512="$(sha512sum output/sshyp-"$version".tar.xz | awk '{print $1;}')"
-    echo -e "\nsha512 sum:\n$sha512"
-    echo -e "\ngeneric packaging complete\n"
+mkdir -p port-jobs/working
+
+_create_generic_linux() {
+    printf '\npackaging as generic (Linux)...\n'
+    mkdir -p output/linuxtemp/usr/bin \
+         output/linuxtemp/usr/lib/sshyp/extensions \
+         output/linuxtemp/usr/share/man/man1 \
+         output/linuxtemp/usr/share/bash-completion/completions \
+         output/linuxtemp/usr/share/zsh/functions/Completion/Unix
+    # START PORT
+    cp lib/* port-jobs/working/
+    cd port-jobs
+    ./CLIPTOOL.py LINUX
+    ./CLIPBOARD.py LINUX
+    ./UNAME.py LINUX
+    ./COMMENTS.py ALL
+    ./BLANKS.py
+    ./TABS.sh TABS
+    cd ..
+    mv port-jobs/working/* output/linuxtemp/usr/lib/sshyp/
+    # END PORT
+    ln -s /usr/lib/sshyp/sshyp.py output/linuxtemp/usr/bin/sshyp
+    cp -r share output/linuxtemp/usr/
+    cp extra/completion.bash output/linuxtemp/usr/share/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/linuxtemp/usr/share/zsh/functions/Completion/Unix/_sshyp
+    cp extra/manpage output/linuxtemp/usr/share/man/man1/sshyp.1
+    gzip output/linuxtemp/usr/share/man/man1/sshyp.1
+    XZ_OPT=-e6 tar -C output/linuxtemp -cvJf output/GENERIC-LINUX-sshyp-"$version".tar.xz usr/
+    rm -rf output/linuxtemp
+    sha512="$(sha512sum output/GENERIC-LINUX-sshyp-"$version".tar.xz | cut -d' ' -f1)"
+    printf '\ngeneric (Linux) packaging complete\n\n'
 } &&
 
 _create_pkgbuild() {
-    source='https://github.com/rwinkhart/sshyp/releases/download/v$pkgver/sshyp-$pkgver.tar.xz'
-    echo -e '\ngenerating PKGBUILD...'
-    echo "# Maintainer: Randall Winkhart <idgr at tutanota dot com>
+    printf '\ngenerating PKGBUILD...\n'
+    if [ "$1" = 'Deb' ]; then
+        local source='https://github.com/rwinkhart/sshyp/releases/download/v"$pkgver"/DEBIAN-sshyp_"$pkgver"-"$pkgrel"_all.deb'
+        local decomp_target='data.tar.xz'
+    else
+        local source='https://github.com/rwinkhart/sshyp/releases/download/v"$pkgver"/GENERIC-LINUX-sshyp-"$pkgver".tar.xz'
+        local decomp_target='GENERIC-LINUX-sshyp-"$pkgver".tar.xz'
+    fi
+    printf "# Maintainer: Randall Winkhart <idgr at tutanota dot com>
 pkgname=sshyp
 pkgver="$version"
 pkgrel="$revision"
@@ -34,21 +57,43 @@ pkgdesc='A light-weight, self-hosted, synchronized password manager'
 url='https://github.com/rwinkhart/sshyp'
 arch=('any')
 license=('GPL-3.0-only')
-depends=(python gnupg openssh xclip wl-clipboard)
-optdepends=('bash-completion: bash completion support')
+depends=(python gnupg openssh)
+optdepends=(
+    'wl-clipboard: wayland clipboard support'
+    'xclip: x11 clipboard support'
+    'bash-completion: bash completion support'
+)
 source=(\""$source"\")
 sha512sums=('"$sha512"')
 
 package() {
-    tar xf sshyp-"\"\$pkgver\"".tar.xz -C "\"\${pkgdir}\""
+    tar -xf $decomp_target -C "\"\${pkgdir}\""
 }
 " > output/PKGBUILD
-    echo -e "\nPKGBUILD generated\n"
+    printf '\nPKGBUILD generated\n\n'
 } &&
 
 _create_apkbuild() {
-    echo -e '\ngenerating APKBUILD...'
-    echo "# Maintainer: Randall Winkhart <idgr@tutanota.com>
+    printf '\ngenerating APKBUILD...\n'
+    if [ "$1" = 'Deb' ]; then
+        local source="https://github.com/rwinkhart/sshyp/releases/download/v\"\$pkgver\"/DEBIAN-sshyp_\"\$pkgver\"-"$revision"_all.deb"
+        local sumsname="DEBIAN-sshyp_\"\$pkgver\"-"$revision"_all.deb"
+        local processing='mkdir -p "$pkgdir"
+    7z x "$srcdir"/* -o"$srcdir"
+    tar -xf "$srcdir"/data.tar -C "$pkgdir"
+    mkdir -p "$pkgdir/usr/share/zsh/site-functions"
+    mv "$pkgdir/usr/share/zsh/functions/Completion/Unix/_sshyp" "$pkgdir/usr/share/zsh/site-functions/_sshyp"
+    rm -rf "$pkgdir/usr/share/zsh/functions"'
+    else
+        local source='https://github.com/rwinkhart/sshyp/releases/download/v"$pkgver"/GENERIC-LINUX-sshyp-"$pkgver".tar.xz'
+        local sumsname='GENERIC-LINUX-sshyp-"$pkgver".tar.xz'
+        local processing='mkdir -p "$pkgdir"
+    mkdir -p "$srcdir/usr/share/zsh/site-functions"
+    mv "$srcdir/usr/share/zsh/functions/Completion/Unix/_sshyp" "$srcdir/usr/share/zsh/site-functions/_sshyp"
+    rm -rf "$srcdir/usr/share/zsh/functions"
+    cp -r "$srcdir/usr/" "$pkgdir"'
+    fi
+    printf "# Maintainer: Randall Winkhart <idgr@tutanota.com>
 pkgname=sshyp
 pkgver="$version"
 pkgrel="$((revision-1))"
@@ -57,98 +102,172 @@ options=!check
 url='https://github.com/rwinkhart/sshyp'
 arch='noarch'
 license='GPL-3.0-only'
-depends='python3 gnupg openssh xclip wl-clipboard'
+depends='python3 gnupg openssh'
 source=\""$source"\"
 
 package() {
-    mkdir -p "\"\$pkgdir\""
-    cp -r "\"\$srcdir/usr/"\" "\"\$pkgdir\""
+    $processing
 }
 
 sha512sums=\"
-"$sha512'  'sshyp-\"\$pkgver\".tar.xz"
+"$sha512"  "$sumsname"
 \"
 " > output/APKBUILD
-    echo -e "\nAPKBUILD generated\n"
+    printf '\nAPKBUILD generated\n\n'
 } &&
 
 _create_hpkg() {
-    echo -e '\npackaging for Haiku...\n'
-    mkdir -p output/haikutemp/{bin,lib/sshyp,documentation/{packages/sshyp,man/man1},data/bash-completion/completions}
-    echo "name			sshyp
-version			"$version"-"$revision"
-architecture		any
-summary			\"A light-weight, self-hosted, synchronized password manager\"
-description		\"sshyp is the only password-store compatible CLI password manager available for Haiku - it is also available on Linux/Android (via Termux) so that you can sync your entries across all of your devices.\"
-packager		\"Randall Winkhart <idgr at tutanota dot com>\"
-vendor			\"Randall Winkhart\"
+    printf '\npackaging for Haiku...\n'
+    mkdir -p output/haikutemp/bin \
+         output/haikutemp/lib/sshyp/extensions \
+         output/haikutemp/documentation/packages/sshyp \
+         output/haikutemp/documentation/man/man1 \
+         output/haikutemp/data/bash-completion/completions \
+         output/haikutemp/data/zsh/site-functions
+    printf "name            sshyp_client
+version         "$version"-"$revision"
+architecture        any
+summary         \"A light-weight, self-hosted, synchronized password manager (client only)\"
+description     \"The fully-featured client for the sshyp password manager ported for Haiku. This is just a client: server hosting functionality is only available on Linux/BSD.\"
+packager        \"Randall Winkhart <idgr at tutanota dot com>\"
+vendor          \"Randall Winkhart\"
 licenses {
-	\"GNU GPL v3\"
+    \"GNU GPL v3\"
 }
 copyrights {
-	\"2021-2022 Randall Winkhart\"
+    \"2021-2023 Randall Winkhart\"
 }
 provides {
-	sshyp = "$version"
-	cmd:sshyp
+    sshyp_client = "$version"
+    cmd:sshyp
 }
 requires {
-	gnupg
-	openssh
-	python310
+    gnupg
+    openssh
+    python3.11
 }
 urls {
-	\"https://github.com/rwinkhart/sshyp\"
+    \"https://github.com/rwinkhart/sshyp\"
 }
 " > output/haikutemp/.PackageInfo
-    cp -r lib/. output/haikutemp/lib/sshyp/
-    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshync.py
-    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshyp.py
+    # START PORT
+    cp lib/* port-jobs/working/
+    cd port-jobs
+    ./SHEBANG.sh
+    ./RMSERVER.py
+    ./RMEXTMAN.py
+    ./CLIPTOOL.py
+    ./CLIPBOARD.py HAIKU
+    ./UNAME.py TMP
+    ./COMMENTS.py ALL
+    ./BLANKS.py
+    ./TABS.sh TABS
+    cd ..
+    mv port-jobs/working/* output/haikutemp/lib/sshyp/
+    # END PORT
     ln -s /system/lib/sshyp/sshyp.py output/haikutemp/bin/sshyp
-    cp -r share/doc/sshyp/. output/haikutemp/documentation/packages/sshyp/
     cp -r share/licenses/sshyp/. output/haikutemp/documentation/packages/sshyp/
-    cp extra/sshyp-completion.bash output/haikutemp/data/bash-completion/completions/sshyp
+    cp extra/completion.bash output/haikutemp/data/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/haikutemp/data/zsh/site-functions/_sshyp
     cp extra/manpage output/haikutemp/documentation/man/man1/sshyp.1
     gzip output/haikutemp/documentation/man/man1/sshyp.1
     cd output/haikutemp
-    package create -b sshyp-"$version"-"$revision"_all.hpkg
-    package add sshyp-"$version"-"$revision"_all.hpkg bin lib documentation data
+    package create -b HAIKU-sshyp_client-"$version"-"$revision"_all.hpkg
+    package add HAIKU-sshyp_client-"$version"-"$revision"_all.hpkg bin lib documentation data
     cd ../..
-    mv output/haikutemp/sshyp-"$version"-"$revision"_all.hpkg output/
+    mv output/haikutemp/HAIKU-sshyp_client-"$version"-"$revision"_all.hpkg output/
     rm -rf output/haikutemp
-    echo -e "\nHaiku packaging complete\n"
+    printf '\nHaiku packaging complete\n\n'
 } &&
 
 _create_deb() {
-    echo -e '\npackaging for Debian/Ubuntu...\n'
-    mkdir -p output/debiantemp/sshyp_"$version"-"$revision"_all/{DEBIAN,usr/{lib/sshyp,bin,share/{bash-completion/completions,man/man1}}}
-    echo "Package: sshyp
+    printf "\npackaging for $1...\n"
+    mkdir -p output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN \
+         output/debiantemp/sshyp_"$version"-"$revision"_all/usr/lib/sshyp/extensions \
+         output/debiantemp/sshyp_"$version"-"$revision"_all/usr/bin \
+         output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1 \
+         output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/bash-completion/completions \
+         output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/zsh/functions/Completion/Unix
+    # START PORT
+    cp lib/* port-jobs/working/
+    cd port-jobs
+    if [ "$1" = 'Debian' ]; then
+        ./CLIPTOOL.py LINUX
+        ./CLIPBOARD.py LINUX
+        special=DEBIAN
+    else
+        ./CLIPTOOL.py
+        ./CLIPBOARD.py WSL
+        special=WSL-ONLY-DEBIAN
+    fi
+    ./UNAME.py LINUX
+    ./COMMENTS.py ALL
+    ./BLANKS.py
+    ./TABS.sh TABS
+    cd ..
+    mv port-jobs/working/* output/debiantemp/sshyp_"$version"-"$revision"_all/usr/lib/sshyp/
+    # END PORT
+    ln -s /usr/lib/sshyp/sshyp.py output/debiantemp/sshyp_"$version"-"$revision"_all/usr/bin/sshyp
+    cp -r share output/debiantemp/sshyp_"$version"-"$revision"_all/usr/
+    cp extra/completion.bash output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/zsh/functions/Completion/Unix/_sshyp
+    cp extra/manpage output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
+    gzip output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
+    size=$(du --block-size=1024 -s output/debiantemp/sshyp_"$version"-"$revision"_all | cut -f1)
+    printf "Package: sshyp
 Version: $version
 Section: utils
 Architecture: all
 Maintainer: Randall Winkhart <idgr at tutanota dot com>
 Description: A light-weight, self-hosted, synchronized password manager
-Depends: python3, gnupg, openssh-client, xclip, wl-clipboard
-Suggests: bash-completion
 Priority: optional
-Installed-Size: 14584
+Installed-Size: $size
+Depends: python3, gnupg, openssh-client
 " > output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
-    cp -r lib/. output/debiantemp/sshyp_"$version"-"$revision"_all/usr/lib/sshyp/
-    ln -s /usr/lib/sshyp/sshyp.py output/debiantemp/sshyp_"$version"-"$revision"_all/usr/bin/sshyp
-    cp -r share output/debiantemp/sshyp_"$version"-"$revision"_all/usr/
-    cp extra/sshyp-completion.bash output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/bash-completion/completions/sshyp
-    cp extra/manpage output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
-    gzip output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
-    dpkg-deb --build --root-owner-group output/debiantemp/sshyp_"$version"-"$revision"_all/
-    mv output/debiantemp/sshyp_"$version"-"$revision"_all.deb output/
+    if [ "$1" = 'Debian' ]; then
+        printf "Suggests: wl-clipboard, xclip, bash-completion, openssh-server
+" >> output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
+    else
+        printf "Suggests: bash-completion, openssh-server
+" >> output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
+    fi
+    dpkg-deb --build --root-owner-group -z6 -Sextreme -Zxz output/debiantemp/sshyp_"$version"-"$revision"_all/
+    mv output/debiantemp/sshyp_"$version"-"$revision"_all.deb output/"$special"-sshyp_"$version"-"$revision"_all.deb
     rm -rf output/debiantemp
-    echo -e "\nDebian/Ubuntu packaging complete\n"
+    sha512="$(sha512sum output/"$special"-sshyp_"$version"-"$revision"_all.deb | cut -d' ' -f1)"
+    printf "\n$1 packaging complete\n\n"
 } &&
 
 _create_termux() {
-    echo -e '\npackaging for Termux...\n'
-    mkdir -p output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/{DEBIAN,data/data/com.termux/files/usr/{lib/sshyp,bin,share/{bash-completion/completions,man/man1}}}
-    echo "Package: sshyp
+    printf '\npackaging for Termux...\n'
+    mkdir -p output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/DEBIAN \
+         output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/lib/sshyp/extensions \
+         output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/bin \
+         output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1 \
+         output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/bash-completion/completions \
+         output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/zsh/site-functions
+    # START PORT
+    cp lib/* port-jobs/working/
+    cd port-jobs
+    ./RMSERVER.py
+    ./RMEXTMAN.py
+    ./CLIPTOOL.py
+    ./CLIPBOARD.py TERMUX
+    ./UNAME.py TERMUX
+    ./COMMENTS.py ALL
+    ./BLANKS.py
+    ./TABS.sh TABS
+    cd ..
+    mv port-jobs/working/* output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/lib/sshyp/
+    # END PORT
+    ln -s /data/data/com.termux/files/usr/lib/sshyp/sshyp.py output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/bin/sshyp
+    cp -r share output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/
+    cp extra/completion.bash output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/zsh/site-functions/_sshyp
+    cp extra/manpage output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
+    gzip output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
+    size=$(du --block-size=1024 -s output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux | cut -f1)
+    printf "Package: sshyp-client
 Version: $version
 Section: utils
 Architecture: all
@@ -157,60 +276,85 @@ Description: A light-weight, self-hosted, synchronized password manager
 Depends: python, gnupg, openssh, termux-api, termux-am
 Suggests: bash-completion
 Priority: optional
-Installed-Size: 14584
-" > output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/DEBIAN/control
-    cp -r lib/. output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/lib/sshyp/
-    ln -s /data/data/com.termux/files/usr/lib/sshyp/sshyp.py output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/bin/sshyp
-    cp -r share output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/
-    cp extra/sshyp-completion.bash output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/bash-completion/completions/sshyp
-    cp extra/manpage output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
-    gzip output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
-    dpkg-deb --build --root-owner-group output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/
-    mv output/termuxtemp/sshyp_"$version"-"$revision"_all_termux.deb output/
+Installed-Size: $size
+" > output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/DEBIAN/control
+    dpkg-deb --build --root-owner-group -z6 -Sextreme -Zxz output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux/
+    mv output/termuxtemp/TERMUX-sshyp-client_"$version"-"$revision"_all_termux.deb output/
     rm -rf output/termuxtemp
-    echo -e "\nTermux packaging complete\n"
+    printf '\nTermux packaging complete\n\n'
 } &&
 
 _create_rpm() {
-    echo -e '\npackaging for Fedora...\n'
+    printf '\npackaging for Fedora...\n'
     rm -rf ~/rpmbuild
     rpmdev-setuptree
-    cp output/sshyp-"$version".tar.xz ~/rpmbuild/SOURCES
-    echo "Name:           sshyp
+    mkdir -p output/fedoratemp/usr/bin \
+         output/fedoratemp/usr/lib/sshyp/extensions \
+         output/fedoratemp/usr/share/man/man1 \
+         output/fedoratemp/usr/share/bash-completion/completions \
+         output/fedoratemp/usr/share/zsh/site-functions
+    printf "Name:           sshyp
 Version:        "$version"
 Release:        "$revision"
 Summary:        A light-weight, self-hosted, synchronized password manager
 BuildArch:      noarch
 License:        GPL-3.0-only
 URL:            https://github.com/rwinkhart/sshyp
-Source0:        sshyp-"$version".tar.xz
-Requires:       python gnupg openssh-clients wl-clipboard
-Recommends:     bash-completion
-%description
+Source0:        GENERIC-FEDORA-sshyp-"$version".tar.xz
+Requires:       python gnupg openssh-clients
+Recommends:     wl-clipboard xclip bash-completion openssh-server
+%%description
 sshyp is a password-store compatible CLI password manager available for UNIX(-like) systems - its primary goal is to make syncing passwords and notes across devices as easy as possible via CLI.
-%install
-tar xf %{_sourcedir}/sshyp-"$version".tar.xz -C %{_sourcedir}
-cp -r %{_sourcedir}/usr %{buildroot}
-%files
+%%install
+tar xf %%{_sourcedir}/GENERIC-FEDORA-sshyp-"$version".tar.xz -C %%{_sourcedir}
+cp -r %%{_sourcedir}/usr %%{buildroot}
+%%files
 /usr/bin/sshyp
 /usr/lib/sshyp/sshyp.py
 /usr/lib/sshyp/sshync.py
+/usr/lib/sshyp/stweak.py
+/usr/lib/sshyp/extensions/
 /usr/share/bash-completion/completions/sshyp
-%license /usr/share/licenses/sshyp/license
-%doc
-/usr/share/doc/sshyp/changelog
+/usr/share/zsh/site-functions/_sshyp
+%%license /usr/share/licenses/sshyp/license
+%%doc
 /usr/share/man/man1/sshyp.1.gz
 " > ~/rpmbuild/SPECS/sshyp.spec
-rpmbuild -bb ~/rpmbuild/SPECS/sshyp.spec
-mv ~/rpmbuild/RPMS/noarch/* output/
-rm -rf ~/rpmbuild
-echo -e "\nFedora packaging complete\n"
+    # START PORT
+    cp lib/* port-jobs/working/
+    cd port-jobs
+    ./CLIPTOOL.py LINUX
+    ./CLIPBOARD.py LINUX
+    ./UNAME.py LINUX
+    ./COMMENTS.py ALL
+    ./BLANKS.py
+    ./TABS.sh TABS
+    cd ..
+    mv port-jobs/working/* output/fedoratemp/usr/lib/sshyp/
+    # END PORT
+    ln -s /usr/lib/sshyp/sshyp.py output/fedoratemp/usr/bin/sshyp
+    cp -r share output/fedoratemp/usr/
+    cp extra/completion.bash output/fedoratemp/usr/share/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/fedoratemp/usr/share/zsh/site-functions/_sshyp
+    cp extra/manpage output/fedoratemp/usr/share/man/man1/sshyp.1
+    gzip output/fedoratemp/usr/share/man/man1/sshyp.1
+    XZ_OPT=-e6 tar -C output/fedoratemp -cvJf output/GENERIC-FEDORA-sshyp-"$version".tar.xz usr/
+    rm -rf output/fedoratemp
+    cp output/GENERIC-FEDORA-sshyp-"$version".tar.xz ~/rpmbuild/SOURCES
+    rpmbuild -bb ~/rpmbuild/SPECS/sshyp.spec
+    mv ~/rpmbuild/RPMS/noarch/sshyp-"$version"-"$revision".noarch.rpm output/FEDORA-sshyp-"$version"-"$revision".noarch.rpm
+    rm -rf ~/rpmbuild
+    printf '\nFedora packaging complete\n\n'
 } &&
 
 _create_freebsd_pkg() {
-    echo -e '\npackaging for FreeBSD...'
-    mkdir -p output/freebsdtemp/usr/{lib/sshyp,bin,share/{bash-completion/completions,man/man1}}
-    echo "name: sshyp
+    printf '\npackaging for FreeBSD...\n'
+    mkdir -p output/freebsdtemp/usr/lib/sshyp/extensions \
+         output/freebsdtemp/usr/bin \
+         output/freebsdtemp/usr/share/man/man1 \
+         output/freebsdtemp/usr/local/share/bash-completion/completions \
+         output/freebsdtemp/usr/local/share/zsh/site-functions
+    printf "name: sshyp
 version: \""$version"\"
 abi = \"FreeBSD:13:*\";
 arch = \"freebsd:13:*\";
@@ -221,69 +365,113 @@ maintainer: <idgr at tutanota dot com>
 www: https://github.com/rwinkhart/sshyp
 prefix: /
 \"deps\" : {
-                   \"python\" : {
-                      \"origin\" : \"lang/python\"
+                   \"python3\" : {
+                      \"origin\" : \"lang/python3\"
                    },
                    \"gnupg\" : {
                       \"origin\" : \"security/gnupg\"
                    },
-                   \"xclip\" : {
-                      \"origin\" : \"x11/xclip\"
-                   },
-                   \"wl-clipboard\" : {
-                      \"origin\" : \"x11/wl-clipboard\"
-                   },
                 },
 " > output/freebsdtemp/+MANIFEST
-echo "/usr/bin/sshyp
-/usr/lib/sshyp/sshync.py
+printf "/usr/bin/sshyp
 /usr/lib/sshyp/sshyp.py
-/usr/share/bash-completion/completions/sshyp
-/usr/share/doc/sshyp/changelog
+/usr/lib/sshyp/sshync.py
+/usr/lib/sshyp/stweak.py
+/usr/local/share/bash-completion/completions/sshyp
+/usr/local/share/zsh/site-functions/_sshyp
 /usr/share/licenses/sshyp/license
 /usr/share/man/man1/sshyp.1.gz
+@dir /usr/lib/sshyp/extensions/
 " > output/freebsdtemp/plist
-cp -r lib/. output/freebsdtemp/usr/lib/sshyp/
-ln -s /usr/lib/sshyp/sshyp.py output/freebsdtemp/usr/bin/sshyp
-cp -r share output/freebsdtemp/usr/
-cp extra/sshyp-completion.bash output/freebsdtemp/usr/share/bash-completion/completions/sshyp
-cp extra/manpage output/freebsdtemp/usr/share/man/man1/sshyp.1
-gzip output/freebsdtemp/usr/share/man/man1/sshyp.1
-pkg create -m output/freebsdtemp/ -r output/freebsdtemp/ -p output/freebsdtemp/plist -o output/
-rm -rf output/freebsdtemp
-echo -e "\nFreeBSD packaging complete\n"
+    # START PORT
+    cp lib/* port-jobs/working/
+    cd port-jobs
+    ./CLIPTOOL.py LINUX
+    ./CLIPBOARD.py BSD
+    ./UNAME.py TMP
+    ./COMMENTS.py ALL
+    ./BLANKS.py
+    ./TABS.sh TABS
+    cd ..
+    mv port-jobs/working/* output/freebsdtemp/usr/lib/sshyp/
+    # END PORT
+    ln -s /usr/lib/sshyp/sshyp.py output/freebsdtemp/usr/bin/sshyp
+    cp -r share output/freebsdtemp/usr/
+    cp extra/completion.bash output/freebsdtemp/usr/local/share/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/freebsdtemp/usr/local/share/zsh/site-functions/_sshyp
+    cp extra/manpage output/freebsdtemp/usr/share/man/man1/sshyp.1
+    gzip output/freebsdtemp/usr/share/man/man1/sshyp.1
+    pkg create -m output/freebsdtemp/ -r output/freebsdtemp/ -p output/freebsdtemp/plist -o output/
+    mv output/sshyp-"$version".pkg output/FREEBSD-sshyp-"$version"-"$revision".pkg
+    rm -rf output/freebsdtemp
+    printf '\nFreeBSD packaging complete\n\n'
 } &&
 
-if [ "$1" == "generic" ]; then  # build scripts
-    _create_generic
-elif [ "$1" == "pkgbuild" ]; then
-    _create_generic
-    _create_pkgbuild
-elif [ "$1" == "apkbuild" ]; then
-    _create_generic
-    _create_apkbuild
-elif [ "$1" == "haiku" ]; then  # distribution packages
-    _create_hpkg
-elif [ "$1" == "debian" ]; then
-    _create_deb
-elif [ "$1" == "termux" ]; then
-    _create_termux
-elif [ "$1" == "fedora" ]; then
-    _create_generic
-    _create_rpm
-elif [ "$1" == "freebsd" ]; then
-    _create_freebsd_pkg
-elif [ "$1" == "buildable-arch" ]; then
-    _create_generic
-    _create_pkgbuild
-    _create_apkbuild
-    if [[ $(pacman -Q dpkg) == "dpkg"* ]]; then
-        _create_deb
+case "$1" in
+    pkgbuild)
+        _create_generic_linux
+        _create_pkgbuild Generic
+        ;;
+    pkgbuild-deb)
+        _create_deb Debian
+        _create_pkgbuild Deb
+        ;;
+    apkbuild)
+        _create_generic_linux
+        _create_apkbuild Generic
+        ;;
+    apkbuild-deb)
+        _create_deb Debian
+        _create_apkbuild Deb
+        ;;
+    haiku)
+        _create_hpkg
+        ;;
+    debian)
+        _create_deb Debian
+        ;;
+    wsl)
+        _create_deb WSL
+        ;;
+    termux)
         _create_termux
-    fi
-    if [[ "$(pacman -Q freebsd-pkg)" == "freebsd-pkg"* ]]; then
+        ;;
+    fedora)
+        _create_rpm
+        ;;
+    freebsd)
         _create_freebsd_pkg
-    fi
-else
-    echo -e '\nusage: package.sh [target] <revision>\n\ntargets:\n mainline: pkgbuild apkbuild haiku fedora debian\n experimental: freebsd termux\n other: buildable-arch\n'
-fi
+        ;;
+    buildable-arch)
+        _create_generic_linux
+        _create_pkgbuild Generic
+        _create_apkbuild Generic
+        case "$(pacman -Q dpkg)" in
+            dpkg*)
+            _create_termux
+            _create_deb WSL
+            _create_deb Debian
+            ;;
+        esac
+        case "$(pacman -Q freebsd-pkg)" in
+            freebsd-pkg*)
+            _create_freebsd_pkg
+            ;;
+        esac
+        ;;
+    buildable-arch-deb)
+        _create_termux
+        _create_deb WSL
+        _create_deb Debian
+        _create_pkgbuild Deb
+        _create_apkbuild Deb
+        case "$(pacman -Q freebsd-pkg)" in
+            freebsd-pkg*)
+            _create_freebsd_pkg
+            ;;
+        esac
+        ;;
+    *)
+    printf '\nusage: package.sh [target] <revision>\n\ntargets:\n full support: pkgbuild pkgbuild-deb apkbuild apkbuild-deb fedora debian wsl freebsd\n client-only: haiku termux\n groups: buildable-arch buildable-arch-deb\n\n'
+    ;;
+esac

port-jobs/BLANKS.py

@@ -0,0 +1,16 @@
+#!/usr/bin/env python3
+from os import listdir
+
+# loop through all Python files in the working directory
+for filename in listdir('working'):
+    if filename.endswith('.py'):
+        filepath = 'working/' + filename
+        # read input file
+        with open(filepath, 'r') as file:
+            new_file = []
+            for line in file:
+                # remove blank lines
+                if line != '\n':
+                    new_file.append(line)
+        # write the updated file contents
+        open(filepath, 'w').writelines(new_file)

port-jobs/CLIPBOARD.py

@@ -0,0 +1,62 @@
+#!/usr/bin/env python3
+import re
+from sys import argv, exit as s_exit
+
+# read arguments
+arguments, clip_replacement, clear_replacement = argv[1:], None, None
+
+# define replacement text depending on arguments
+if len(arguments) > 0:
+    if arguments[0] == 'WSL':
+        clip_replacement = """run(('powershell.exe', '-c', "Set-Clipboard '" + _copy_subject.replace("'", "''") + "'"))
+    Popen((realpath(__file__).rsplit('/', 1)[0] + "/clipclear.py", _hash.hexdigest(), 'wsl'), stdout=DEVNULL, stderr=DEVNULL)"""
+        clear_replacement = """hash_paste.update(run(('powershell.exe', '-c', 'Get-Clipboard'), stdout=PIPE).stdout.strip())
+if argv[1] == hash_paste.hexdigest():
+    run(('powershell.exe', '-c', 'Set-Clipboard'))"""
+    elif arguments[0] == 'MAC':
+        clip_replacement = """run('pbcopy', stdin=Popen(('printf', '%b', _copy_subject.replace('\\\\\\', '\\\\\\\\\\\\\\')), stdout=PIPE).stdout)
+    Popen((realpath(__file__).rsplit('/', 1)[0] + "/clipclear.py", _hash.hexdigest(), 'mac'))"""
+        clear_replacement = """hash_paste.update(run('pbpaste', stdout=PIPE).stdout.strip())
+if argv[1] == hash_paste.hexdigest():
+    run('pbcopy', input=b'')"""
+    elif arguments[0] == 'HAIKU':
+        clip_replacement = """run(('clipboard', '-c', _copy_subject))
+    Popen((realpath(__file__).rsplit('/', 1)[0] + "/clipclear.py", _hash.hexdigest(), 'haiku'))"""
+        clear_replacement = """hash_paste.update(run(('clipboard', '-p'), stdout=PIPE).stdout.strip())
+if argv[1] == hash_paste.hexdigest():
+    run(('clipboard', '-r'))"""
+    elif arguments[0] == 'TERMUX':
+        clip_replacement = """run(('termux-clipboard-set', _copy_subject))
+    Popen((realpath(__file__).rsplit('/', 1)[0] + "/clipclear.py", _hash.hexdigest(), 'termux'))"""
+        clear_replacement = """hash_paste.update(run('termux-clipboard-get', stdout=PIPE).stdout.strip())
+if argv[1] == hash_paste.hexdigest():
+    run(("termux-clipboard-set", "''"))"""
+    elif arguments[0] in ('LINUX', 'BSD'):
+        clip_replacement = """if 'WAYLAND_DISPLAY' in environ:
+        run('wl-copy', stdin=Popen(('printf', '%b', _copy_subject.replace('\\\\\\', '\\\\\\\\\\\\\\')), stdout=PIPE).stdout)
+        Popen((realpath(__file__).rsplit('/', 1)[0] + "/clipclear.py", _hash.hexdigest(), 'wayland'))
+    else:
+        run(('xclip', '-sel', 'c'), stdin=Popen(('printf', '%b', _copy_subject.replace('\\\\\\', '\\\\\\\\\\\\\\')), stdout=PIPE).stdout)
+        Popen((realpath(__file__).rsplit('/', 1)[0] + "/clipclear.py", _hash.hexdigest(), 'x11'))"""
+        clear_replacement = """if argv[2] == 'wayland':
+    hash_paste.update(run('wl-paste', stdout=PIPE).stdout.strip())
+    if argv[1] == hash_paste.hexdigest():
+        run(('wl-copy', '-c'))
+else:
+    hash_paste.update(run(('xclip', '-o', '-sel', 'c'), stdout=PIPE).stdout.strip())
+    if argv[1] == hash_paste.hexdigest():
+        run(('xclip', '-i', '/dev/null', '-sel', 'c'))"""
+else:
+    s_exit()
+
+targets = (('CLIPBOARD', 'sshyp.py', '', '', clip_replacement),
+           ('CLIPCLEAR', 'clipclear.py', '\n', '', clear_replacement))
+
+for target in targets:
+    # read text from target file
+    text = open(f"working/{target[1]}", 'r').read()
+    # compile regex and modify text
+    regex = re.compile(f"{target[2]}# PORT START {target[0]}.*?# PORT END {target[0]}{target[3]}", re.DOTALL)
+    new_text = re.sub(regex, target[4], text)
+    # write updated text to target file
+    open(f"working/{target[1]}", 'w').write(new_text)

port-jobs/CLIPTOOL.py

@@ -0,0 +1,36 @@
+#!/usr/bin/env python3
+import re
+from sys import argv
+
+# read arguments
+arguments = argv[1:]
+
+# define PORT target
+string1 = '# PORT START CLIPTOOL'
+string2 = '# PORT END CLIPTOOL'
+
+# define replacement text depending on arguments
+if len(arguments) > 0:
+    regex = re.compile(f"{string1}.*?{string2}", re.DOTALL)
+    replacement = """# check for clipboard tool and display warning if missing
+        _display_server, _clipboard_tool, _clipboard_package = None, None, None
+        if 'WAYLAND_DISPLAY' in environ:
+            _display_server, _clipboard_tool, _clipboard_package = 'Wayland', 'wl-copy', 'wl-clipboard'
+        elif 'DISPLAY' in environ:
+            _display_server, _clipboard_tool, _clipboard_package = 'X11', 'xclip', 'xclip'
+        if _display_server is not None and which(_clipboard_tool) is None:
+            curses_radio(['okay'], f'''WARNING: you are using {_display_server} and "{_clipboard_tool}" is not present -
+copying entry fields will not function until "{_clipboard_package}" is installed'''
+)"""
+else:
+    regex = re.compile(f"{string1}.*?{string2}\n", re.DOTALL)
+    replacement = ''
+
+# read input file
+text = open('working/stweak.py', 'r').read()
+
+# find and replace the defined PORT target
+new_text = re.sub(regex, replacement, text)
+
+# write updated text
+open('working/stweak.py', 'w').write(new_text)

port-jobs/COMMENTS.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+from os import listdir
+from re import match as rematch
+from sys import argv
+
+# read arguments
+arguments = argv[1:]
+
+# loop through all Python files in the working directory
+for filename in listdir('working'):
+    if filename.endswith('.py'):
+        filepath = 'working/' + filename
+        # read input file
+        with open(filepath, 'r') as file:
+            new_file = []
+            first_line = True
+            for line in file:
+                # determine whether to remove all or only PORT comments
+                if first_line:
+                    new_file.append(line)
+                    first_line = False
+                else:
+                    if len(arguments) > 0 and arguments[0] == 'ALL':
+                        if not rematch(r'^\s*#', line):
+                            new_file.append(line)
+                    elif not rematch(r'^\s*# PORT', line):
+                        new_file.append(line)
+        # write the updated file contents
+        open(filepath, 'w').writelines(new_file)

port-jobs/RMEXTMAN.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python3
+import re
+
+targets = (('TWEAK-EXTEND-FUNCTIONS', 'stweak.py', '\n', '\n\n', ''), 
+           ('TWEAK-EXTEND-OPTION', 'stweak.py', '', '', "curses_radio(['okay'], "
+            "'extension management is not supported on this platform\\\\n\\\\ninstead, you may install and manage "
+            "extensions through your system package manager\\\\n\\\\nofficial extension packages are available "
+            "at https://github.com/rwinkhart/sshyp-labs/releases')"))
+
+for target in targets:
+    # read text from target file
+    text = open(f"working/{target[1]}", 'r').read()
+    # compile regex and modify text
+    regex = re.compile(f"{target[2]}# PORT START {target[0]}.*?# PORT END {target[0]}{target[3]}", re.DOTALL)
+    new_text = re.sub(regex, target[4], text)
+    # write updated text to target file
+    open(f"working/{target[1]}", 'w').write(new_text)

port-jobs/RMSERVER.py

@@ -0,0 +1,18 @@
+#!/usr/bin/env python3
+import re
+
+devtype_replacement = """_install_type = curses_radio(('client (ssh-synchronized)', 'client (offline)'),
+                                 'device + sync type configuration')"""
+
+targets = (('SSHYNC-REMOTE', 'sshync.py', '\n', '\n\n', ''), ('WHITELIST-SERVER', 'stweak.py', '\n', '\n\n', ''),
+           ('TWEAK-DEVTYPE', 'stweak.py', '', '', devtype_replacement),
+           ('ARGS-SERVER', 'sshyp.py', '', '\n\n        ', ''), ('HELP-SERVER', 'sshyp.py', '', '\n', ''))
+
+for target in targets:
+    # read text from target file
+    text = open(f"working/{target[1]}", 'r').read()
+    # compile regex and modify text
+    regex = re.compile(f"{target[2]}# PORT START {target[0]}.*?# PORT END {target[0]}{target[3]}", re.DOTALL)
+    new_text = re.sub(regex, target[4], text)
+    # write updated text to target file
+    open(f"working/{target[1]}", 'w').write(new_text)

port-jobs/SHEBANG.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+if [ "$1" = 'PREP' ]; then
+    sed -i '1 s/.*/#!\/bin\/env\ python3.11/' ./*.py
+else
+    sed -i '1 s/.*/#!\/bin\/env\ python3.11/' ./working/sshyp.py ./working/clipclear.py
+fi

port-jobs/TABS.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+if [ "$1" = 'TABS' ]; then
+    unexpand -t 3,7,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,71,75,79,83,87,91,95,99,103,107,111,115,119,123 working/sshyp.py > working/sshyp.py.new
+    unexpand -t 3,7,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,71,75,79,83,87,91,95,99,103,107,111,115,119,123 working/sshync.py > working/sshync.py.new
+    unexpand -t 3,7,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,71,75,79,83,87,91,95,99,103,107,111,115,119,123 working/stweak.py > working/stweak.py.new
+    mv working/sshyp.py.new working/sshyp.py
+    mv working/sshync.py.new working/sshync.py
+    mv working/stweak.py.new working/stweak.py
+    chmod +x working/sshyp.py working/sshync.py working/stweak.py
+elif [ "$(grep -qP '\t' "$1" && echo TABS)" = 'TABS' ]; then
+    printf "$1 contains tab characters...\n"
+    read -rp 'replace with (4) spaces? (Y/n) ' replace
+    if [ "$replace" != 'n' ] && [ "$replace" != 'N' ]; then
+        expand -t 3,7,11,15,19,23,27,31,35,39,43,47,51,55,59,63,67,71,75,79,83,87,91,95,99,103,107,111,115,119,123 "$1" > "$1".new
+        chmod --reference="$1" "$1".new
+        mv "$1".new "$1"
+    fi
+fi

port-jobs/UNAME.py

@@ -0,0 +1,13 @@
+#!/usr/bin/env python3
+import re
+
+targets = (('UNAME-IMPORT-SSHYP', 'sshyp.py', ''), ('UNAME-IMPORT-STWEAK', 'stweak.py', ''))
+
+for target in targets:
+    # read text from target file
+    text, special = open(f"working/{target[1]}", 'r').read(), ''
+    # compile regex and modify text
+    regex = re.compile(f"# PORT START {target[0]}.*?# PORT END {target[0]}\n", re.DOTALL)
+    new_text = re.sub(regex, target[2], text)
+    # write updated text to target file
+    open(f"working/{target[1]}", 'w').write(new_text)

share/doc/sshyp/changelog

@@ -1,50 +0,0 @@
-sshyp v1.3.0
-
-the serious shepherd update
-
-this release ties up many of sshyp's loose ends where there was
-room for major performance, compatibility, and security improvements
-
-compatibility-breaking changes:
-
-- due to a near full re-write of the syncing functionality, all clients and servers
-must be updated to this release (v1.3.0 is not backwards compatible with any prior release)
-- it is recommended to either delete the contents of ~/.config/sshyp/deleted (on the server-side)
-or sync all of your clients before updating
-    ^ old entries in this folder will throw errors with v1.3.0
-
-user-facing features:
-
-- none - all changes were under-the-hood - the user experience should be
-exactly the same as v1.2.0 - just faster, less buggy, and more secure
-
-major fixes/optimizations:
-
-- a near full re-write of the syncing functionality
-    ^ all syncing logic has been moved into sshync.py (from sshyp.py and sshypRemote.py)
-    ^ in my setup, a dry, local "sshyp sync" went from 2.00+ seconds (v1.2.0) to 0.36 seconds (v1.3.0)
-        ^ the performance improvements are even greater when syncing from outside your local network
-- the following character sequences will no longer break the syncing logic: "@", "^&*", and "*&^"
-    ^ ASCII separator characters 29-31 are now used, instead
-- os.system has been replaced with subprocess.run in all cases, shell=True is no longer used with subprocess.run
-    ^ this protects against shell escape attacks and potentially makes sshyp more compatible with some environments
-- replaced shell commands with python built-in library functions where applicable
-    ^ this brings speed and compatibility improvements
-- sshyp should no longer incorrectly assume an X11 environment when Wayland is in use
-    ^ this fixes clipboard support in some Wayland environments, such as Sway (Plasma/Gnome/Phosh were unaffected)
-- sshyp now uses the default pinentry on Haiku thanks to haikuports/haikuports#7457
-    ^ this brings the Haiku port in-line with the other sshyp packages in terms of security
-- "python3" is now called over ssh, rather than "python"
-    ^ some environments do not have a "python" symlink, or it links to "python2" - changing this increases compatibility
-- fixed an issue from v1.2.0 where renaming threw an error if not in offline mode
-
-other notable changes:
-
-- quick-unlock password input is now hidden while the user is typing
-    ^ user input is now invisible to prevent snooping
-- lots of smaller optimizations not listed here
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-The full history of changes to "sshyp" can be found on the following page:
-https://raw.githubusercontent.com/rwinkhart/sshyp/main/extra/changelog-total

share/licenses/sshyp/license

@@ -1,5 +1,5 @@
     sshyp is a FOSS password manager that uses an sftp-based syncing back-end.
-    Copyright (C) 2022  Randall Winkhart  idgr@tutanota.com
+    Copyright (C) 2021-2023  Randall Winkhart  idgr@tutanota.com
 
     This program is free software: you can redistribute it and/or modify
     it under the terms of version 3 (only) of the GNU General Public License