Backport /lib/sshyp fix

Former-commit-id: 21f1705abc3581a6317cd4a390324a97de9ba1b9
Former-commit-id: 56ccd20bef6587cc3b185c6260b4328001eb541c

.gitignore

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

README.md

@@ -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".
@@ -33,26 +31,20 @@ 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)!
+- everything above on Haiku, FreeBSD, Linux, and Termux!
-
-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)
 
 # 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.
 
-Requests for additional distribution/OS support can be filed as issues.
+Support for additional environments, such as MacOS and OpenBSD, is coming soon.
 
 Extensions are available in the [sshyp-labs](https://github.com/rwinkhart/sshyp-labs) repository.
 
-Bash completions can be enabled by installing your distribution's "bash-completion" package and restarting your terminal.
-
 # 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,11 +53,11 @@ 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.
 
@@ -78,15 +70,15 @@ 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
+sshyp help
 ```
 
-Or alternatively, in the manpage:
+Or alternatively, in the man page:
 
 ```
 man sshyp
@@ -95,8 +87,9 @@ man sshyp
 # Roadmap
 Short-term Goals:
 
+- MacOS support
+- improved temporary directory security
 - a minimal GUI app - being made as an [extension](https://github.com/rwinkhart/sshyp-labs)
-- improved extension integration (allow extensions to add new arguments)
 
 Long-term Goals:
 

commit.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+git add -f extra lib/sshyp.py lib/sshync.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

@@ -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,110 @@
+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,10 +1,10 @@
-.TH sshyp 1 "14 December 2022" "v1.3.0" "sshyp man page"
+.TH sshyp 1 "08 June 2023" "v1.4.3" "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> [option] [flag]] [option]
 
-Server Usage: sshyp [option [flag] [<device id>]]
+Server Usage: sshyp <option> [flag] [device id]
 .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)
@@ -14,26 +14,26 @@ Setting up sshyp for the first time or altering its configuration (also recommen
 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:
+Copying the password of an existing entry saved as '~/.local/share/sshyp/financial/bank.gpg':
-    sshyp copy -p /financial/bank
+    sshyp /financial/bank copy -p
 
-Editing the username of an existing entry saved as ~/.local/share/sshyp/game.gpg:
+Editing the username of an existing entry saved as '~/.local/share/sshyp/game.gpg':
-    sshyp edit -u game
+    sshyp /game edit -u
 
-Making a new entry saved as ~/.local/share/sshyp/school/university.gpg using the built-in password generator:
+Making a new entry saved as '~/.local/share/sshyp/school/university.gpg' using the built-in password generator:
-    sshyp gen /school/university
+    sshyp /school/university gen
 
-Creating a note-only entry saved as ~/.local/share/sshyp/notes/testNote.gpg:
+Creating a note-only entry saved as '~/.local/share/sshyp/notes/test note.gpg':
-    sshyp add -n /notes/testNote
+    sshyp /notes/test\ note add -n
 
 Manually syncing entries with the server:
     sshyp sync
 
-Removing an existing folder saved as ~/.local/share/sshyp/social:
+Removing an existing folder saved as '~/.local/share/sshyp/social':
-    sshyp shear social/
+    sshyp /social/ shear
 .SH EXAMPLES (SERVER)
 Setting up the quick-unlock whitelist:
     sshyp whitelist setup
@@ -41,21 +41,21 @@ Setting up the quick-unlock whitelist:
 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:
+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:
+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 OPTIONS (CLIENT)
- help/--help/-h           bring up the help menu
+ 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
+ shear                    delete an existing entry
- sync/-s                  manually sync the entry directory via sshync
+ sync                     manually sync the entry directory via sshync
 .SH FLAGS (CLIENT)
 add:
  password/-p              add a password entry
@@ -78,7 +78,7 @@ copy:
 gen:
  update/-u                generate a password for an existing entry
 .SH OPTIONS (SERVER)
- help/--help/-h           bring up this menu
+ help/-h                  bring up this menu
  version/-v               display sshyp version info
  tweak                    configure sshyp
  whitelist                manage the quick-unlock whitelist
@@ -87,11 +87,11 @@ 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
+ del                      remove a device id from the quick-unlock whitelist
 .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)
@@ -106,23 +106,21 @@ Client setup:
     Run "sshyp tweak" 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 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
 .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/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, getmtime, join
 from subprocess import CalledProcessError, PIPE, run
 from sys import exit as s_exit
+home = expanduser("~")
 
 
+# PORT START SSHYNC-REMOTE
 # REMOTE
-
+# prints all necessary remote data to stdout
-def remote_list_gen(_client_device_name, _remote_dir):  # 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
-
+# deletes a file or folder and/or marks it for deletion upon syncing
-def delete(_file_path, _target_database):  # deletes a file or folder and/or marks it for deletion upon syncing
+def delete(_file_path, _target_database):
     from shutil import rmtree
+    _directory = f"{home}/.local/share/sshyp/"
     try:
-        if _file_path.endswith('/'):
+        if isdir(_directory + _file_path):
-            rmtree(f"{expanduser('~/.local/share/sshyp/')}{_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 _target_database == 'remotely':
-        for _device_name in listdir(expanduser('~/.config/sshyp/devices')):
+        for _device_name in listdir(f"{home}/.config/sshyp/devices"):
-            open(expanduser('~/.config/sshyp/deleted/') + _file_path.replace('/', '\x1e') + '\x1f' + _device_name, 'w')
+            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,45 @@ def get_local_data(_directory, _device):  # retrieves and returns titles and mod
 
 
 # LOCAL
-
+# captures and returns all necessary data from the remote server
-def remote_list_fetch(_user_data):  # 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'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)
+        s_exit(5)
-    _deletion_database = _remote_data[0].strip().split('\n')
+    _deletion_database = _remote_data[0].strip().splitlines()
-    _folder_database = _remote_data[1].strip().split('\n')
+    _folder_database = _remote_data[1].strip().splitlines()
-    _titles_mods = _remote_data[2].strip().split('\n')
+    _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):
     for _file in _deletion_database:
         if _file != '':
-            if _silent != 1:
+            if not _silent:
                 print(f"\u001b[38;5;208m{_file}\u001b[0m has been sheared, removing...")
             delete(_file, 'locally')
 
 
-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
+# creates and returns two lists (of titles and mod times) generated by sorting information from two provided 2D lists
-    # 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 +117,33 @@ 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
+# creates a sshync job profile
+def make_profile(_profile_dir, _local_dir, _remote_dir, _identity, _ip, _port, _user):
     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
+# returns a list of data read from a sshync job profile
+def get_profile(_profile_dir):
     try:
         _profile_data = open(_profile_dir).readlines()
     except (FileNotFoundError, IndexError):
         print('\n\u001b[38;5;9merror: the profile does not exist or is corrupted\u001b[0m\n')
         _profile_data = None
-        s_exit(3)
+        s_exit(2)
     _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()
+    _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
+# runs a sshync job profile
-    _user_data = get_profile(_profile_dir)  # import profile data
+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)
@@ -150,19 +162,19 @@ def run_profile(_profile_dir, _silent):  # runs a sshync job profile
             if int(_index_local[1][_i]) > int(_index_remote[1][_i]):
                 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]) + '/'}"])
