Add distribution names to packages

Former-commit-id: 9dd795c4a3d84f7cba92c99de1389a200aad9d9f
Former-commit-id: dfd3368e54eaf4429637f27cf437d3535ae78d4c

.SRCINFO

@@ -1,15 +0,0 @@
-pkgbase = rpass
-	pkgdesc = An rsync-based password manager and alternative to GNU pass
-	pkgver = 2021.09.07.pr3.1
-	pkgrel = 1
-	arch = x86_64
-	arch = aarch64
-	license = GPL3
-	depends = python
-	depends = gnupg
-	depends = openssh
-	depends = rsync
-	source = https://cloud.watergateserver.xyz/api/public/dl/6b0Wqz-J
-	sha512sums = f59cd1cd3c981b9424fba85bfd5e7b33e26a482d48b9b47a77be6f8e7cecbf078ec956a46b37db488d5173cd0a439f572ff06fc7d35cc3e9b0a7666e49cadeee
-
-pkgname = rpass

.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

PKGBUILD

@@ -1,21 +0,0 @@
-# Maintainer: Randall Winkhart (Cuan) <idgr at tutanota dot com>
-
-pkgname=rpass
-pkgver=2021.09.07.pr3.1
-pkgrel=1
-pkgdesc="An rsync-based password manager and alternative to GNU pass"
-arch=('x86_64' 'aarch64')
-license=('GPL3')
-depends=( python gnupg openssh rsync )
-
-source=('https://cloud.watergateserver.xyz/api/public/dl/6b0Wqz-J')
-sha512sums=('f59cd1cd3c981b9424fba85bfd5e7b33e26a482d48b9b47a77be6f8e7cecbf078ec956a46b37db488d5173cd0a439f572ff06fc7d35cc3e9b0a7666e49cadeee')
-
-package() {
-
-    mv 6b0Wqz-J rpass-2021.09.07.pr3.1.tar.xz
-	tar xf rpass-2021.09.07.pr3.1.tar.xz -C "${pkgdir}"
-	chown -R "$USER" ${pkgdir}/var/lib/rpass
-
-}
-

README.md

