Fixed re-encryption not being possible in offline mode

Former-commit-id: f608b138c1d850523c3c5cde0e65ec592a1e1a10
Former-commit-id: 0c5f542c6bf66e51c79969dd3ba60586d814d73a

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,72 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '34 22 * * 5'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        
+        # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+        
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines. 
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #   echo "Run, Build Application using script"
+    #   ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2

.gitignore

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

PKGBUILD

@@ -1,22 +0,0 @@
-# Maintainer: Randall Winkhart <idgr at tutanota dot com>
-
-pkgname=sshyp
-pkgver=2021.12.01.fr2.1
-pkgrel=1
-pkgdesc='A self-hosted, synchronized password manager'
-url='https://github.com/rwinkhart/sshyp'
-arch=('x86_64' 'aarch64')
-license=('GPL3')
-depends=( python gnupg openssh nano xclip wl-clipboard)
-
-source_x86_64=('https://github.com/rwinkhart/sshyp/releases/download/v2021.12.01.fr2.1/sshyp-2021.12.01.fr2.1.tar.xz')
-source_aarch64=('https://github.com/rwinkhart/sshyp/releases/download/v2021.12.01.fr2.1/sshyp-2021.12.01.fr2.1.tar.xz')
-sha512sums_x86_64=('fdef7455fd48d190794d2323b3e8d75251d21a472cffb72757e1422c532731492234f250c292e6f27955f6670aa528c609ad786f4abab79a5b4a4d070ce6343b')
-sha512sums_aarch64=('fdef7455fd48d190794d2323b3e8d75251d21a472cffb72757e1422c532731492234f250c292e6f27955f6670aa528c609ad786f4abab79a5b4a4d070ce6343b')
-
-package() {
-
-	tar xf sshyp-"$pkgver".tar.xz -C "${pkgdir}"
-	chown -R "$USER" ${pkgdir}/var/lib/sshyp
-
-}

README.md