+                     f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
             elif int(_index_local[1][_i]) < int(_index_remote[1][_i]):
                 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[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}",
                      f"{_user_data[3]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
         else:
             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]) + '/'}"])
+                 f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
     for _title in _index_remote[0]:
         if _title not in _index_local[0]:
             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[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}",
                  f"{_user_data[3]}{'/'.join(_title.split('/')[:-1]) + '/'}"])

package.sh

@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/bin/sh
 
 version=$(sed -n '1{p;q}' share/doc/sshyp/changelog | cut -c8-)
 if [ -z "$2" ]; then
@@ -7,26 +7,46 @@ else
     revision="$2"
 fi
 
-_create_generic() {
+_create_generic_linux() {
-    echo -e '\npackaging as generic...\n'
+    printf '\npackaging as generic (Linux)...\n'
-    mkdir -p output/generictemp/usr/{bin,lib/sshyp,share/{man/man1,bash-completion/completions}}
+    mkdir -p output/linuxtemp/usr/bin \
-    cp -r lib/. output/generictemp/usr/lib/sshyp/
+         output/linuxtemp/usr/lib/sshyp/extensions \
-    ln -s /usr/lib/sshyp/sshyp.py output/generictemp/usr/bin/sshyp
+         output/linuxtemp/usr/share/man/man1 \
-    cp -r share output/generictemp/usr/
+         output/linuxtemp/usr/share/bash-completion/completions \
-    cp extra/sshyp-completion.bash output/generictemp/usr/share/bash-completion/completions/sshyp
+         output/linuxtemp/usr/share/zsh/functions/Completion/Unix
-    cp extra/manpage output/generictemp/usr/share/man/man1/sshyp.1
+    # START PORT
-    gzip output/generictemp/usr/share/man/man1/sshyp.1
+    cp -r lib/. port-jobs/working/
-    tar -C output/generictemp -cvJf output/sshyp-"$version".tar.xz usr/
+    cd port-jobs
-    rm -rf output/generictemp
+    ./CLIPBOARD.py LINUX
-    sha512="$(sha512sum output/sshyp-"$version".tar.xz | awk '{print $1;}')"
+    ./UNAME.py LINUX
-    echo -e "\nsha512 sum:\n$sha512"
+    ./COMMENTS.py ALL
-    echo -e "\ngeneric packaging complete\n"
+    ./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 | awk '{print $1;}')"
+    printf '\ngeneric (Linux) packaging complete\n\n'
 } &&
 
 _create_pkgbuild() {
-    source='https://github.com/rwinkhart/sshyp/releases/download/v$pkgver/sshyp-$pkgver.tar.xz'
+    printf '\ngenerating PKGBUILD...\n'
-    echo -e '\ngenerating PKGBUILD...'
+    if [ "$1" = 'Deb' ]; then
-    echo "# Maintainer: Randall Winkhart <idgr at tutanota dot com>
+        local source='https://github.com/rwinkhart/sshyp/releases/download/v"$pkgver"/UBUNTU-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"
@@ -40,15 +60,33 @@ 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...'
+    printf '\ngenerating APKBUILD...\n'
-    echo "# Maintainer: Randall Winkhart <idgr@tutanota.com>
+    if [ "$1" = 'Deb' ]; then
+        local source="https://github.com/rwinkhart/sshyp/releases/download/v\"\$pkgver\"/UBUNTU-sshyp_\"\$pkgver\"-"$revision"_all.deb"
+        local sumsname="UBUNTU-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))"
@@ -61,94 +99,144 @@ depends='python3 gnupg openssh xclip wl-clipboard'
 source=\""$source"\"
 
 package() {
-    mkdir -p "\"\$pkgdir\""
+    $processing
-    cp -r "\"\$srcdir/usr/"\" "\"\$pkgdir\""
 }
 
 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'
+    printf '\npackaging for Haiku...\n'
-    mkdir -p output/haikutemp/{bin,lib/sshyp,documentation/{packages/sshyp,man/man1},data/bash-completion/completions}
+    mkdir -p output/haikutemp/bin \
-    echo "name			sshyp
+         output/haikutemp/lib/sshyp/extensions \
-version			"$version"-"$revision"
+         output/haikutemp/documentation/packages/sshyp \
-architecture		any
+         output/haikutemp/documentation/man/man1 \
-summary			\"A light-weight, self-hosted, synchronized password manager\"
+         output/haikutemp/data/bash-completion/completions \
-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.\"
+         output/haikutemp/data/zsh/site-functions
-packager		\"Randall Winkhart <idgr at tutanota dot com>\"
+    printf "name            sshyp_client
-vendor			\"Randall Winkhart\"
+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"
+    sshyp_client = "$version"
-	cmd:sshyp
+    cmd:sshyp
 }
 requires {
-	gnupg
+    gnupg
-	openssh
+    openssh
-	python310
+    python310
 }
 urls {
-	\"https://github.com/rwinkhart/sshyp\"
+    \"https://github.com/rwinkhart/sshyp\"
 }
 " > output/haikutemp/.PackageInfo