@@ -1,14 +1,97 @@
-# rpass
+![sshyp](https://github.com/rwinkhart/sshyp-labs/blob/main/extra/artwork/sshyp-banner.png)
-A password manager with rsync integration - alternative to GNU pass
+
+[![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.
+
+# 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.
+
+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 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
+**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.*
 
-Arch Linux (x86_64, aarch64)
+Please see the [installation guide](https://github.com/rwinkhart/sshyp/wiki/Installation) in the sshyp wiki for directions specific to your distribution/OS.
 
-rpass is available in the Arch User Repository as 'rpass'.
+Pre-built packages exist for Haiku, FreeBSD, Alpine Linux, Arch Linux, Debian/Ubuntu Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
 
-Install with your preferred AUR helper or use:
+Support for additional environments, such as MacOS and OpenBSD, is coming soon.
 
-git clone https://aur.archlinux.org/rpass.git
+Extensions are available in the [sshyp-labs](https://github.com/rwinkhart/sshyp-labs) repository.
-cd rpass
+
-makepkg -si
+# 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://github.com/rwinkhart/sshyp.git
+cd sshyp
+./package.sh [target] <revision>
+```
+
+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 generic.
+
+# Usage
+Upon initial installation (on both the server and client devices), be sure to run:
+
+```
+sshyp tweak
+```
+
+This command will allow you to configure the settings necessary for sshyp to function. To ensure configuration compatibility, it is a good idea to run 'sshyp tweak' after each major update.
+
+Please note that decrypting and reading entries is disabled on server devices for security reasons. Only devices configured as clients can use the GPG key to decrypt entries.
+
+All available options can be found with:
+
+```
+sshyp help
+```
+
+Or alternatively, in the man page:
+
+```
+man sshyp
+```
+
+# Roadmap
+Short-term Goals:
+
+- MacOS support
+- improved temporary directory security
+- a minimal GUI app - being made as an [extension](https://github.com/rwinkhart/sshyp-labs)
+
+Long-term Goals:
+
+- a fun surprise
+- seize the thrones, shear the humans

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,126 @@
+.TH sshyp 1 "02 April 2023" "v1.4.1" "sshyp man page"
+.SH NAME
+sshyp \- A very simple self-hosted, synchronized password manager for UNIX(-like) systems. Alternative to (and compatible with) pass/password-store.
+.SH SYNOPSIS
+Client Usage: sshyp [</entry name> [option] [flag]] [option]
+
+Server Usage: sshyp <option> [flag] [<device id>]
+.SH DESCRIPTION
+sshyp is a lightweight password and note management program written in Python. sshyp is used via CLI and is self-hosted with a client-server model. sshyp expects that you have access to a personal server with a properly configured ssh server, ideally accepting remote connections.
+.SH EXAMPLES (CLIENT)
+Setting up sshyp for the first time or altering its configuration (also recommended after major updates):
+    sshyp tweak
+
+Viewing the entry database:
+    sshyp
+
+Reading an existing entry saved as '~/.local/share/sshyp/development/github.gpg':
+    sshyp /development/github
+
+Copying the password of an existing entry saved as '~/.local/share/sshyp/financial/bank.gpg':
+    sshyp /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
+
+Removing an existing folder saved as '~/.local/share/sshyp/social':
+    sshyp /social/ shear
+.SH EXAMPLES (SERVER)
+Setting up the quick-unlock whitelist:
+    sshyp whitelist setup
+
+Checking the quick-unlock whitelist status of all registered client devices:
+    sshyp whitelist list
+
+Adding a device with the id 'laptop-im|lAoa;&;r&o:ez((g/Dz;EVb.nO_' to the quick-unlock whitelist:
+    sshyp whitelist add 'laptop-im|lAoa;&;r&o:ez((g/Dz;EVb.nO_'
+
+Removing a device with the id 'laptop-im|lAoa;&;r&o:ez((g/Dz;EVb.nO_' from the quick-unlock whitelist:
+    sshyp whitelist del 'laptop-im|lAoa;&;r&o:ez((g/Dz;EVb.nO_'
+.SH OPTIONS (CLIENT)
+ help/-h                  bring up the help menu
+ version/-v               display sshyp version info
+ tweak                    configure sshyp
+ add                      add an entry
+ gen                      generate a new password
+ edit                     edit an existing entry
+ copy                     copy details of an entry to your clipboard
+ shear                    delete an existing entry
+ sync                     manually sync the entry directory via sshync
+.SH FLAGS (CLIENT)
+add:
+ password/-p              add a password entry
+ note/-n                  add a note entry
+ folder/-f                add a new folder for entries
+
+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 OPTIONS (SERVER)
+ help/-h                  bring up this menu
+ version/-v               display sshyp version info
+ tweak                    configure sshyp
+ whitelist                manage the quick-unlock whitelist
+.SH FLAGS (SERVER)
+whitelist:
+ setup                    set up the quick-unlock whitelist
+ list/-l                  view all registered device ids and their quick-unlock whitelist status
+ add                      whitelist a device id for quick-unlock
+ del                      remove a device id from the quick-unlock whitelist
+.SH SETUP
+sshyp operates on a client-server model, and thus requires you to have access to your own server (whether it be a physical home server or a cloud rental) with remote access via SSH.
+
+The sshyp package includes modes for operating on both client and server devices, so only one package is necessary.
+
+Server setup:
+    Configure an OpenSSH server (if sshyp was installed from the Debian package, openssh-server and openssh-sftp-server must be installed manually - if sshyp was installed from the Fedora package, openssh-server must be installed manually)
+    Allow remote access to the SSH server w/public key authentication (disabling password-only authentication recommended)
+    Install sshyp
+    Run "sshyp tweak" and set the device type as server
+    Optionally, run "sshyp whitelist setup" and configure quick-unlock
+    Done!
+
+Client setup:
+    Install sshyp
+    Run "sshyp tweak" and follow the prompts
+    Copy the generated public SSH key (located at ~/.ssh/sshyp.pub) to the server using preferred method (manually adding to authorized_keys, ssh-copy-id, etc.)
+    If you already have entries on the server, sync them using "sshyp sync"
+    Optionally, 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
+.SH AUTHOR
+Randall Winkhart (https://github.com/rwinkhart)

lib/sshync.py

@@ -0,0 +1,170 @@
+#!/usr/bin/env python3
+from os import listdir, remove, walk
+from os.path import expanduser, isdir, getmtime, join
+from subprocess import CalledProcessError, PIPE, run
+from sys import exit as s_exit
+home = expanduser("~")
+
+
+# REMOTE
+
+def remote_list_gen(_client_device_name, _remote_dir):  # prints all necessary remote data to stdout
+    # 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')
+    get_local_data(_remote_dir, 'server')  # titles and mod times
+
+
+# HYBRID
+
+def delete(_file_path, _target_database):  # deletes a file or folder and/or marks it for deletion upon syncing
+    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:
+        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')
+
+
+def get_local_data(_directory, _device):  # retrieves and returns titles and mod times from the local 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
+
+def remote_list_fetch(_user_data):  # captures and returns all necessary data from the remote server
+    try:
+        _remote_data = run(['ssh', '-i', _user_data[5], '-p', _user_data[2], f"{_user_data[0]}@{_user_data[1]}",
+                            f'cd /lib/sshyp; python3 -c \'from sshync import remote_list_gen; remote_list_gen'
+                            f'("{_user_data[6]}", "{_user_data[4]}")\''], stdout=PIPE, text=True, check=True
+                           ).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:]
+
+
+def deletion_sync(_deletion_database, _silent):  # checks for and acts upon files and folders marked for deletion
+    for _file in _deletion_database:
+        if _file != '':
+            if not _silent:
+                print(f"\u001b[38;5;208m{_file}\u001b[0m has been sheared, removing...")
+            delete(_file, 'locally')
+
+
+def folder_sync(_folder_database):  # creates matches of remote folders on the local client
+    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)
+
+
+def sort_titles_mods(_list_1, _list_2):  # creates and returns two lists (of titles and mod times) generated by sorting
+    # information from two provided 2D lists
+    _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):  # creates a sshync job profile
+    open(_profile_dir, 'w').write(f"{_user}\n{_ip}\n{_port}\n{_local_dir}\n{_remote_dir}\n{_identity}\n")
+
+
+def get_profile(_profile_dir):  # returns a list of data read from a sshync job profile
+    try:
+        _profile_data = open(_profile_dir).readlines()
+    except (FileNotFoundError, IndexError):
+        print('\n\u001b[38;5;9merror: the profile does not exist or is corrupted\u001b[0m\n')
+        _profile_data = None
+        s_exit(2)
+    _user = _profile_data[0].rstrip()
+    _ip = _profile_data[1].rstrip()
+    _port = _profile_data[2].rstrip()
+    _local_dir = _profile_data[3].rstrip()
+    _remote_dir = _profile_data[4].rstrip()
+    _identity = _profile_data[5].rstrip()
+    _client_device_id = listdir(f"{home}/.config/sshyp/devices")[0].rstrip()
+    return _user, _ip, _port, _local_dir, _remote_dir, _identity, _client_device_id
+
+
+def run_profile(_profile_dir, _silent):  # runs a sshync job profile
+    _user_data = get_profile(_profile_dir)  # import profile data
+    # 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 = -1
+    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]):
+                print(f"\u001b[38;5;4m{_title[:-4]}\u001b[0m is newer locally, uploading...")
+                run(['scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5], _user_data[3] + _title,
+                     f"{_user_data[0]}@{_user_data[1]}:{_user_data[4]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
+            elif int(_index_local[1][_i]) < int(_index_remote[1][_i]):
+                print(f"\u001b[38;5;2m{_title[:-4]}\u001b[0m is newer remotely, downloading...")
+                run(['scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5],
+                     f"{_user_data[0]}@{_user_data[1]}:{_user_data[4]}{_title}",
+                     f"{_user_data[3]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
+        else:
+            print(f"\u001b[38;5;4m{_title[:-4]}\u001b[0m is not on remote server, uploading...")
+            run(['scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5], _user_data[3] + _title,
+                 f"{_user_data[0]}@{_user_data[1]}:{_user_data[4]}{'/'.join(_title.split('/')[:-1]) + '/'}"])
+    for _title in _index_remote[0]:
+        if _title not in _index_local[0]:
+            print(f"\u001b[38;5;2m{_title[:-4]}\u001b[0m is not in local directory, downloading...")
+            run(['scp', '-pqs', '-P', _user_data[2], '-i', _user_data[5],
+                 f"{_user_data[0]}@{_user_data[1]}:{_user_data[4]}{_title}",
+                 f"{_user_data[3]}{'/'.join(_title.split('/')[:-1]) + '/'}"])

lib/sshyp.py

@@ -0,0 +1,861 @@
+#!/usr/bin/env python3
+from os import chmod, environ, listdir, remove, uname, walk
+from os.path import exists, expanduser, isdir, isfile, realpath
+from pathlib import Path
+from random import randint
+from shutil import get_terminal_size, move, rmtree
+from sshync import delete as offline_delete, run_profile, make_profile, get_profile
+from subprocess import CalledProcessError, DEVNULL, PIPE, run
+from sys import argv, exit as s_exit
+home = expanduser("~")
+
+
+# UTILITY FUNCTIONS
+
+def entry_list_gen(_directory=f"{home}/.local/share/sshyp/"):  # generates and prints full entry list
+    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
+
+
+def entry_reader(_decrypted_entry):  # displays the contents of an entry in a readable format
+    _entry_lines, _notes_flag = open(_decrypted_entry, 'r').readlines(), 0
+    print()
+    for _num in range(len(_entry_lines)):
+        try:
+            if _num == 0 and _entry_lines[1] != '\n':
+                print(f"\u001b[38;5;15;48;5;238musername:\u001b[0m\n{_entry_lines[1].strip()}\n")
+            elif _num == 1 and _entry_lines[0] != '\n':
+                print(f"\u001b[38;5;15;48;5;238mpassword:\u001b[0m\n{_entry_lines[0].strip()}\n")
+            elif _num == 2 and _entry_lines[2] != '\n':
+                print(f"\u001b[38;5;15;48;5;238murl:\u001b[0m\n{_entry_lines[_num].strip()}\n")
+            elif _num >= 3 and _entry_lines[_num] != '\n' and _notes_flag != 1:
+                _notes_flag = 1
+                print(f"\u001b[38;5;15;48;5;238mnotes:\u001b[0m\n{_entry_lines[_num].strip()}")
+            elif _num >= 3 and _notes_flag == 1:
+                print(_entry_lines[_num].replace('\n', ''))
+            if _notes_flag == 1:
+                try:
+                    _line_test = _entry_lines[_num + 1]
+                except IndexError:
+                    print()
+        except IndexError:
+            if _num == 0:
+                print(f"\u001b[38;5;15;48;5;238mpassword:\u001b[0m\n{_entry_lines[0]}\n")
+
+
+def string_gen(_complexity, _length):  # generates and returns a random string based on input
+    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
+
+
+def pass_gen():  # prompts the user for necessary information to generate a password and passes it to string_gen
+    _length = 9
+    while True:
+        try:
+            _length = int(input('password length: '))
+        except ValueError:
+            continue
+        else:
+            if _length < 1:
+                continue
+            else:
+                break
+    _complexity = str(input('password 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
+
+
+def shm_gen(_tmp_dir=f"{home}/.config/sshyp/tmp/"):  # creates a temporary directory for entry editing
+    _shm_folder_gen = string_gen('f', randint(12, 48))
+    _shm_entry_gen = string_gen('f', randint(12, 48))
+    Path(_tmp_dir + _shm_folder_gen).mkdir(mode=0o700)
+    return _shm_folder_gen, _shm_entry_gen
+
+
+def encrypt(_entry_dir, _shm_folder, _shm_entry, _gpg_id, _tmp_dir=f"{home}/.config/sshyp/tmp/"):
+    # encrypts an entry and cleans up the temporary files
+    run(['gpg', '-qr', str(_gpg_id), '-e', f"{_tmp_dir}{_shm_folder}/{_shm_entry}"])
+    move(f"{_tmp_dir}{_shm_folder}/{_shm_entry}.gpg", f"{_entry_dir}.gpg")
+    rmtree(f"{_tmp_dir}{_shm_folder}")
+
+
+def decrypt(_entry_dir, _shm_folder, _shm_entry, _quick_pass,
+            _tmp_dir=f"{home}/.config/sshyp/tmp/"):  # decrypts an entry to a temporary directory
+    if not isinstance(_quick_pass, bool):
+        _unlock_method = ['gpg', '--pinentry-mode', 'loopback', '--passphrase', _quick_pass, '-qd', '--output']
+    else:
+        _unlock_method = ['gpg', '-qd', '--output']
+    if _shm_folder is None and _shm_entry is None:
+        _output_target = ['/dev/null', f"{home}/.config/sshyp/lock.gpg"]
+    else:
+        _output_target = [f"{_tmp_dir}{_shm_folder}/{_shm_entry}", f"{_entry_dir}.gpg"]
+    try:
+        run(_unlock_method + _output_target, stderr=DEVNULL, check=True)
+    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:
+                run(['gpg', '-qd', '--output'] + _output_target, stderr=DEVNULL, check=True)
+            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)
+
+
+def determine_decrypt(_entry_dir, _shm_folder, _shm_entry):  # call decrypt() based on quick-unlock status
+    if quick_unlock_enabled == 'y':
+        decrypt(_entry_dir, _shm_folder, _shm_entry, whitelist_verify(port, username_ssh, ip, client_device_id))
+    else:
+        decrypt(_entry_dir, _shm_folder, _shm_entry, False)
+
+
+def optimized_edit(_lines, _edit_data, _edit_line):  # ensures an edited entry is optimized for best compatibility
+    while len(_lines) < _edit_line + 1:
+        _lines.append('\n')
+    if _edit_data is not None:
+        _lines[_edit_line] = _edit_data.strip('\n').rstrip() + '\n'
+    for _num in range(len(_lines)):
+        if not _lines[_num].endswith('\n'):
+            _lines[_num] += '\n'
+    for _num in reversed(range(len(_lines))):
+        if _lines[_num] == '\n':
+            _lines = _lines[:-1]
+        elif _lines[_num].endswith('\n'):
+            _lines[_num] = _lines[_num].rstrip()
+            break
+        else:
+            break
+    return _lines
+
+
+def edit_note(_shm_folder, _shm_entry, _lines):  # edits the note attached to an entry
+    _reg_lines = _lines[0:3]
+    open(f"{tmp_dir}{_shm_folder}/{_shm_entry}-n", 'w').writelines(_lines[3:])
+    run([editor, f"{tmp_dir}{_shm_folder}/{_shm_entry}-n"])
+    _new_notes = open(f"{tmp_dir}{_shm_folder}/{_shm_entry}-n").readlines()
+    while len(_reg_lines) < 3:
+        _reg_lines.append('\n')
+    _noted_lines = _reg_lines + _new_notes
+    return _noted_lines
+
+
+def copy_id_check(_port, _username_ssh, _ip, _client_device_id):
+    # attempts to connect to the user's server via ssh to register the device for syncing
+    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')
+        open(f"{home}/.config/sshyp/ssh-error", 'w').write('1')
+        return True
+    open(f"{home}/.config/sshyp/ssh-error", 'w').write('0')
+    return False
+
+
+# ARGUMENT-SPECIFIC FUNCTIONS
+
+def tweak():  # runs configuration wizard
+    from os import symlink
+    _divider = f"\n{'=' * (get_terminal_size()[0] - int((.5 * get_terminal_size()[0])))}\n\n"
+
+    # config directory creation
+    Path(f"{home}/.config/sshyp/devices").mkdir(mode=0o700, parents=True, exist_ok=True)
+    if not exists(f"{home}/.config/sshyp/tmp"):
+        if uname()[0] in ('Haiku', 'FreeBSD'):
+            symlink('/tmp', f"{home}/.config/sshyp/tmp")
+        elif exists('/data/data/com.termux'):
+            symlink('/data/data/com.termux/files/usr/tmp', f"{home}/.config/sshyp/tmp")
+        else:
+            symlink('/dev/shm', f"{home}/.config/sshyp/tmp")
+
+    # device type configuration
+    _device_type = input('\nclient or server installation? (C/s) ')
+    if _device_type.lower() == 's':
+        _sshyp_data = ['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)
+        print(f"\n\u001b[4;1mmake sure the ssh service is running and properly configured\u001b[0m")
+    else:
+        _sshyp_data = ['client']
+        Path(f"{home}/.local/share/sshyp").mkdir(mode=0o700, parents=True, exist_ok=True)
+
+        # gpg configuration
+        _gpg_gen = input(f"{_divider}sshyp requires the use of a unique gpg key - use an (e)xisting key or (g)enerate a"
+                         f" new one? (E/g) ")
+        if _gpg_gen.lower() != 'g':
+            run(['gpg', '-k'])
+            _sshyp_data.append(str(input('gpg key id: ')))
+        else:
+            print('\na unique gpg key is being generated for you...')
+            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: https://github.com/rwinkhart/sshyp\n', 'Expire-Date: 0'])
+            run(['gpg', '--batch', '--generate-key', f"{home}/.config/sshyp/gpg-gen"])
+            remove(f"{home}/.config/sshyp/gpg-gen")
+            _sshyp_data.append(run(['gpg', '-k'], stdout=PIPE, text=True).stdout.splitlines()[-3].strip())
+
+        # text editor configuration
+        _sshyp_data.append(input(f"{_divider}example input: vim\n\npreferred text editor: "))
+
+        # 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', str(_sshyp_data[1]), '-e', f"{home}/.config/sshyp/lock"])
+        remove(f"{home}/.config/sshyp/lock")
+
+        # ssh key configuration
+        _offline_mode = False
+        _ssh_gen = (input(f"{_divider}make sure the ssh service on the remote server is running and properly "
+                          f"configured\n\nsync support requires a unique ssh key - would you like to have this "
+                          f"automatically generated? (Y/n/o(ffline)) "))
+        if _ssh_gen.lower() not in ('n', 'o', 'offline'):
+            Path(f"{home}/.ssh").mkdir(mode=0o700, exist_ok=True)
+            run(['ssh-keygen', '-t', 'ed25519', '-f', f"{home}/.ssh/sshyp"])
+        elif _ssh_gen.lower() == 'n':
+            print(f"\n\u001b[4;1mensure that the key file you are using is located at {home}/.ssh/sshyp\u001b[0m")
+        elif _ssh_gen.lower() in ('o', 'offline'):
+            _offline_mode = True
+            print('\nsshyp has been set to offline mode - to enable syncing, run "sshyp tweak" again')
+
+        if not _offline_mode:
+            # ssh ip+port configuration
+            _iport = str(input(f"{_divider}example inputs:\n\n ipv4: 10.10.10.10:22\n ipv6: [2000:2000:2000:2000:"
+                               f"2000:2000:2000:2000]:22\n domain: mydomain.com:22\n\nip and ssh port of sshyp server: "
+                               )).lstrip('[').replace(']', '').rsplit(':', 1)
+
+            # ssh user configuration
+            _username_ssh = str(input('\nusername of the remote server: '))
+
+            # sshync profile generation
+            make_profile(f"{home}/.config/sshyp/sshyp.sshync",
+                         f"{home}/.local/share/sshyp/", f"/home/{_username_ssh}/.local/share/sshyp/",
+                         f"{home}/.ssh/sshyp", _iport[0], _iport[1], _username_ssh)
+
+            # device id configuration
+            for _id in listdir(f"{home}/.config/sshyp/devices"):  # remove existing device id
+                remove(f"{home}/.config/sshyp/devices/{_id}")
+            print(f"{_divider}\u001b[4;1mimportant:\u001b[0m this id \u001b[4;1mmust\u001b[0m be unique amongst your "
+                  f"client devices\n\nthis is used to keep track of database syncing and quick-unlock permissions\n")
+            _device_id_prefix = str(input('device id: ')) + '-'
+            _device_id_suffix = string_gen('f', randint(24, 48))
+            _device_id = _device_id_prefix + _device_id_suffix
+            open(f"{home}/.config/sshyp/devices/{_device_id}", 'w')
+
+            # quick-unlock configuration
+            print(f"{_divider}this allows you to use a shorter version of your gpg key password and\n"
+                  f"requires a constant connection to your sshyp server to authenticate")
+            _sshyp_data.append(input('\nenable quick-unlock? (y/N) ').lower())
+            if _sshyp_data[3] == 'y':
+                print(f"\nquick-unlock has been enabled client-side - in order for this device to be able to read "
+                      f"entries,\nyou must first login to the sshyp server and run:\n\nsshyp whitelist setup "
+                      f"(if not already done)\nsshyp whitelist add '{_device_id}'")
+
+            # test server connection and attempt to register device id
+            copy_id_check(_iport[1], _username_ssh, _iport[0], _device_id)
+
+        elif isfile(f"{home}/.config/sshyp/sshyp.sshync"):
+            remove(f"{home}/.config/sshyp/sshyp.sshync")
+
+    # write main config file (sshyp-data)
+    with open(f"{home}/.config/sshyp/sshyp-data", 'w') as _config_file:
+        _lines = 0
+        for _item in _sshyp_data:
+            _lines += 1
+            _config_file.write(_item + '\n')
+        while _lines < 4:
+            _lines += 1
+            _config_file.write('n')
+    print(f"{_divider}configuration complete\n")
+
+
+def print_info():  # prints help text based on argument
+    if arguments[0] in ('version', '-v'):
+        print('\nsshyp is a simple, self-hosted, sftp-synchronized\npassword manager for unix(-like) systems\n')
+        print("                ..       \u001b[38;5;9m♥♥ ♥♥\u001b[0m       ..\n         .''.''/()\\     \u001b[38;5;13m"
+              "♥♥♥♥♥♥♥\u001b[0m     /()\\''.''.\n        *       :        \u001b[38;5;9m♥♥♥♥♥\u001b[0m        :       *"
+              "\n         `..'..'          \u001b[38;5;13m♥♥♥\u001b[0m          `..'..'\n         //   \\\\           "
+              "\u001b[38;5;9m♥\u001b[0m           //   \\\\")
+        print('\u001b[38;5;7;48;5;8m<><><><><><><><><><><><><><><><><><><><><><><><><><><><>\u001b[0m')
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                                                      '
+              '\u001b[38;5;7;48;5;8m/\u001b[0m')
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m   \u001b[38;5;15;48;5;8msshyp  copyright (c) 2021-2023  '
+              'randall winkhart\u001b[38;5;15;48;5;15m   \u001b[38;5;7;48;5;8m/\u001b[0m')
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                                                      '
+              '\u001b[38;5;7;48;5;8m/\u001b[0m')
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                    \u001b[38;5;15;48;5;8mversion 1.4.1'
+              '\u001b[38;5;15;48;5;15m                     \u001b[38;5;7;48;5;8m/\u001b[0m')
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m         \u001b[38;5;15;48;5;8mthe argumentative '
+              'agronomist update\u001b[38;5;15;48;5;15m          \u001b[38;5;7;48;5;8m/\u001b[0m')
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                                                      '
+              '\u001b[38;5;7;48;5;8m/\u001b[0m')
+        print('\u001b[38;5;7;48;5;8m<><><><><><><><><><><><><><><><><><><><><><><><><><><><>\u001b[0m\n')
+        print('see 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('\n\u001b[1musage:\u001b[0m sshyp </entry name> add <flag>\u001b[0m\n')
+        print('\u001b[1mflags:\u001b[0m')
+        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')
+    elif arguments[0] == 'edit' and device_type == 'client':
+        print('\n\u001b[1musage:\u001b[0m sshyp </entry name> edit <flag>\u001b[0m\n')
+        print('\u001b[1mflags:\u001b[0m')
+        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')
+    elif arguments[0] == 'copy' and device_type == 'client':
+        print('\n\u001b[1musage:\u001b[0m sshyp </entry name> copy <flag>\u001b[0m\n')
+        print('\u001b[1mflags:\u001b[0m')
+        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')
+    elif arguments[0] == 'whitelist':
+        if device_type == 'server':
+            print('\n\u001b[1musage:\u001b[0m sshyp whitelist <flag> [device id]\u001b[0m\n')
+            print('\u001b[1mflags:\u001b[0m')
+            print('whitelist:')
+            print(' setup                   set up the quick-unlock whitelist')
+            print(' list/-l                 view all registered device ids and their quick-unlock whitelist status')
+            print(' add                     whitelist a device id for quick-unlock')
+            print(' delete/del              remove a device id from the quick-unlock whitelist\n')
+        else:
+            print('\n\u001b[38;5;9merror: argument (whitelist) only available on server\u001b[0m\n')
+    else:
+        print('\n\u001b[1msshyp  copyright (c) 2021-2023  randall winkhart\u001b[0m\n')
+        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")
+        if device_type == 'client':
+            print('\n\u001b[1musage:\u001b[0m sshyp [</entry name> [option] [flag]] [option]\n')
+            print('\u001b[1moptions:\u001b[0m')
+            print('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                    delete an existing entry')
+            print('sync                     manually sync the entry directory via sshync')
+            print('\n\u001b[1mflags:\u001b[0m')
+            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(' url/-l                  change the url attached to an entry')
+            print(' note/-n                 change the note 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')
+            print("\n\u001b[1mtip 1:\u001b[0m you can quickly read an entry with 'sshyp </entry name>'")
+            print("\u001b[1mtip 2:\u001b[0m type 'sshyp' to view a list of saved entries\n")
+        else:
+            print('\n\u001b[1musage:\u001b[0m sshyp <option> [flag] [<device id>]\n')
+            print('\u001b[1moptions:\u001b[0m')
+            print('help/-h                  bring up this menu')
+            print('version/-v               display sshyp version info')
+            print('tweak                    configure sshyp')
+            print('whitelist                manage the quick-unlock whitelist')
+            print('\n\u001b[1mflags:\u001b[0m')
+            print('whitelist:')
+            print(' setup                   set up the quick-unlock whitelist')
+            print(' list/-l                 view all registered device ids and their quick-unlock whitelist status')
+            print(' add                     whitelist a device id for quick-unlock')
+            print(' del                     remove a device id from the quick-unlock whitelist\n')
+
+
+def read_shortcut():  # shortcut to quickly read an entry
+    if not exists(f"{directory}{entry_name}.gpg"):
+        if not entry_name:
+            print(f"\n\u001b[38;5;9merror: missing entry name\u001b[0m\n")
+        elif isdir(f"{directory}{entry_name}"):
+            print(f"\n\u001b[38;5;9merror: entry ({arguments[0]}) is a directory\u001b[0m\n")
+        else:
+            print(f"\n\u001b[38;5;9merror: entry ({arguments[0]}) does not exist\u001b[0m\n")
+        s_exit(2)
+    _shm_folder, _shm_entry = shm_gen()
+    determine_decrypt(directory + entry_name, _shm_folder, _shm_entry)
+    entry_reader(f"{tmp_dir}{_shm_folder}/{_shm_entry}")
+    rmtree(f"{tmp_dir}{_shm_folder}")
+
+
+def sync():  # calls sshync to sync changes to the user's server
+    print('\nsyncing 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.sshync", silent_sync)
+
+
+def whitelist_setup():  # takes input from the user to set up quick-unlock password
+    _gpg_password_temp = str(input('\nfull gpg passphrase: '))
+    _half_length = int(len(_gpg_password_temp)/2)
+    try:
+        _short_password_length = int(input(f"\nquick unlock pin length (must be half the length of gpg password or "
+                                           f"less) ({_half_length}): "))
+        if _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: https://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'], stdout=PIPE, text=True).stdout.splitlines()[-3].strip()
+
+    # encrypt excluded with the assembly key
+    _shm_folder, _shm_entry = shm_gen()
+    open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'w').write(_quick_unlock_password_excluded)
+    encrypt(f"{home}/.config/sshyp/excluded", _shm_folder, _shm_entry, _gpg_id)
+    print(f"\nyour quick-unlock passphrase: {_quick_unlock_password}")
+
+
+def whitelist_verify(_port, _username_ssh, _ip, _client_device_id):
+    # checks the user's whitelist status and fetches the full gpg key password if possible
+    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 passphrase: ')
+                _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
+
+
+def whitelist_list():  # shows the quick-unlock whitelist status of device ids
+    _whitelisted_ids = listdir(f"{home}/.config/sshyp/whitelist")
+    _device_ids = listdir(f"{home}/.config/sshyp/devices")
+    print('\n\u001b[1mquick-unlock whitelisted device ids:\u001b[0m')
+    for _id in _whitelisted_ids:
+        print(_id)
+    print('\n\u001b[1mother registered device ids:\u001b[0m')
+    for _id in _device_ids:
+        if _id not in _whitelisted_ids:
+            print(_id)
+    print()
+
+
+def whitelist_manage():  # adds or removes quick-unlock whitelisted device ids
+    if arg_count == 2:
+        whitelist_list()
+        _device_id = input('device id: ')
+    else:
+        _device_id = arguments[2]
+
+    if arguments[1] == 'add':
+        if _device_id in listdir(f"{home}/.config/sshyp/devices"):
+            open(f"{home}/.config/sshyp/whitelist/{_device_id}", 'w').write('')
+            whitelist_list()
+        else:
+            print(f"\n\u001b[38;5;9merror: device id ({_device_id}) is not registered\u001b[0m\n")
+            s_exit(1)
+
+    elif isfile(f"{home}/.config/sshyp/whitelist/{_device_id}"):
+        remove(f"{home}/.config/sshyp/whitelist/{_device_id}")
+        whitelist_list()
+
+
+def add_entry():  # adds a new entry
+    _shm_folder, _shm_entry = None, None  # set to avoid PEP8 warnings
+    if isfile(f"{directory}{entry_name}.gpg"):
+        print(f"\n\u001b[38;5;9merror: entry (/{entry_name}) already exists\u001b[0m\n")
+        s_exit(3)
+    if arguments[2] in ('note', '-n'):  # note entry
+        _shm_folder, _shm_entry = shm_gen()
+        run([editor, f"{tmp_dir}{_shm_folder}/{_shm_entry}-n"])
+        _notes = open(f"{tmp_dir}{_shm_folder}/{_shm_entry}-n", 'r').read()
+        open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'w').writelines(optimized_edit(['', '', '', _notes], None, -1))
+    else:  # password entry
+        _username = str(input('username: '))
+        _password = str(input('password: '))
+        _url = str(input('url: '))
+        _add_note = input('add a note to this entry? (y/N) ')
+        _shm_folder, _shm_entry = shm_gen()
+        if _add_note.lower() == 'y':
+            run([editor, f"{tmp_dir}{_shm_folder}/{_shm_entry}-n"])
+            _notes = open(f"{tmp_dir}{_shm_folder}/{_shm_entry}-n", 'r').read()
+        else:
+            _notes = ''
+        open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'w')\
+            .writelines(optimized_edit([_password, _username, _url, _notes], None, -1))
+    print('\n\u001b[1mentry preview:\u001b[0m')
+    entry_reader(f"{tmp_dir}{_shm_folder}/{_shm_entry}")
+    encrypt(directory + entry_name, _shm_folder, _shm_entry, gpg_id)
+
+
+def add_folder():  # creates a new 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)\''])
+
+
+def rename():  # renames an entry or folder
+    from shutil import copy
+    _file = True
+    if not exists(f"{directory}{entry_name}.gpg") and not exists(f"{directory}{entry_name}"):
+        print(f"\n\u001b[38;5;9merror: (/{entry_name}) does not exist\u001b[0m\n")
+        s_exit(2)
+    elif not isfile(f"{directory}{entry_name}.gpg"):
+        _file = False
+    _new_name = str(input('new name: ')).strip('/')
+    if _file:  # if renaming a file
+        if isfile(f"{directory}{_new_name}.gpg"):  # check if the new file already exists
+            print(f"\n\u001b[38;5;9merror: (/{_new_name}) already exists\u001b[0m\n")
+            s_exit(3)
+        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 isdir(f"{directory}{_new_name}"):  # check if the new folder already exists
+            print(f"\n\u001b[38;5;9merror: (/{_new_name}/) already exists\u001b[0m\n")
+            s_exit(3)
+        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}{_new_name}")'
+                 f'.mkdir(mode=0o700, parents=True, exist_ok=True)\''])
+        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 /lib/sshyp; python3 -c \'from sshync import delete; delete("{entry_name}", "remotely")\''])
+
+
+def edit():  # edits the contents of an entry
+    _shm_folder, _shm_entry, _detail, _edit_line = None, None, None, None  # set to avoid PEP8 warnings
+    if not isfile(f"{directory}{entry_name}.gpg"):
+        print(f"\n\u001b[38;5;9merror: entry (/{entry_name}) does not exist\u001b[0m\n")
+        s_exit(2)
+    _shm_folder, _shm_entry = shm_gen()
+    determine_decrypt(directory + entry_name, _shm_folder, _shm_entry)
+    if arguments[2] in ('username', '-u'):
+        _detail, _edit_line = str(input('username: ')), 1
+    elif arguments[2] in ('password', '-p'):
+        _detail, _edit_line = str(input('password: ')), 0
+    elif arguments[2] in ('url', '-l'):
+        _detail, _edit_line = str(input('url: ')), 2
+    if arguments[2] in ('note', '-n'):
+        _edit_line = 2
+        _new_lines = optimized_edit(edit_note(_shm_folder, _shm_entry,
+                                              open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'r').readlines()), None, -1)
+    else:
+        _new_lines = optimized_edit(open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'r').readlines(), _detail, _edit_line)
+    open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'w').writelines(_new_lines)
+    remove(f"{directory}{entry_name}.gpg")
+    print('\n\u001b[1mentry preview:\u001b[0m')
+    entry_reader(f"{tmp_dir}{_shm_folder}/{_shm_entry}")
+    encrypt(directory + entry_name, _shm_folder, _shm_entry, gpg_id)
+
+
+def gen():  # generates a password for a new or an existing entry
+    _username, _url, _notes = None, None, None  # set to avoid PEP8 warnings
+    _shm_folder, _shm_entry = shm_gen()
+    if arg_count == 3 and arguments[2] in ('update', '-u'):  # gen update
+        if not isfile(f"{directory}{entry_name}.gpg"):
+            print(f"\n\u001b[38;5;9merror: entry (/{entry_name}) does not exist\u001b[0m\n")
+            s_exit(2)
+        determine_decrypt(directory + entry_name, _shm_folder, _shm_entry)
+        _new_lines = optimized_edit(open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'r').readlines(), pass_gen(), 0)
+        open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'w').writelines(_new_lines)
+        remove(f"{directory}{entry_name}.gpg")
+    elif isfile(f"{directory}{entry_name}.gpg"):  # gen
+        print(f"\n\u001b[38;5;9merror: entry (/{entry_name}) already exists\u001b[0m\n")
+        s_exit(3)
+    else:
+        _username = str(input('username: '))
+        _password = pass_gen()
+        _url = str(input('url: '))
+        _add_note = input('add a note to this entry? (y/N) ')
+        if _add_note.lower() == 'y':
+            run([editor, f"{tmp_dir}{_shm_folder}/{_shm_entry}-n"])
+            _notes = open(f"{tmp_dir}{_shm_folder}/{_shm_entry}-n", 'r').read()
+        else:
+            _notes = ''
+        open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'w')\
+            .writelines(optimized_edit([_password, _username, _url, _notes], None, -1))
+    print('\n\u001b[1mentry preview:\u001b[0m')
+    entry_reader(f"{tmp_dir}{_shm_folder}/{_shm_entry}")
+    encrypt(directory + entry_name, _shm_folder, _shm_entry, gpg_id)
+
+
+def copy_data():  # copies a specified field of an entry to the clipboard
+    from subprocess import Popen
+    if not isfile(f"{directory}{entry_name}.gpg"):
+        print(f"\n\u001b[38;5;9merror: entry (/{entry_name}) does not exist\u001b[0m\n")
+        s_exit(2)
+    _shm_folder, _shm_entry = shm_gen()
+    determine_decrypt(directory + entry_name, _shm_folder, _shm_entry)
+    _copy_line, _index = open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'r').readlines(), 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
+    if 'WAYLAND_DISPLAY' in environ:  # Wayland clipboard detection
+        run(['wl-copy', _copy_line[_index].rstrip()])
+        Popen('sleep 30; wl-copy -c', shell=True)
+    elif uname()[0] == 'Haiku':  # Haiku clipboard detection
+        run(['clipboard', '-c', _copy_line[_index].rstrip()])
+        Popen('sleep 30; clipboard -r', shell=True)
+    elif exists("/data/data/com.termux"):  # Termux (Android) clipboard detection
+        run(['termux-clipboard-set', _copy_line[_index].rstrip()])
+        Popen("sleep 30; termux-clipboard-set ''", shell=True)
+    else:  # X11 clipboard detection
+        run(['xclip', '-sel', 'c'], stdin=Popen(['echo', '-n', _copy_line[_index].rstrip()], stdout=PIPE).stdout)
+        Popen("sleep 30; echo -n '' | xclip -sel c", shell=True)
+    rmtree(f"{tmp_dir}{_shm_folder}")
+
+
+def remove_data():  # deletes an entry from the server and flags it for local deletion on sync
+    determine_decrypt(f"{home}/.config/sshyp/lock.gpg", None, None)
+    if not ssh_error:
+        run(['ssh', '-i', f"{home}/.ssh/sshyp", '-p', port, f"{username_ssh}@{ip}",
+             f'cd /lib/sshyp; python3 -c \'from sshync import delete; delete("{entry_name}", "remotely")\''])
+    else:
+        offline_delete(entry_name, 'locally')
+
+
+def extension_runner():  # checks extension config files for matches to argument, runs extensions
+    from configparser import ConfigParser
+    _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:
+        ssh_error, success_flag, sync_flag, silent_sync = False, False, False, False
+        arg_start, device_type = None, None  # set to avoid PEP8 warnings
+        # retrieve typed argument
+        arguments = argv[1:]
+        arg_count = len(arguments)
+
+        if arg_count < 1 or (arg_count > 0 and arguments[0] != 'tweak'):
+            if arg_count > 0 and arguments[0].startswith('/'):
+                arg_start = 1
+                entry_name = arguments[0].strip('/')
+            else:
+                arg_start = 0
+
+            # import saved userdata
+            tmp_dir = f"{home}/.config/sshyp/tmp/"
+            try:
+                sshyp_data = open(f"{home}/.config/sshyp/sshyp-data").readlines()
+                device_type = sshyp_data[0].rstrip()
+                if device_type == 'client':
+                    directory = f"{home}/.local/share/sshyp/"
+                    gpg_id = sshyp_data[1].rstrip()
+                    editor = sshyp_data[2].rstrip()
+                    quick_unlock_enabled = sshyp_data[3].rstrip()
+                    if isfile(f"{home}/.config/sshyp/sshyp.sshync"):
+                        ssh_info = get_profile(f"{home}/.config/sshyp/sshyp.sshync")
+                        username_ssh = ssh_info[0].rstrip()
+                        ip = ssh_info[1].rstrip()
+                        port = ssh_info[2].rstrip()
+                        directory_ssh = str(ssh_info[4].rstrip())
+                        client_device_id = listdir(f"{home}/.config/sshyp/devices")[0].rstrip()
+                        ssh_error = int(open(f"{home}/.config/sshyp/ssh-error").read().rstrip())
+                        if ssh_error == 1:
+                            ssh_error = copy_id_check(port, username_ssh, ip, client_device_id)
+                        else:
+                            ssh_error = False
+                    else:
+                        ssh_error = True
+            except (FileNotFoundError, IndexError):
+                print('\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')
+                print("not all necessary configuration files are present - please run 'sshyp tweak'")
+                print('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n')
+                s_exit(1)
+        else:
+            tweak()
+            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(f"\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, sync_flag = True, True
+                    remove_data()
+
+            elif arg_count == 1 and arg_start == 1:
+                success_flag = True
+                read_shortcut()
+
+        else:  # server arguments
+            if arg_count < 1:
+                arguments.append('help')
+                print_info()
+            elif arg_count > 1 and arguments[0] == 'whitelist':
+                if arguments[1] in ('list', '-l'):
+                    success_flag = True
+                    whitelist_list()
+                elif arguments[1] in ('add', 'del'):
+                    success_flag = True
+                    whitelist_manage()
+                elif arguments[1] == 'setup':
+                    success_flag = True
+                    whitelist_setup()
+
+        if arg_count > 0 and success_flag == 0 and arguments[0] != 'sync':
+            if device_type == 'client' and arguments[0] not in ('help', '-h', 'version', '-v', 'license'):
+                extension_runner()
+            else:
+                print_info()
+        elif (not ssh_error and sync_flag) or (arg_count > 0 and arguments[0] == 'sync'):
+            sync()
+
+    except KeyboardInterrupt:
+        print('\n')

package.sh

@@ -0,0 +1,338 @@
+#!/bin/sh
+
+version=$(sed -n '1{p;q}' share/doc/sshyp/changelog | cut -c8-)
+if [ -z "$2" ]; then
+    revision=1
+else
+    revision="$2"
+fi
+
+_create_generic() {
+    printf '\npackaging as generic...\n'
+    mkdir -p output/generictemp/usr/bin \
+         output/generictemp/usr/lib/sshyp/extensions \
+         output/generictemp/usr/share/man/man1 \
+         output/generictemp/usr/share/bash-completion/completions \
+         output/generictemp/usr/share/zsh/functions/Completion/Unix
+    cp -r lib/. output/generictemp/usr/lib/sshyp/
+    ln -s /usr/lib/sshyp/sshyp.py output/generictemp/usr/bin/sshyp
+    cp -r share output/generictemp/usr/
+    cp extra/completion.bash output/generictemp/usr/share/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/generictemp/usr/share/zsh/functions/Completion/Unix/_sshyp
+    cp extra/manpage output/generictemp/usr/share/man/man1/sshyp.1
+    gzip output/generictemp/usr/share/man/man1/sshyp.1
+    XZ_OPT=-e6 tar -C output/generictemp -cvJf output/GENERIC-sshyp-"$version".tar.xz usr/
+    rm -rf output/generictemp
+    sha512="$(sha512sum output/GENERIC-sshyp-"$version".tar.xz | awk '{print $1;}')"
+    printf '\ngeneric packaging complete\n\n'
+} &&
+
+_create_pkgbuild() {
+    local source='https://github.com/rwinkhart/sshyp/releases/download/v$pkgver/GENERIC-sshyp-$pkgver.tar.xz'
+    printf '\ngenerating PKGBUILD...\n'
+    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 xclip wl-clipboard)
+optdepends=('bash-completion: bash completion support')
+source=(\""$source"\")
+sha512sums=('"$sha512"')
+
+package() {
+    tar xf GENERIC-sshyp-"\"\$pkgver\"".tar.xz -C "\"\${pkgdir}\""
+}
+" > output/PKGBUILD
+    printf '\nPKGBUILD generated\n\n'
+} &&
+
+_create_apkbuild() {
+    local source='https://github.com/rwinkhart/sshyp/releases/download/v$pkgver/GENERIC-sshyp-$pkgver.tar.xz'
+    printf '\ngenerating APKBUILD...\n'
+    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 xclip wl-clipboard'
+source=\""$source"\"
+
+package() {
+    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\""
+}
+
+sha512sums=\"
+"$sha512'  'GENERIC-sshyp-\"\$pkgver\".tar.xz"
+\"
+" > 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
+version			"$version"-"$revision"
+architecture		any
+summary			\"A light-weight, self-hosted, synchronized password manager\"
+description		\"sshyp is the only password-store compatible CLI password manager available for Haiku - it is also available on Linux/Android (via Termux) so that you can sync your entries across all of your devices.\"
+packager		\"Randall Winkhart <idgr at tutanota dot com>\"
+vendor			\"Randall Winkhart\"
+licenses {
+	\"GNU GPL v3\"
+}
+copyrights {
+	\"2021-2023 Randall Winkhart\"
+}
+provides {
+	sshyp = "$version"
+	cmd:sshyp
+}
+requires {
+	gnupg
+	openssh
+	python310
+}
+urls {
+	\"https://github.com/rwinkhart/sshyp\"
+}
+" > output/haikutemp/.PackageInfo
+    cp -r lib/. output/haikutemp/lib/sshyp/
+    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshync.py
+    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshyp.py
+    ln -s /system/lib/sshyp/sshyp.py output/haikutemp/bin/sshyp
+    cp -r share/doc/sshyp/. output/haikutemp/documentation/packages/sshyp/
+    cp -r share/licenses/sshyp/. output/haikutemp/documentation/packages/sshyp/
+    cp extra/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-"$version"-"$revision"_all.hpkg
+    package add HAIKU-sshyp-"$version"-"$revision"_all.hpkg bin lib documentation data
+    cd ../..
+    mv output/haikutemp/HAIKU-sshyp-"$version"-"$revision"_all.hpkg output/
+    rm -rf output/haikutemp
+    printf '\nHaiku packaging complete\n\n'
+} &&
+
+_create_deb() {
+    printf '\npackaging for Debian/Ubuntu...\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
+    printf "Package: sshyp
+Version: $version
+Section: utils
+Architecture: all
+Maintainer: Randall Winkhart <idgr at tutanota dot com>
+Description: A light-weight, self-hosted, synchronized password manager
+Depends: python3, gnupg, openssh-client, xclip, wl-clipboard
+Suggests: bash-completion
+Priority: optional
+Installed-Size: 14584
+" > output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
+    cp -r lib/. output/debiantemp/sshyp_"$version"-"$revision"_all/usr/lib/sshyp/
+    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
+    dpkg-deb --build --root-owner-group output/debiantemp/sshyp_"$version"-"$revision"_all/
+    mv output/debiantemp/sshyp_"$version"-"$revision"_all.deb output/DEBIAN-sshyp_"$version"-"$revision"_all.deb
+    rm -rf output/debiantemp
+    printf '\nDebian/Ubuntu packaging complete\n\n'
+} &&
+
+_create_termux() {
+    printf '\npackaging for Termux...\n'
+    mkdir -p output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/DEBIAN \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/lib/sshyp/extensions \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/bin \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1 \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/bash-completion/completions \
+         output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/zsh/functions/Completion/Unix
+    printf "Package: sshyp
+Version: $version
+Section: utils
+Architecture: all
+Maintainer: Randall Winkhart <idgr at tutanota dot com>
+Description: A light-weight, self-hosted, synchronized password manager
+Depends: python, gnupg, openssh, termux-api, termux-am
+Suggests: bash-completion
+Priority: optional
+Installed-Size: 14584
+" > output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/DEBIAN/control
+    cp -r lib/. output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/lib/sshyp/
+    ln -s /data/data/com.termux/files/usr/lib/sshyp/sshyp.py output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/bin/sshyp
+    cp -r share output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/
+    cp extra/completion.bash output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/bash-completion/completions/sshyp
+    cp extra/completion.zsh output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/zsh/functions/Completion/Unix/_sshyp
+    cp extra/manpage output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
+    gzip output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
+    dpkg-deb --build --root-owner-group output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/
+    mv output/termuxtemp/sshyp_"$version"-"$revision"_all_termux.deb output/TERMUX-sshyp_"$version"-"$revision"_all_termux.deb
+    rm -rf output/termuxtemp
+    printf '\nTermux packaging complete\n\n'
+} &&
+
+_create_rpm() {
+    printf '\npackaging for Fedora...\n'
+    rm -rf ~/rpmbuild
+    rpmdev-setuptree
+    cp output/GENERIC-sshyp-"$version".tar.xz ~/rpmbuild/SOURCES
+    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-sshyp-"$version".tar.xz
+Requires:       python gnupg openssh-clients wl-clipboard
+Recommends:     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-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/share/bash-completion/completions/sshyp
+/usr/share/zsh/functions/Completion/Unix/_sshyp
+%license /usr/share/licenses/sshyp/license
+%doc
+/usr/share/doc/sshyp/changelog
+/usr/share/man/man1/sshyp.1.gz
+" > ~/rpmbuild/SPECS/sshyp.spec
+rpmbuild -bb ~/rpmbuild/SPECS/sshyp.spec
+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\" : {
+                   \"python\" : {
+                      \"origin\" : \"lang/python\"
+                   },
+                   \"gnupg\" : {
+                      \"origin\" : \"security/gnupg\"
+                   },
+                   \"xclip\" : {
+                      \"origin\" : \"x11/xclip\"
+                   },
+                   \"wl-clipboard\" : {
+                      \"origin\" : \"x11/wl-clipboard\"
+                   },
+                },
+" > output/freebsdtemp/+MANIFEST
+printf "/usr/bin/sshyp
+/usr/lib/sshyp/sshync.py
+/usr/lib/sshyp/sshyp.py
+/usr/local/share/bash-completion/completions/sshyp
+/usr/local/share/zsh/site-functions/_sshyp
+/usr/share/doc/sshyp/changelog
+/usr/share/licenses/sshyp/license
+/usr/share/man/man1/sshyp.1.gz
+" > output/freebsdtemp/plist
+cp -r lib/. output/freebsdtemp/usr/lib/sshyp/
+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
+    generic)
+        _create_generic
+        ;;
+    pkgbuild)
+        _create_generic
+        _create_pkgbuild
+        ;;
+    apkbuild)
+        _create_generic
+        _create_apkbuild
+        ;;
+    haiku)
+        _create_hpkg
+        ;;
+    debian)
+        _create_deb
+        ;;
+    termux)
+        _create_termux
+        ;;
+    fedora)
+        _create_generic
+        _create_rpm
+        ;;
+    freebsd)
+        _create_freebsd_pkg
+        ;;
+    buildable-arch)
+        _create_generic
+        _create_pkgbuild
+        _create_apkbuild
+        case "$(pacman -Q dpkg)" in
+            dpkg*)
+            _create_deb
+            _create_termux
+            ;;
+        esac
+        case "$(pacman -Q freebsd-pkg)" in
+            freebsd-pkg*)
+            _create_freebsd_pkg
+            ;;
+        esac
+        ;;
+    *)
+    printf '\nusage: package.sh [target] <revision>\n\ntargets:\n mainline: pkgbuild apkbuild haiku fedora debian\n experimental: freebsd termux\n other: buildable-arch\n\n'
+    ;;
+esac

share/doc/sshyp/changelog

@@ -0,0 +1,24 @@
+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
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+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 @@
-    rpass is a FOSS password manager that takes advantage of rsync
+    sshyp is a FOSS password manager that uses an sftp-based syncing back-end.
-    Copyright (C) 2021  Randall Winkhart  idgr@tutanota.com
+    Copyright (C) 2021-2023  Randall Winkhart  idgr@tutanota.com
 
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
+    it under the terms of version 3 (only) of the GNU General Public License
-    the Free Software Foundation, either version 3 of the License, or
+    as published by the Free Software Foundation.
-    (at your option) any later version.
 
     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/>.

usr/bin/rpass

@@ -1,605 +0,0 @@
-#!/usr/bin/python
-
-# rpass 2021.09.07.pr3.1
-# rpass is the gnu pass alternative for those who don't want to use git
-# rpass is freely licensed for modification and redistribution under the GNU General Public License V3
-
-from os import system
-from os import remove
-from os import environ
-from shutil import move
-from shutil import rmtree
-from sys import argv
-import random
-import string
-
-
-def clear():
-    print("\n" * 100)
-
-
-def term(cmd):
-    _ = system(cmd)
-
-
-def replace_line(file_name, line_num, text):
-    lines = open(file_name, 'r').readlines()
-    lines[line_num] = text
-    out = open(file_name, 'w')
-    out.writelines(lines)
-    out.close()
-
-
-def encrypt():
-    term('gpg -r ' + str(gpgid) + ' -e ' + "'" + '/dev/shm/' + shmfolder + '/' + shmentry + "'")
-    move('/dev/shm/' + shmfolder + '/' + shmentry + '.gpg', directory + entryname.replace('/', '', 1) + '.gpg')
-    rmtree('/dev/shm/' + shmfolder)
-
-
-def encryptfolder():
-    term('gpg -r ' + str(gpgid) + ' -e ' + "'" + '/dev/shm/' + shmfolder + '/' + shmentry + "'")
-    move('/dev/shm/' + shmfolder + '/' + shmentry + '.gpg', directory + folder + '/' + folderentry + '.gpg')
-    rmtree('/dev/shm/' + shmfolder)
-
-
-def rsyncup():
-    term(rsyncupp + ' ' + directory + ' ' + usernamessh + '@' + ip + ':' + directoryssh)
-
-
-def rsyncdown():
-    term(rsyncdownn + ' ' + usernamessh + '@' + ip + ':' + directoryssh + ' ' + directory)
-
-
-# argument - filter the argument to usable text - some replacements are only done once to prevent interference
-
-argument = str(argv).replace('[', '', 1).replace(']', '', 1).replace(',', '').replace("'", '') \
-    .replace(' ', '', 1).replace('/usr/bin/', '', 1).replace('rpass', '', 1)
-
-# startup help
-
-if argument == '':
-    clear()
-    print("use 'help', '--help', or '-h' to see a list of commands")
-    print()
-    print('<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>')
-    print("If you are receiving errors, run 'rpass config' and go through the guided setup wizard.")
-    print('This MUST be done before rpass will function!!')
-    print('<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>')
-    print()
-    print('rpass is currently early software with very little polish')
-    print()
-
-# help
-
-if argument == 'help' or argument == '--help' or argument == '-h':
-    print()
-    print('rpass  Copyright (C) 2021  Randall Winkhart')
-    print("This program comes with ABSOLUTELY NO WARRANTY; for details type `rpass show w'. This is free software, "
-          "and you are welcome to redistribute it under certain conditions; type `rpass show c' for details.")
-    print()
-    print('USAGE: rpass [/<entry name>] [OPTION] [FLAG]')
-    print()
-    print('Options: ')
-    print('help/--help/-h           bring up this menu')
-    print('config                   configure rpass')
-    print('add                      add an entry')
-    print('gen                      generate a new password')
-    print('edit                     edit an existing entry')
-    print('remove/-rm               delete an existing entry')
-    print('sync/-s                  manually sync the entry directory via rsync')
-    print()
-    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('gen:')
-    print(' update/-u               generate a password for an existing entry')
-    print()
-    print("Tip: You can quickly read an entry with 'rpass /<entry name>'!")
-    print("When specifying entry names, do not include the file extension! '.gpg' is assumed!")
-    print()
-
-# licensing info
-
-if argument == 'show w':
-    clear()
-    print('This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;')
-    print('without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.')
-    print('See the GNU General Public License for more details.')
-    print()
-    print('https://opensource.org/licenses/GPL-3.0')
-    print()
-
-if argument == 'show c':
-    clear()
-    print('This program is free software: you can redistribute it and/or modify it under the terms of the GNU General')
-    print('Public License as published by the Free Software Foundation, either version 3 of the License,')
-    print('or (at your option) any later version.')
-    print()
-
-# config
-
-if argument == 'config':
-    print()
-    directorychoice = str(input('Would you like to use the default entry directory (~/.rpass-store/)? (Y/n) '))
-    if directorychoice != 'n':
-        with open("/var/lib/rpass/rpassdir", 'w') as f:
-            f.write('/home/' + environ.get('USER') + '/.rpass-store/' + '\n')
-    if directorychoice == 'n':
-        print()
-        print('Format: /this/path/ends/with/a/slash/')
-        print()
-        directory = str(input('Please input a custom directory: '))
-        with open("/var/lib/rpass/rpassdir", 'w') as f:
-            f.write(directory + '\n')
-    print()
-    gpgpresent = str(input('rpass requires the use of a unique gpg key. Do you already have one you are willing to '
-                           'use? (y/N) '))
-    if gpgpresent == 'y' or gpgpresent == 'Y':
-        print()
-        gpgid = str(input('Please input the ID of your gpg key: '))
-        with open("/var/lib/rpass/rpassgpg", 'w') as f:
-            f.write(gpgid + '\n')
-    if gpgpresent != 'y':
-        print()
-        gpggen = str(input('Would you like to generate one now? Note that if you choose not to do this, you will have '
-                           'to re-run "rpass config" to specify a gpg key when you acquire one (Y/n) '))
-        if gpggen != 'n':
-            term('gpg --full-generate-key')
-            print()
-            gpgid = str(input('Please input the ID of your gpg key: '))
-            with open("/var/lib/rpass/rpassgpg", 'w') as f:
-                f.write(gpgid + '\n')
-        if gpggen == 'n' or gpggen == 'N':
-            exit()
-    print()
-    syncsetup = str(input('Would you like to configure rsync over ssh for entry backup and syncing? (Y/n) '))
-    if syncsetup != 'n':
-        print()
-        sshgen = str(input('rsync support requires a unique ssh key. Would you like to have this '
-                           'automatically generated? (Y/n) '))
-        if sshgen != 'n':
-            term('ssh-keygen -f ~/.ssh/rpass')
-        print()
-        print('The server device(s) should be configured first.')
-        print()
-        devicetype = str(input('Will this be a client or a server device? (c/S) '))
-        if devicetype != 'c':
-            print()
-            print('Make sure the ssh service is running and that the proper port is forwarded.')
-        if devicetype == 'c':
-            print()
-            print('Make sure the ssh service is running and that the proper port is forwarded on the remote server.')
-            print('Example input: 10.10.10.10:9999')
-            print()
-            ip_port = str(input('What is the IP and ssh port of the remote server? '))
-            print()
-            usernamessh = str(input('What is the username of the remote server? '))
-            ip, sep, port = ip_port.partition(':')
-            with open("/var/lib/rpass/rpassuserssh", 'w') as f:
-                f.write(usernamessh + '\n')
-            with open("/var/lib/rpass/rpassrsyncup", 'w') as f:
-                f.write('rsync -v -H -r -l -t -p -e ' + '"ssh -i ~/.ssh/rpass -p ' + port + '" ' + '\n')
-            with open("/var/lib/rpass/rpassrsyncdown", 'w') as f:
-                f.write('rsync -v -H -r -l -t -p --delete -e ' + '"ssh -i ~/.ssh/rpass -p ' + port + '" ' + '\n')
-            with open("/var/lib/rpass/rpassip", 'w') as f:
-                f.write(ip + '\n')
-            print()
-            print('Default directory: ' + '/home/' + usernamessh + '/.rpass-store/')
-            print()
-            directoryssh = str(input('Is the remote server using the default password directory? (Y/n) '))
-            if directoryssh != 'n':
-                directoryssh = ('/home/' + usernamessh + '/.rpass-store/')
-            if directoryssh == 'n' or directoryssh == 'N':
-                print()
-                print('Format: /this/path/ends/with/a/slash/')
-                print()
-                directoryssh = str(input('What directory is the server using?: '))
-            with open("/var/lib/rpass/rpassdirssh", 'w') as f:
-                f.write(directoryssh + '\n')
-
-# import userdata
-
-with open("/var/lib/rpass/rpassgpg") as f:
-    gpgid = f.read().strip()
-with open("/var/lib/rpass/rpassdir") as f:
-    directory = f.read().strip()
-term('mkdir -p ' + directory)
-with open("/var/lib/rpass/rpassdirssh") as f:
-    directoryssh = f.read().strip()
-with open("/var/lib/rpass/rpassrsyncup") as f:
-    rsyncupp = f.read().strip()
-with open("/var/lib/rpass/rpassrsyncdown") as f:
-    rsyncdownn = f.read().strip()
-with open("/var/lib/rpass/rpassip") as f:
-    ip = f.read().strip()
-with open("/var/lib/rpass/rpassuserssh") as f:
-    usernamessh = f.read().strip()
-
-if argument == '':
-    print()
-    term('cd ~/.rpass-store; ls -1 *')
-    print()
-    readentry = str(input('Entry to read: '))
-    clear()
-    term('gpg -d ' + directory + "'" + readentry.replace('/', '', 1) + "'" + '.gpg')
-    print()
-
-# read shortcut
-
-if argument.startswith('/'):
-    if argument.replace('/', '', 1).__contains__('/'):
-        folder, sep, folderentry = argument.replace('/', '', 1).partition('/')
-        term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-    else:
-        term('gpg -d ' + directory + "'" + argument.replace('/', '', 1) + '.gpg' + "'")
-
-# add
-
-if argument == 'add':
-    print()
-    print('USAGE: rpass 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')
-    print()
-
-if argument == 'add note' or argument == 'add -n':
-    clear()
-    entryname = str(input('Name of note: '))
-    notes = str(input('Contents of note: '))
-    # generate random strings for /dev/shm
-    shmfolder = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                        for _ in range(random.randint(10, 30)))
-    shmentry = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                       for _ in range(random.randint(10, 30)))
-    term('mkdir -p /dev/shm/' + shmfolder)
-    # end string and folder generation
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-                f.writelines('\n\n\n' + notes + '\n\n')
-            encryptfolder()
-            term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-        else:
-            with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-                f.writelines('\n\n\n' + notes + '\n\n')
-            encrypt()
-            term('gpg -d ' + directory + "'" + entryname.replace('/', '', 1) + '.gpg' + "'")
-    else:
-        with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-            f.writelines('\n\n\n' + notes + '\n\n')
-        encrypt()
-        term('gpg -d ' + directory + "'" + entryname + '.gpg' + "'")
-
-if argument == 'add password' or argument == 'add -p':
-    clear()
-    entryname = str(input('Name of service: '))
-    username = str(input('Username: '))
-    password = str(input('Password: '))
-    url = str(input('URL: '))
-    notes = str(input('Additional notes: '))
-    # generate random strings for /dev/shm
-    shmfolder = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                        for _ in range(random.randint(10, 30)))
-    shmentry = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                       for _ in range(random.randint(10, 30)))
-    term('mkdir -p /dev/shm/' + shmfolder)
-    # end string and folder generation
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-                f.writelines(username + '\n' + password + '\n' + url + '\n' + notes + '\n\n')
-            encryptfolder()
-            term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-        else:
-            with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-                f.writelines(username + '\n' + password + '\n' + url + '\n' + notes + '\n\n')
-            encrypt()
-            term('gpg -d ' + directory + "'" + entryname.replace('/', '', 1) + '.gpg' + "'")
-    else:
-        with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-            f.writelines(username + '\n' + password + '\n' + url + '\n' + notes + '\n\n')
-        encrypt()
-        term('gpg -d ' + directory + "'" + entryname + '.gpg' + "'")
-
-if argument == 'add folder' or argument == 'add -f':
-    newfolder = str(input('Name of new folder: '))
-    term('mkdir ' + "'" + directory + newfolder + "'")
-
-# edit
-
-if argument == 'edit':
-    print()
-    print('USAGE: rpass 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(' note/-n                 change the note attached to an entry')
-    print(' url/-l                  change the url attached to an entry')
-    print()
-
-if argument == 'edit rename' or argument == 'edit relocate' or argument == 'edit -r':
-    clear()
-    term('cd ~/.rpass-store; ls -1 *')
-    print()
-    entryname = str(input('What file would you like to edit? '))
-    newname = str(input('New Name: '))
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            move(directory + folder + '/' + folderentry + '.gpg', directory + '/' + newname + '.gpg')
-        else:
-            move(directory + entryname.replace('/', '', 1) + '.gpg', directory + newname.replace('/', '', 1) + '.gpg')
-    else:
-        move(directory + entryname + '.gpg', directory + newname + '.gpg')
-
-if argument == 'edit username' or argument == 'edit -u':
-    clear()
-    term('cd ~/.rpass-store; ls -1 *')
-    print()
-    entryname = str(input('What file would you like to edit? '))
-    username = str(input('New Username: '))
-    # generate random strings for /dev/shm
-    shmfolder = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                        for _ in range(random.randint(10, 30)))
-    shmentry = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                       for _ in range(random.randint(10, 30)))
-    term('mkdir -p /dev/shm/' + shmfolder)
-    # end string and folder generation
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 folder + '/' + folderentry + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 0, username + '\n')
-            remove(directory + folder + '/' + folderentry + '.gpg')
-            encryptfolder()
-            term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-        else:
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 entryname.replace('/', '', 1) + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 0, username + '\n')
-            remove(directory + entryname.replace('/', '', 1) + '.gpg')
-            encrypt()
-            term('gpg -d ' + directory + "'" + entryname.replace('/', '', 1) + '.gpg' + "'")
-    else:
-        term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory + entryname + '.gpg')
-        replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 0, username + '\n')
-        remove(directory + entryname + '.gpg')
-        encrypt()
-        term('gpg -d ' + directory + "'" + entryname + '.gpg' + "'")
-
-if argument == 'edit password' or argument == 'edit -p':
-    clear()
-    term('cd ~/.rpass-store; ls -1 *')
-    print()
-    entryname = str(input('What file would you like to edit? '))
-    password = str(input('New Password: '))
-    # generate random strings for /dev/shm
-    shmfolder = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                        for _ in range(random.randint(10, 30)))
-    shmentry = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                       for _ in range(random.randint(10, 30)))
-    term('mkdir -p /dev/shm/' + shmfolder)
-    # end string and folder generation
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 folder + '/' + folderentry + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 1, password + '\n')
-            remove(directory + folder + '/' + folderentry + '.gpg')
-            encryptfolder()
-            term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-        else:
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 entryname.replace('/', '', 1) + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 1, password + '\n')
-            remove(directory + entryname.replace('/', '', 1) + '.gpg')
-            encrypt()
-            term('gpg -d ' + directory + "'" + entryname.replace('/', '', 1) + '.gpg' + "'")
-    else:
-        term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory + entryname + '.gpg')
-        replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 1, password + '\n')
-        remove(directory + entryname + '.gpg')
-        encrypt()
-        term('gpg -d ' + directory + "'" + entryname + '.gpg' + "'")
-
-if argument == 'edit url' or argument == 'edit -l':
-    clear()
-    term('cd ~/.rpass-store; ls -1 *')
-    print()
-    entryname = str(input('What file would you like to edit? '))
-    url = str(input('New URL: '))
-    # generate random strings for /dev/shm
-    shmfolder = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                        for _ in range(random.randint(10, 30)))
-    shmentry = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                       for _ in range(random.randint(10, 30)))
-    term('mkdir -p /dev/shm/' + shmfolder)
-    # end string and folder generation
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 folder + '/' + folderentry + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 2, url + '\n')
-            remove(directory + folder + '/' + folderentry + '.gpg')
-            encryptfolder()
-            term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-        else:
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 entryname.replace('/', '', 1) + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 2, url + '\n')
-            remove(directory + entryname.replace('/', '', 1) + '.gpg')
-            encrypt()
-            term('gpg -d ' + directory + "'" + entryname.replace('/', '', 1) + '.gpg' + "'")
-    else:
-        term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory + entryname + '.gpg')
-        replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 2, url + '\n')
-        remove(directory + entryname + '.gpg')
-        encrypt()
-        term('gpg -d ' + directory + "'" + entryname + '.gpg' + "'")
-
-if argument == 'edit note' or argument == 'edit -n':
-    clear()
-    term('cd ~/.rpass-store; ls -1 *')
-    print()
-    entryname = str(input('What file would you like to edit? '))
-    notes = str(input('New Note: '))
-    # generate random strings for /dev/shm
-    shmfolder = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                        for _ in range(random.randint(10, 30)))
-    shmentry = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                       for _ in range(random.randint(10, 30)))
-    term('mkdir -p /dev/shm/' + shmfolder)
-    # end string and folder generation
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 folder + '/' + folderentry + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 3, notes + '\n')
-            remove(directory + folder + '/' + folderentry + '.gpg')
-            encryptfolder()
-            term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-        else:
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 entryname.replace('/', '', 1) + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 3, notes + '\n')
-            remove(directory + entryname.replace('/', '', 1) + '.gpg')
-            encrypt()
-            term('gpg -d ' + directory + "'" + entryname.replace('/', '', 1) + '.gpg' + "'")
-    else:
-        term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory + entryname + '.gpg')
-        replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 3, notes + '\n')
-        remove(directory + entryname + '.gpg')
-        encrypt()
-        term('gpg -d ' + directory + "'" + entryname + '.gpg' + "'")
-
-# gen
-
-if argument == 'gen':
-    clear()
-    entryname = str(input('Name of service: '))
-    username = str(input('Username: '))
-    passlength = int(input('How many characters should be in the password? '))
-    passtype = str(input('Should the password be simple (for compatibility) or complex (for security)? (s/C) '))
-    if passtype != 's':
-        passtype = string.ascii_letters + string.digits + string.punctuation
-    if passtype == 's':
-        passtype = string.ascii_letters + string.digits
-    passgen = ''.join(random.SystemRandom().choice(passtype) for _ in range(passlength))
-    url = str(input('URL: '))
-    notes = str(input('Additional notes: '))
-    # generate random strings for /dev/shm
-    shmfolder = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                        for _ in range(random.randint(10, 30)))
-    shmentry = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                       for _ in range(random.randint(10, 30)))
-    term('mkdir -p /dev/shm/' + shmfolder)
-    # end string and folder generation
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-                f.writelines(username + '\n' + passgen + '\n' + url + '\n' + notes + '\n\n')
-            encryptfolder()
-            term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-        else:
-            with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-                f.writelines(username + '\n' + passgen + '\n' + url + '\n' + notes + '\n\n')
-            encrypt()
-            term('gpg -d ' + directory + "'" + entryname.replace('/', '', 1) + '.gpg' + "'")
-    else:
-        with open('/dev/shm/' + shmfolder + '/' + shmentry, 'w') as f:
-            f.writelines(username + '\n' + passgen + '\n' + url + '\n' + notes + '\n\n')
-        encrypt()
-        term('gpg -d ' + directory + "'" + entryname + '.gpg' + "'")
-
-if argument == 'gen update' or argument == 'gen -u':
-    clear()
-    term('cd ~/.rpass-store; ls -1 *')
-    print()
-    entryname = str(input('Which password would you like to re-generate? '))
-    passlength = int(input('How many characters should be in the password? '))
-    passtype = str(input('Should the password be simple (for compatibility) or complex (for security)? (s/C) '))
-    # generate random strings for /dev/shm
-    shmfolder = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                        for _ in range(random.randint(10, 30)))
-    shmentry = ''.join(random.SystemRandom().choice(string.ascii_letters + string.digits)
-                       for _ in range(random.randint(10, 30)))
-    term('mkdir -p /dev/shm/' + shmfolder)
-    # end string and folder generation
-    if passtype != 's':
-        passtype = string.ascii_letters + string.digits + string.punctuation
-    if passtype == 's':
-        passtype = string.ascii_letters + string.digits
-    passgen = ''.join(random.SystemRandom().choice(passtype) for _ in range(passlength))
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            folder, sep, folderentry = entryname.replace('/', '', 1).partition('/')
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 folder + '/' + folderentry + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 1, passgen + '\n')
-            remove(directory + folder + '/' + folderentry.replace('/', '', 1) + '.gpg')
-            encryptfolder()
-            term('gpg -d ' + directory + folder + '/' + "'" + folderentry + '.gpg' + "'")
-        else:
-            term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory +
-                 entryname.replace('/', '', 1) + '.gpg')
-            replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 1, passgen + '\n')
-            remove(directory + entryname.replace('/', '', 1) + '.gpg')
-            encrypt()
-            term('gpg -d ' + directory + "'" + entryname.replace('/', '', 1) + '.gpg' + "'")
-    else:
-        term('gpg --output /dev/shm/' + shmfolder + '/' + shmentry + ' ' + directory + entryname + '.gpg')
-        replace_line('/dev/shm/' + shmfolder + '/' + shmentry, 1, passgen + '\n')
-        remove(directory + entryname + '.gpg')
-        encrypt()
-        term('gpg -d ' + directory + "'" + entryname + '.gpg' + "'")
-
-# remove
-
-if argument == 'remove' or argument == '-rm':
-    clear()
-    term('cd ~/.rpass-store; ls -1 *')
-    print()
-    entryname = str(input('What would you like to delete? '))
-    if entryname.startswith('/'):
-        if entryname.replace('/', '', 1).__contains__('/'):
-            remove(directory + entryname.replace('/', '', 1) + '.gpg')
-        else:
-            rmtree(directory + entryname.replace('/', '', 1))
-    else:
-        remove(directory + entryname + '.gpg')
-
-# permissions - applied pre-sync to ensure permissions are correct before upload
-
-term('find ' + directory + ' -type d -exec chmod -R 700 {} +')
-term('find ' + directory + ' -type f -exec chmod -R 600 {} +')
-
-# rsync - ran at end of program to ensure all files are properly synced
-
-if argument.__contains__('add') or argument.__contains__('-rm') or argument.__contains__('remove') or argument. \
-        __contains__('edit') or argument.__contains__('gen') or argument == 'sync' or argument == '-s':
-    rsyncup()
-    rsyncdown()
-    print()
-    print('Please note that as of this time, entries can only be deleted if removed from the central server in a '
-          'client-server scenario. This will be adjusted soon.')
-    print()