@@ -1,14 +1,28 @@
-# sshyp
-A very simple self-hosted, synchronized password manager. Alternative to GNU pass.
+![sshyp](https://github.com/rwinkhart/sshyp-labs/blob/main/extra/artwork/sshyp-banner.png)
 
-"sshyp" stands for "sshync passwords", or "ssh sync passwords".
-"sshync" is the custom syncing backend (based on sftp) used by "sshyp".
+[![release](https://img.shields.io/github/v/release/rwinkhart/sshyp)](https://github.com/rwinkhart/sshyp/releases)
+![python](https://img.shields.io/badge/python-3.7--3.11-yellow)
+[![downloads](https://img.shields.io/github/downloads/rwinkhart/sshyp/total)](https://github.com/rwinkhart/sshyp/releases)
+
+[![CodeQL](https://github.com/rwinkhart/sshyp/actions/workflows/codeql-analysis.yml/badge.svg?branch=main)](https://github.com/rwinkhart/sshyp/actions/workflows/codeql-analysis.yml)
+
+pronounced as: 'sheep', 'shēp'
+
+sshyp is a very simple self-hosted, synchronized password manager for UNIX(-like) systems (currently Haiku/FreeBSD/Linux).
+
+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 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".
 
 # WARNING
 It is your responsibility to assess the security and stability of "sshyp" before using it and ensure it meets your needs.
 I am not responsible for any data loss or breaches of your information resulting from the use of "sshyp".
 "sshyp" is a new project that is constantly being updated, and though safety and security are priorities, they cannot be guaranteed.
 
+Always check the [known bugs](https://github.com/rwinkhart/sshyp/wiki/Known-Bugs) list before updating or installing sshyp.
+
 # Mission Statement
 sshyp aims to make it as simple as possible to manage passwords and notes via CLI across multiple devices in a secure, self-hosted fashion.
 
@@ -16,75 +30,56 @@ What sshyp can do:
 
 - securely manage a collection of encrypted passwords and notes via CLI
 - generate new, secure passwords to the user's choice in length and complexity
-- securely sync said passwords and notes seamlessly between multiple POSIX compliant Unix devices
-
-What sshyp will do:
-
-- everything it already does, but also in a GUI for Linux/Android
-- have a distinct retro theme
-- receive many usability enhancements
-
-What sshyp definitely won't do:
-
-- 2FA/MFA (for security purposes, this should not be handled by your password manager)
-- Windows support (I don't use Windows and I have no interest in developing for it)
+- 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!
 
 # Installation
-Arch Linux (x86_64, aarch64)
+**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.*
 
-Note: currently unavailable in the AUR (the older version, "rpass", will remain available until sshyp is stable)
+Please see the [installation guide](https://github.com/rwinkhart/sshyp/wiki/Installation) in the sshyp wiki for directions specific to your distribution/OS.
 
-sshyp releases will be available in the Arch User Repository as 'sshyp'.
+Pre-built packages exist for Haiku, FreeBSD, Alpine Linux, Debian/Ubuntu Linux, Fedora Linux, Termux, and WSL. These can be downloaded from the releases page.
 
-Install with your preferred AUR helper or use:
+Additionally, sshyp is distributed on the AUR.
+
+Extensions can be installed from the `sshyp tweak` menu on most supported platforms.
+
+For Haiku and Termux, extensions must instead be installed through the [system package manager](https://github.com/rwinkhart/sshyp-labs/releases).
+
+# Building
+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:
 
 ```
-git clone https://aur.archlinux.org/sshyp.git
+git clone https://github.com/rwinkhart/sshyp.git
 cd sshyp
-makepkg -si
+./package.sh [target] <revision>
 ```
 
-Packaging for other distributions coming soon.
+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 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 WSL.
 
 # Usage
-Upon initial installation, be sure to run:
+Upon initial installation (on both the server and client devices), run `sshyp init` to configure the settings necessary for sshyp to function.
 
-```
-sshyp tweak
-```
+In order to configure optional settings or change already configured settings, run `sshyp tweak`.
 
-This command will allow you to configure the settings necessary for sshyp to function.
-As of right now, sshyp is rapidly changing, and as such, it is a good idea to run "sshyp tweak" after each 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.
 
-All available options can be found with:
-
-```
-sshyp --help
-```
+All available options can be found with `sshyp help`, or alternatively, in the man page.
 
 # Roadmap
 Short-term Goals:
 
-- create new file list w/color and w/o file extensions
-- create a man page
-- overhaul argument system
-- fix lots of bugs!
-- make lots of optimizations!
-
-Medium-term Goals:
-
-- create minimal GUI apps (Linux x86_64, Linux aarch64)
-- auto-completion on tab for CLI version
+- migrate from gpg to a better-suited utility focused on symmetric cipher encryption
 
 Long-term Goals:
 
+- improve OS compatibility
 - seize the thrones, shear the humans
-
-# Known Issues
-Broken Features in Latest Release:
-
-- the 'gen' function uses the older notetaking system
-
-Broken Features in Source:
-
-- the 'gen' function uses the older notetaking system

bin/sshync.py

@@ -1,106 +0,0 @@
-#!/usr/bin/python3
-
-# sshync 2021.12.01.unreleased6
-
-# external modules
-
-from os import system, remove, walk
-from os.path import getmtime, join
-from sys import exit as s_exit
-
-
-# utility functions
-
-def get_titles_mods(_directory, _destination, _user_data):
-    _title_list, _mod_list = [], []
-    # local fetching
-    if _destination == 'l':
-        if type(_user_data) == str:
-            _user_data = str(_user_data).strip('(').strip(')').replace(' ', '').split(',')
-        remove(_user_data[6] + 'sshync_database')
-        for _root, _directories, _files in walk(_directory):
-            for _filename in _files:
-                _title_list.append(join(_root.replace(_directory, '', 1), _filename))
-                _mod_list.append(int(getmtime(join(_root, _filename))))
-        i = -1
-        for _title in _title_list:
-            open(_user_data[6] + 'sshync_database', 'a').write(str(_title) + '\n')
-        open(_user_data[6] + 'sshync_database', 'a').write('^&*\n')
-        for _mod in _mod_list:
-            open(_user_data[6] + 'sshync_database', 'a').write(str(_mod) + '\n')
-    # remote fetching
-    if _destination == 'r':
-        system(f"ssh -i '{_user_data[5]}' -p {_user_data[2]} {_user_data[0]}@{_user_data[1]} \"python -c 'import sshync"
-               f"; sshync.get_titles_mods(\"'\"{_user_data[4]}\"'\", \"'\"l\"'\", \"'\"{_user_data}\"'\")'\"")
-        system(f"sftp -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:'{_user_data[6]}sshync_database' "
-               f"'{_user_data[6]}sshync_database'")
-        _titles, _sep, _mods = ' '.join(open(_user_data[6] + 'sshync_database').readlines()).replace('\n', '').partition('^&*')
-        _title_list, _mod_list = _titles.split(' ')[:-1], _mods.split(' ')[1:]
-    return _title_list, _mod_list
-
-
-def sort_titles_mods(_list_1, _list_2):
-    _title_list_2_sorted, _mod_list_2_sorted = [], []
-    # title sorting
-    for _title in _list_1[0]:
-        if _title in _list_2[0]:
-            _title_list_2_sorted.append(_title)
-    for _title in _list_2[0]:
-        if _title not in _title_list_2_sorted:
-            _title_list_2_sorted.append(_title)
-    # mod time sorting
-    for _title in _title_list_2_sorted:
-        _mod_list_2_sorted.append(_list_2[1][_list_2[0].index(_title)])
-    return _title_list_2_sorted, _mod_list_2_sorted
-
-
-def make_profile(_profile_dir, _local_dir, _remote_dir, _identity, _ip, _port, _user):
-    open(_profile_dir, 'w').write(_user + '\n' + _ip + '\n' + _port + '\n' + _local_dir + '\n' + _remote_dir + '\n' +
-                                  _identity + '\n')
-
-
-def get_profile(_profile_dir):
-    try:
-        _profile_data = open(_profile_dir).readlines()
-    except (FileNotFoundError, IndexError):
-        print('\nEither the profile does not exist, or it is corrupted.\n')
-        _profile_data = None
-        s_exit()
-    # extract data from profile
-    _user = _profile_data[0].replace('\n', '')
-    _ip = _profile_data[1].replace('\n', '')
-    _port = _profile_data[2].replace('\n', '')
-    _local_dir = _profile_data[3].replace('\n', '')
-    _remote_dir = _profile_data[4].replace('\n', '')
-    _identity = _profile_data[5].replace('\n', '')
-    _data_dir = ' '.join(_profile_dir.split('/')[:-1]).replace(' ', '/') + '/'
-    return _user, _ip, _port, _local_dir, _remote_dir, _identity, _data_dir
-
-
-def run_profile(_profile_dir):
-    _user_data = get_profile(_profile_dir)
-    _remote_titles_mods_saver = get_titles_mods(_user_data[4], 'r', _user_data)  # saved to prevent re-walking directory
-    _index_l = sort_titles_mods(_remote_titles_mods_saver, get_titles_mods(_user_data[3], 'l', _user_data))
-    _index_r = sort_titles_mods(_index_l, _remote_titles_mods_saver)
-    _i = -1
-    for _title in _index_l[0]:
-        _i += 1
-        if _title in _index_r[0]:
-            # compare mod times and sync
-            if int(_index_l[1][_i]) > int(_index_r[1][_i]):
-                print(f"[{_title}] Local is newer, uploading...")
-                system(f"sftp -p -i '{_user_data[5]}' -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:"
-                       f"{_user_data[4]}{_title} <<< $'put {_user_data[3]}{_title}'")
-            elif int(_index_l[1][_i]) < int(_index_r[1][_i]):
-                print(f"[{_title}] Remote is newer, downloading...")
-                system(f"sftp -p -i '{_user_data[5]}' -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:"
-                       f"{_user_data[4]}{_title} {_user_data[3]}{_title}")
-        else:
-            print(f"[{_title}] Not on remote server, uploading...")
-            system(f"sftp -p -i '{_user_data[5]}' -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:{_user_data[4]}"
-                   f"{_title} <<< $'put {_user_data[3]}{_title}'")
-    for _title in _index_r[0]:
-        if _title not in _index_l[0]:
-            print(f"[{_title}] Not in local directory, downloading...")
-            system(f"sftp -p -i '{_user_data[5]}' -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:{_user_data[4]}"
-                   f"{_title} {_user_data[3]}{_title}")

bin/sshyp

@@ -1,484 +0,0 @@
-#!/usr/bin/python3
-
-# external modules
-
-from os import environ, mkdir, remove, system
-from shutil import copy, move, rmtree
-from sys import argv, exit as s_exit
-import random
-import sshync
-import string
-
-
-# utility functions
-
-def replace_line(file_name, line_num, text):  # replaces text in a given line with different text
-    _lines = open(file_name, 'r').readlines()
-    _lines[line_num] = text
-    open(file_name, 'w').writelines(_lines)
-
-
-def shm_gen():  # generates random folder in /dev/shm for security and returns random names for the folder and temp file
-    _shm_folder_gen = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                              for _ in range(random.randint(10, 30)))
-    _shm_entry_gen = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                             for _ in range(random.randint(10, 30)))
-    mkdir(f"/dev/shm/{_shm_folder_gen}", 0o700)
-    return _shm_folder_gen, _shm_entry_gen
-
-
-def encrypt(_shm_folder, _shm_entry, _location):
-    system(f"gpg -r {str(gpg_id)} -e '/dev/shm/{_shm_folder}/{_shm_entry}'")
-    move(f"/dev/shm/{_shm_folder}/{_shm_entry}.gpg", f"{directory}{_location}.gpg")
-    rmtree(f"/dev/shm/{_shm_folder}")
-
-
-def edit_note(_shm_folder, _shm_entry):
-    lines = open(f"/dev/shm/{_shm_folder}/{_shm_entry}").readlines()
-    open(f"/dev/shm/{_shm_folder}/{_shm_entry}", 'w').writelines(lines[0:3])
-    open(f"/dev/shm/{_shm_folder}/{_shm_entry}-n", 'w').writelines(lines[4:-2])
-    system(f"nano /dev/shm/{_shm_folder}/{_shm_entry}-n")
-    edit_notes = open(f"/dev/shm/{_shm_folder}/{_shm_entry}-n").read()
-    open(f"/dev/shm/{_shm_folder}/{_shm_entry}", 'a').write('\n' + edit_notes + '\n\n')
-
-
-# argument-specific functions
-
-
-def tweak():  # runs configuration wizard
-    # storage directory creation
-    try:
-        mkdir(f"/home/{environ.get('USER')}/.password-pasture", 0o700)
-    except FileExistsError:
-        pass
-
-    # device type configuration
-    _device_type = input('\nIs this installation for a client or for a server? (C/s) ')
-    if _device_type == 'S' or _device_type == 's':
-        open("/var/lib/sshyp/sshyp-device", 'w').write(_device_type)
-        copy('/usr/bin/sshync.py', f"/home/{environ.get('USER')}/")
-        print('\nMake sure the ssh service is running and properly configured.\n\nConfiguration complete!')
-    else:
-        # device type configuration
-        _device_type = 'c'  # ensure device type flag is properly set
-        open("/var/lib/sshyp/sshyp-device", 'w').write(_device_type)
-
-        # gpg configuration
-        _gpg_id = input('\nsshyp requires the use of a unique gpg key. Do you already have one that you are '
-                        'willing to use? (y/N)')
-        if _gpg_id != 'y' and _gpg_id != 'Y':
-            print('\nA unique gpg key has been generated for you.')
-            system('gpg --full-generate-key')
-        _gpg_id = str(input('\nPlease input the ID of your gpg key: '))
-        open("/var/lib/sshyp/sshyp-gpg", 'w').write(_gpg_id + '\n')
-
-        # lock file generation
-        try:
-            open('/var/lib/sshyp/lock', 'x').write('')
-        except FileExistsError:
-            pass
-        system(f"gpg -r {str(_gpg_id)} -e /var/lib/sshyp/lock")
-        remove('/var/lib/sshyp/lock')
-
-        # ssh key configuration
-        _ssh_gen = (input('\nMake sure the ssh service on the remote server is running and properly configured.'
-                          '\n\nrsync support requires a unique ssh key. Would you like to have this automatically '
-                          'generated? (Y/n) '))
-        if _ssh_gen != 'n' and _ssh_gen != 'N':
-            system('ssh-keygen -t ed25519 -f ~/.ssh/sshyp')
-        else:
-            print(f"\nEnsure that the key file you are using is located at /home/{environ.get('USER')}/.ssh/sshyp")
-
-        # ssh ip+port configuration
-        print('\nExample input: 10.10.10.10:9999\n')
-        _ip_port = str(input('What is the IP and ssh port of the remote server? '))
-        _ip, _sep, _port = _ip_port.partition(':')
-
-        # ssh user configuration
-        _username_ssh = str(input('\nWhat is the username of the remote server? '))
-        print(f"\nEntry directory: /home/{_username_ssh}/.password-pasture/")
-
-        # sshync profile generation
-        sshync.make_profile('/var/lib/sshyp/sshyp.sshync', f"/home/{environ.get('USER')}/.password-pasture/",
-                            f"/home/{_username_ssh}/.password-pasture/", f"/home/{environ.get('USER')}/.ssh/sshyp",
-                            _ip, _port, _username_ssh)
-        print('\nConfiguration complete!\n')
-
-
-def helper():  # displays help menu
-    print('\nsshyp  Copyright (C) 2021  Randall Winkhart')
-    print("This is free software, and you are welcome to redistribute it under certain conditions;\nthis program comes "
-          "with ABSOLUTELY NO WARRANTY;\ntype `sshyp license' for details.")
-    print('\nUSAGE: sshyp [/<entry name>] [OPTION] [FLAG]\n')
-    print('Options: ')
-    print('help/--help/-h           bring up this menu')
-    print('version/-v               display sshyp version info')
-    print('tweak                    configure sshyp')
-    print('add                      add an entry')
-    print('gen                      generate a new password')
-    print('edit                     edit an existing entry')
-    print('copy                     copy details of an entry to your clipboard')
-    print('shear/-rm                delete an existing entry')
-    print('sync/-s                  manually sync the entry directory via sshync\n')
-    print('Flags:')
-    print('add:')
-    print(' password/-p             add a password entry')
-    print(' note/-n                 add a note entry')
-    print(' folder/-f               add a new folder for entries')
-    print('edit:')
-    print(' rename/relocate/-r      rename or relocate an entry')
-    print(' username/-u             change the username of an entry')
-    print(' password/-p             change the password of an entry')
-    print(' note/-n                 change the note attached to an entry')
-    print(' url/-l                  change the url attached to an entry')
-    print('copy:')
-    print(' username/-u             copy the username of an entry to your clipboard')
-    print(' password/-p             copy the password of an entry to your clipboard')
-    print(' url/-l                  copy the URL of an entry to your clipboard')
-    print(' note/-n                 copy the note of an entry to your clipboard')
-    print('gen:')
-    print(' update/-u               generate a password for an existing entry\n')
-    print("Tip: You can quickly read an entry with 'sshyp /<entry name>'!")
-    print("When specifying entry names, do not include the file extension! '.gpg' is assumed!\n")
-
-
-def version():  # displays version information
-    print('\n////////////////////////////////////////////////////////')
-    print('/                                                      /')
-    print('/     sshyp  Copyright (C) 2021  Randall Winkhart      /')
-    print('/                                                      /')
-    print('/              Version 2021.12.01.fr2.1                /')
-    print('/                 The Lighter Update                   /')
-    print('/                                                      /')
-    print('////////////////////////////////////////////////////////\n')
-
-
-def no_arg():  # displays a list of entries and gives an option to select one for viewing
-    print("\nFor a list of usable commands, run 'sshyp help'.\n")
-    system(f"cd {directory}; ls -1 *")
-    _read_entry = str(input('\nEntry to read: '))
-    system(f"gpg -d '{directory}{_read_entry.replace('/', '', 1)}.gpg'")
-    print()
-
-
-def show_license():  # displays licensing information
-    print('\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU General'
-          '\nPublic License as published by the Free Software Foundation, either version 3 of the License,\nor '
-          '(at your option) any later version.\n'
-          '\nThis program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;\nwithout even '
-          'the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\nSee the GNU General Public '
-          'License for more details.\n\nhttps://opensource.org/licenses/GPL-3.0\n')
-
-
-def read_shortcut():  # shortcut to quickly read an entry
-    system(f"gpg -d '{directory}{argument.replace('/', '', 1)}.gpg'")
-
-
-def sync():  # calls sshync to sync changes to the user's server
-    print('\nSyncing entries with the server device...\n')
-    # set permissions before uploading
-    system('find ' + directory + ' -type d -exec chmod -R 700 {} +')
-    system('find ' + directory + ' -type f -exec chmod -R 600 {} +')
-    sshync.run_profile('/var/lib/sshyp/sshyp.sshync')
-
-
-def add_info():  # displays 'add' syntax
-    print('\nUSAGE: sshyp add [FLAG]')
-    print('Flags:')
-    print('add:')
-    print(' password/-p             add a password entry')
-    print(' note/-n                 add a note entry')
-    print(' folder/-f               add a new folder for entries\n')
-
-
-def add_entry():  # adds a new entry
-    _entry_name = str(input('\nName of entry: '))
-    if _entry_name.startswith('/'):
-        _entry_name = _entry_name.replace('/', '', 1)
-    _shm_folder, _shm_entry = shm_gen()
-    if argument == 'add note' or argument == 'add -n':
-        system(f"nano /dev/shm/{_shm_folder}/{_shm_entry}-n")
-        _notes = open(f"/dev/shm/{_shm_folder}/{_shm_entry}-n", 'r').read()
-        open(f"/dev/shm/{_shm_folder}/{_shm_entry}", 'w').writelines('\n\n\n\n' + _notes + '\n\n')
-    if argument == 'add password' or argument == 'add -p':
-        _username = str(input('Username: '))
-        _password = str(input('Password: '))
-        _url = str(input('URL: '))
-        _add_note = input('Add a note to this entry? (y/N) ')
-        if _add_note == 'y' or _add_note == 'Y':
-            system(f"nano /dev/shm/{_shm_folder}/{_shm_entry}-n")
-            _notes = open(f"/dev/shm/{_shm_folder}/{_shm_entry}-n", 'r').read()
-        else:
-            _notes = ''
-        open(f"/dev/shm/{_shm_folder}/{_shm_entry}", 'w').writelines(_username + '\n' + _password + '\n' + _url + '\n\n'
-                                                                     + _notes + '\n\n')
-    encrypt(_shm_folder, _shm_entry, _entry_name)
-    system(f"gpg -d '{directory}{_entry_name}.gpg'")
-
-
-def add_folder():  # creates a new folder
-    _folder_name = str(input('Name of new folder: '))
-    mkdir(directory + _folder_name, 0o700)
-    system(f"ssh -p {port} {username_ssh}@{ip} \"mkdir -p '{directory_ssh}{_folder_name}'\"")
-
-
-def edit_info():  # displays 'edit' syntax
-    print('\nUSAGE: sshyp edit [FLAG]')
-    print('Flags:')
-    print('edit:')
-    print(' rename/relocate/-r      rename or relocate an entry')
-    print(' username/-u             change the username of an entry')
-    print(' password/-p             change the password of an entry')
-    print(' url/-l                  change the url attached to an entry')
-    print(' note/-n                 change the note attached to an entry\n')
-
-
-def rename():  # renames an entry or folder TODO delete original from server to prevent re-downloading
-    print()
-    system(f"cd {directory}; ls -1 *")  # TODO replace with new list
-    _entry_name = str(input('\nWhat would you like to rename/relocate? '))
-    _new_name = str(input('New Name: '))
-    if _entry_name.startswith('/'):
-        if _entry_name.replace('/', '', 1).__contains__('/'):
-            _folder, _sep, _folder_entry = _entry_name.replace('/', '', 1).partition('/')
-            move(f"{directory}{_folder}/{_folder_entry}.gpg", f"{directory}/{_new_name}.gpg")
-        else:
-            move(f"{directory}{_entry_name.replace('/', '', 1)}.gpg", f"{directory}{_new_name.replace('/', '', 1)}.gpg")
-    else:
-        move(f"{directory}{_entry_name}.gpg", f"{directory}{_new_name}.gpg")
-
-
-def edit():  # edits the contents of an entry
-    print()
-    system(f"cd {directory}; ls -1 *")  # TODO replace with new list
-    _entry_name = str(input('\nWhat file would you like to edit? '))
-    if _entry_name.startswith('/'):
-        _entry_name = _entry_name.replace('/', '', 1)
-    _shm_folder, _shm_entry = shm_gen()
-    system(f"gpg -d --output /dev/shm/{_shm_folder}/{_shm_entry} '{directory}{_entry_name}.gpg'")
-    if argument == 'edit username' or argument == 'edit -u':
-        _detail = str(input('New Username: '))
-        replace_line(f"/dev/shm/{_shm_folder}/{_shm_entry}", 0, _detail + '\n')
-    if argument == 'edit password' or argument == 'edit -p':
-        _detail = str(input('New Password: '))
-        replace_line(f"/dev/shm/{_shm_folder}/{_shm_entry}", 1, _detail + '\n')
-    if argument == 'edit url' or argument == 'edit -l':
-        _detail = str(input('New URL: '))
-        replace_line(f"/dev/shm/{_shm_folder}/{_shm_entry}", 2, _detail + '\n')
-    if argument == 'edit note' or argument == 'edit -n':
-        edit_note(_shm_folder, _shm_entry)
-    remove(f"{directory}{_entry_name}.gpg")
-    encrypt(_shm_folder, _shm_entry, _entry_name)
-    system(f"gpg -d '{directory}{_entry_name}.gpg'")
-
-
-def gen():  # generates a password for a new or an existing entry
-    _username, _url, _notes = None, None, None  # sets base-line values to avoid errors
-    _shm_folder, _shm_entry = shm_gen()
-    if argument == 'gen update' or argument == 'gen -u':
-        print()
-        system(f"cd {directory}; ls -1 *")  # TODO replace with new list
-    _entry_name = str(input('\nName of service: '))
-    if _entry_name.startswith('/'):
-        _entry_name = _entry_name.replace('/', '', 1)
-    if argument != 'gen update' and argument != 'gen -u':
-        _username = str(input('Username: '))
-    _pass_length = int(input('How many characters should be in the password? '))
-    _pass_type = str(input('Should the password be simple (for compatibility) or complex (for security)? (s/C) '))
-    if _pass_type != 's':
-        _pass_type = string.ascii_letters + string.digits + string.punctuation
-    if _pass_type == 's':
-        _pass_type = string.ascii_letters + string.digits
-    _pass_gen = ''.join(random.SystemRandom().choice(_pass_type) for _ in range(_pass_length))
-    if argument != 'gen update' and argument != 'gen -u':
-        _url = str(input('URL: '))
-        _notes = str(input('Additional notes: '))  # TODO update w/new notes system
-    if argument != 'gen update' and argument != 'gen -u':
-        open(f"/dev/shm/{_shm_folder}/{_shm_entry}", 'w').writelines(_username + '\n' + _pass_gen + '\n' + _url +
-                                                                     '\n\n' + _notes + '\n\n')
-    if argument != 'gen update' and argument != 'gen -u':
-        encrypt(_shm_folder, _shm_entry, _entry_name)
-        system(f"gpg -d '{directory}{_entry_name}.gpg'")
-    else:
-        system(f"gpg -d --output /dev/shm/{_shm_folder}/{_shm_entry} '{directory}{_entry_name}.gpg'")
-        replace_line(f"/dev/shm/{_shm_folder}/{_shm_entry}", 1, _pass_gen + '\n')
-        remove(f"{directory}{_entry_name}.gpg")
-        encrypt(_shm_folder, _shm_entry, _entry_name)
-        system(f"gpg -d '{directory}{_entry_name}.gpg'")
-
-
-def copy_info():  # displays 'copy' syntax
-    print('\nUSAGE: sshyp copy [FLAG]')
-    print('Flags:')
-    print('copy:')
-    print(' username/-u             copy the username of an entry to your clipboard')
-    print(' password/-p             copy the password of an entry to your clipboard')
-    print(' url/-l                  copy the URL of an entry to your clipboard')
-    print(' note/-n                 copy the note of an entry to your clipboard\n')
-
-
-def copy_data():  # copies a specified field of an entry to the clipboard
-    print()
-    system(f"cd {directory}; ls -1 *")  # TODO replace with new list
-    _read_entry = str(input('\nEntry to copy: '))
-    _shm_folder, _shm_entry = shm_gen()
-    system(f"gpg -d --output /dev/shm/{_shm_folder}/{_shm_entry} '{directory}{_read_entry}.gpg'")
-    _copy_line = open(f"/dev/shm/{_shm_folder}/{_shm_entry}", 'r').readlines()
-    if environ.get('WAYLAND_DISPLAY') == 'wayland-0':  # checks if the user is using Wayland or X for clipboard
-        if argument == 'copy username' or argument == 'copy -u':
-            system('wl-copy ' + "'" + _copy_line[0].replace('\n', '').replace("'", "'\\''") + "'")
-        elif argument == 'copy password' or argument == 'copy -p':
-            system('wl-copy ' + "'" + _copy_line[1].replace('\n', '').replace("'", "'\\''") + "'")
-        elif argument == 'copy url' or argument == 'copy -l':
-            system('wl-copy ' + "'" + _copy_line[2].replace('\n', '').replace("'", "'\\''") + "'")
-        elif argument == 'copy note' or argument == 'copy -n':
-            system('wl-copy ' + "'" + _copy_line[4].replace('\n', '').replace("'", "'\\''") + "'")
-    else:
-        if argument == 'copy username' or argument == 'copy -u':
-            system('echo -n ' + "'" + _copy_line[0].replace('\n', '').replace("'", "'\\''") + "'" + ' | xclip -sel c')
-        elif argument == 'copy password' or argument == 'copy -p':
-            system('echo -n ' + "'" + _copy_line[1].replace('\n', '').replace("'", "'\\''") + "'" + ' | xclip -sel c')
-        elif argument == 'copy url' or argument == 'copy -l':
-            system('echo -n ' + "'" + _copy_line[2].replace('\n', '').replace("'", "'\\''") + "'" + ' | xclip -sel c')
-        elif argument == 'copy note' or argument == 'copy -n':
-            system('echo -n ' + "'" + _copy_line[4].replace('\n', '').replace("'", "'\\''") + "'" + ' | xclip -sel c')
-    rmtree(f"/dev/shm/{_shm_folder}")
-
-
-def remove_data():  # deletes an entry or folder from both the client and the server
-    print()
-    system(f"cd {directory}; ls -1 *")  # TODO replace with new list
-    _entry_name = str(input('\nWhat would you like to delete? '))
-    if _entry_name.startswith('/'):
-        _entry_name = _entry_name.replace('/', '', 1)
-    try:
-        system('gpg -d --output /dev/shm/sshyp.lock /var/lib/sshyp/lock.gpg')
-        _unlock = open('/dev/shm/sshyp.lock', 'r').readlines()
-        remove('/dev/shm/sshyp.lock')
-    except FileNotFoundError:
-        print('\nAccess denied.\n')
-        s_exit()
-    if device_type == 'c':
-        system(f"ssh -p {port} {username_ssh}@{ip} \"rm -rf '{directory_ssh}{_entry_name}.gpg'\"")
-    remove(f"{directory}{_entry_name}.gpg")
-
-
-# program start sequence
-
-# retrieve typed argument
-argument_list = argv
-i, argument = 0, ''
-for _ in argument_list:
-    while i < len(argument_list) - 1:
-        i += 1
-        argument += argument_list[i] + ' '
-argument = argument[:-1]
-
-# import saved userdata
-if argument != 'tweak':
-    device_type = ''
-    try:
-        device_type = open('/var/lib/sshyp/sshyp-device').read().strip()
-        if device_type == 'c':
-            gpg_id = open('/var/lib/sshyp/sshyp-gpg').read().strip()
-            ssh_info = sshync.get_profile('/var/lib/sshyp/sshyp.sshync')
-            username_ssh = ssh_info[0].replace('\n', '')
-            ip = ssh_info[1].replace('\n', '')
-            port = ssh_info[2].replace('\n', '')
-            directory = str(ssh_info[3].replace('\n', ''))
-            directory_ssh = '/home/' + username_ssh + '/.password-pasture/'
-    except FileNotFoundError:
-        if device_type != 's' and device_type != 'S':
-            print('\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')
-            print("Not all necessary configuration files are present. Please run 'sshyp tweak'!")
-            print('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n')
-        s_exit()
-else:
-    try:
-        tweak()
-        s_exit()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-
-# run function based on argument
-error = 0  # create an error flag to determine if syncing should occur at end
-if argument.startswith('/'):
-    read_shortcut()
-elif argument == '':
-    try:
-        no_arg()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-elif argument == 'help' or argument == '--help' or argument == '-h':
-    helper()
-elif argument == 'license':
-    show_license()
-elif argument == 'version' or argument == '-v':
-    version()
-elif argument == 'add':
-    add_info()
-elif argument == 'add note' or argument == 'add -n' or argument == 'add password' or argument == 'add -p':
-    try:
-        add_entry()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-elif argument == 'add folder' or argument == 'add -f':
-    try:
-        add_folder()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-elif argument == 'edit':
-    edit_info()
-elif argument == 'edit rename' or argument == 'edit relocate' or argument == 'edit -r':
-    try:
-        rename()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-elif argument == 'edit username' or argument == 'edit -u' or argument == 'edit password' or argument == 'edit -p' or \
-        argument == 'edit url' or argument == 'edit -l' or argument == 'edit note' or argument == 'edit -n':
-    try:
-        edit()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-elif argument == 'gen' or argument == 'gen update' or argument == 'gen -u':
-    try:
-        gen()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-elif argument == 'copy':
-    copy_info()
-elif argument == 'copy username' or argument == 'copy -u' or argument == 'copy password' or argument == 'copy -p' or \
-        argument == 'copy url' or argument == 'copy -l' or argument == 'copy note' or argument == 'copy -n':
-    try:
-        copy_data()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-elif argument == 'shear' or argument == '-rm':
-    try:
-        remove_data()
-    except KeyboardInterrupt:
-        print('\n')
-        s_exit()
-elif argument == 'sync' or argument == '-s':
-    sync()
-else:
-    error = 1  # set error flag to 1 to stop syncing
-    print("\nArgument error! Please run 'sshyp help' for a list of usable commands.\n")
-    s_exit()
-
-# sync at end of program if any changes were made
-if argument != '' and argument != 'help' and argument != '--help' and argument != '-h' and argument != 'license' and \
-        argument != 'add' and argument != 'sync' and argument != 'edit' and argument != 'copy username' and argument \
-        != 'copy -u' and argument != 'copy password' and argument != 'copy -p' and argument != 'copy url' and argument \
-        != 'copy -l' and argument != 'copy note' and argument != 'copy -n' and argument != 'copy' and argument != \
-        'shear' and argument != '-rm' and argument != 'version' and argument != '-v' and error == 0 and \
-        argument.startswith('/') is False:
-    sync()

commit.sh

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

extra/changelog-archive/2021

@@ -1,3 +1,51 @@
+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
@@ -213,7 +261,7 @@ Planned for next update (The Housekeeping Update Pt. 2):
 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 
+- modularize code in preparation for GUI frontends
 
 Planned, no timeline:
 
@@ -410,5 +458,3 @@ What is currently functional:
 - sort notes and passwords into folders
 - gpg encryption
 - edit password/note entries
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>

extra/changelog-archive/2022

@@ -0,0 +1,899 @@
+sshyp v1.3.0
+
+the serious shepherd update
+
+this release ties up many of sshyp's loose ends where there was
+room for major performance, compatibility, and security improvements
+
+compatibility-breaking changes:
+
+- due to a near full re-write of the syncing functionality, all clients and servers
+must be updated to this release (v1.3.0 is not backwards compatible with any prior release)
+- it is recommended to either delete the contents of ~/.config/sshyp/deleted (on the server-side)
+or sync all of your clients before updating
+    ^ old entries in this folder will throw errors with v1.3.0
+
+user-facing features:
+
+- none - all changes were under-the-hood - the user experience should be
+exactly the same as v1.2.0 - just faster, less buggy, and more secure
+
+major fixes/optimizations:
+
+- a near full re-write of the syncing functionality
+    ^ all syncing logic has been moved into sshync.py (from sshyp.py and sshypRemote.py)
+    ^ in my setup, a dry, local "sshyp sync" went from 2.00+ seconds (v1.2.0) to 0.36 seconds (v1.3.0)
+        ^ the performance improvements are even greater when syncing from outside your local network
+- the following character sequences will no longer break the syncing logic: "@", "^&*", and "*&^"
+    ^ ASCII separator characters 29-31 are now used, instead
+- os.system has been replaced with subprocess.run in all cases, shell=True is no longer used with subprocess.run
+    ^ this protects against shell escape attacks and potentially makes sshyp more compatible with some environments
+- replaced shell commands with python built-in library functions where applicable
+    ^ this brings speed and compatibility improvements
+- sshyp should no longer incorrectly assume an X11 environment when Wayland is in use
+    ^ this fixes clipboard support in some Wayland environments, such as Sway (Plasma/Gnome/Phosh were unaffected)
+- sshyp now uses the default pinentry on Haiku thanks to haikuports/haikuports#7457
+    ^ this brings the Haiku port in-line with the other sshyp packages in terms of security
+- "python3" is now called over ssh, rather than "python"
+    ^ some environments do not have a "python" symlink, or it links to "python2" - changing this increases compatibility
+- fixed an issue from v1.2.0 where renaming threw an error if not in offline mode
+
+other notable changes:
+
+- quick-unlock password input is now hidden while the user is typing
+    ^ user input is now invisible to prevent snooping
+- lots of smaller optimizations not listed here
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.2.0
+
+the brisk bahh update
+
+this release focuses on speeding up the sshyp user experience by adding
+new features that reduce wasted time
+
+compatibility-breaking changes:
+
+- new configuration options (quick-unlock, offline mode) have been added and
+the configuration files have been reorganized
+    ^ simply running "sshyp tweak" and following the setup wizard will correct any compatibility
+    issues
+- for quick-unlock security, device names have been replaced with more secure device ids
+    ^ older device names are still compatible, but for security reasons it is recommended
+    to delete any pre-existing device names from the server and allow "sshyp tweak" to re-register
+    your devices
+
+user-facing features:
+
+- quick-unlock mode has been added
+    ^ this allows you to use a shortened version of your password by verifying that your device
+    is whitelisted on your sshyp server - it's both faster and more secure than standard unlock,
+    but it requires an active connection to your sshyp server to authenticate (otherwise it will
+    fall back to standard unlock)
+- full support for offline usage
+    ^ though sshyp could be used without a server before, it now can be configured to not attempt
+    to find one ever - this saves time and hides sync failure error messages
+- bash completions have been added
+    ^ if you have bash-completion installed, you can now use the tab key in bash to auto-complete
+    sshyp arguments and entry names (client only, not added for server-specific arguments)
+        ^ if you do not have bash-completion installed, you can source
+        /usr/share/bash-completion/completions/sshyp (Linux/BSD) or
+        /boot/system/data/bash-completion/completions/sshyp (Haiku) in your ~/.bashrc to
+        use this feature
+
+fixes/optimizations:
+
+- fixed entries with multi-word titles failing to decrypt
+- password generation is now much faster and more resource efficient
+- there is no longer a length limit on generated passwords
+- improved visual consistency of help menus
+- rarely used modules are now imported only when needed
+- sshyp now uses one fewer configuration file
+
+other notable changes:
+
+- sshyp is now specifically licensed under the GPL-3.0-only (keyword: only)
+- sshyp now has some possible arguments and its own help menu when running in server mode
+- temporary files in /dev/shm are now generated with more complex names
+- sshyp now installs in /usr/lib/sshyp (Linux/BSD) or /system/lib/sshyp (Haiku) instead of
+/usr/bin or /bin (it is still symlinked to the old directories)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.1.2
+
+the sheecrets update - patch two
+
+this is a general polish/bugfix release
+
+user-facing features:
+
+- packaging support for Alpine Linux/postmarketOS
+- the rename() function is no longer unnecessarily verbose
+- handled exception for when the user attempts to copy an entry field that does not exist
+
+fixes/optimizations:
+
+- replaced shebang with "#!/usr/bin/env python3" for improved compatibility with various systems
+    ^ does not affect Haiku packaging
+- fixed the generic package not actually being compressed
+- reduced lines of code used for cross-device entry deletion
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.1.1
+
+the sheecrets update - patch one
+
+this is a polish/bug fix release that makes tweaks to the entry format (without breaking compatibility)
+
+compatibility-breaking changes:
+
+- none; the entry format tweaks are backward compatible with sshyp v1.0.0+
+    ^ the new format is slightly more efficient in terms of storage space
+        ^ if you would like to upgrade to it, run this script (after updating to v1.1.1):
+          https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/extra/conversion-scripts/sshyp-refresh-1.1.1%2B.py
+
+user-facing features:
+
+- entries (when editing or adding) are now run through the new optimized_edit() function to strip trailing new lines
+and ensure the format of the entries is fully compatible with all of sshyp's functions
+
+fixes:
+
+- when adding a note to an entry, there is no longer a chance the first note line will be added as a url
+if the entry is using an older format/pass format
+- the gpg auto-generation file temporarily created by sshyp no longer includes extra spaces
+    ^ seems to serve no functional purpose - fixed for the sake of polish
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.1.0
+
+the sheecrets update
+
+the main focus of this release was adding extension support (particularly for sshyp-mfa)
+and cleaning up the configuration experience
+
+compatibility-breaking changes:
+
+- the entry directory has been moved from ~/.password-pasture to ~/.local/share/sshyp
+as a means of complying with the XDG base directory spec
+    ^ this requires the user to move their entry directory to the new location manually
+        ^ if this is not done, sshyp will not be able to find entries made prior to v1.1.0
+- due to a new configuration option (preferred text editor), 'sshyp tweak' must be run after updating
+
+user-facing features:
+
+- extension support
+    ^ some of sshyp's critical functions can now be imported into other programs to extend
+    upon sshyp's functionality
+        ^ the first usecase of this is sshyp-mfa, which can be found at https://github.com/rwinkhart/sshyp-labs
+- a new configuration experience
+    ^ the 'sshyp tweak' menu has been made much more readable, and now the automatically generated
+    gpg key has its id automatically input, making the process easier for the user
+- customizable text editor
+    ^ the text editor used for editing notes can now be set to any editor preferred by the user
+        ^ this means that nano was dropped as a dependency
+
+fixes:
+
+- to avoid exceptions on server devices, all arguments (apart from 'tweak') have been disabled on servers
+- fixed entry readout not printing blank lines between fields under certain conditions
+- various optimizations
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.0.1
+
+The Polished Trotters Update - Patch 1
+
+This is a hotfix for the Haiku decryption bug.
+
+Changes:
+
+- subprocess.Popen has been replaced with subprocess.run where applicable
+- stdout is no longer captured with any subprocess.Popen or subprocess.run usages
+    ^ this fixes decryption on Haiku
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.0.0
+
+The Polished Trotters Update
+
+This release brings 'sshyp' in line with the original goals of the project.
+As such, it is being crowned "v1.0.0", and is considered a stable base for future expansions.
+
+Features:
+
+- sshyp has been modified to run on Haiku, an open-source re-implementation of BeOS
+    ^ new package formats have been added for Haiku, FreeBSD, and Fedora Linux
+- the entry format has been changed to support entries created in pass/password-store
+    ^ this change requires existing entry libraries to be converted - see the sshyp v1.0.0 release page on GitHub for a conversion script
+- majorly overhauled visual experience for sshyp
+    ^ this includes a new entry list, a new entry readout, colored output, ascii art, and more!
+- entries can now optionally be passed as arguments, directly
+    ^ as opposed to the user being prompted for an entry name after running a command
+
+Changes:
+
+- corrected outdated licensing and copyright information
+- 'if __name__=="__main__":' convention is now used
+- help screens have been overhauled
+- improved password generator to guarantee more secure results
+- fixed errors when trying to sync with a multi-word entry on the server
+- sshync now uses 'scp' (via the sftp protocol), rather than 'sftp'
+- rename function now properly allows for renaming folders
+- renaming an entry/folder will now properly delete the old entry/folder from the server
+- entry previews at the time of entry creation/editing no longer require entering the gpg password more times than necessary
+- entries will no longer be overwritten if attempting to create a new entry that uses an already existing name
+- the clipboard now automatically clears after 30 seconds
+- sshyp server no longer needs to create copies of its libraries in ~/
+- added more and improved existing exceptions
+- the lock file is now decrypted to /dev/null
+- ...and lots of minor (under the hood) changes!
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.02.16.fr4.7
+
+The High-Tech Shears Update - Patch 7
+
+This release enables recursive folder syncing.
+
+Note: Upgrading from releases older than fr4.7 requires the configuration ("sshyp tweak") to be re-done, as the configuration process has changed.
+
+Changes:
+
+- re-wrote folder checking function to fetch subdirectories recursively
+- added in user-facing messages for when folders are being synced or entries are being removed
+- fixed a typo preventing folder syncing from working (actually tested this time)
+
+&&
+
+Planned for next major update (fr5, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr6, The Farmer Shearing the sshyp Update):
+
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.02.16.fr4.6
+
+The High-Tech Shears Update - Patch 6
+
+This release addresses a critical typo.
+
+Note: Upgrading from releases older than fr4.6 requires the configuration ("sshyp tweak") to be re-done, as the configuration process has changed.
+
+Changes:
+
+- corrected a typo error causing folder syncing issues
+
+&&
+
+Planned for next major update (fr5, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr6, The Farmer Shearing the sshyp Update):
+
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.02.16.fr4.5
+
+The High-Tech Shears Update - Patch 5
+
+This release addresses a critical syntax error.
+
+Note: Upgrading from releases older than fr4.5 requires the configuration ("sshyp tweak") to be re-done, as the configuration process has changed.
+
+Changes:
+
+- corrected a syntax error causing critical functionality issues
+
+&&
+
+Planned for next major update (fr5, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr6, The Farmer Shearing the sshyp Update):
+
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.02.16.fr4.4
+
+The High-Tech Shears Update - Patch 4
+
+This release automatically generates user-created folders on new client devices.
+
+Note: Upgrading to releases in the fr4 series requires the configuration ("sshyp tweak") to be re-done, as a device name now must be set (for multi-client deletion). Even upgrading from fr4.3 to fr4.4 will require re-running "sshyp tweak" due to file name changes.
+
+Features:
+
+- implemented proper folder syncing for new clients and clients missing folders that exist server-side
+
+Changes:
+
+- old device names are now automatically deleted (locally) when running "sshyp tweak", to prevent conflicts
+
+&&
+
+Planned for next major update (fr5, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr6, The Farmer Shearing the sshyp Update):
+
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.02.16.fr4.3
+
+The High-Tech Shears Update - Patch 3
+
+This release addresses a bug with local entry deletion.
+
+Note: Upgrading to releases in the fr4 series requires the configuration ("sshyp tweak") to be re-done, as a device name now must be set (for multi-client deletion).
+
+Changes:
+
+- fixed an issue where entries could not be deleted locally
+
+&&
+
+Planned for next major update (fr5, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr6, The Farmer Shearing the sshyp Update):
+
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.02.16.fr4.2
+
+The High-Tech Shears Update - Patch 2
+
+This release re-addresses a bug with local folder deletion.
+
+Note: Upgrading to releases in the fr4 series requires the configuration ("sshyp tweak") to be re-done, as a device name now must be set (for multi-client deletion).
+
+Changes:
+
+- fixed an issue where folders could not be deleted locally (actually, this time)
+- properly handled an exception for when the user forgets a following '/' when attempting to delete a folder
+
+&&
+
+Planned for next major update (fr5, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr6, The Farmer Shearing the sshyp Update):
+
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.02.16.fr4.1
+
+The High-Tech Shears Update - Patch 1
+
+This release addresses a bug with local folder deletion.
+
+Note: Upgrading to releases in the fr4 series requires the configuration ("sshyp tweak") to be re-done, as a device name now must be set (for multi-client deletion).
+
+Changes:
+
+- fixed an issue where folders could not be deleted locally
+- optimized deletion flags
+
+&&
+
+Planned for next major update (fr5, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr6, The Farmer Shearing the sshyp Update):
+
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.02.16.fr4
+
+The High-Tech Shears Update
+
+This release adds in a major feature: multi-client deletion (details below)
+
+Note: This release requires the configuration ("sshyp tweak") to be re-done, as a device name now must be set (for multi-client deletion).
+
+Features:
+
+- added multi-client deletion
+    ^ this means that when an entry is deleted from one client (and thus the server), if another client that has a copy of the deleted entry tries to sync, instead of re-uploading the deleted entry, it will now also have its entry deleted.
+    ^ the current implementation requires a new Python script in addition to sshyp and sshync
+
+Changes:
+
+- fixed an issue where sshyp would use the wrong SSH key when trying to delete entries from or create folders on the server
+    ^ this is a fix that was recently applied to sshync - turns out I made the same mistake in sshyp
+- deleting folders should now work properly with "sshyp shear" if the directory is entered with a following "/"
+
+&&
+
+Planned for next major update (fr5, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr6, The Farmer Shearing the sshyp Update):
+
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.26.fr3.4
+
+The Boxing Update - Patch 4
+
+This release is a hotfix for 2022.01.17.fr3.3. It fixes a major bug with sshync.
+
+Changes:
+
+- sshync now correctly uses the auto-generated SSH key in all operations
+- an exception has been added for attempting to delete/shear a file that does not exist
+- the manpage has been updated and now includes setup instructions
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+- allow for multi-client deletion... somehow (in sshync)
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.17.fr3.3
+
+The Boxing Update - Patch 3
+
+This release is a hotfix for 2022.01.16.fr3.2. It fixes major bugs, especially with Termux.
+
+Changes:
+
+- the temporary directory for Termux is now sym-linked with its full path (no longer dangling)
+- the copy function can now properly detect if Termux is being used
+- ~/.config is created, if it does not already exist
+- "sshyp shear" now functions again, as a bug with the lock file has been fixed
+- sshync -should- now properly detect the database file on all platforms (was broken on Termux)
+- total lines of code have been slightly reduced with various small optimizations
+
+Additions planned for minor releases:
+
+- updated the manpage with more information regarding how sshyp works and how to set it up
+- ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+- reduced total lines of code with small optimizations
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+- allow for multi-client deletion... somehow (in sshync)
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.16.fr3.2
+
+The Boxing Update - Patch 2
+
+This release is a hotfix for 2022.01.16.fr3.1. It fixes major bugs, including one massively impacting Termux.
+
+Changes:
+
+- sshyp now uses a symlink to the temporary storage directory, allowing for easy implementation of different temporary directories on different platforms
+    ^ the first usage of this is enabling the use of temporary storage on Termux
+- sshync now properly auto-generates its config directory
+
+Additions planned for minor releases:
+
+- updated the manpage with more information regarding how sshyp works and how to set it up
+- ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+- reduced total lines of code with small optimizations
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+- allow for multi-client deletion... somehow (in sshync)
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.16.fr3.1
+
+The Boxing Update - Patch 1
+
+This release is a hotfix for 2022.01.13.fr3. It fixes sshync/syncing support after the changes in the last release.
+
+Changes:
+
+- sshync has been updated to work with the new config directory
+- sshync now uses its own directory to store the database file
+    ^ this is preperation for separating sshync into its own package
+- expanduser lines in sshyp have been simplified (no user-facing impact)
+
+Additions planned for minor releases:
+
+- updated the manpage with more information regarding how sshyp works and how to set it up
+- ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+- reduced total lines of code with small optimizations
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+- allow for multi-client deletion... somehow (in sshync)
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.13.fr3
+
+The Boxing Update
+
+This release adapts sshyp to be compatible with Termux and allows for packaging for various distributions in addition to Arch Linux.
+
+Features:
+
+- the copy function now has support for termux-clipboard-set from termux-api
+    ^ this allows clipboard functionality to work on Termux
+
+Changes:
+
+- sshyp no longer writes to/reads from /var
+    ^ configuration files are now stored under the user's home directory in ~/.config/sshyp
+    ^ this change allows for compatibility with less standard environments, such as Termux on Android
+
+Additions planned for minor releases:
+
+- updated the manpage with more information regarding how sshyp works and how to set it up
+- ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+- reduced total lines of code with small optimizations
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+- sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+- sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+- allow for multi-client deletion... somehow (in sshync)
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+- imporove password generator to guarantee more secure results
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+- create separate gui frontend targetting mobile and desktop Linux
+- auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.10.fr2.3
+
+The Lighter Update - Patch 3
+
+This release is a hotfix for 2021.12.01.fr2.2. It features critical security fixes and quality-of-life improvements.
+
+New features:
+
+- a man page has been added
+
+Changes:
+
+- folders in /dev/shm are no longer created before input from the user (fixes critical security flaws)
+- fixed syncing of files (specifically downloading) with special characters, such as '('
+- fixed program still continuing after trying to edit an entry that doesn't exist
+- the gen command has been updated to use the newer notetaking system
+- printing functions in sshyp have been combined into one function (arguments determine section to print, fewer lines of code)
+- file not found exceptions have been re-implemented
+- .lower() is now used to remove casing when checking inputs
+- removed an old reference to "rsync" in the configuration dialog
+
+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
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+
+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 (in sshync)
+- detatch sshync and make it a separate package
+
+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

extra/changelog-archive/2023

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

extra/completion.bash

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

extra/completion.zsh

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

extra/manpage

@@ -0,0 +1,117 @@
+.TH sshyp 1 "12 July 2023" "v1.5.0" "sshyp man page"
+.SH NAME
+\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 [/<entry name> [argument] [option]] | [argument]
+
+Server Usage: sshyp <argument>
+.SH DESCRIPTION
+sshyp is a lightweight password and note management program written in Python. sshyp is used via CLI and is self-hosted with a client-server model. sshyp expects that you have access to a personal server with a properly configured ssh server, ideally accepting remote connections.
+.SH EXAMPLES (CLIENT)
+Setting up sshyp for the first time:
+    sshyp init
+
+Altering the existing sshyp configuration:
+    sshyp tweak
+
+Viewing the entry database:
+    sshyp
+
+Reading an existing entry saved as '~/.local/share/sshyp/development/github.gpg':
+    sshyp /development/github
+
+Removing an existing folder saved as '~/.local/share/sshyp/social':
+    sshyp /social shear
+
+Reading the same entry without hiding the password:
+    sshyp /development/github --show
+
+Copying the password of an existing entry saved as '~/.local/share/sshyp/financial/bank.gpg':
+    sshyp /financial/bank copy -p
+
+Editing the username of an existing entry saved as '~/.local/share/sshyp/game.gpg':
+    sshyp /game edit -u
+
+Making a new entry saved as '~/.local/share/sshyp/school/university.gpg' using the built-in password generator:
+    sshyp /school/university gen
+
+Creating a note-only entry saved as '~/.local/share/sshyp/notes/test note.gpg':
+    sshyp /notes/test\ note add -n
+
+Manually syncing entries with the server:
+    sshyp sync
+.SH ARGUMENTS (CLIENT)
+ help/-h                 bring up the help menu
+ version/-v              display sshyp version info
+ init                    set up sshyp
+ tweak                   change configuration options/manage extensions and updates
+ add                     add an entry
+ gen                     generate a new password
+ edit                    edit an existing entry
+ copy                    copy details of an entry to your clipboard
+ shear                   delete an existing entry
+ sync                    manually sync the entry directory via sshync
+.SH OPTIONS (CLIENT)
+add:
+ password/-p             add a password entry
+ note/-n                 add a note entry
+ folder/-f               add a new folder for entries
+
+edit:
+ rename/relocate/-r      rename or relocate an entry
+ username/-u             change the username of an entry
+ password/-p             change the password of an entry
+ note/-n                 change the note attached to an entry
+ url/-l                  change the url attached to an entry
+
+copy:
+ username/-u             copy the username of an entry to your clipboard
+ password/-p             copy the password of an entry to your clipboard
+ url/-l                  copy the URL of an entry to your clipboard
+ note/-n                 copy the note of an entry to your clipboard
+
+gen:
+ update/-u               generate a password for an existing entry
+.SH ARGUMENTS (SERVER)
+ help/-h                 bring up this menu
+ version/-v              display sshyp version info
+ init                    set up sshyp
+ tweak                   change configuration options/manage extensions and updates
+.SH SETUP
+sshyp operates on a client-server model, and thus requires you to have access to your own server (whether it be a physical home server or a cloud rental) with remote access via SSH.
+
+The sshyp package (on fully supported platforms) includes modes for operating on both client and server devices, so only one package is necessary.
+
+Server setup:
+    Configure an OpenSSH server (if sshyp was installed from the Debian package, openssh-server and openssh-sftp-server must be installed manually - if sshyp was installed from the Fedora package, openssh-server must be installed manually)
+    Allow remote access to the SSH server w/public key authentication (disabling password-only authentication recommended)
+    Install sshyp
+    Run "sshyp init" and set the device type as server
+    Optionally, configure a quick-unlock pin from the tweak menu
+    Done!
+
+Client setup:
+    Install sshyp
+    Run "sshyp init" and follow the prompts
+    Copy the generated public SSH key (located at ~/.ssh/sshyp.pub) to the server using preferred method (manually adding to authorized_keys, ssh-copy-id, etc.)
+    If you already have entries on the server, sync them using "sshyp sync"
+    Optionally, 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 - configuration error
+
+2 - data not found error
+
+3 - data already exists error
+
+4 - decryption/encryption error
+
+5 - server connection error
+
+6 - other error
+.SH AUTHOR
+Randall Winkhart (https://github.com/rwinkhart)

lib/sshync.py

@@ -0,0 +1,184 @@
+from os import listdir, remove, walk
+from os.path import expanduser, isdir, isfile, getmtime, join
+from subprocess import CalledProcessError, PIPE, run
+from sys import exit as s_exit
+home = expanduser('~')
+
+
+# PORT START SSHYNC-REMOTE
+# REMOTE
+# prints all necessary remote data to stdout
+def remote_list_gen(_client_device_name, _remote_dir):
+    # deletions
+    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"{home}/.config/sshyp/deleted/{_file}")
+            except FileNotFoundError:
+                pass
+    print('\x1d')
+    # folders
+    for _root, _directories, _files in walk(f"{home}/.local/share/sshyp"):
+        for _dir in _directories:
+            print(f"{_root.replace(home, '')}/{_dir}")
+    print('\x1d')
+    # 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, _silent):
+    from shutil import rmtree
+    _directory = f"{home}/.local/share/sshyp/"
+    try:
+        if isdir(_directory + _file_path):
+            rmtree(_directory + _file_path)
+        else:
+            remove(f"{_directory}{_file_path}.gpg")
+    except FileNotFoundError:
+        if not _silent:
+            print(f"location does not exist {_target_database}")
+    if _target_database == 'remotely':
+        for _device_name in listdir(f"{home}/.config/sshyp/devices"):
+            open(f"{home}/.config/sshyp/deleted/" + _file_path.replace('/', '\x1e') + '\x1f' + _device_name, 'w')
+
+
+# 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:
+            _title_list.append(join(_root.replace(_directory, '', 1), _filename))
+            _mod_list.append(int(getmtime(join(_root, _filename))))
+    if _device == 'server':
+        for _title in _title_list:
+            print(_title.rstrip())
+        for _time in _mod_list:
+            print(_time)
+    return _title_list, _mod_list
+
+
+# LOCAL
+# 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 /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(5)
+    _deletion_database = _remote_data[0].strip().splitlines()
+    _folder_database = _remote_data[1].strip().splitlines()
+    _titles_mods = _remote_data[2].strip().splitlines()
+    return _deletion_database, _folder_database, _titles_mods[:len(_titles_mods)//2], \
+        _titles_mods[len(_titles_mods)//2:]
+
+
+# checks for and acts upon files and folders marked for deletion
+def deletion_sync(_deletion_database, _silent):
+    _synced = False
+    for _file in _deletion_database:
+        if _file != '':
+            if not _silent:
+                _synced = True
+                print(f"\u001b[38;5;208m{_file}\u001b[0m has been sheared, removing...")
+            delete(_file, 'locally', _silent)
+    if _synced:
+        print()
+
+
+# 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 isdir(home + _folder):
+            print(f"\u001b[38;5;2m{_folder.replace('/.local/share/sshyp/', '')}/\u001b[0m does not exist locally, "
+                  f"creating...")
+            Path(home + _folder).mkdir(mode=0o700, parents=True, exist_ok=True)
+
+
+# creates and returns two lists (of titles and mod times) generated by sorting information from two provided 2D lists
+def sort_titles_mods(_list_1, _list_2):
+    _title_list_2_sorted, _mod_list_2_sorted = [], []
+    # title sorting
+    for _title in _list_1[0]:
+        if _title in _list_2[0]:
+            _title_list_2_sorted.append(_title)
+    for _title in _list_2[0]:
+        if _title not in _title_list_2_sorted:
+            _title_list_2_sorted.append(_title)
+    # mod time sorting
+    for _title in _title_list_2_sorted:
+        _mod_list_2_sorted.append(_list_2[1][_list_2[0].index(_title)])
+    return _title_list_2_sorted, _mod_list_2_sorted
+
+
+# returns a list of data read from a sshync job profile
+def get_profile(_profile_dir):
+    from configparser import ConfigParser
+    _profile_data = ConfigParser()
+    if isfile(_profile_dir):
+        _profile_data.read(_profile_dir)
+    else:
+        print('\n\u001b[38;5;9merror: the profile does not exist or is corrupted\u001b[0m\n')
+        s_exit(2)
+    _user = _profile_data.get('SSHYNC', 'user')
+    _ip = _profile_data.get('SSHYNC', 'ip')
+    _port = _profile_data.get('SSHYNC', 'port')
+    _local_dir = _profile_data.get('SSHYNC', 'local_dir')
+    _remote_dir = _profile_data.get('SSHYNC', 'remote_dir')
+    _identity = _profile_data.get('SSHYNC', 'identity_file')
+    _client_device_id = listdir(f"{home}/.config/sshyp/devices")[0].rstrip()
+    return _user, _ip, _port, _local_dir, _remote_dir, _identity, _client_device_id
+
+
+# runs a sshync job profile
+def run_profile(_profile_dir, _silent):
+    # import profile data
+    _user_data = get_profile(_profile_dir)
+    # fetch remote lists
+    _deletion_database, _folder_database, _remote_titles, _remote_mods = remote_list_fetch(_user_data)
+    _remote_titles_mods = (_remote_titles, _remote_mods)
+    # sync deletions and folders
+    deletion_sync(_deletion_database, _silent)
+    folder_sync(_folder_database)
+    # sort titles and mods
+    _index_local = sort_titles_mods(_remote_titles_mods, get_local_data(_user_data[3], 'client'))
+    _index_remote = sort_titles_mods(_index_local, _remote_titles_mods)
+    # sync new and updated files
+    _i, _synced = -1, False
+    for _title in _index_local[0]:
+        _i += 1
+        if _title in _index_remote[0]:
+            # compare mod times and sync
+            if int(_index_local[1][_i]) > int(_index_remote[1][_i]):
+                _synced = True
+                print(f"\u001b[38;5;4m{_title[:-4]}\u001b[0m is newer locally, uploading...")
+                run(('scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5], _user_data[3] + _title,
+                     f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}"))
+            elif int(_index_local[1][_i]) < int(_index_remote[1][_i]):
+                _synced = True
+                print(f"\u001b[38;5;2m{_title[:-4]}\u001b[0m is newer remotely, downloading...")
+                run(('scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5],
+                     f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}", f"{_user_data[3]}{_title}"))
+        else:
+            _synced = True
+            print(f"\u001b[38;5;4m{_title[:-4]}\u001b[0m is not on remote server, uploading...")
+            run(('scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5], _user_data[3] + _title,
+                 f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}"))
+    for _title in _index_remote[0]:
+        if _title not in _index_local[0]:
+            _synced = True
+            print(f"\u001b[38;5;2m{_title[:-4]}\u001b[0m is not in local directory, downloading...")
+            run(('scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5],
+                 f"{_user_data[0]}@[{_user_data[1]}]:{_user_data[4]}{_title}", f"{_user_data[3]}{_title}"))
+    if _synced:
+        print()

lib/sshyp.py

@@ -0,0 +1,732 @@
+#!/usr/bin/env python3
+from configparser import ConfigParser, NoOptionError, NoSectionError
+from os import chmod, environ, listdir, walk
+from os.path import expanduser, isdir, isfile, realpath
+from pathlib import Path
+from shutil import move
+from sshync import delete as offline_delete, run_profile
+from subprocess import CalledProcessError, DEVNULL, PIPE, run
+from sys import argv, exit as s_exit
+# PORT START UNAME-IMPORT-SSHYP
+from os import uname
+# PORT END UNAME-IMPORT-SSHYP
+home = expanduser('~')
+
+
+# UTILITY FUNCTIONS
+
+# generates and prints full entry list
+def entry_list_gen(_directory=f"{home}/.local/share/sshyp/"):
+    from shutil import get_terminal_size
+    from textwrap import fill
+    _ran = False
+    print("\nfor a list of usable commands, run 'sshyp help'\n\n\u001b[38;5;0;48;5;15msshyp entries:\u001b[0m\n")
+    for _root, _dirs, _files in sorted(walk(_directory, topdown=True)):
+        _entry_list, _color_alternator = [], 1
+        if _ran:
+            print(f"\u001b[38;5;15;48;5;238m{_root.replace(f'{home}/.local/share/sshyp', '', 1)}/\u001b[0m")
+        for filename in sorted(_files):
+            if _color_alternator > 0:
+                _entry_list.append(filename[:-4])
+            else:
+                _entry_list.append(f"\u001b[38;5;8m{filename[:-4]}\u001b[0m")
+            _color_alternator = _color_alternator * -1
+        _real = len(' '.join(_entry_list)) - (5.5 * len(_entry_list))
+        if _real <= get_terminal_size()[0]:
+            _width = len(' '.join(_entry_list))
+        else:
+            _width = (len(' '.join(_entry_list)) / (_real / get_terminal_size()[0]) - 25)
+        if len(_entry_list) > 0:
+            print(fill(' '.join(_entry_list), width=_width) + '\n')
+        elif _ran:
+            print('\u001b[38;5;9m-empty directory-\u001b[0m\n')
+        _ran = True
+
+
+# displays the contents of an entry in a readable format
+def entry_reader(_decrypted_entry):
+    _notes_flag = 0
+    if pass_show:
+        _entry_password = f'\u001b[38;5;10m{_decrypted_entry[0]}\u001b[0m'
+    else:
+        _entry_password = f'\u001b[38;5;3mend command in "--show" or "-s" to view\u001b[0m'
+    print()
+    for _num in range(len(_decrypted_entry)):
+        try:
+            if _num == 0 and _decrypted_entry[1] != '':
+                print(f"\u001b[38;5;15;48;5;238musername:\u001b[0m\n{_decrypted_entry[1]}\n")
+            elif _num == 1 and _decrypted_entry[0] != '':
+                print(f"\u001b[38;5;15;48;5;238mpassword:\u001b[0m\n{_entry_password}\n")
+            elif _num == 2 and _decrypted_entry[2] != '':
+                print(f"\u001b[38;5;15;48;5;238murl:\u001b[0m\n{_decrypted_entry[_num]}\n")
+            elif _num >= 3 and _decrypted_entry[_num] != '' and _notes_flag != 1:
+                _notes_flag = 1
+                print('\u001b[38;5;15;48;5;238mnotes:\u001b[0m\n' + _decrypted_entry[_num])
+            elif _num >= 3 and _notes_flag == 1:
+                print(_decrypted_entry[_num])
+            if _notes_flag == 1:
+                try:
+                    _line_test = _decrypted_entry[_num + 1]
+                except IndexError:
+                    print()
+        except IndexError:
+            if _num == 0 and _decrypted_entry[0] != '':
+                print(f"\u001b[38;5;15;48;5;238mpassword:\u001b[0m\n{_entry_password}\n")
+
+
+# generates and returns a random string based on input
+def string_gen(_complexity, _length):
+    from random import SystemRandom
+    import string
+    if _complexity == 's':
+        _character_pool = string.ascii_letters + string.digits
+    elif _complexity == 'f':
+        _character_pool = string.digits + string.ascii_letters + string.punctuation.replace('/', '').replace('\\', '')\
+            .replace("'", '').replace('"', '').replace('`', '').replace('~', '')
+    else:
+        _character_pool = string.digits + string.ascii_letters + string.punctuation
+    _min_special, _special = round(.2 * _length), 0
+    while True:
+        _gen = ''.join(SystemRandom().choice(_character_pool) for _ in range(_length))
+        for _character in _gen:
+            if not _character.isalpha():
+                _special += 1
+        if _special >= _min_special:
+            break
+    return _gen
+
+
+# prompts the user for necessary information to generate a password and passes it to string_gen
+def pass_gen():
+    _length = 9
+    while True:
+        try:
+            _length = int(input('\npassword length: '))
+        except ValueError:
+            continue
+        else:
+            if _length < 1:
+                continue
+            else:
+                break
+    _complexity = str(input('\npassword complexity - simple (for compatibility) or complex (for security)? (s/C) '))
+    if _complexity not in ('s', 'S'):
+        _complexity = 'c'
+    _gen = string_gen(_complexity.lower(), _length)
+    return _gen
+
+
+# creates a temporary file to allow notes to be edited by standard editors
+def edit_note(_note_lines, _exit_on_match=False):
+    from tempfile import NamedTemporaryFile
+    _joined_note_lines = '\n'.join(_note_lines)
+    with NamedTemporaryFile(mode='w+') as _tmp:
+        _tmp.write(_joined_note_lines)
+        _tmp.seek(0)
+        run((editor, _tmp.name))
+        _tmp.seek(0)
+        _new_note = _tmp.read().rstrip()
+    if _exit_on_match and _joined_note_lines == _new_note:
+        s_exit(0)
+    return _new_note
+
+
+# encrypts an entry and cleans up the temporary files
+def encrypt(_entry_data, _entry_dir, _gpg_id):
+    _bytes_data = '\n'.join(_entry_data).rstrip().encode()
+    _encrypted_data = run(('gpg', '-qr', str(_gpg_id), '-e'), input=_bytes_data, stdout=PIPE).stdout
+    open(_entry_dir + '.gpg', 'wb').write(_encrypted_data)
+
+
+# decrypts an entry to a temporary directory
+def decrypt(_entry_dir, _quick_verify=None, _quick_pass=None):
+    _contents = None
+
+    # check quick-unlock status, fetch passphrase
+    if _quick_verify == 'true':
+        _quick_pass = whitelist_verify(port, username_ssh, ip, client_device_id)
+    else:
+        if _quick_pass is None:
+            _quick_pass = False
+
+    # set decryption method based on quick-unlock availability
+    if not isinstance(_quick_pass, bool):
+        _cmd = ['gpg', '--pinentry-mode', 'loopback', '--passphrase', _quick_pass, '-qd']
+    else:
+        _cmd = ['gpg', '-qd']
+
+    # set decryption target based on lock file availability
+    if _entry_dir is None:
+        _dec_target = [f"{home}/.config/sshyp/lock.gpg"]
+    else:
+        _dec_target = [f"{_entry_dir}.gpg"]
+
+    # run decryption command
+    try:
+        _contents = run(_cmd + _dec_target, stderr=DEVNULL, stdout=PIPE, text=True, check=True).stdout
+    except CalledProcessError:
+        if not isinstance(_quick_pass, bool):
+            print('\n\u001b[38;5;9merror: quick-unlock failed as a result of an incorrect passphrase, an unreachable '
+                  'sshyp server, or an invalid configuration\n\nfalling back to standard unlock\u001b[0m\n')
+            try:
+                _contents = run(['gpg', '-qd'] + _dec_target, stderr=DEVNULL, stdout=PIPE, text=True, check=True).stdout
+            except CalledProcessError:
+                print('\n\u001b[38;5;9merror: could not decrypt - ensure the correct gpg key is present\u001b[0m\n')
+                s_exit(4)
+        else:
+            print('\n\u001b[38;5;9merror: could not decrypt - ensure the correct gpg key is present\u001b[0m\n')
+            s_exit(4)
+    return _contents.rstrip().split('\n')
+
+
+# checks the user's whitelist status and fetches the full gpg key password if possible
+def whitelist_verify(_port, _username_ssh, _ip, _client_device_id):
+    try:
+        run(('gpg', '--pinentry-mode', 'cancel', '-qd', '--output', '/dev/null',
+             f"{home}/.config/sshyp/lock.gpg"), stderr=DEVNULL, check=True)
+        return False
+    except CalledProcessError:
+        _i, _full_password = 0, ''
+        _server_whitelist = run(('ssh', '-i', f"{home}/.ssh/sshyp", '-p', _port, f"{_username_ssh}@{_ip}",
+                                 f'python3 -c \'from os import listdir; print(*listdir("/home/{_username_ssh}'
+                                 f'/.config/sshyp/whitelist"))\''), stdout=PIPE, text=True).stdout.rstrip().split()
+        for _device_id in _server_whitelist:
+            if _device_id == _client_device_id:
+                from getpass import getpass
+                _quick_unlock_password = getpass(prompt='\nquick-unlock pin: ')
+                _quick_unlock_password_excluded = \
+                    run(('ssh', '-i', f"{home}/.ssh/sshyp", '-p',  _port, f"{_username_ssh}@{_ip}",
+                         f"gpg --pinentry-mode loopback --passphrase '{_quick_unlock_password}' "
+                         f"-qd ~/.config/sshyp/excluded.gpg"), stdout=PIPE, text=True).stdout.rstrip()
+                while _i < len(_quick_unlock_password_excluded):
+                    try:
+                        _full_password += _quick_unlock_password_excluded[_i]
+                    except IndexError:
+                        pass
+                    try:
+                        _full_password += _quick_unlock_password[_i]
+                    except IndexError:
+                        pass
+                    _i += 1
+                break
+    return _full_password
+
+
+# returns True if expected and reality align, otherwise error
+def target_exists_check(_target_name, _expected_presence):
+    if isfile(f"{directory}{_target_name}.gpg") or isdir(f"{directory}{_target_name}"):
+        if _expected_presence:
+            return True
+        else:
+            print(f"\n\u001b[38;5;9merror: (/{_target_name}) already exists\u001b[0m\n")
+            s_exit(3)
+    else:
+        if not _expected_presence:
+            return True
+        else:
+            print(f"\n\u001b[38;5;9merror: (/{_target_name}) does not exist\u001b[0m\n")
+            s_exit(2)
+        
+
+# returns target type (entry == True, folder == False, null == None), optional errors
+def target_type_check(_target_name, _expected_type=True, _error=False):
+    if isfile(f"{directory}{_target_name}.gpg"):
+        if _error and not _expected_type:
+            print(f"\n\u001b[38;5;9merror: (/{_target_name}) is an entry\u001b[0m\n")
+            s_exit(2)
+        return True
+    elif isdir(f"{directory}{_target_name}"):
+        if _error and _expected_type:
+            print(f"\n\u001b[38;5;9merror: (/{_target_name}) is a folder\u001b[0m\n")
+            s_exit(2)
+        return False
+    else:
+        print(f"\n\u001b[38;5;9merror: (/{_target_name}) does not exist\u001b[0m\n")
+        s_exit(2)
+
+
+# ensures an edited entry is optimized for best compatibility
+def line_edit(_lines, _edit_data, _edit_line):
+    # ensure enough lines are present for edited field
+    while len(_lines) < _edit_line + 1:
+        _lines.append('')
+    # write the edited field
+    _lines[_edit_line] = _edit_data.rstrip()
+    return _lines
+
+
+# attempts to connect to the user's server via ssh to register the device for syncing
+def copy_id_check(_port, _username_ssh, _ip, _client_device_id, _sshyp_data):
+    from stweak import write_config
+    if not _sshyp_data.has_section('CLIENT-ONLINE'):
+        _sshyp_data.add_section('CLIENT-ONLINE')
+    try:
+        run(('ssh', '-o', 'ConnectTimeout=3', '-i', f"{home}/.ssh/sshyp", '-p', _port, f"{_username_ssh}@{_ip}",
+             f'python3 -c \'from pathlib import Path; Path("/home/{_username_ssh}/.config/sshyp/devices/'
+             f'{_client_device_id}").touch(mode=0o400, exist_ok=True)\''), stderr=DEVNULL, check=True)
+    except CalledProcessError:
+        print('\n\u001b[38;5;9mwarning: ssh connection could not be made - ensure the public key (~/.ssh/sshyp.pub) is '
+              'registered on the remote server and that the entered ip, port, and username are correct\n\nsyncing '
+              'functionality will be disabled until this is addressed\u001b[0m\n')
+        _sshyp_data.set('CLIENT-ONLINE', 'ssh_error', '1')
+        write_config(_sshyp_data)
+        return True
+    _sshyp_data.set('CLIENT-ONLINE', 'ssh_error', '0')
+    write_config(_sshyp_data)
+    return False
+
+
+# ARGUMENT-SPECIFIC FUNCTIONS
+
+# prints help text based on argument
+def print_info():
+    if arguments[0] in ('version', '-v'):
+        _blank = '\u001b[38;5;7;48;5;8m\\\u001b[38;5;15;48;5;15m' + 55*' ' + '\u001b[38;5;7;48;5;8m/\u001b[0m'
+        _border = '\u001b[38;5;7;48;5;8m' + 14*'<>' + '-' + 14*'<>' + '\u001b[0m\n'
+        print(f"""\nsshyp is a simple, self-hosted, sftp-synchronized\npassword manager for unix(-like) systems\n
+{9*' '}..{15*' '}\u001b[38;5;12m♥♥ \u001b[38;5;9m♥♥\u001b[0m{15*' '}..
+{8*' '}/()\\''.''.{7*' '}\u001b[38;5;12m♥♥♥\u001b[0m♥♥♥♥\u001b[0m{7*' '}.''.''/()\\{3*' '}_)
+{5*' '}_.{3*' '}:{7*' '}*{7*' '}\u001b[38;5;9m♥♥♥♥♥\u001b[0m{7*' '}*{7*' '}:{3*' '}<[◎]|_|=
+ }}-}}-*]{4*' '}`..'..'{9*' '}\u001b[0m♥♥♥\u001b[0m{9*' '}`..'..'{6*' '}|
+{4*' '}◎-◎{4*' '}//{3*' '}\\\\{10*' '}\u001b[38;5;9m♥\u001b[0m{10*' '}//{3*' '}\\\\{5*' '}/|\\""")
+        print(f"{_border}{_blank}\n\u001b[38;5;7;48;5;8m\\\u001b[38;5;15;48;5;15m{18*' '}\u001b[38;5;15;48;5;8msshyp "
+              f"version 1.5.0\u001b[38;5;15;48;5;15m{18*' '}\u001b[38;5;7;48;5;8m/\u001b[0m")
+        print(f"\u001b[38;5;7;48;5;8m\\\u001b[38;5;15;48;5;15m{14*' '}\u001b[38;5;15;48;5;8mthe fortified flock"
+              f" update\u001b[38;5;15;48;5;15m{15*' '}\u001b[38;5;7;48;5;8m/\u001b[0m\n{_blank}")
+        print(f"\u001b[38;5;7;48;5;8m\\\u001b[38;5;15;48;5;15m{9*' '}\u001b[38;5;15;48;5;8mcopyright 2021-2023 ", 
+              f"randall winkhart\u001b[38;5;15;48;5;15m{9*' '}\u001b[38;5;7;48;5;8m/\u001b[0m")
+        print(f"{_blank}\n{_border}\nsee https://github.com/rwinkhart/sshyp for more information\n")
+    elif arguments[0] == 'license':
+        print('\nThis program is free software: you can redistribute it and/or modify it under the terms\nof version 3 '
+              '(only) of the GNU General Public License as published by the Free Software Foundation.\n\nThis program '
+              'is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;\nwithout even the implied '
+              'warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\nSee the GNU General Public License for'
+              ' more details.\n\nhttps://opensource.org/licenses/GPL-3.0\n')
+    elif arguments[0] == 'add' and device_type == 'client':
+        print(f"""\n\u001b[1musage:\u001b[0m sshyp /<entry name> add <option>\u001b[0m\n
+\u001b[1moptions:\u001b[0m
+ add:
+  password/-p{12*' '}add a password entry
+  note/-n{16*' '}add a note entry
+  folder/-f{14*' '}add a new folder for entries\n""")
+    elif arguments[0] == 'edit' and device_type == 'client':
+        print(f"""\n\u001b[1musage:\u001b[0m sshyp /<entry name> edit <option>\u001b[0m\n
+\u001b[1moptions:\u001b[0m
+ edit:
+  rename/relocate/-r{5*' '}rename or relocate an entry
+  username/-u{12*' '}change the username of an entry
+  password/-p{12*' '}change the password of an entry
+  url/-l{17*' '}change the url attached to an entry
+  note/-n{16*' '}change the note attached to an entry\n""")
+    elif arguments[0] == 'copy' and device_type == 'client':
+        print(f"""\n\u001b[1musage:\u001b[0m sshyp /<entry name> copy <option>\u001b[0m\n
+\u001b[1moptions:\u001b[0m
+ copy:
+  username/-u{12*' '}copy the username of an entry to your clipboard
+  password/-p{12*' '}copy the password of an entry to your clipboard
+  url/-l{17*' '}copy the url of an entry to your clipboard
+  note/-n{16*' '}copy the note of an entry to your clipboard\n""")
+    elif arguments[0] == 'gen' and device_type == 'client':
+        print(f"""\n\u001b[1musage:\u001b[0m sshyp /<entry name> gen [option]\u001b[0m\n
+\u001b[1moptions:\u001b[0m
+ gen:
+  update/-u{14*' '}generate a password for an existing entry\n""")
+    else:
+        print("\n\u001b[1msshyp ", "copyright (c) 2021-2023 ", """randall winkhart\u001b[0m
+this is free software, and you are welcome to redistribute it under certain conditions;
+this program comes with absolutely no warranty; type 'sshyp license' for details""")
+        if device_type == 'client':
+            print(f"""\n\u001b[1musage:\u001b[0m sshyp [/<entry name> [argument] [option]] | [argument]\n
+\u001b[1marguments:\u001b[0m
+ help/-h{17*' '}bring up this menu
+ version/-v{14*' '}display sshyp version info
+ init{20*' '}set up sshyp
+ tweak{19*' '}change configuration options/manage extensions and updates
+ add{21*' '}add an entry
+ gen{21*' '}generate a new password
+ edit{20*' '}edit an existing entry
+ copy{20*' '}copy details of an entry to your clipboard
+ shear{19*' '}delete an existing entry
+ sync{20*' '}manually sync the entry directory via sshync
+\n\u001b[1moptions:\u001b[0m
+ add:
+  password/-p{12*' '}add a password entry
+  note/-n{16*' '}add a note entry
+  folder/-f{14*' '}add a new folder for entries
+ edit:
+  rename/relocate/-r{5*' '}rename or relocate an entry
+  username/-u{12*' '}change the username of an entry
+  password/-p{12*' '}change the password of an entry
+  url/-l{17*' '}change the url attached to an entry
+  note/-n{16*' '}change the note attached to an entry
+ copy:
+  username/-u{12*' '}copy the username of an entry to your clipboard
+  password/-p{12*' '}copy the password of an entry to your clipboard
+  url/-l{17*' '}copy the url of an entry to your clipboard
+  note/-n{16*' '}copy the note of an entry to your clipboard
+ gen:
+  update/-u{14*' '}generate a password for an existing entry
+\n\u001b[1mtip 1:\u001b[0m you can quickly read an entry with 'sshyp /<entry name>'
+\u001b[1mtip 2:\u001b[0m type 'sshyp' to view a list of saved entries\n""")
+        # PORT START HELP-SERVER
+        else:
+            print(f"""\n\u001b[1musage:\u001b[0m sshyp <argument>\n
+\u001b[1marguments:\u001b[0m
+ help/-h{17*' '}bring up this menu
+ version/-v{14*' '}display sshyp version info
+ init{20*' '}set up sshyp
+ tweak{19*' '}change configuration options/manage extensions and updates\n""")
+        # PORT END HELP-SERVER
+
+
+# shortcut to quickly read an entry
+def read_shortcut():
+    target_type_check(entry_name, True, True)
+    entry_reader(decrypt(directory + entry_name, _quick_verify=quick_unlock_enabled))
+
+
+# calls sshync to sync changes to the user's server
+def sync(_start_text=''):
+    print(f"{_start_text}syncing entries with the server device...\n")
+    # set permissions before uploading
+    for _root, _dirs, _files in walk(f"{home}/.local/share/sshyp"):
+        for _path in _root.splitlines():
+            chmod(_path, 0o700)
+        for _file in _files:
+            chmod(_root + '/' + _file, 0o600)
+    run_profile(f"{home}/.config/sshyp/sshyp.ini", silent_sync)
+
+
+# adds a new entry
+def add_entry():
+    # make sure the add target does not already exist
+    target_exists_check(entry_name, False)
+
+    # note entry
+    if arguments[2] in ('note', '-n'):
+        _password, _username, _url, _note = '', '', '', edit_note([])
+    else:
+        # password entry
+        from getpass import getpass
+        _username = str(input('\nusername: '))
+        _password = str(getpass(prompt='\npassword: '))
+        _url = str(input('\nurl: '))
+        if input('\nadd a note to this entry? (y/N) ').lower() == 'y':
+            _note = edit_note([])
+        else:
+            _note = ''
+    print('\n\u001b[1mentry preview:\u001b[0m')
+    entry_reader([_password, _username, _url, _note])
+    encrypt([_password, _username, _url, _note], directory + entry_name, gpg_id)
+
+
+# creates a new folder
+def add_folder():
+    Path(directory + entry_name).mkdir(mode=0o700, parents=True, exist_ok=True)
+    if not ssh_error:
+        run(('ssh', '-i', f"{home}/.ssh/sshyp", '-p', port, f"{username_ssh}@{ip}",
+             f'python3 -c \'from pathlib import Path; Path("{directory_ssh}{entry_name}")'
+             f'.mkdir(mode=0o700, parents=True, exist_ok=True)\''))
+
+
+# renames an entry or folder
+def rename():
+    from shutil import copy
+
+    # check if the renaming target is an entry (file) or a folder
+    _file = target_type_check(entry_name)
+
+    # collect the new name for the target from user input
+    _new_name = str(input('new name: ')).strip('/')
+
+    # check if the new name already exists
+    target_exists_check(_new_name, False)
+
+    # if renaming a file
+    if _file:
+        if not ssh_error:
+            copy(f"{directory}{entry_name}.gpg", f"{directory}{_new_name}.gpg")
+        else:
+            move(f"{directory}{entry_name}.gpg", f"{directory}{_new_name}.gpg")
+    else:
+
+        # if renaming a folder
+        if not ssh_error:
+            Path(f"{directory}{_new_name}").mkdir(mode=0o700, parents=True, exist_ok=True)
+            run(('ssh', '-i', f"{home}/.ssh/sshyp", '-p', port, f"{username_ssh}@{ip}",
+                 f'python3 -c \'from pathlib import Path; Path("{directory_ssh}{entry_name}")'
+                 f'.rename(Path("{directory_ssh}{_new_name}"))\''))                 
+        else:
+            move(f"{directory}{entry_name}", f"{directory}{_new_name}")
+    if not ssh_error:
+        run(('ssh', '-i', f"{home}/.ssh/sshyp", '-p', port, f"{username_ssh}@{ip}",
+             f'cd /usr/lib/sshyp; python3 -c \'from sshync import delete; delete("{entry_name}", "remotely", True)\''))
+
+
+# edits the contents of an entry
+def edit():
+    # set to avoid PEP8 warnings
+    _detail, _edit_line = None, None
+    
+    # ensure the edit target is an entry
+    target_type_check(entry_name, True, True)
+
+    if arguments[2] in ('username', '-u'):
+        _detail, _edit_line = str(input('\nusername: ')), 1
+    elif arguments[2] in ('password', '-p'):
+        from getpass import getpass
+        _detail, _edit_line = str(getpass(prompt='\npassword: ')), 0
+    elif arguments[2] in ('url', '-l'):
+        _detail, _edit_line = str(input('\nurl: ')), 2
+    if arguments[2] in ('note', '-n'):
+        _old_lines = decrypt(directory + entry_name, _quick_verify=quick_unlock_enabled)
+        _new_lines = _old_lines[0:3] + edit_note(_old_lines[3:], True).split('\n')
+    else:
+        _new_lines = line_edit(decrypt(directory + entry_name, _quick_verify=quick_unlock_enabled), _detail,
+                               _edit_line)
+    print('\n\u001b[1mentry preview:\u001b[0m')
+    entry_reader(_new_lines)
+    encrypt(_new_lines, directory + entry_name, gpg_id)
+
+
+# generates a password for a new or an existing entry
+def gen():
+    # set to avoid PEP8 warnings
+    _username, _url, _notes = None, None, None
+    # gen update
+    if arg_count == 3 and arguments[2] in ('update', '-u'):
+        # ensure the gen update target is an entry        
+        target_type_check(entry_name, True, True)
+        _new_lines = line_edit(decrypt(directory + entry_name, _quick_verify=quick_unlock_enabled), pass_gen(), 0)
+    # gen
+    else:
+        # make sure the gen target does not already exist
+        target_exists_check(entry_name, False)
+        _username = str(input('\nusername: '))
+        _password = pass_gen()
+        _url = str(input('\nurl: '))
+        if input('\nadd a note to this entry? (y/N) ').lower() == 'y':
+            _note = edit_note([])
+        else:
+            _note = ''
+        _new_lines = [_password, _username, _url, _note]
+    print('\n\u001b[1mentry preview:\u001b[0m')
+    entry_reader(_new_lines)
+    encrypt(_new_lines, directory + entry_name, gpg_id)
+
+
+# copies a specified field of an entry to the clipboard
+def copy_data():
+    from subprocess import Popen
+    # ensure the copy target is an entry
+    target_type_check(entry_name, True, True)
+    _index = 0
+    if arguments[2] in ('username', '-u'):
+        _index = 1
+    elif arguments[2] in ('password', '-p'):
+        _index = 0
+    elif arguments[2] in ('url', '-l'):
+        _index = 2
+    elif arguments[2] in ('note', '-n'):
+        _index = 3
+    _copy_subject = decrypt(directory + entry_name, _quick_verify=quick_unlock_enabled)[_index]
+    # ensure field is not blank
+    if _copy_subject == '':
+        raise IndexError
+    # PORT START CLIPBOARD
+    # WSL clipboard detection
+    if 'WSL_DISTRO_NAME' in environ:
+        run(('powershell.exe', '-c', "Set-Clipboard '" + _copy_subject.replace("'", "''") + "'"))
+        Popen("sleep 30; powershell.exe -c Set-Clipboard ''", shell=True, stdout=DEVNULL, stderr=DEVNULL)
+    # Wayland clipboard detection
+    elif 'WAYLAND_DISPLAY' in environ:
+        run(('wl-copy', _copy_subject))
+        Popen('sleep 30; wl-copy -c', shell=True)
+    # Haiku clipboard detection
+    elif uname()[0] == 'Haiku':
+        run(('clipboard', '-c', _copy_subject))
+        Popen('sleep 30; clipboard -r', shell=True)
+    # MacOS clipboard detection
+    elif uname()[0] == 'Darwin':
+        run('pbcopy', stdin=Popen(('printf', _copy_subject.replace('\\', '\\\\').replace('%', '%%')), stdout=PIPE)
+            .stdout)
+        Popen("sleep 30; printf '' | pbcopy", shell=True)
+    # Termux (Android) clipboard detection
+    elif isdir("/data/data/com.termux"):
+        run(('termux-clipboard-set', _copy_subject))
+        Popen("sleep 30; termux-clipboard-set ''", shell=True)
+    # X11 clipboard detection
+    elif 'DISPLAY' in environ:
+        run(('xclip', '-sel', 'c'), stdin=Popen(('printf', _copy_subject.replace('\\', '\\\\')
+                                                .replace('%', '%%')), stdout=PIPE).stdout)
+        Popen("sleep 30; printf '' | xclip -sel c", shell=True)
+    else:
+        print('\n\u001b[38;5;9merror: clipboard tool could not be determined\n\nnote that the clipboard does not '
+              'function in a raw tty\u001b[0m\n')
+    # PORT END CLIPBOARD
+
+
+# deletes an entry from the server and flags it for local deletion on sync
+def remove_data():
+    decrypt(None, _quick_verify=quick_unlock_enabled)
+    if not ssh_error:
+        run(('ssh', '-i', f"{home}/.ssh/sshyp", '-p', port, f"{username_ssh}@{ip}",
+             f'cd /usr/lib/sshyp; python3 -c \'from sshync import delete; delete("{entry_name}", "remotely", True)\''))
+    else:
+        offline_delete(entry_name, 'locally', silent_sync)
+
+
+# checks extension config files for matches to argument, runs extensions
+def extension_runner():
+    _output_com, _extension_dir = None, realpath(__file__).rsplit('/', 1)[0] + '/extensions/'
+    if isdir(_extension_dir):
+        for _extension in listdir(_extension_dir):
+            _extension_config = ConfigParser()
+            _extension_config.read(_extension_dir + _extension)
+            _input_com = _extension_config.get('config', 'input').split()
+            if _input_com == arguments[arg_start:]:
+                _output_com = _extension_config.get('config', 'output').split()
+                if arg_start == 1:
+                    _output_com.append(arguments[0])
+        if _output_com is not None:
+            run(_output_com)
+        else:
+            print_info()
+    else:
+        print_info()
+    s_exit()
+
+
+if __name__ == "__main__":
+    try:
+        # set default states
+        ssh_error, success_flag, sync_flag, silent_sync, pass_show = False, False, False, False, False
+        
+        # set to avoid PEP8 warnings
+        arg_start, device_type = None, None
+        
+        # retrieve typed argument
+        arguments = argv[1:]
+        arg_count = len(arguments)
+
+        # check if an entry name is correctly supplied
+        if arg_count < 1 or (arg_count > 0 and arguments[0] != 'init'):
+            if arg_count > 0 and arguments[0].startswith('/'):
+                arg_start = 1
+                entry_name = arguments[0].strip('/')
+                # determine whether to show passwords in entry previews
+                if arg_count > 1 and arguments[arg_count-1] in ('--show', '-s'):
+                    arguments.pop()
+                    arg_count -= 1
+                    pass_show = True
+            else:
+                arg_start = 0
+
+            # import saved userdata
+            try:
+                sshyp_data = ConfigParser()
+                sshyp_data.read(f"{home}/.config/sshyp/sshyp.ini")
+                device_type = sshyp_data.get('GENERAL', 'device_type')
+                if device_type == 'client':
+                    directory = f"{home}/.local/share/sshyp/"
+                    gpg_id = sshyp_data.get('CLIENT-GENERAL', 'gpg_id')
+                    editor = sshyp_data.get('CLIENT-GENERAL', 'text_editor')
+                    offline_mode_enabled = sshyp_data.get('CLIENT-GENERAL', 'offline_mode_enabled')
+                    if offline_mode_enabled == 'true':
+                        ssh_error = True
+                        quick_unlock_enabled = 'false'
+                    else:
+                        quick_unlock_enabled = sshyp_data.get('CLIENT-ONLINE', 'quick_unlock_enabled')
+                        username_ssh = sshyp_data.get('SSHYNC', 'user')
+                        ip = sshyp_data.get('SSHYNC', 'ip')
+                        port = sshyp_data.get('SSHYNC', 'port')
+                        directory_ssh = sshyp_data.get('SSHYNC', 'remote_dir')
+                        client_device_id = listdir(f"{home}/.config/sshyp/devices")[0]
+                        ssh_error = int(sshyp_data.get('CLIENT-ONLINE', 'ssh_error'))
+                        if ssh_error == 1:
+                            ssh_error = copy_id_check(port, username_ssh, ip, client_device_id, sshyp_data)
+            except (FileNotFoundError, NoSectionError, NoOptionError):
+                print(f"\n{73*'!'}")
+                print("not all necessary configurations have been made - please run 'sshyp init'")
+                print(f"{73*'!'}\n")
+                s_exit(1)
+        else:
+            from stweak import wrapped_entry
+            wrapped_entry(False)
+            s_exit()
+
+        # run function based on arguments
+        if device_type == 'client':
+            if arg_count < 1:
+                entry_list_gen()
+
+            elif arg_count == 3 and arg_start == 1:
+                if arguments[1] == 'copy':
+                    if arguments[2] in ('username', '-u', 'password', '-p', 'url', '-l', 'note', '-n'):
+                        try:
+                            success_flag = 1
+                            copy_data()
+                        except IndexError:
+                            print('\n\u001b[38;5;9merror: field does not exist in entry\u001b[0m\n')
+                            s_exit(2)
+                elif arguments[1] == 'add':
+                    if arguments[2] in ('note', '-n', 'password', '-p'):
+                        success_flag, sync_flag = True, True
+                        add_entry()
+                    elif arguments[2] in ('folder', '-f'):
+                        success_flag = 1
+                        add_folder()
+                elif arguments[1] == 'edit':
+                    if arguments[2] in ('rename', 'relocate', '-r'):
+                        success_flag, sync_flag, silent_sync = True, True, True
+                        rename()
+                    elif arguments[2] in ('username', '-u', 'password', '-p', 'url', '-l', 'note', '-n'):
+                        success_flag, sync_flag = True, True
+                        edit()
+                elif arguments[1] == 'gen' and arguments[2] in ('update', '-u'):
+                    success_flag, sync_flag = True, True
+                    gen()
+
+            elif arg_count == 2 and arg_start == 1:
+                if arguments[1] == 'gen':
+                    success_flag, sync_flag = True, True
+                    gen()
+                elif arguments[1] == 'shear':
+                    success_flag = True
+                    remove_data()
+
+            elif arg_count == 1:
+                if arg_start == 1:
+                    success_flag = True
+                    read_shortcut()
+                elif arguments[0] == 'tweak':
+                    success_flag = True
+                    from stweak import wrapped_entry
+                    wrapped_entry(device_type)
+       
+            if arg_count > 0 and success_flag == 0 and arguments[0] != 'sync':
+                if arguments[0] not in ('help', '-h', 'version', '-v', 'license'):
+                    extension_runner()
+                else:
+                    print_info()
+            elif not ssh_error:
+                if sync_flag: 
+                    sync()
+                elif (arg_count > 0 and arguments[0] == 'sync') or (arg_count > 1 and arguments[1] == 'shear'):
+                    sync('\n')
+
+        # PORT START ARGS-SERVER
+        # server arguments
+        else:
+            if arg_count == 1 and arguments[0] == 'tweak':
+                success_flag = True
+                from stweak import wrapped_entry
+                wrapped_entry(device_type)
+            else:
+                if arg_count < 1:
+                    arguments.append('help')
+                print_info()
+        # PORT END ARGS-SERVER
+
+    except KeyboardInterrupt:
+        print('\n')

lib/stweak.py

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

package.sh

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

port-jobs/BLANKS.py

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

port-jobs/CLIPBOARD.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+import re
+from sys import argv, exit as s_exit
+
+# read arguments
+arguments, replacement = argv[1:], None
+
+# define replacement text depending on arguments
+if len(arguments) > 0:
+    if arguments[0] == 'WSL':
+        replacement = """run(('powershell.exe', '-c', "Set-Clipboard '" + _copy_subject.replace("'", "''") + "'"))
+    Popen("sleep 30; powershell.exe -c Set-Clipboard ''", shell=True, stdout=DEVNULL, stderr=DEVNULL)"""
+    elif arguments[0] == 'MAC':
+        replacement = """run('pbcopy', stdin=Popen(('printf', _copy_subject.replace('\\\\\\', '\\\\\\\\\\\\\\')
+        .replace('%', '%%')), stdout=PIPE).stdout)
+    Popen("sleep 30; printf '' | pbcopy", shell=True)"""
+    elif arguments[0] == 'HAIKU':
+        replacement = """run(('clipboard', '-c', _copy_subject))
+    Popen('sleep 30; clipboard -r', shell=True)"""
+    elif arguments[0] == 'TERMUX':
+        replacement = """run(('termux-clipboard-set', _copy_subject))
+    Popen("sleep 30; termux-clipboard-set ''", shell=True)"""
+    elif arguments[0] == 'LINUX':
+        replacement = """if 'WAYLAND_DISPLAY' in environ:
+        run(('wl-copy', _copy_subject))
+        Popen('sleep 30; wl-copy -c', shell=True)
+    else:
+        run(('xclip', '-sel', 'c'), stdin=Popen(('printf', _copy_subject
+        .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/CLIPTOOL.py

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

port-jobs/COMMENTS.py

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

port-jobs/RMEXTMAN.py

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

port-jobs/RMSERVER.py

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

port-jobs/SHEBANG.sh

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

port-jobs/TABS.sh

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

port-jobs/UNAME.py

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

share/doc/sshyp/changelog

@@ -1,52 +0,0 @@
-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
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-The full history of changes to "sshyp" can be found on the following page:
-https://raw.githubusercontent.com/rwinkhart/sshyp/main/extra/changelog-total

share/licenses/sshyp/license

@@ -1,10 +1,9 @@
-    sshyp is a FOSS password manager that takes advantage of rsync
-    Copyright (C) 2021  Randall Winkhart  idgr@tutanota.com
+    sshyp is a FOSS password manager that uses an sftp-based syncing back-end.
+    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 the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
+    it under the terms of version 3 (only) of the GNU General Public License
+    as published by the Free Software Foundation.
 
     This program is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -12,4 +11,4 @@
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+    along with this program. If not, see <http://www.gnu.org/licenses/>.