-    cp -r lib/. output/haikutemp/lib/sshyp/
+    # START PORT
-    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshync.py
+    cp -r lib/. port-jobs/working/
-    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshyp.py
+    cd port-jobs
+    ./SHEBANG.sh
+    ./RMSERVER.py
+    ./CLIPBOARD.py HAIKU
+    ./COMMENTS.py ALL
+    ./UNAME.py TMP
+    ./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 create -b HAIKU-sshyp-client-"$version"-"$revision"_all.hpkg
-    package add sshyp-"$version"-"$revision"_all.hpkg bin lib documentation data
+    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'
+    printf "\npackaging for $1...\n"
-    mkdir -p output/debiantemp/sshyp_"$version"-"$revision"_all/{DEBIAN,usr/{lib/sshyp,bin,share/{bash-completion/completions,man/man1}}}
+    mkdir -p output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN \
-    echo "Package: sshyp
+         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
+    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
 " > output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
-    cp -r lib/. output/debiantemp/sshyp_"$version"-"$revision"_all/usr/lib/sshyp/
+    if [ "$1" = 'Debian' ]; then
+        printf "Depends: python3, gnupg, openssh-client, xclip, wl-clipboard
+" >> output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
+    else
+        printf "Depends: python3, gnupg, openssh-client
+" >> output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
+    fi
+    printf "Suggests: bash-completion
+Priority: optional
+Installed-Size: 71680
+" >> output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
+    # START PORT
+    cp -r lib/. port-jobs/working/
+    cd port-jobs
+    if [ "$1" = 'Debian' ]; then
+        ./CLIPBOARD.py LINUX
+        special=UBUNTU
+    else
+        ./CLIPBOARD.py WSL
+        special=WSL-ONLY-UBUNTU
+    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/sshyp-completion.bash output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/bash-completion/completions/sshyp
+    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
-    dpkg-deb --build --root-owner-group output/debiantemp/sshyp_"$version"-"$revision"_all/
+    dpkg-deb --build --root-owner-group -z6 -Sextreme -Zxz output/debiantemp/sshyp_"$version"-"$revision"_all/
-    mv output/debiantemp/sshyp_"$version"-"$revision"_all.deb output/
+    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 | awk '{print $1;}')"
+    printf "\n$1 packaging complete\n\n"
 } &&
 
 _create_termux() {
-    echo -e '\npackaging for Termux...\n'
+    printf '\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}}}
+    mkdir -p output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/DEBIAN \
-    echo "Package: sshyp
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/lib/sshyp/extensions \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/bin \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1 \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/bash-completion/completions \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/zsh/site-functions
+    printf "Package: sshyp
 Version: $version
 Section: utils
 Architecture: all
@@ -157,60 +245,100 @@ 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
+Installed-Size: 71680
 " > 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/
+    # START PORT
+    cp -r lib/. port-jobs/working/
+    cd port-jobs
+    ./CLIPBOARD.py TERMUX
+    ./UNAME.py TERMUX
+    ./COMMENTS.py ALL
+    ./BLANKS.py
+    ./TABS.sh TABS
+    cd ..
+    mv port-jobs/working/* output/termuxtemp/sshyp_"$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/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/completion.bash output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/zsh/site-functions/_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/
+    dpkg-deb --build --root-owner-group -z6 -Sextreme -Zxz output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/
-    mv output/termuxtemp/sshyp_"$version"-"$revision"_all_termux.deb output/
+    mv output/termuxtemp/sshyp_"$version"-"$revision"_all_termux.deb output/TERMUX-sshyp_"$version"-"$revision"_all_termux.deb
     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
+    mkdir -p output/fedoratemp/usr/bin \
-    echo "Name:           sshyp
+         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
+Source0:        GENERIC-FEDORA-sshyp-"$version".tar.xz
 Requires:       python gnupg openssh-clients wl-clipboard
 Recommends:     bash-completion
-%description
+%%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
+%%install
-tar xf %{_sourcedir}/sshyp-"$version".tar.xz -C %{_sourcedir}
+tar xf %%{_sourcedir}/GENERIC-FEDORA-sshyp-"$version".tar.xz -C %%{_sourcedir}
-cp -r %{_sourcedir}/usr %{buildroot}
+cp -r %%{_sourcedir}/usr %%{buildroot}
-%files
+%%files
 /usr/bin/sshyp
 /usr/lib/sshyp/sshyp.py
 /usr/lib/sshyp/sshync.py
 /usr/share/bash-completion/completions/sshyp
-%license /usr/share/licenses/sshyp/license
+/usr/share/zsh/site-functions/_sshyp
-%doc
+%%license /usr/share/licenses/sshyp/license
+%%doc
 /usr/share/doc/sshyp/changelog
 /usr/share/man/man1/sshyp.1.gz
 " > ~/rpmbuild/SPECS/sshyp.spec
-rpmbuild -bb ~/rpmbuild/SPECS/sshyp.spec
+    # START PORT
-mv ~/rpmbuild/RPMS/noarch/* output/
+    cp -r lib/. port-jobs/working/
-rm -rf ~/rpmbuild
+    cd port-jobs
-echo -e "\nFedora packaging complete\n"
+    ./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...'
+    printf '\npackaging for FreeBSD...\n'
-    mkdir -p output/freebsdtemp/usr/{lib/sshyp,bin,share/{bash-completion/completions,man/man1}}
+    mkdir -p output/freebsdtemp/usr/lib/sshyp/extensions \
-    echo "name: sshyp
+         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:*\";
@@ -235,55 +363,103 @@ prefix: /
                    },
                 },
 " > output/freebsdtemp/+MANIFEST
-echo "/usr/bin/sshyp
+printf "/usr/bin/sshyp
 /usr/lib/sshyp/sshync.py
 /usr/lib/sshyp/sshyp.py
-/usr/share/bash-completion/completions/sshyp
+/usr/local/share/bash-completion/completions/sshyp
+/usr/local/share/zsh/site-functions/_sshyp
 /usr/share/doc/sshyp/changelog
 /usr/share/licenses/sshyp/license
 /usr/share/man/man1/sshyp.1.gz
 " > output/freebsdtemp/plist
-cp -r lib/. output/freebsdtemp/usr/lib/sshyp/
+    # START PORT
-ln -s /usr/lib/sshyp/sshyp.py output/freebsdtemp/usr/bin/sshyp
+    cp -r lib/. port-jobs/working/
-cp -r share output/freebsdtemp/usr/
+    cd port-jobs
-cp extra/sshyp-completion.bash output/freebsdtemp/usr/share/bash-completion/completions/sshyp
+    ./CLIPBOARD.py TERMUX
-cp extra/manpage output/freebsdtemp/usr/share/man/man1/sshyp.1
+    ./UNAME.py TMP
-gzip output/freebsdtemp/usr/share/man/man1/sshyp.1
+    ./COMMENTS.py ALL
-pkg create -m output/freebsdtemp/ -r output/freebsdtemp/ -p output/freebsdtemp/plist -o output/
+    ./BLANKS.py
-rm -rf output/freebsdtemp
+    ./TABS.sh TABS
-echo -e "\nFreeBSD packaging complete\n"
+    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
+case "$1" in
-    _create_generic
+    pkgbuild)
-elif [ "$1" == "pkgbuild" ]; then
+        _create_generic_linux
-    _create_generic
+        _create_pkgbuild Generic
-    _create_pkgbuild
+        ;;
-elif [ "$1" == "apkbuild" ]; then
+    pkgbuild-deb)
-    _create_generic
+        _create_deb Debian
-    _create_apkbuild
+        _create_pkgbuild Deb
-elif [ "$1" == "haiku" ]; then  # distribution packages
+        ;;
-    _create_hpkg
+    apkbuild)
-elif [ "$1" == "debian" ]; then
+        _create_generic_linux
-    _create_deb
+        _create_apkbuild Generic
-elif [ "$1" == "termux" ]; then
+        ;;
-    _create_termux
+    apkbuild-deb)
-elif [ "$1" == "fedora" ]; then
+        _create_deb Debian
-    _create_generic
+        _create_apkbuild Deb
-    _create_rpm
+        ;;
-elif [ "$1" == "freebsd" ]; then
+    haiku)
-    _create_freebsd_pkg
+        _create_hpkg
-elif [ "$1" == "buildable-arch" ]; then
+        ;;
-    _create_generic
+    debian)
-    _create_pkgbuild
+        _create_deb Debian
-    _create_apkbuild
+        ;;
-    if [[ $(pacman -Q dpkg) == "dpkg"* ]]; then
+    wsl)
-        _create_deb
+        _create_deb WSL
+        ;;
+    termux)
         _create_termux
-    fi
+        ;;
-    if [[ "$(pacman -Q freebsd-pkg)" == "freebsd-pkg"* ]]; then
+    fedora)
+        _create_rpm
+        ;;
+    freebsd)
         _create_freebsd_pkg
-    fi
+        ;;
-else
+    buildable-arch)
-    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'
+        _create_generic_linux
-fi
+        _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 mainline: pkgbuild pkgbuild-deb apkbuild apkbuild-deb fedora debian wsl haiku freebsd\n experimental: 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,50 @@
+#!/usr/bin/env python3
+import re
+from sys import argv, exit as s_exit
+
+# read arguments
+arguments = argv[1:]
+
+# define replacement text depending on arguments
+if len(arguments) > 0:
+    if arguments[0] == 'WSL':
+        replacement = """run(['powershell.exe', '-c', "Set-Clipboard '" + _copy_line[_index].rstrip().replace("'", "''") + "'"])
+    Popen("sleep 30; powershell.exe -c Set-Clipboard ''", shell=True, stdout=DEVNULL, stderr=DENVULL)"""
+    elif arguments[0] == 'MAC':
+        replacement = """run(['pbcopy'], stdin=Popen(['printf', _copy_line[_index].rstrip().replace('\\\\\\', '\\\\\\\\\\\\\\').replace('%', '%%')],
+                                    stdout=PIPE).stdout)
+    Popen("sleep 30; printf '' | pbcopy", shell=True)"""
+    elif arguments[0] == 'HAIKU':
+        replacement = """run(['clipboard', '-c', _copy_line[_index].rstrip()])
+    Popen('sleep 30; clipboard -r', shell=True)"""
+    elif arguments[0] == 'TERMUX':
+        replacement = """run(['termux-clipboard-set', _copy_line[_index].rstrip()])
+    Popen("sleep 30; termux-clipboard-set ''", shell=True)"""
+    elif arguments[0] == 'BSD':
+        replacement = """run(['xclip', '-sel', 'c'], stdin=Popen(['printf', _copy_line[_index].rstrip().replace('\\', '\\\\')
+                                            .replace('%', '%%')], stdout=PIPE).stdout)
+    Popen("sleep 30; printf '' | xclip -sel c", shell=True)"""
+    elif arguments[0] == 'LINUX':
+        replacement = """if 'WAYLAND_DISPLAY' in environ:
+        run(['wl-copy', _copy_line[_index].rstrip()])
+        Popen('sleep 30; wl-copy -c', shell=True)
+    else:
+        run(['xclip', '-sel', 'c'], stdin=Popen(['printf', _copy_line[_index].rstrip().replace('\\\\\\', '\\\\\\\\\\\\\\')
+                                                .replace('%', '%%')], stdout=PIPE).stdout)
+        Popen("sleep 30; printf '' | xclip -sel c", shell=True)"""
+else:
+    s_exit()
+
+# define PORT target
+string1 = '# PORT START CLIPBOARD'
+string2 = '# PORT END CLIPBOARD'
+
+# read input file
+text = open('working/sshyp.py', 'r').read()
+
+# find and replace the defined PORT target
+regex = re.compile(f"{string1}.*?{string2}", re.DOTALL)
+new_text = re.sub(regex, replacement, text)
+
+# write updated text
+open('working/sshyp.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/RMSERVER.py

@@ -0,0 +1,82 @@
+#!/usr/bin/env python3
+import re
+
+# SSHYNC-REMOTE
+# define PORT target
+string1 = '# PORT START SSHYNC-REMOTE'
+string2 = '# PORT END SSHYNC-REMOTE'
+
+# read input file
+text = open('working/sshync.py', 'r').read()
+
+# find and replace the defined PORT target
+regex = re.compile(f"\n{string1}.*?{string2}\n\n", re.DOTALL)
+new_text = re.sub(regex, '', text)
+
+# write updated text
+open('working/sshync.py', 'w').write(new_text)
+
+# WHITELIST-SERVER
+# define PORT target
+string1 = '# PORT START WHITELIST-SERVER'
+string2 = '# PORT END WHITELIST-SERVER'
+
+# read input file
+text = open('working/sshyp.py', 'r').read()
+
+# find and replace the defined PORT target
+regex = re.compile(f"\n{string1}.*?{string2}\n\n", re.DOTALL)
+new_text = re.sub(regex, '', text)
+
+# write updated text
+open('working/sshyp.py', 'w').write(new_text)
+
+# TWEAK-DEVTYPE
+# define PORT target
+string1 = '# PORT START TWEAK-DEVTYPE'
+string2 = '# PORT END TWEAK-DEVTYPE'
+
+# set replacement text
+replacement = """if True:
+        _sshyp_data = ['client']
+        Path(f"{home}/.local/share/sshyp").mkdir(mode=0o700, parents=True, exist_ok=True)"""
+
+# read input file
+text = open('working/sshyp.py', 'r').read()
+
+# find and replace the defined PORT target
+regex = re.compile(f"{string1}.*?{string2}", re.DOTALL)
+new_text = re.sub(regex, replacement, text)
+
+# write updated text
+open('working/sshyp.py', 'w').write(new_text)
+
+# ARGS-SERVER
+# define PORT target
+string1 = '# PORT START ARGS-SERVER'
+string2 = '# PORT END ARGS-SERVER'
+
+# read input file
+text = open('working/sshyp.py', 'r').read()
+
+# find and replace the defined PORT target
+regex = re.compile(f"{string1}.*?{string2}\n\n        ", re.DOTALL)
+new_text = re.sub(regex, '', text)
+
+# write updated text
+open('working/sshyp.py', 'w').write(new_text)
+
+# HELP-SERVER
+# define PORT target
+string1 = '# PORT START HELP-SERVER'
+string2 = '# PORT END HELP-SERVER'
+
+# read input file
+text = open('working/sshyp.py', 'r').read()
+
+# find and replace the defined PORT target
+regex = re.compile(f"{string1}.*?{string2}\n", re.DOTALL)
+new_text = re.sub(regex, '', text)
+
+# write updated text
+open('working/sshyp.py', 'w').write(new_text)

port-jobs/SHEBANG.sh

@@ -0,0 +1,5 @@
+#!/bin/sh
+if [ "$1" = 'HAIKU' ]; then
+    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' ./working/sshync.py
+    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' ./working/sshyp.py
+fi

port-jobs/TABS.sh

@@ -0,0 +1,16 @@
+#!/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
+    mv working/sshyp.py.new working/sshyp.py
+    mv working/sshync.py.new working/sshync.py
+    chmod +x working/sshyp.py working/sshync.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,47 @@
+#!/usr/bin/env python3
+import re
+from sys import argv, exit as s_exit
+
+# read arguments
+arguments = argv[1:]
+
+# define replacement text depending on arguments
+if len(arguments) > 0:
+    if arguments[0] == 'TMP':
+        replacement = 'symlink("/tmp", f"{home}/.config/sshyp/tmp")'
+    elif arguments[0] == 'TERMUX':
+        replacement = 'symlink("/data/data/com.termux/files/usr/tmp", f"{home}/.config/sshyp/tmp")'
+    elif arguments[0] == 'LINUX':
+        replacement = 'symlink("/dev/shm", f"{home}/.config/sshyp/tmp")'
+else:
+    s_exit()
+
+# UNAME-IMPORT
+# define PORT target
+string1 = '# PORT START UNAME-IMPORT'
+string2 = '# PORT END UNAME-IMPORT'
+
+# read input file
+text = open('working/sshyp.py', 'r').read()
+
+# find and replace the defined PORT target
+regex = re.compile(f"{string1}.*?{string2}\n", re.DOTALL)
+new_text = re.sub(regex, '', text)
+
+# write updated text
+open('working/sshyp.py', 'w').write(new_text)
+
+# UNAME-TMP
+# define PORT target
+string1 = '# PORT START UNAME-TMP'
+string2 = '# PORT END UNAME-TMP'
+
+# read input file
+text = open('working/sshyp.py', 'r').read()
+
+# find and replace the defined PORT target
+regex = re.compile(f"{string1}.*?{string2}", re.DOTALL)
+new_text = re.sub(regex, replacement, text)
+
+# write updated text
+open('working/sshyp.py', 'w').write(new_text)

share/doc/sshyp/changelog

@@ -1,50 +1,27 @@
-sshyp v1.3.0
+sshyp v1.4.3
+06/08/2023
 
-the serious shepherd update
+the argumentative agronomist update - patch three
 
-this release ties up many of sshyp's loose ends where there was
+IMPORTANT: the next major release of sshyp, v1.5.0, will make breaking changes that will require
-room for major performance, compatibility, and security improvements
+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)
 
-compatibility-breaking changes:
+this is a highly unconventional release featuring backports to fix critical bugs found during the
+development of the upcoming v1.5.0
 
-- due to a near full re-write of the syncing functionality, all clients and servers
+fixes:
-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:
+- 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
-- none - all changes were under-the-hood - the user experience should be
+    to be updated - to avoid breaking compatibility with 1.4.X, folder renaming was simply disabled
-exactly the same as v1.2.0 - just faster, less buggy, and more secure
+    for the time being
-
+- backported fix for syncing over IPv6
-major fixes/optimizations:
+- backported fix for multiple versions of Powershell being called under WSL
-
+- backported fix for checking /lib/sshyp instead of /usr/lib/sshyp
-- 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
+https://github.com/rwinkhart/sshyp/tree/main/extra/changelog-archive/

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