usr/share/doc/rpass/changelog

@@ -1,165 +0,0 @@
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass-2021.09.08.pr4
-
-The Housekeeping Update - Fourth public release of rpass
-
-This release focuses primarily on polishing rpass and tying up loose ends before
-making any major changes in the future.
-
-New features:
-
-**overhaul error message using exceptions
-**add exceptions for unknown arguments
-**make clean, colorful file list by exporting to document and removing extensions
-**make a manpage
-**multi-line notes?
-
-Changes:
-
-**move project to github
-**change gpg prompt to get rid of expiration date
-**get rid of gpg decryption warnings
-**optimize code (specifically for when there is no folder but there is a slash)
-**add version info argument
-**update rsync config wizard
-**properly comment the code
-**validate for Python 3.10
-
-Planned for next update (The Secret Update):
-
-- allow to function as alternative to gnome keyring (libsecret integration)
-
-Planned, no timeline:
-
-- create separate gui frontend targetting mobile devices (first linux phones, maybe android at a later date - official iOS client not likely)
-    ^ the gui will also function on desktop linux
-- make platform agnostic (add windows support and package for more Linux distributions)
-- ability to pass entries as arguments for more functions
-- auto-completion on tab (currently unsure of best way to make this work)
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.07.pr3.1
-
-The Sync and Foundations Update - Hotfix
-
-Changes:
-
-- gpg configuration now prompts for expiration, rather than defaulting to two years
-- rsync is now configured to not delete anything from any remote device when uploading
-    ^ this behavior may be modified in the future - this is a quick fix to prevent data loss
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.07.pr3
-
-The Sync and Foundations Update - Third public release of rpass.
-
-As of this version, rpass has its intended base set of features and is considered usable.
-It will now primarily recieve bug fixes and polish updates to prepare it to go
-cross-platform and to make it compatible with GUI frontends.
-
-New features:
-
-- rsync support!
-- new entry format with URL field (for future use)
-- the temporary directory (/dev/shm) for editing entries has been somewhat secured
-
-Changes:
-
-- 'rpass edit relocate' is now properly bound
-- dropped the use of 'echo'
-- added 'rsync' and 'openssh' as dependencies
-- fixed a bug with deleting entries from folders
-- entry directory now has more secure permissions
-        ^ these permissions are re-enforced every time rpass is used
-- fixed some small typos and potential bugs, made some small optimizations
-
-Planned for next update (The Housekeeping Update):
-
-- move to github
-- get rid of gpg decryption warnings
-- proper error messages using 'except'
-- add exceptions for unknown arguments
-- cleanup file list by exporting to document and removing .gpg, adding color
-- add a manpage
-- allow notes to be multiple lines long (break lines after so many characters)
-- validate for Python 3.10
-- properly comment the code
-
-Planned, no timeline:
-
-- allow to function as alternative to gnome keyring (libsecret integration)
-- create separate gui frontend targetting mobile devices (first linux phones, maybe android at a later date - official iOS client not likely)
-    ^ the gui will also function on desktop linux
-- make platform agnostic (add windows support and package for more Linux distributions)
-- ability to pass entries as arguments for more functions
-- auto-completion on tab (currently unsure of best way to make this work)
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.02.pr2
-
-The Folder Update - Second public release of rpass.
-
-New features:
-
-- entry and folder titles can now have spaces and be as long as you want
-- entires and folders can now be deleted with 'rpass remove' or 'rpass -rm'
-- entries now properly save to folders via 'rpass add' and should no longer throw errors
-- entries saved in folders are now readable
-- existing entries can now be moved to, from, and between folders
-- previews are now shown after creating or editing an entry
-
-Changes:
-
-- every pre-existing function of rpass has been updated to work with the new folder system
-- dropped awk as a dependency
-- removed 'argument' file in /var/lib/rpass
-- reduced unneccessary characters in argument parsing to decrease compatibility issues
-- ensured all user input is handled correctly as a string or an integer
-- lots of miscellaneous optimizations
-
-Expected for next update (The rsync Update):
-
-- rsync (over ssh) support!
-    ^ including any fixes, changes, or optimizations necessary to make that happen
-- new file formatting with support for URLs
-    ^all entries created in new format should be compatible with future versions of rpass
-- secure /dev/shm with random text generator
-
-Expected for the next (next) update (The Housekeeping Update)
-
-- get rid of gpg decryption warnings
-- proper error messages using 'except'
-- add exceptions for unknown arguments
-- cleanup file list by exporting to document and removing .gpg, adding color
-
-Planned, no timeline:
-
-- make platform agnostic (basically, add windows support)
-- create separate gui frontend targetting mobile devices (first linux phones, android at a later date)
-    ^ the gui will also function on desktop linux
-- ability to pass entries as arguments for more functions
-- auto-completion on tab
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
-
-rpass 2021.09.01.pr1.1
-
-First public release of rpass.
-
-Early build, missing critical features (e.g. sync support and the ability to have spaces in filenames).
-
-What is currently functional:
-
-- guided configuration wizard
-- generate passwords
-- add existing passwords
-- make notes
-- sort notes and passwords into folders
-- gpg encryption
-- edit password/note entries
-
-<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>