Removed '~' from generated filename character pool to avoid issues with quick-unlock

Former-commit-id: bcb77c5030c48693bcd0a479f7576e6ddc4d6729 [formerly 109141a266]
Former-commit-id: b7bd4134b3bee5760aaa56064a1ad9b29957fa1c

README.md

@@ -2,6 +2,8 @@
 
 [![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.
@@ -24,15 +26,11 @@ 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
+- 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)
+- utilize [extensions](https://github.com/rwinkhart/sshyp-labs) to interact with your entries is additional ways (such as generating TOTP keys or managing your entries in a GUI)
 - everything above with entries created by pass/password-store!
 - everything above on Haiku, FreeBSD, Linux, and Termux (an Android terminal emulator)!
 
-What sshyp will likely do:
-
-- (planned v1.2.0) everything it already does, but also in a GUI for Linux/Haiku
-
 What sshyp definitely won't do:
 
 - Non-UNIX(-like) support, e.g. Windows (I'd be happy to link to third-party ports, if someone were to make them)
@@ -40,12 +38,14 @@ What sshyp definitely won't do:
 # Installation
 Please see the [installation guide](https://github.com/rwinkhart/sshyp/wiki/Installation) in the sshyp wiki for directions specific to your distribution/OS.
 
-Pre-built packages exist for Haiku, FreeBSD, Arch Linux, Debian/Ubuntu Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
+Pre-built packages exist for Haiku, FreeBSD, Alpine Linux, Arch Linux, Debian/Ubuntu Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
 
 Requests for additional distribution/OS support can be filed as issues.
 
 Extensions are available in the [sshyp-labs](https://github.com/rwinkhart/sshyp-labs) repository.
 
+Bash completions can be enabled by installing your distribution's "bash-completion" package and restarting your terminal.
+
 # Building
 Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation.
 
@@ -54,7 +54,7 @@ A packaging script is included in the root directory of the repo in order to pac
 ```
 git clone https://github.com/rwinkhart/sshyp.git
 cd sshyp
-./package.sh
+./package.sh [target] <revision>
 ```
 
 The packaging script has been tested on Arch Linux with "dpkg" as a dependency for Debian/Ubuntu and Termux packaging and "freebsd-pkg" as a dependency for FreeBSD packaging.
@@ -63,7 +63,7 @@ Haiku and Fedora packaging must be done on their own respective distributions.
 
 The AUR version and the packages attatched to the release tags were already packaged using this script.
 
-Currently, the script can create packages for Haiku, FreeBSD, Arch Linux (PKGBUILD), Debian/Ubuntu Linux, Fedora Linux, Termux, and generic.
+Currently, the script can create packages for Haiku, FreeBSD, Alpine Linux (APKBUILD), Arch Linux (PKGBUILD), Debian/Ubuntu Linux, Fedora Linux, Termux, and generic.
 
 # Usage
 Upon initial installation (on both the server and client devices), be sure to run:
@@ -91,8 +91,9 @@ man sshyp
 # Roadmap
 Short-term Goals:
 
-- create minimal GUI app (Linux x86_64, Linux aarch64)
+- create minimal GUI app (Linux x86_64, Linux aarch64) - being done as an [extension](https://github.com/rwinkhart/sshyp-labs)
-- various optimizations/bug fixes
+- significant optimizations
+- vaious bug fixes
 
 Long-term Goals:
 

extra/changelog-total

@@ -1,3 +1,79 @@
+sshyp v1.2.0
+
+the brisk bahh update
+
+this release focuses on speeding up the sshyp user experience by adding
+new features that reduce wasted time
+
+compatibility-breaking changes:
+
+- new configuration options (quick-unlock, offline mode) have been added and
+the configuration files have been reorganized
+    ^ simply running "sshyp tweak" and following the setup wizard will correct any compatibility
+    issues
+- for quick-unlock security, device names have been replaced with more secure device ids
+    ^ older device names are still compatible, but for security reasons it is recommended
+    to delete any pre-existing device names from the server and allow "sshyp tweak" to re-register
+    your devices
+
+user-facing features:
+
+- quick-unlock mode has been added
+    ^ this allows you to use a shortened version of your password by verifying that your device
+    is whitelisted on your sshyp server - it's both faster and more secure than standard unlock,
+    but it requires an active connection to your sshyp server to authenticate (otherwise it will
+    fall back to standard unlock)
+- full support for offline usage
+    ^ though sshyp could be used without a server before, it now can be configured to not attempt
+    to find one ever - this saves time and hides sync failure error messages
+- bash completions have been added
+    ^ if you have bash-completion installed, you can now use the tab key in bash to auto-complete
+    sshyp arguments and entry names (client only, not added for server-specific arguments)
+        ^ if you do not have bash-completion installed, you can source
+        /usr/share/bash-completion/completions/sshyp (Linux/BSD) or
+        /boot/system/data/bash-completion/completions/sshyp (Haiku) in your ~/.bashrc to
+        use this feature
+
+fixes/optimizations:
+
+- fixed entries with multi-word titles failing to decrypt
+- password generation is now much faster and more resource efficient
+- there is no longer a length limit on generated passwords
+- improved visual consistency of help menus
+- rarely used modules are now imported only when needed
+- sshyp now uses one fewer configuration file
+
+other notable changes:
+
+- sshyp is now specifically licensed under the GPL-3.0-only (keyword: only)
+- sshyp now has some possible arguments and its own help menu when running in server mode
+- temporary files in /dev/shm are now generated with more complex names
+- sshyp now installs in /usr/lib/sshyp (Linux/BSD) or /system/lib/sshyp (Haiku) instead of
+/usr/bin or /bin (it is still symlinked to the old directories)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp v1.1.2
+
+the sheecrets update - patch two
+
+this is a general polish/bugfix release
+
+user-facing features:
+
+- packaging support for Alpine Linux/postmarketOS
+- the rename() function is no longer unnecessarily verbose
+- handled exception for when the user attempts to copy an entry field that does not exist
+
+fixes/optimizations:
+
+- replaced shebang with "#!/usr/bin/env python3" for improved compatibility with various systems
+    ^ does not affect Haiku packaging
+- fixed the generic package not actually being compressed
+- reduced lines of code used for cross-device entry deletion
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
 sshyp v1.1.1
 
 the sheecrets update - patch one

extra/manpage

@@ -1,11 +1,13 @@
-.TH sshyp 1 "21 July 2022" "v1.1.1" "sshyp man page"
+.TH sshyp 1 "06 November 2022" "v1.2.0" "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
-sshyp [OPTION] [[FLAG]] [/<entry name>]
+Client Usage: sshyp [option [flag] [<entry name>]] | [/<entry name>]
+
+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
+.SH EXAMPLES (CLIENT)
 Setting up sshyp for the first time or altering its configuration (also recommended after major updates):
     sshyp tweak
 
@@ -32,10 +34,19 @@ Manually syncing entries with the server:
 
 Removing an existing folder saved as ~/.local/share/sshyp/social:
     sshyp shear social/
+.SH EXAMPLES (SERVER)
+Setting up the quick-unlock whitelist:
+    sshyp whitelist setup
 
-.SH OPTIONS
+Checking the quick-unlock whitelist status of all registered client devices:
-USAGE: sshyp [OPTION [FLAG] [<entry name>]] | [/<entry name>]
+    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/--help/-h           bring up the help menu
  version/-v               display sshyp version info
  tweak                    configure sshyp
@@ -45,24 +56,38 @@ USAGE: sshyp [OPTION [FLAG] [<entry name>]] | [/<entry name>]
  copy                     copy details of an entry to your clipboard
  shear/-rm                delete an existing entry
  sync/-s                  manually sync the entry directory via sshync
-.SH FLAGS
+.SH FLAGS (CLIENT)
 add:
- password/-p             add a password entry
+ password/-p              add a password entry
- note/-n                 add a note entry
+ note/-n                  add a note entry
- folder/-f               add a new folder for entries
+ folder/-f                add a new folder for entries
+
 edit:
- rename/relocate/-r      rename or relocate an entry
+ rename/relocate/-r       rename or relocate an entry
- username/-u             change the username of an entry
+ username/-u              change the username of an entry
- password/-p             change the password of an entry
+ password/-p              change the password of an entry
- note/-n                 change the note attached to an entry
+ note/-n                  change the note attached to an entry
- url/-l                  change the url 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
+ username/-u              copy the username of an entry to your clipboard
- password/-p             copy the password 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
+ url/-l                   copy the URL of an entry to your clipboard
- note/-n                 copy the note 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
+ update/-u                generate a password for an existing entry
+.SH OPTIONS (SERVER)
+ help/--help/-h           bring up this menu
+ version/-v               display sshyp version info
+ tweak                    configure sshyp
+ whitelist                manage the quick-unlock whitelist
+.SH FLAGS (SERVER)
+whitelist:
+ setup                    set up the quick-unlock whitelist
+ list/-l                  view all registered device ids and their quick-unlock whitelist status
+ add                      whitelist a device id for quick-unlock
+ delete/del               remove a device id from the quick-unlock whitelist
 .SH LIMITATIONS
 The following characters/character sequences are not supported in entry/folder titles:
 
@@ -73,10 +98,11 @@ sshyp operates on a client-server model, and thus requires you to have access to
 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, the ssh server was not installed as a dependency and needs to be installed manually)
+    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:
@@ -84,8 +110,23 @@ Client setup:
     Run "sshyp tweak" and follow the prompts
     Copy the generated public SSH key (located at ~/.ssh/sshyp.pub) to the server using preferred method (manually adding to authorized_keys, ssh-copy-id, etc.)
     If you already have entries on the server, sync them using "sshyp sync"
+    Optionally, Bash completions can be enabled by installing your distribution's "bash-completion" package and restarting your terminal
     Done!
 
 Please note that the server setup intentionally does not allow the reading of entries (it does not allow adding a gpg decryption key). For security purposes, only clients can read entries.
+.SH EXIT CODES
+0 - no error
+
+1 - argument error
+
+2 - configuration error
+
+3 - data not found error
+
+4 - data already exists error
+
+5 - decryption/encryption error
+
+6 - server data retrieval error
 .SH AUTHOR
 Randall Winkhart (https://github.com/rwinkhart)

extra/sshyp-completion.bash

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

lib/sshync.py

@@ -1,16 +1,16 @@
-#!/bin/python3
+#!/usr/bin/env python3
 
 # external modules
 
 from os import path, system, walk
 from os.path import expanduser, getmtime, join
-from pathlib import Path
 from sys import exit as s_exit
 
 
 # utility functions
 
 def get_titles_mods(_directory, _destination, _user_data):  # fetches and returns lists of titles and their mod times
+    from pathlib import Path
     _title_list, _mod_list = [], []
     Path(path.expanduser('~/.config/sshync')).mkdir(0o700, parents=True, exist_ok=True)  # create config directory
     # local fetching
@@ -27,8 +27,9 @@ def get_titles_mods(_directory, _destination, _user_data):  # fetches and return
             open(expanduser('~/.config/sshync/database'), 'a').write(str(_mod) + '\n')
     # remote fetching
     if _destination == 'r':
-        system(f"ssh -i '{_user_data[5]}' -p {_user_data[2]} {_user_data[0]}@{_user_data[1]} \"cd /bin; python -c 'impo"
+        system(f"ssh -i '{_user_data[5]}' -p {_user_data[2]} {_user_data[0]}@{_user_data[1]} \"cd /lib/sshyp; python -c"
-               f"rt sshync; sshync.get_titles_mods(\"'\"{_user_data[4]}\"'\", \"'\"l\"'\", \"'\"{_user_data}\"'\")'\"")
+               f" 'import sshync; sshync.get_titles_mods(\"'\"{_user_data[4]}\"'\", \"'\"l\"'\", \"'\"{_user_data}"
+               f"\"'\")'\"")
         system(f"scp -pqs -P {_user_data[2]} -i '{_user_data[5]}' {_user_data[0]}@{_user_data[1]}:"
                f"'/home/{_user_data[0]}/.config/sshync/database' '{expanduser('~/.config/sshync/')}'")
         _titles, _sep, _mods = '*&^'.join(open(expanduser('~/.config/sshync/database')).readlines()).replace('\n', '')\
@@ -54,8 +55,7 @@ def sort_titles_mods(_list_1, _list_2):  # creates and returns two lists (of tit
 
 
 def make_profile(_profile_dir, _local_dir, _remote_dir, _identity, _ip, _port, _user):  # creates a sshync job profile
-    open(_profile_dir, 'w').write(_user + '\n' + _ip + '\n' + _port + '\n' + _local_dir + '\n' + _remote_dir + '\n' +
+    open(_profile_dir, 'w').write(f"{_user}\n{_ip}\n{_port}\n{_local_dir}\n{_remote_dir}\n{_identity}\n")
-                                  _identity + '\n')
 
 
 def get_profile(_profile_dir):  # returns a list of data read from a sshync job profile
@@ -64,14 +64,14 @@ def get_profile(_profile_dir):  # returns a list of data read from a sshync job
     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(1)
+        s_exit(3)
     # extract data from profile
-    _user = _profile_data[0].replace('\n', '')
+    _user = _profile_data[0].rstrip()
-    _ip = _profile_data[1].replace('\n', '')
+    _ip = _profile_data[1].rstrip()
-    _port = _profile_data[2].replace('\n', '')
+    _port = _profile_data[2].rstrip()
-    _local_dir = _profile_data[3].replace('\n', '')
+    _local_dir = _profile_data[3].rstrip()
-    _remote_dir = _profile_data[4].replace('\n', '')
+    _remote_dir = _profile_data[4].rstrip()
-    _identity = _profile_data[5].replace('\n', '')
+    _identity = _profile_data[5].rstrip()
     return _user, _ip, _port, _local_dir, _remote_dir, _identity
 
 

lib/sshyp.py

@@ -1,4 +1,4 @@
-#!/bin/python3
+#!/usr/bin/env python3
 
 # external modules
 
@@ -7,15 +7,14 @@ from pathlib import Path
 from random import randint, SystemRandom
 from shutil import get_terminal_size, move, rmtree
 import sshync
-import string
 from subprocess import CalledProcessError, Popen, PIPE, run
 from sys import argv, exit as s_exit
-from textwrap import fill
 
 
 # BELOW - utility functions
 
 def entry_list_gen(_directory=path.expanduser('~/.local/share/sshyp/')):  # generates and prints full entry list
+    from textwrap import fill
     print('\n\u001b[38;5;0;48;5;15msshyp entries:\u001b[0m\n')
     _entry_list, _color_alternator = [], 1
     for _entry in sorted(listdir(_directory)):
@@ -99,43 +98,47 @@ def entry_name_fetch(_entry_name_location):  # fetches and returns entry name fr
         return _entry_name
 
 
-def shm_gen(_tmp_dir=path.expanduser('~/.config/sshyp/tmp/')):  # creates a temporary directory for entry editing
+def string_gen(_complexity, _length):  # generates and returns a random string based on input
-    _shm_folder_gen = ''.join(SystemRandom().choice(string.ascii_letters + string.digits)
+    import string
-                              for _ in range(randint(10, 30)))
+    if _complexity == 's':
-    _shm_entry_gen = ''.join(SystemRandom().choice(string.ascii_letters + string.digits)
+        _character_pool = string.ascii_letters + string.digits
-                             for _ in range(randint(10, 30)))
+    elif _complexity == 'f':
-    Path(_tmp_dir + _shm_folder_gen).mkdir(0o700)
+        _character_pool = string.digits + string.ascii_letters + string.punctuation.replace('/', '').replace('\\', '')\
-    return _shm_folder_gen, _shm_entry_gen
+            .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():  # generates and returns a random password based on user-specified options
+def pass_gen():  # prompts the user for necessary information to generate a password and passes it to string_gen
-    def _pass_gen_function(__complexity, __length):
-        if __complexity.lower() == 's':
-            __character_pool = string.ascii_letters + string.digits
-        else:
-            __character_pool = string.ascii_letters + string.digits + string.punctuation
-        __gen = ''.join(SystemRandom().choice(__character_pool) for _ in range(__length))
-        __min_special, __special = round(.2 * __length), 0
-        for __character in __gen:
-            if not __character.isalpha():
-                __special += 1
-        if __special < __min_special:
-            __gen = _pass_gen_function(__complexity, __length)
-        return __gen
     try:
         _length = int(input('password length: '))
     except ValueError:
         print(f"\n\u001b[38;5;9merror: a non-integer value was input for password length\u001b[0m\n")
         _gen = pass_gen()
         return _gen
-    if _length > 840:
-        _length = 840
-        print('\n\u001b[38;5;9mpassword length has been limited to the maximum of 840 characters\u001b[0m\n')
     _complexity = str(input('password complexity - simple (for compatibility) or complex (for security)? (s/C) '))
-    _gen = _pass_gen_function(_complexity, _length)
+    if _complexity != 's' and _complexity != 'S':
+        _complexity = 'c'
+    _gen = string_gen(_complexity.lower(), _length)
     return _gen
 
 
+def shm_gen(_tmp_dir=path.expanduser('~/.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(0o700)
+    return _shm_folder_gen, _shm_entry_gen
+
+
 def encrypt(_entry_dir, _shm_folder, _shm_entry, _gpg_com, _gpg_id, _tmp_dir=path.expanduser('~/.config/sshyp/tmp/')):
     # encrypts an entry and cleans up the temporary files
     system(f"{_gpg_com} -qr {str(_gpg_id)} -e '{_tmp_dir}{_shm_folder}/{_shm_entry}'")
@@ -143,17 +146,39 @@ def encrypt(_entry_dir, _shm_folder, _shm_entry, _gpg_com, _gpg_id, _tmp_dir=pat
     rmtree(f"{_tmp_dir}{_shm_folder}")
 
 
-def decrypt(_entry_dir, _shm_folder, _shm_entry, _gpg_command, _tmp_dir=path.expanduser('~/.config/sshyp/tmp/')):
+def decrypt(_entry_dir, _shm_folder, _shm_entry, _gpg_com, _quick_pass,
-    # decrypts an entry to a temporary directory
+            _tmp_dir=path.expanduser('~/.config/sshyp/tmp/')):  # decrypts an entry to a temporary directory
-    if _shm_folder == 0 and _shm_entry == 0:
+    if not isinstance(_quick_pass, bool):
-        _command = f"{_gpg_command} -qd --output /dev/null {path.expanduser('~/.config/sshyp/lock.gpg')}"
+        _unlock_method = f"gpg --pinentry-mode loopback --passphrase '{_quick_pass}' -qd --output "
     else:
-        _command = f"{_gpg_command} -qd --output {_tmp_dir}{_shm_folder}/{_shm_entry} {_entry_dir}.gpg"
+        _unlock_method = f"{_gpg_com} -qd --output "
+    if _shm_folder == 0 and _shm_entry == 0:
+        _output_target = f"/dev/null {path.expanduser('~/.config/sshyp/lock.gpg')}"
+    else:
+        _output_target = f"'{_tmp_dir}{_shm_folder}/{_shm_entry}' '{_entry_dir}.gpg'"
     try:
-        run(_command, shell=True, stderr=PIPE, check=True, close_fds=True)
+        run(_unlock_method + _output_target, shell=True, stderr=PIPE, check=True, close_fds=True)
     except CalledProcessError:
-        print(f"\n\u001b[38;5;9merror: could not decrypt - ensure the correct gpg key is present\u001b[0m\n")
+        if not isinstance(_quick_pass, bool):
-        s_exit(1)
+            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(f"{_gpg_com} -qd --output {_output_target}", shell=True, stderr=PIPE, check=True,
+                    close_fds=True)
+            except CalledProcessError:
+                print('\n\u001b[38;5;9merror: could not decrypt - ensure the correct gpg key is present\u001b[0m\n')
+                s_exit(5)
+        else:
+            print('\n\u001b[38;5;9merror: could not decrypt - ensure the correct gpg key is present\u001b[0m\n')
+            s_exit(5)
+
+
+def determine_decrypt(_entry_dir, _shm_folder, _shm_entry, _gpg_com):
+    if quick_unlock_enabled == 'y':
+        decrypt(_entry_dir, _shm_folder, _shm_entry, _gpg_com, whitelist_verify(port, username_ssh, ip,
+                                                                                client_device_id))
+    else:
+        decrypt(_entry_dir, _shm_folder, _shm_entry, _gpg_com, False)
 
 
 def optimized_edit(_lines, _edit_data, _edit_line):  # ensures an edited entry is optimized for best compatibility
@@ -178,7 +203,7 @@ def optimized_edit(_lines, _edit_data, _edit_line):  # ensures an edited entry i
 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:])
-    system(f"{editor} {tmp_dir}{_shm_folder}/{_shm_entry}-n")
+    system(f"{editor} '{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 += ['\n']
@@ -186,10 +211,10 @@ def edit_note(_shm_folder, _shm_entry, _lines):  # edits the note attached to an
     return _noted_lines
 
 
-def copy_name_check(_port, _username_ssh, _ip, _client_device_name):
+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
     _command = f"ssh -o ConnectTimeout=3 -i '{path.expanduser('~/.ssh/sshyp')}' -p {_port} {_username_ssh}@{_ip} " \
-               f"\"touch '/home/{_username_ssh}/.config/sshyp/devices/{_client_device_name}'\""
+               f"\"touch '/home/{_username_ssh}/.config/sshyp/devices/{_client_device_id}'\""
     try:
         run(_command, shell=True, stderr=PIPE, check=True, close_fds=True)
     except CalledProcessError:
@@ -206,8 +231,8 @@ def copy_name_check(_port, _username_ssh, _ip, _client_device_name):
 
 def tweak():  # runs configuration wizard
     _divider = f"\n{'=' * (get_terminal_size()[0] - int((.5 * get_terminal_size()[0])))}\n\n"
-    # storage/config directory creation
+
-    Path(path.expanduser('~/.local/share/sshyp')).mkdir(0o700, parents=True, exist_ok=True)
+    # config directory creation
     Path(path.expanduser('~/.config/sshyp/devices')).mkdir(0o700, parents=True, exist_ok=True)
     if not Path(f"{path.expanduser('~/.config/sshyp/tmp')}").exists():
         if uname()[0] == 'Haiku' or uname()[0] == 'FreeBSD':
@@ -216,25 +241,24 @@ def tweak():  # runs configuration wizard
             system(f"ln -s '/data/data/com.termux/files/usr/tmp' {path.expanduser('~/.config/sshyp/tmp')}")
         else:
             system(f"ln -s /dev/shm {path.expanduser('~/.config/sshyp/tmp')}")
+
     # device type configuration
     _device_type = input('\nclient or server installation? (C/s) ')
     if _device_type.lower() == 's':
-        open(path.expanduser('~/.config/sshyp/sshyp-device'), 'w').write(_device_type)
+        _sshyp_data = ['server']
-        Path(path.expanduser('~/.config/sshyp/deleted')).mkdir(0o700, parents=True, exist_ok=True)
+        Path(path.expanduser('~/.config/sshyp/deleted')).mkdir(0o700, exist_ok=True)
-        print(f"\n\u001b[4;1mmake sure the ssh service is running and properly configured\u001b[0m\n"
+        Path(path.expanduser('~/.config/sshyp/whitelist')).mkdir(0o700, exist_ok=True)
-              f"{_divider}configuration complete\n")
+        print(f"\n\u001b[4;1mmake sure the ssh service is running and properly configured\u001b[0m")
-        s_exit(0)
     else:
-        # device type configuration
+        _sshyp_data = ['client']
-        _device_type = 'c'  # ensure device type flag is properly set
+        Path(path.expanduser('~/.local/share/sshyp')).mkdir(0o700, parents=True, exist_ok=True)
-        open(path.expanduser('~/.config/sshyp/sshyp-device'), 'w').write(_device_type)
 
         # gpg configuration
-        _gpg_id = input(f"{_divider}sshyp requires the use of a unique gpg key - use an (e)xisting key or (g)enerate "
+        _gpg_gen = input(f"{_divider}sshyp requires the use of a unique gpg key - use an (e)xisting key or (g)enerate a"
-                        f"a new one? (E/g) ")
+                         f" new one? (E/g) ")
-        if _gpg_id.lower() != 'g':
+        if _gpg_gen.lower() != 'g':
             system(f"{gpg} -k")
-            _gpg_id = str(input('gpg key id: '))
+            _sshyp_data += [str(input('gpg key id: '))]
         else:
             print('\na unique gpg key is being generated for you...')
             if not Path(path.expanduser('~/.config/sshyp/gpg-gen')).is_file():
@@ -248,90 +272,133 @@ def tweak():  # runs configuration wizard
             else:
                 run(f"{gpg} --batch --generate-key '{path.expanduser('~/.config/sshyp/gpg-gen')}'", shell=True)
             remove(path.expanduser('~/.config/sshyp/gpg-gen'))
-            _gpg_id = run(f"{gpg} -k", shell=True, stdout=PIPE, text=True).stdout.split('\n')[-4].strip()
+            _sshyp_data += [run(f"{gpg} -k", shell=True, stdout=PIPE, text=True).stdout.split('\n')[-4].strip()]
+
+        # text editor configuration
+        _sshyp_data += [input(f"{_divider}example input: vim\n\npreferred text editor: ")]
 
         # lock file generation
         if Path(path.expanduser('~/.config/sshyp/lock.gpg')).is_file():
             remove(path.expanduser('~/.config/sshyp/lock.gpg'))
         open(path.expanduser('~/.config/sshyp/lock'), 'w')
-        system(f"{gpg} -qr {str(_gpg_id)} -e {path.expanduser('~/.config/sshyp/lock')}")
+        system(f"{gpg} -qr {str(_sshyp_data[1])} -e {path.expanduser('~/.config/sshyp/lock')}")
         remove(path.expanduser('~/.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) "))
+                          f"automatically generated? (Y/n/o(ffline)) "))
-        if _ssh_gen.lower() != 'n':
+        if _ssh_gen.lower() != 'n' and _ssh_gen.lower() != 'o' and _ssh_gen.lower() != 'offline':
             if uname()[0] == 'Haiku':
                 Path(f"{path.expanduser('~')}/.ssh").mkdir(0o700, exist_ok=True)
             system('ssh-keygen -t ed25519 -f ~/.ssh/sshyp')
-        else:
+        elif _ssh_gen.lower() == 'n':
             print(f"\n\u001b[4;1mensure that the key file you are using is located at "
                   f"{path.expanduser('~/.ssh/sshyp')}\u001b[0m")
+        elif _ssh_gen.lower() == 'o' or _ssh_gen.lower() == 'offline':
+            _offline_mode = True
+            print('\nsshyp has been set to offline mode - to enable syncing, run "sshyp tweak" again')
 
-        # ssh ip+port configuration
+        if not _offline_mode:
-        _ip_port = str(input(f"{_divider}example input: 10.10.10.10:9999\n\nip and ssh port of the remote server: "))
+            # ssh ip+port configuration
-        _ip, _sep, _port = _ip_port.partition(':')
+            _ip_port = str(input(f"{_divider}example input: 10.10.10.10:9999\n\nip and ssh port of sshyp server: "))
+            _ip, _sep, _port = _ip_port.partition(':')
 
-        # ssh user configuration
+            # ssh user configuration
-        _username_ssh = str(input('\nusername of the remote server: '))
+            _username_ssh = str(input('\nusername of the remote server: '))
 
-        # sshyp-only data storage
+            # sshync profile generation
-        open(path.expanduser('~/.config/sshyp/sshyp-data'), 'w')\
+            sshync.make_profile(path.expanduser('~/.config/sshyp/sshyp.sshync'),
-            .write(_gpg_id + '\n' + input(f"{_divider}example input: vim\n\npreferred text editor: "))
+                                path.expanduser('~/.local/share/sshyp/'), f"/home/{_username_ssh}/.local/share/sshyp/",
+                                path.expanduser('~/.ssh/sshyp'), _ip, _port, _username_ssh)
 
-        # sshync profile generation
+            # device id configuration
-        sshync.make_profile(path.expanduser('~/.config/sshyp/sshyp.sshync'),
+            for _id in listdir(path.expanduser('~/.config/sshyp/devices')):  # remove existing device id
-                            path.expanduser('~/.local/share/sshyp/'), f"/home/{_username_ssh}/.local/share/sshyp/",
+                remove(f"{path.expanduser('~/.config/sshyp/devices/')}{_id}")
-                            path.expanduser('~/.ssh/sshyp'), _ip, _port, _username_ssh)
+            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"{path.expanduser('~/.config/sshyp/devices/')}{_device_id}", 'w')
 
-        # device name configuration
+            # quick-unlock configuration
-        for _name in listdir(path.expanduser('~/.config/sshyp/devices')):  # remove existing device name
+            print(f"{_divider}this allows you to use a shorter version of your gpg key password and\n"
-            remove(f"{path.expanduser('~/.config/sshyp/devices/')}{_name}")
+                  f"requires a constant connection to your sshyp server to authenticate")
-        print(f"{_divider}\u001b[4;1mimportant:\u001b[0m this name \u001b[4;1mmust\u001b[0m be unique amongst your "
+            _sshyp_data += [input('\nenable quick-unlock? (y/N) ').lower()]
-              f"client devices\n\nthis is used to keep track of which devices have up-to-date databases\n")
+            if _sshyp_data[3] == 'y':
-        _client_device_name = str(input('device name: '))
+                print(f"\nquick-unlock has been enabled client-side - in order for this device to be able to read "
-        open(f"{path.expanduser('~/.config/sshyp/devices/')}{_client_device_name}", 'w')
+                      f"entries,\nyou must first login to the sshyp server and run:\n\nsshyp whitelist setup "
-        copy_name_check(_port, _username_ssh, _ip, _client_device_name)
+                      f"(if not already done)\nsshyp whitelist add '{_device_id}'")
 
-        print(f"{_divider}configuration complete\n")
+            # test server connection and attempt to register device id
+            copy_id_check(_port, _username_ssh, _ip, _device_id)
+
+        elif Path(path.expanduser('~/.config/sshyp/sshyp.sshync')).is_file():
+            remove(path.expanduser('~/.config/sshyp/sshyp.sshync'))
+
+    # write main config file (sshyp-data)
+    with open(path.expanduser('~/.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 argument_list[1] == 'help' or argument_list[1] == '--help' or argument_list[1] == '-h':
         print('\n\u001b[1msshyp  copyright (c) 2021-2022  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")
+              "comes with absolutely no warranty;\ntype 'sshyp license' for details")
-        print('\n\u001b[1musage:\u001b[0m sshyp [option [flag] [<entry name>]] | [/<entry name>]\n')
+        if device_type == 'client':
-        print('\u001b[1moptions:\u001b[0m')
+            print('\n\u001b[1musage:\u001b[0m sshyp [option [flag] [<entry name>]] | [/<entry name>]\n')
-        print('help/--help/-h           bring up this menu')
+            print('\u001b[1moptions:\u001b[0m')
-        print('version/-v               display sshyp version info')
+            print('help/--help/-h           bring up this menu')
-        print('tweak                    configure sshyp')
+            print('version/-v               display sshyp version info')
-        print('add                      add an entry')
+            print('tweak                    configure sshyp')
-        print('gen                      generate a new password')
+            print('add                      add an entry')
-        print('edit                     edit an existing entry')
+            print('gen                      generate a new password')
-        print('copy                     copy details of an entry to your clipboard')
+            print('edit                     edit an existing entry')
-        print('shear/-rm                delete an existing entry')
+            print('copy                     copy details of an entry to your clipboard')
-        print('sync/-s                  manually sync the entry directory via sshync\n')
+            print('shear/-rm                delete an existing entry')
-        print('\u001b[1mflags:\u001b[0m')
+            print('sync/-s                  manually sync the entry directory via sshync')
-        print('add:')
+            print('\n\u001b[1mflags:\u001b[0m')
-        print(' password/-p             add a password entry')
+            print('add:')
-        print(' note/-n                 add a note entry')
+            print(' password/-p             add a password entry')
-        print(' folder/-f               add a new folder for entries')
+            print(' note/-n                 add a note entry')
-        print('edit:')
+            print(' folder/-f               add a new folder for entries')
-        print(' rename/relocate/-r      rename or relocate an entry')
+            print('edit:')
-        print(' username/-u             change the username of an entry')
+            print(' rename/relocate/-r      rename or relocate an entry')
-        print(' password/-p             change the password of an entry')
+            print(' username/-u             change the username of an entry')
-        print(' note/-n                 change the note attached to an entry')
+            print(' password/-p             change the password of an entry')
-        print(' url/-l                  change the url attached to an entry')
+            print(' url/-l                  change the url attached to an entry')
-        print('copy:')
+            print(' note/-n                 change the note attached to an entry')
-        print(' username/-u             copy the username of an entry to your clipboard')
+            print('copy:')
-        print(' password/-p             copy the password of an entry to your clipboard')
+            print(' username/-u             copy the username of an entry to your clipboard')
-        print(' url/-l                  copy the url of an entry to your clipboard')
+            print(' password/-p             copy the password of an entry to your clipboard')
-        print(' note/-n                 copy the note of an entry to your clipboard')
+            print(' url/-l                  copy the url of an entry to your clipboard')
-        print('gen:')
+            print(' note/-n                 copy the note of an entry to your clipboard')
-        print(' update/-u               generate a password for an existing entry\n')
+            print('gen:')
-        print("\u001b[1mtip:\u001b[0m you can quickly read an entry with 'sshyp /<entry name>'")
+            print(' update/-u               generate a password for an existing entry')
+            print("\n\u001b[1mtip:\u001b[0m you can quickly read an entry with 'sshyp /<entry name>'\n")
+        else:
+            print('\n\u001b[1musage:\u001b[0m sshyp [option [flag] [<device id>]]\n')
+            print('\u001b[1moptions:\u001b[0m')
+            print('help/--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(' delete/del              remove a device id from the quick-unlock whitelist\n')
     elif argument_list[1] == 'version' or argument_list[1] == '-v':
         print('\nsshyp is a simple, self-hosted, sftp-synchronized password manager\nfor unix(-like) systems (haiku/'
               'freebsd/linux/termux)\n\nsshyp is a viable alternative to (and compatible with) pass/password-store\n')
@@ -346,21 +413,20 @@ def print_info():  # prints help text based on argument
               '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.1.1'
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                    \u001b[38;5;15;48;5;8mversion 1.2.0'
               '\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 sheecrets '
+        print('\u001b[38;5;7;48;5;8m/\u001b[38;5;15;48;5;15m                \u001b[38;5;15;48;5;8mthe brisk bahh '
               '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 argument_list[1] == 'license':
-        print('\nThis program is free software: you can redistribute it and/or modify it under the terms of the GNU '
+        print('\nThis program is free software: you can redistribute it and/or modify it under the terms\nof version 3 '
-              'General\nPublic License as published by the Free Software Foundation, either version 3 of the License,'
+              '(only) of the GNU General Public License as published by the Free Software Foundation.\n\nThis program '
-              '\nor (at your option) any later version.\n\nThis program is distributed in the hope that it will be '
+              'is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;\nwithout even the implied '
-              'useful, but WITHOUT ANY WARRANTY;\nwithout even the implied warranty of MERCHANTABILITY or FITNESS FOR A'
+              'warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.\nSee the GNU General Public License for'
-              ' PARTICULAR PURPOSE.\nSee the GNU General Public License for more details.'
+              ' more details.\n\nhttps://opensource.org/licenses/GPL-3.0\n')
-              '\n\nhttps://opensource.org/licenses/GPL-3.0\n')
     elif argument_list[1] == 'add':
         print('\n\u001b[1musage:\u001b[0m sshyp add [flag [<entry name>]]\u001b[0m\n')
         print('\u001b[1mflags:\u001b[0m')
@@ -385,6 +451,18 @@ def print_info():  # prints help text based on argument
         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 argument_list[1] == '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')
+    s_exit(0)
 
 
 def no_arg():  # displays a list of entries and gives an option to select one for viewing
@@ -392,9 +470,9 @@ def no_arg():  # displays a list of entries and gives an option to select one fo
     _entry_name = entry_name_fetch('entry to read: ')
     if not Path(f"{directory}{_entry_name}.gpg").exists():
         print(f"\n\u001b[38;5;9merror: entry ({_entry_name}) does not exist\u001b[0m\n")
-        s_exit(1)
+        s_exit(3)
     _shm_folder, _shm_entry = shm_gen()
-    decrypt(directory + _entry_name, _shm_folder, _shm_entry, gpg)
+    determine_decrypt(directory + _entry_name, _shm_folder, _shm_entry, gpg)
     entry_reader(f"{tmp_dir}{_shm_folder}/{_shm_entry}")
     rmtree(f"{tmp_dir}{_shm_folder}")
 
@@ -402,9 +480,9 @@ def no_arg():  # displays a list of entries and gives an option to select one fo
 def read_shortcut():  # shortcut to quickly read an entry
     if not Path(f"{directory}{argument.replace('/', '', 1)}.gpg").exists():
         print(f"\n\u001b[38;5;9merror: entry ({argument.replace('/', '', 1)}) does not exist\u001b[0m\n")
-        s_exit(1)
+        s_exit(3)
     _shm_folder, _shm_entry = shm_gen()
-    decrypt(directory + argument.replace('/', '', 1), _shm_folder, _shm_entry, gpg)
+    determine_decrypt(directory + argument.replace('/', '', 1), _shm_folder, _shm_entry, gpg)
     entry_reader(f"{tmp_dir}{_shm_folder}/{_shm_entry}")
     rmtree(f"{tmp_dir}{_shm_folder}")
 
@@ -412,8 +490,8 @@ def read_shortcut():  # shortcut to quickly read an entry
 def sync():  # calls sshync to sync changes to the user's server
     print('\nsyncing entries with the server device...\n')
     # check for deletions
-    system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /bin; python -c "
+    system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /lib/sshyp; python -c "
-           f"'import sshypRemote; sshypRemote.deletion_check(\"'\"{client_device_name}\"'\")'\"")
+           f"'import sshypRemote; sshypRemote.deletion_check(\"'\"{client_device_id}\"'\")'\"")
     system(f"scp -pqs -P {port} -i '{path.expanduser('~/.ssh/sshyp')}' {username_ssh}@{ip}:'/home/{username_ssh}"
            f"/.config/sshyp/deletion_database' {path.expanduser('~/.config/sshyp/')}")
     try:
@@ -421,26 +499,20 @@ def sync():  # calls sshync to sync changes to the user's server
     except (FileNotFoundError, IndexError):
         print('\n\u001b[38;5;9merror: the deletion database does not exist or is corrupted\u001b[0m\n')
         _deletion_database = None
-        s_exit(1)
+        s_exit(6)
     for _file in _deletion_database:
-        if _file[:-1].endswith('/'):
+        try:
-            try:
+            if silent_sync != 1:
-                if silent_sync != 1:
+                print(f"\u001b[38;5;208m{_file[:-1]}\u001b[0m has been sheared, removing...")
-                    print(f"\u001b[38;5;208m{_file[:-1]}\u001b[0m has been sheared, removing...")
+            if _file[:-1].endswith('/'):
                 rmtree(f"{directory}{_file[:-1]}")
-            except FileNotFoundError:
+            else:
-                if silent_sync != 1:
-                    print('folder does not exist locally.')
-        else:
-            try:
-                if silent_sync != 1:
-                    print(f"\u001b[38;5;208m{_file[:-1]}\u001b[0m has been sheared, removing...")
                 remove(f"{directory}{_file[:-1]}.gpg")
-            except (FileNotFoundError, IsADirectoryError):
+        except FileNotFoundError:
-                if silent_sync != 1:
+            if silent_sync != 1:
-                    print('file does not exist locally.')
+                print('location does not exist locally')
     # check for new folders
-    system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /bin; python -c "
+    system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /lib/sshyp; python -c "
            f"'import sshypRemote; sshypRemote.folder_check()'\"")
     system(f"scp -pqs -P {port} -i '{path.expanduser('~/.ssh/sshyp')}' {username_ssh}@{ip}:'/home/{username_ssh}"
            f"/.config/sshyp/folder_database' {path.expanduser('~/.config/sshyp/')}")
@@ -449,7 +521,7 @@ def sync():  # calls sshync to sync changes to the user's server
     except (FileNotFoundError, IndexError):
         print('\n\u001b[38;5;9merror: the folder database does not exist or is corrupted\u001b[0m\n')
         _folder_database = None
-        s_exit(1)
+        s_exit(6)
     for _folder in _folder_database:
         if Path(f"{path.expanduser('~')}{_folder[:-1]}").is_dir():
             pass
@@ -463,6 +535,107 @@ def sync():  # calls sshync to sync changes to the user's server
     sshync.run_profile(path.expanduser('~/.config/sshyp/sshyp.sshync'))
 
 
+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(path.expanduser('~/.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 + "'" +
+        " '" + path.expanduser('~/.config/sshyp/gpg-gen') + "'", shell=True)
+    remove(path.expanduser('~/.config/sshyp/gpg-gen'))
+    _gpg_id = run(f"{gpg} -k", shell=True, stdout=PIPE, text=True).stdout.split('\n')[-4].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(path.expanduser('~/.config/sshyp/excluded'), _shm_folder, _shm_entry, gpg, _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(f"gpg --pinentry-mode cancel -qd --output /dev/null {path.expanduser('~/.config/sshyp/lock.gpg')}",
+            shell=True, stderr=PIPE, check=True, close_fds=True)
+        return False
+    except CalledProcessError:
+        _i, _full_password = 0, ''
+        _server_whitelist = run('ssh -i ' + "'" + path.expanduser('~/.ssh/sshyp') + "' -p " + _port + " " +
+                                _username_ssh + '@' + _ip + " 'ls ~/.config/sshyp/whitelist'",
+                                shell=True, stdout=PIPE, text=True)
+        for _device_id in _server_whitelist.stdout.rstrip().split('\n'):
+            if _device_id == _client_device_id:
+                _quick_unlock_password = input('\nquick-unlock passphrase: ')
+                _quick_unlock_password_excluded = \
+                    run('ssh -i ' + "'" + path.expanduser('~/.ssh/sshyp') + "' -p " + _port + " " + _username_ssh + '@'
+                        + _ip + f" 'gpg --pinentry-mode loopback --passphrase '{_quick_unlock_password}' -qd"
+                                f" ~/.config/sshyp/excluded.gpg'", shell=True, 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(path.expanduser('~/.config/sshyp/whitelist'))
+    _device_ids = listdir(path.expanduser('~/.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 len(argument_list) == 3:
+        whitelist_list()
+        _device_id = input('device id: ')
+    else:
+        _argument_split = argument.split(' ')
+        del _argument_split[:2]
+        _device_id = ' '.join(_argument_split)
+
+    if argument_list[2] == 'add':
+        if _device_id in listdir(path.expanduser('~/.config/sshyp/devices')):
+            open(path.expanduser(f"~/.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(2)
+
+    elif Path(path.expanduser(f"~/.config/sshyp/whitelist/{_device_id}")).is_file():
+        remove(path.expanduser(f"~/.config/sshyp/whitelist/{_device_id}"))
+        whitelist_list()
+
+
 def add_entry():  # adds a new entry
     _shm_folder, _shm_entry = None, None  # sets base-line values to avoid errors
     if len(argument_list) < 4:
@@ -471,10 +644,10 @@ def add_entry():  # adds a new entry
         _entry_name = entry_name_fetch(2)
     if Path(f"{directory}{_entry_name}.gpg").is_file():
         print(f"\n\u001b[38;5;9merror: entry ({_entry_name}) already exists\u001b[0m\n")
-        s_exit(1)
+        s_exit(4)
     if argument_list[2] == 'note' or argument_list[2] == '-n':
         _shm_folder, _shm_entry = shm_gen()
-        system(f"{editor} {tmp_dir}{_shm_folder}/{_shm_entry}-n")
+        system(f"{editor} '{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))
     elif argument_list[2] == 'password' or argument_list[2] == '-p':
@@ -484,7 +657,7 @@ def add_entry():  # adds a new entry
         _add_note = input('add a note to this entry? (y/N) ')
         _shm_folder, _shm_entry = shm_gen()
         if _add_note.lower() == 'y':
-            system(f"{editor} {tmp_dir}{_shm_folder}/{_shm_entry}-n")
+            system(f"{editor} '{tmp_dir}{_shm_folder}/{_shm_entry}-n'")
             _notes = open(f"{tmp_dir}{_shm_folder}/{_shm_entry}-n", 'r').read()
         else:
             _notes = ''
@@ -501,8 +674,9 @@ def add_folder():  # creates a new folder
     else:
         _entry_name = entry_name_fetch(2)
     Path(directory + _entry_name).mkdir(0o700)
-    system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"mkdir -p '{directory_ssh}"
+    if ssh_error != 1:
-           f"{_entry_name}'\"")
+        system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"mkdir -p "
+               f"'{directory_ssh}{_entry_name}'\"")
 
 
 def rename():  # renames an entry or folder
@@ -512,20 +686,21 @@ def rename():  # renames an entry or folder
         _entry_name = entry_name_fetch(2)
     if not Path(f"{directory}{_entry_name}.gpg").is_file() and not Path(f"{directory}{_entry_name}").is_dir():
         print(f"\n\u001b[38;5;9merror: entry ({_entry_name}) does not exist\u001b[0m\n")
-        s_exit(1)
+        s_exit(3)
-    _new_name = str(input('new name: '))
+    _new_name = entry_name_fetch('new name: ')
-    print(f"{directory}{_new_name}")
     if Path(f"{directory}{_new_name}.gpg").is_file() or Path(f"{directory}{_new_name}").is_dir():
         print(f"\n\u001b[38;5;9merror: ({_new_name}) already exists\u001b[0m\n")
-        s_exit(1)
+        s_exit(4)
     if _entry_name.endswith('/'):
         move(f"{directory}{_entry_name}", f"{directory}{_new_name}")
-        system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"mkdir -p '{directory_ssh}"
+        if ssh_error != 1:
-               f"{_new_name}'\"")
+            system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"mkdir -p "
+                   f"'{directory_ssh}{_new_name}'\"")
     else:
         move(f"{directory}{_entry_name}.gpg", f"{directory}{_new_name}.gpg")
-    system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /bin; python -c "
+    if ssh_error != 1:
-           f"'import sshypRemote; sshypRemote.delete(\"'\"{_entry_name}\"'\")'\"")
+        system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /lib/sshyp; python -c "
+               f"'import sshypRemote; sshypRemote.delete(\"'\"{_entry_name}\"'\", \"'\"remotely\"'\")'\"")
 
 
 def edit():  # edits the contents of an entry
@@ -536,9 +711,9 @@ def edit():  # edits the contents of an entry
         _entry_name = entry_name_fetch(2)
     if not Path(f"{directory}{_entry_name}.gpg").is_file():
         print(f"\n\u001b[38;5;9merror: entry ({_entry_name}) does not exist\u001b[0m\n")
-        s_exit(1)
+        s_exit(3)
     _shm_folder, _shm_entry = shm_gen()
-    decrypt(directory + _entry_name, _shm_folder, _shm_entry, gpg)
+    determine_decrypt(directory + _entry_name, _shm_folder, _shm_entry, gpg)
     if argument_list[2] == 'username' or argument_list[2] == '-u':
         _detail, _edit_line = str(input('username: ')), 1
     elif argument_list[2] == 'password' or argument_list[2] == '-p':
@@ -566,20 +741,20 @@ def gen():  # generates a password for a new or an existing entry
         _entry_name = entry_name_fetch(2)
         if not Path(f"{directory}{_entry_name}.gpg").is_file():
             print(f"\n\u001b[38;5;9merror: entry ({_entry_name}) does not exist\u001b[0m\n")
-            s_exit(1)
+            s_exit(3)
     else:
         _entry_name = entry_name_fetch(1)
     if len(argument_list) == 2 or (not argument_list[2] == 'update' and not argument_list[2] == '-u'):
         if Path(f"{directory}{_entry_name}.gpg").is_file():
             print(f"\n\u001b[38;5;9merror: entry ({_entry_name}) already exists\u001b[0m\n")
-            s_exit(1)
+            s_exit(4)
         _username = str(input('username: '))
         _password = pass_gen()
         _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':
-            system(f"{editor} {tmp_dir}{_shm_folder}/{_shm_entry}-n")
+            system(f"{editor} '{tmp_dir}{_shm_folder}/{_shm_entry}-n'")
             _notes = open(f"{tmp_dir}{_shm_folder}/{_shm_entry}-n", 'r').read()
         else:
             _notes = ''
@@ -587,7 +762,7 @@ def gen():  # generates a password for a new or an existing entry
             .writelines(optimized_edit([_password, _username, _url, _notes], None, -1))
     else:
         _shm_folder, _shm_entry = shm_gen()
-        decrypt(directory + _entry_name, _shm_folder, _shm_entry, gpg)
+        determine_decrypt(directory + _entry_name, _shm_folder, _shm_entry, gpg)
         _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")
@@ -603,49 +778,49 @@ def copy_data():  # copies a specified field of an entry to the clipboard
         _entry_name = entry_name_fetch(2)
     if not Path(f"{directory}{_entry_name}.gpg").is_file():
         print(f"\n\u001b[38;5;9merror: entry ({_entry_name}) does not exist\u001b[0m\n")
-        s_exit(1)
+        s_exit(3)
     _shm_folder, _shm_entry = shm_gen()
-    decrypt(directory + _entry_name, _shm_folder, _shm_entry, gpg)
+    determine_decrypt(directory + _entry_name, _shm_folder, _shm_entry, gpg)
     _copy_line = open(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 'r').readlines()
     if uname()[0] == 'Haiku':  # Haiku clipboard detection
         if argument_list[2] == 'username' or argument_list[2] == '-u':
-            system('clipboard -c ' + "'" + _copy_line[1].replace('\n', '').replace("'", "'\\''") + "'")
+            system('clipboard -c ' + "'" + _copy_line[1].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'password' or argument_list[2] == '-p':
-            system('clipboard -c ' + "'" + _copy_line[0].replace('\n', '').replace("'", "'\\''") + "'")
+            system('clipboard -c ' + "'" + _copy_line[0].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'url' or argument_list[2] == '-l':
-            system('clipboard -c ' + "'" + _copy_line[2].replace('\n', '').replace("'", "'\\''") + "'")
+            system('clipboard -c ' + "'" + _copy_line[2].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'note' or argument_list[2] == '-n':
-            system('clipboard -c ' + "'" + _copy_line[3].replace('\n', '').replace("'", "'\\''") + "'")
+            system('clipboard -c ' + "'" + _copy_line[3].rstrip().replace("'", "'\\''") + "'")
         Popen('sleep 30; clipboard -r', shell=True, close_fds=True)
     elif Path("/data/data/com.termux").exists():  # Termux (Android) clipboard detection
         if argument_list[2] == 'username' or argument_list[2] == '-u':
-            system('termux-clipboard-set ' + "'" + _copy_line[1].replace('\n', '').replace("'", "'\\''") + "'")
+            system('termux-clipboard-set ' + "'" + _copy_line[1].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'password' or argument_list[2] == '-p':
-            system('termux-clipboard-set ' + "'" + _copy_line[0].replace('\n', '').replace("'", "'\\''") + "'")
+            system('termux-clipboard-set ' + "'" + _copy_line[0].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'url' or argument_list[2] == '-l':
-            system('termux-clipboard-set ' + "'" + _copy_line[2].replace('\n', '').replace("'", "'\\''") + "'")
+            system('termux-clipboard-set ' + "'" + _copy_line[2].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'note' or argument_list[2] == '-n':
-            system('termux-clipboard-set ' + "'" + _copy_line[3].replace('\n', '').replace("'", "'\\''") + "'")
+            system('termux-clipboard-set ' + "'" + _copy_line[3].rstrip().replace("'", "'\\''") + "'")
         Popen("sleep 30; termux-clipboard-set ''", shell=True, close_fds=True)
     elif environ.get('WAYLAND_DISPLAY') == 'wayland-0':  # Wayland clipboard detection
         if argument_list[2] == 'username' or argument_list[2] == '-u':
-            system('wl-copy ' + "'" + _copy_line[1].replace('\n', '').replace("'", "'\\''") + "'")
+            system('wl-copy ' + "'" + _copy_line[1].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'password' or argument_list[2] == '-p':
-            system('wl-copy ' + "'" + _copy_line[0].replace('\n', '').replace("'", "'\\''") + "'")
+            system('wl-copy ' + "'" + _copy_line[0].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'url' or argument_list[2] == '-l':
-            system('wl-copy ' + "'" + _copy_line[2].replace('\n', '').replace("'", "'\\''") + "'")
+            system('wl-copy ' + "'" + _copy_line[2].rstrip().replace("'", "'\\''") + "'")
         elif argument_list[2] == 'note' or argument_list[2] == '-n':
-            system('wl-copy ' + "'" + _copy_line[3].replace('\n', '').replace("'", "'\\''") + "'")
+            system('wl-copy ' + "'" + _copy_line[3].rstrip().replace("'", "'\\''") + "'")
         Popen('sleep 30; wl-copy -c', shell=True, close_fds=True)
     else:  # X11 clipboard detection
         if argument_list[2] == 'username' or argument_list[2] == '-u':
-            system('echo -n ' + "'" + _copy_line[1].replace('\n', '').replace("'", "'\\''") + "'" + ' | xclip -sel c')
+            system('echo -n ' + "'" + _copy_line[1].rstrip().replace("'", "'\\''") + "'" + ' | xclip -sel c')
         elif argument_list[2] == 'password' or argument_list[2] == '-p':
-            system('echo -n ' + "'" + _copy_line[0].replace('\n', '').replace("'", "'\\''") + "'" + ' | xclip -sel c')
+            system('echo -n ' + "'" + _copy_line[0].rstrip().replace("'", "'\\''") + "'" + ' | xclip -sel c')
         elif argument_list[2] == 'url' or argument_list[2] == '-l':
-            system('echo -n ' + "'" + _copy_line[2].replace('\n', '').replace("'", "'\\''") + "'" + ' | xclip -sel c')
+            system('echo -n ' + "'" + _copy_line[2].rstrip().replace("'", "'\\''") + "'" + ' | xclip -sel c')
         elif argument_list[2] == 'note' or argument_list[2] == '-n':
-            system('echo -n ' + "'" + _copy_line[3].replace('\n', '').replace("'", "'\\''") + "'" + ' | xclip -sel c')
+            system('echo -n ' + "'" + _copy_line[3].rstrip().replace("'", "'\\''") + "'" + ' | xclip -sel c')
         Popen("sleep 30; echo -n '' | xclip -sel c", shell=True, close_fds=True)
     rmtree(f"{tmp_dir}{_shm_folder}")
 
@@ -655,9 +830,13 @@ def remove_data():  # deletes an entry from the server and flags it for local de
         _entry_name = entry_name_fetch('entry/folder to shear: ')
     else:
         _entry_name = entry_name_fetch(1)
-    decrypt(path.expanduser('~/.config/sshyp/lock.gpg'), 0, 0, gpg)
+    determine_decrypt(path.expanduser('~/.config/sshyp/lock.gpg'), 0, 0, gpg)
-    system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /bin; python -c "
+    if ssh_error != 1:
-           f"'import sshypRemote; sshypRemote.delete(\"'\"{_entry_name}\"'\")'\"")
+        system(f"ssh -i '{path.expanduser('~/.ssh/sshyp')}' -p {port} {username_ssh}@{ip} \"cd /lib/sshyp; python -c "
+               f"'import sshypRemote; sshypRemote.delete(\"'\"{_entry_name}\"'\", \"'\"remotely\"'\")'\"")
+    else:
+        from sshypRemote import delete as offline_delete
+        offline_delete(_entry_name, '')
 
 
 if __name__ == "__main__":
@@ -672,34 +851,41 @@ if __name__ == "__main__":
             gpg = 'gpg'
 
         # import saved userdata
+        device_type = ''
         if argument != 'tweak':
-            device_type = ''
             tmp_dir = path.expanduser('~/.config/sshyp/tmp/')
             try:
-                device_type = open(path.expanduser('~/.config/sshyp/sshyp-device')).read().strip()
+                sshyp_data = open(path.expanduser('~/.config/sshyp/sshyp-data')).readlines()
-                if device_type == 'c':
+                device_type = sshyp_data[0].rstrip()
-                    ssh_info = sshync.get_profile(path.expanduser('~/.config/sshyp/sshyp.sshync'))
+                if device_type == 'client':
-                    username_ssh = ssh_info[0].replace('\n', '')
+                    directory = path.expanduser('~/.local/share/sshyp/')
-                    ip = ssh_info[1].replace('\n', '')
+                    gpg_id = sshyp_data[1].rstrip()
-                    port = ssh_info[2].replace('\n', '')
+                    editor = sshyp_data[2].rstrip()
-                    directory = str(ssh_info[3].replace('\n', ''))
+                    quick_unlock_enabled = sshyp_data[3].rstrip()
-                    directory_ssh = str(ssh_info[4].replace('\n', ''))
+                    if Path(path.expanduser('~/.config/sshyp/sshyp.sshync')).is_file():
-                    client_device_name = listdir(path.expanduser('~/.config/sshyp/devices'))[0]
+                        ssh_info = sshync.get_profile(path.expanduser('~/.config/sshyp/sshyp.sshync'))
-                    sshyp_data = open(path.expanduser('~/.config/sshyp/sshyp-data')).readlines()
+                        username_ssh = ssh_info[0].rstrip()
-                    gpg_id = sshyp_data[0].replace('\n', '')
+                        ip = ssh_info[1].rstrip()
-                    editor = sshyp_data[1].replace('\n', '')
+                        port = ssh_info[2].rstrip()
-                    ssh_error = int(open(path.expanduser('~/.config/sshyp/ssh-error')).read().strip())
+                        directory_ssh = str(ssh_info[4].rstrip())
-                    if ssh_error != 0:
+                        client_device_id = listdir(path.expanduser('~/.config/sshyp/devices'))[0].rstrip()
-                        ssh_error = copy_name_check(port, username_ssh, ip, client_device_name)
+                        ssh_error = int(open(path.expanduser('~/.config/sshyp/ssh-error')).read().rstrip())
-                else:
+                        if ssh_error != 0:
-                    print('running as server, option disabled')
+                            ssh_error = copy_id_check(port, username_ssh, ip, client_device_id)
-                    s_exit(0)
+                    else:
+                        ssh_error = 1
+                elif len(argument_list) <= 1 or (argument_list[1] != "help" and argument_list[1] != "--help" and
+                                                 argument_list[1] != "-h" and argument_list[1] != "license" and
+                                                 argument_list[1] != "version" and argument_list[1] != "-v" and
+                                                 argument_list[1] != "whitelist"):
+                    print(f"\n\u001b[38;5;9merror: invalid server argument - run 'sshyp help' to "
+                          f"list usable commands\u001b[0m\n")
+                    s_exit(1)
             except (FileNotFoundError, IndexError):
-                if device_type.lower() != 's':
+                print('\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')
-                    print('\n!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!')
+                print("not all necessary configuration files are present - please run 'sshyp tweak'")
-                    print("not all necessary configuration files are present - please run 'sshyp tweak'")
+                print('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n')
-                    print('!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n')
+                s_exit(2)
-                s_exit(1)
         else:
             tweak()
             s_exit(0)
@@ -712,6 +898,20 @@ if __name__ == "__main__":
         elif argument == 'help' or argument == '--help' or argument == '-h' or argument == 'license' or argument \
                 == 'version' or argument == '-v':
             print_info()
+        elif argument_list[1] == 'whitelist':
+            if device_type == 'server':
+                if len(argument_list) == 2:
+                    print_info()
+                elif argument_list[2] == 'list' or argument_list[2] == '-l':
+                    whitelist_list()
+                elif argument_list[2] == 'add' or argument_list[2] == 'delete' or argument_list[2] == 'del':
+                    whitelist_manage()
+                elif argument_list[2] == 'setup':
+                    whitelist_setup()
+                else:
+                    print_info()
+            else:
+                print_info()
         elif argument_list[1] == 'add':
             if len(argument_list) == 2:
                 print_info()
@@ -722,7 +922,6 @@ if __name__ == "__main__":
                 add_folder()
             else:
                 print_info()
-                s_exit(0)
         elif argument_list[1] == 'edit':
             if len(argument_list) == 2:
                 print_info()
@@ -735,7 +934,6 @@ if __name__ == "__main__":
                 edit()
             else:
                 print_info()
-                s_exit(0)
         elif argument_list[1] == 'gen':
             gen()
         elif argument_list[1] == 'copy':
@@ -744,7 +942,11 @@ if __name__ == "__main__":
             elif argument_list[2] == 'username' or argument_list[2] == '-u' or argument_list[2] == 'password' or \
                     argument_list[2] == '-p' or argument_list[2] == 'url' or argument_list[2] == '-l' or \
                     argument_list[2] == 'note' or argument_list[2] == '-n':
-                copy_data()
+                try:
+                    copy_data()
+                except IndexError:
+                    print(f"\n\u001b[38;5;9merror: field does not exist in entry\u001b[0m\n")
+                    s_exit(3)
             else:
                 print_info()
         elif argument_list[1] == 'shear' or argument_list[1] == '-rm':
@@ -754,15 +956,11 @@ if __name__ == "__main__":
             s_exit(1)
 
         # sync if any changes were made
-        if len(argument_list) > 1 and ssh_error == 0 and \
+        if len(argument_list) > 1 and ssh_error == 0 \
-                ((argument_list[1] == 'sync' or argument_list[1] == '-s' or argument_list[1] == 'gen' or
+                and ((argument_list[1] == 'sync' or argument_list[1] == '-s' or argument_list[1] == 'gen' or
-                  argument_list[1] == 'shear' or argument_list[1] == '-rm') or ((argument_list[1] == 'add'
+                      argument_list[1] == 'shear' or argument_list[1] == '-rm') or
-                                                                                 or argument_list[1] == 'edit')
+                     ((argument_list[1] == 'add' or argument_list[1] == 'edit') and len(argument_list) > 2)):
-                                                                                and len(argument_list) > 2)):
             sync()
 
-        s_exit(0)
-
     except KeyboardInterrupt:
         print('\n')
-        s_exit(0)

lib/sshypRemote.py

@@ -1,4 +1,4 @@
-#!/bin/python3
+#!/usr/bin/env python3
 
 # external modules
 
@@ -9,17 +9,14 @@ from shutil import rmtree
 
 # utility functions
 
-def delete(_file_path):  # deletes an entry or folder, should be run remotely via ssh
+def delete(_file_path, _target_database):  # deletes an entry or folder, should be run remotely via ssh
-    if _file_path.endswith('/'):
+    try:
-        try:
+        if _file_path.endswith('/'):
             rmtree(f"{expanduser('~/.local/share/sshyp/')}{_file_path}")
-        except FileNotFoundError:
+        else:
-            print('folder does not exist remotely')
-    else:
-        try:
             remove(f"{expanduser('~/.local/share/sshyp/')}{_file_path}.gpg")
-        except FileNotFoundError:
+    except FileNotFoundError:
-            print('file does not exist remotely')
+        print(f"location does not exist {_target_database}")
     for _device_name in listdir(expanduser('~/.config/sshyp/devices')):
         open(f"{expanduser('~/.config/sshyp/deleted/')}{_file_path.replace('/', '@')}^&*{_device_name}", 'w')
 

package.sh

@@ -1,39 +1,80 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-# This script packages sshyp (from source) for various UNIX(-like) environments.
+version=$(sed -n '1{p;q}' share/doc/sshyp/changelog | cut -c8-)
-# Dependencies (Arch Linux): dpkg (packaging for Debian/Termux), freebsd-pkg (packaging for FreeBSD)
+if [ -z "$2" ]; then
-# Dependencies (Fedora) (can only package for self): rpmdevtools
+    revision=1
-# NOTE It is recommended to instead use the latest officially packaged and tagged release.
+else
-
+    revision="$2"
-echo -e '\nOptions (please enter the number only):'
-echo -e '\nPackage Formats:\n\n1. Haiku\n2. Debian&Ubuntu Linux\n3. Fedora Linux\n4. FreeBSD\n5. Termux\n6. Generic (used for PKGBUILD/APKBUILD)'
-echo -e '\nBuild Scripts:\n\n7. Arch Linux (PKGBUILD)'
-echo -e '\nOther:\n\n8. All (generates all distribution packages (excluding Haiku and Fedora, as these must be packaged on their respective distributions) and build scripts)\n'
-read -n 1 -r -p "Distribution: " distro
-
-echo -e '\n\nThe value entered in this field will only affect the version reported to the package manager. The latest source is used regardless.\n'
-read -r -p "Version number: " version
-
-echo -e '\nThe value entered in this field will only affect the revision number for build scripts.\n'
-read -r -p "Revision number: " revision
-
-if [ "$distro" == "7" ] || [ "$distro" == "8" ]; then
-    echo -e '\nOptions (please enter the number only):'
-    echo -e '\n1. GitHub Release Tag\n2. Local\n'
-    read -r -p "Source (for build scripts): " source
-
-    if [ "$source" == "1" ]; then
-        source='https://github.com/rwinkhart/sshyp/releases/download/v$pkgver/sshyp-$pkgver.tar.xz'
-    else
-        source=local://sshyp-"$version".tar.xz
-    fi
 fi
 
-mkdir -p packages
+_create_generic() {
+    echo -e '\npackaging as generic...\n'
+    mkdir -p output/generictemp/usr/{bin,lib/sshyp,share/{man/man1,bash-completion/completions}}
+    cp -r lib/. output/generictemp/usr/lib/sshyp/
+    ln -s /usr/lib/sshyp/sshyp.py output/generictemp/usr/bin/sshyp
+    cp -r share output/generictemp/usr/
+    cp extra/sshyp-completion.bash output/generictemp/usr/share/bash-completion/completions/sshyp
+    cp extra/manpage output/generictemp/usr/share/man/man1/sshyp.1
+    gzip output/generictemp/usr/share/man/man1/sshyp.1
+    tar -C output/generictemp -cvJf output/sshyp-"$version".tar.xz usr/
+    rm -rf output/generictemp
+    sha512="$(sha512sum output/sshyp-"$version".tar.xz | awk '{print $1;}')"
+    echo -e "\nsha512 sum:\n$sha512"
+    echo -e "\ngeneric packaging complete\n"
+} &&
 
-if [ "$distro" == "1" ]; then
+_create_pkgbuild() {
-    echo -e '\nPackaging for Haiku...\n'
+    source='https://github.com/rwinkhart/sshyp/releases/download/v$pkgver/sshyp-$pkgver.tar.xz'
-    mkdir -p packages/haikutemp/documentation/{man/man1,packages/sshyp}
+    echo -e '\ngenerating PKGBUILD...'
+    echo "# 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 sshyp-"\"\$pkgver\"".tar.xz -C "\"\${pkgdir}\""
+}
+" > output/PKGBUILD
+    echo -e "\nPKGBUILD generated\n"
+} &&
+
+_create_apkbuild() {
+    echo -e '\ngenerating APKBUILD...'
+    echo "# 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\""
+    cp -r "\"\$srcdir/usr/"\" "\"\$pkgdir\""
+}
+
+sha512sums=\"
+"$sha512'  'sshyp-\"\$pkgver\".tar.xz"
+\"
+" > output/APKBUILD
+    echo -e "\nAPKBUILD generated\n"
+} &&
+
+_create_hpkg() {
+    echo -e '\npackaging for Haiku...\n'
+    mkdir -p output/haikutemp/{bin,lib/sshyp,documentation/{packages/sshyp,man/man1},data/bash-completion/completions}
     echo "name			sshyp
 version			"$version"-"$revision"
 architecture		any
@@ -54,30 +95,34 @@ provides {
 requires {
 	gnupg
 	openssh
-	python3
+	python310
 }
 urls {
 	\"https://github.com/rwinkhart/sshyp\"
 }
-" > packages/haikutemp/.PackageInfo
+" > output/haikutemp/.PackageInfo
-    cp -r bin packages/haikutemp/
+    cp -r lib/. output/haikutemp/lib/sshyp/
-    ln -s /bin/sshyp.py packages/haikutemp/bin/sshyp
+    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshync.py
-    cp -r share/doc/sshyp/ packages/haikutemp/documentation/packages/
+    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshyp.py
-    cp -r share/licenses/sshyp/ packages/haikutemp/documentation/packages/
+    sed -i '1 s/.*/#!\/bin\/env\ python3.10/' output/haikutemp/lib/sshyp/sshypRemote.py
-    cp extra/manpage packages/haikutemp/documentation/man/man1/sshyp.1
+    ln -s /system/lib/sshyp/sshyp.py output/haikutemp/bin/sshyp
-    gzip packages/haikutemp/documentation/man/man1/sshyp.1
+    cp -r share/doc/sshyp/. output/haikutemp/documentation/packages/sshyp/
-    cd packages/haikutemp
+    cp -r share/licenses/sshyp/. output/haikutemp/documentation/packages/sshyp/
+    cp extra/sshyp-completion.bash output/haikutemp/data/bash-completion/completions/sshyp
+    cp extra/manpage output/haikutemp/documentation/man/man1/sshyp.1
+    gzip output/haikutemp/documentation/man/man1/sshyp.1
+    cd output/haikutemp
     package create -b sshyp-"$version"-"$revision"_all.hpkg
-    package add sshyp-"$version"-"$revision"_all.hpkg bin documentation
+    package add sshyp-"$version"-"$revision"_all.hpkg bin lib documentation data
     cd ../..
-    mv packages/haikutemp/sshyp-"$version"-"$revision"_all.hpkg packages/
+    mv output/haikutemp/sshyp-"$version"-"$revision"_all.hpkg output/
-    rm -rf packages/haikutemp
+    rm -rf output/haikutemp
-    echo -e "\nHaiku packaging complete.\n"
+    echo -e "\nHaiku packaging complete\n"
-fi
+} &&
 
-if [ "$distro" == "2" ] || [ "$distro" == "8" ]; then
+_create_deb() {
-    echo -e '\nPackaging for Debian...\n'
+    echo -e '\npackaging for Debian/Ubuntu...\n'
-    mkdir -p packages/debiantemp/sshyp_"$version"-"$revision"_all/{DEBIAN,usr/share/man/man1}
+    mkdir -p output/debiantemp/sshyp_"$version"-"$revision"_all/{DEBIAN,usr/{lib/sshyp,bin,share/{bash-completion/completions,man/man1}}}
     echo "Package: sshyp
 Version: $version
 Section: utils
@@ -85,23 +130,25 @@ 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: 185
+Installed-Size: 14584
-" > packages/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
+" > output/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
-    cp -r bin packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/
+    cp -r lib/. output/debiantemp/sshyp_"$version"-"$revision"_all/usr/lib/sshyp/
-    ln -s /usr/bin/sshyp.py packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/bin/sshyp
+    ln -s /usr/lib/sshyp/sshyp.py output/debiantemp/sshyp_"$version"-"$revision"_all/usr/bin/sshyp
-    cp -r share packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/
+    cp -r share output/debiantemp/sshyp_"$version"-"$revision"_all/usr/
-    cp extra/manpage packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
+    cp extra/sshyp-completion.bash output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/bash-completion/completions/sshyp
-    gzip packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
+    cp extra/manpage output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
-    dpkg-deb --build --root-owner-group packages/debiantemp/sshyp_"$version"-"$revision"_all/
+    gzip output/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
-    mv packages/debiantemp/sshyp_"$version"-"$revision"_all.deb packages/
+    dpkg-deb --build --root-owner-group output/debiantemp/sshyp_"$version"-"$revision"_all/
-    rm -rf packages/debiantemp
+    mv output/debiantemp/sshyp_"$version"-"$revision"_all.deb output/
-    echo -e "\nDebian packaging complete.\n"
+    rm -rf output/debiantemp
-fi
+    echo -e "\nDebian/Ubuntu packaging complete\n"
+} &&
 
-if [ "$distro" == "5" ] || [ "$distro" == "8" ]; then
+_create_termux() {
-    echo -e '\nPackaging for Termux...\n'
+    echo -e '\npackaging for Termux...\n'
-    mkdir -p packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/{data/data/com.termux/files/usr/share/man/man1,DEBIAN}
+    mkdir -p output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/{DEBIAN,data/data/com.termux/files/usr/{lib/sshyp,bin,share/{bash-completion/completions,man/man1}}}
     echo "Package: sshyp
 Version: $version
 Section: utils
@@ -109,79 +156,61 @@ 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: 185
+Installed-Size: 14584
-" > packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/DEBIAN/control
+" > output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/DEBIAN/control
-    cp -r bin packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/
+    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/bin/sshyp.py packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/bin/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 packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/
+    cp -r share output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/
-    cp extra/manpage packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
+    cp extra/sshyp-completion.bash output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/bash-completion/completions/sshyp
-    gzip packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
+    cp extra/manpage output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
-    dpkg-deb --build --root-owner-group packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/
+    gzip output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1/sshyp.1
-    mv packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux.deb packages/
+    dpkg-deb --build --root-owner-group output/termuxtemp/sshyp_"$version"-"$revision"_all_termux/
-    rm -rf packages/termuxtemp
+    mv output/termuxtemp/sshyp_"$version"-"$revision"_all_termux.deb output/
-    echo -e "\nTermux packaging complete.\n"
+    rm -rf output/termuxtemp
-fi
+    echo -e "\nTermux packaging complete\n"
+} &&
 
-if [ "$distro" == "3" ] || [ "$distro" == "4" ] || [ "$distro" == "6" ] || [ "$distro" == "7" ] || [ "$distro" == "8" ]; then
+_create_rpm() {
-    echo -e '\nPackaging as generic...\n'
+    echo -e '\npackaging for Fedora...\n'
-    mkdir -p packages/generictemp/usr/share/man/man1
-    cp -r bin packages/generictemp/usr/
-    ln -s /usr/bin/sshyp.py packages/generictemp/usr/bin/sshyp
-    cp -r share packages/generictemp/usr/
-    cp extra/manpage packages/generictemp/usr/share/man/man1/sshyp.1
-    gzip packages/generictemp/usr/share/man/man1/sshyp.1
-    tar -C packages/generictemp -cvf packages/sshyp-"$version".tar.xz usr/
-    rm -rf packages/generictemp
-    sha512="$(sha512sum packages/sshyp-"$version".tar.xz | awk '{print $1;}')"
-    echo -e "\nsha512 sum:\n$sha512"
-    echo -e "\nGeneric packaging complete.\n"
-fi
-
-if [ "$distro" == "3" ]; then
-    echo -e '\nPackaging for Fedora...\n'
     rm -rf ~/rpmbuild
     rpmdev-setuptree
-    cp packages/sshyp-"$version".tar.xz ~/rpmbuild/SOURCES
+    cp output/sshyp-"$version".tar.xz ~/rpmbuild/SOURCES
     echo "Name:           sshyp
 Version:        "$version"
 Release:        "$revision"
 Summary:        A light-weight, self-hosted, synchronized password manager
 BuildArch:      noarch
-
+License:        GPL-3.0-only
-License:        GPLv3
 URL:            https://github.com/rwinkhart/sshyp
 Source0:        sshyp-"$version".tar.xz
-
+Requires:       python gnupg openssh-clients wl-clipboard
-Requires:       python gnupg openssh 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}/sshyp-"$version".tar.xz -C %{_sourcedir}
 cp -r %{_sourcedir}/usr %{buildroot}
-
 %files
 /usr/bin/sshyp
-/usr/bin/sshyp.py
+/usr/lib/sshyp/sshyp.py
-/usr/bin/sshync.py
+/usr/lib/sshyp/sshync.py
-/usr/bin/sshypRemote.py
+/usr/lib/sshyp/sshypRemote.py
+/usr/share/bash-completion/completions/sshyp
 %license /usr/share/licenses/sshyp/license
-%doc /usr/share/doc/sshyp/changelog
+%changelog /usr/share/doc/sshyp/changelog
 %doc /usr/share/man/man1/sshyp.1.gz
 " > ~/rpmbuild/SPECS/sshyp.spec
 rpmbuild -bb ~/rpmbuild/SPECS/sshyp.spec
-mv ~/rpmbuild/RPMS/noarch/* packages/
+mv ~/rpmbuild/RPMS/noarch/* output/
 rm -rf ~/rpmbuild
-echo -e "\nFedora packaging complete.\n"
+echo -e "\nFedora packaging complete\n"
-fi
+} &&
 
-if [ "$distro" == "4" ] || [ "$distro" == "8" ]; then
+_create_freebsd_pkg() {
-    echo -e '\nPackaging for FreeBSD...\n'
+    echo -e '\npackaging for FreeBSD...'
-    mkdir -p packages/FreeBSDtemp/bin
+    mkdir -p output/freebsdtemp/usr/{lib/sshyp,bin,share/{bash-completion/completions,man/man1}}
-    tar xf packages/sshyp-"$version".tar.xz -C packages/FreeBSDtemp
-    ln -s /usr/local/bin/python3 packages/FreeBSDtemp/bin/python3
     echo "name: sshyp
 version: \""$version"\"
 abi = \"FreeBSD:13:*\";
@@ -206,42 +235,57 @@ prefix: /
                       \"origin\" : \"x11/wl-clipboard\"
                    },
                 },
-" > packages/FreeBSDtemp/+MANIFEST
+" > output/freebsdtemp/+MANIFEST
-echo "/bin/python3
+echo "/usr/bin/sshyp
-/usr/bin/sshync.py
+/usr/lib/sshyp/sshync.py
-/usr/bin/sshyp
+/usr/lib/sshyp/sshyp.py
-/usr/bin/sshyp.py
+/usr/lib/sshyp/sshypRemote.py
-/usr/bin/sshypRemote.py
+/usr/share/bash-completion/completions/sshyp
 /usr/share/doc/sshyp/changelog
 /usr/share/licenses/sshyp/license
 /usr/share/man/man1/sshyp.1.gz
-" > packages/FreeBSDtemp/plist
+" > output/freebsdtemp/plist
-pkg create -m packages/FreeBSDtemp/ -r packages/FreeBSDtemp/ -p packages/FreeBSDtemp/plist -o packages/
+cp -r lib/. output/freebsdtemp/usr/lib/sshyp/
-rm -rf packages/FreeBSDtemp
+ln -s /usr/lib/sshyp/sshyp.py output/freebsdtemp/usr/bin/sshyp
-echo -e "\nFreeBSD packaging complete.\n"
+cp -r share output/freebsdtemp/usr/
-fi
+cp extra/sshyp-completion.bash output/freebsdtemp/usr/share/bash-completion/completions/sshyp
+cp extra/manpage output/freebsdtemp/usr/share/man/man1/sshyp.1
+gzip output/freebsdtemp/usr/share/man/man1/sshyp.1
+pkg create -m output/freebsdtemp/ -r output/freebsdtemp/ -p output/freebsdtemp/plist -o output/
+rm -rf output/freebsdtemp
+echo -e "\nFreeBSD packaging complete\n"
+} &&
 
-if [ "$distro" == "7" ] || [ "$distro" == "8" ]; then
+if [ "$1" == "generic" ]; then  # build scripts
-    echo -e '\nGenerating PKGBUILD...'
+    _create_generic
-    echo "# Maintainer: Randall Winkhart <idgr at tutanota dot com>
+elif [ "$1" == "pkgbuild" ]; then
-
+    _create_generic
-pkgname=sshyp
+    _create_pkgbuild
-pkgver="$version"
+elif [ "$1" == "apkbuild" ]; then
-pkgrel="$revision"
+    _create_generic
-pkgdesc='A light-weight, self-hosted, synchronized password manager'
+    _create_apkbuild
-url='https://github.com/rwinkhart/sshyp'
+elif [ "$1" == "haiku" ]; then  # distribution packages
-arch=('any')
+    _create_hpkg
-license=('GPL3')
+elif [ "$1" == "debian" ]; then
-depends=(python gnupg openssh xclip wl-clipboard)
+    _create_deb
-
+elif [ "$1" == "termux" ]; then
-source=(\""$source"\")
+    _create_termux
-sha512sums=('"$sha512"')
+elif [ "$1" == "fedora" ]; then
-
+    _create_generic
-package() {
+    _create_rpm
-
+elif [ "$1" == "freebsd" ]; then
-    tar xf sshyp-"\"\$pkgver\"".tar.xz -C "\"\${pkgdir}\""
+    _create_freebsd_pkg
-
+elif [ "$1" == "buildable-arch" ]; then
-}
+    _create_generic
-" > packages/PKGBUILD
+    _create_pkgbuild
-    echo -e "\nPKGBUILD generated.\n"
+    _create_apkbuild
+    if [[ $(pacman -Q dpkg) == "dpkg"* ]]; then
+        _create_deb
+        _create_termux
+    fi
+    if [[ "$(pacman -Q freebsd-pkg)" == "freebsd-pkg"* ]]; then
+        _create_freebsd_pkg
+    fi
+else
+    echo -e '\nusage: package.sh [target] <revision>\n\ntargets:\n mainline: pkgbuild apkbuild haiku fedora debian\n experimental: freebsd termux\n other: buildable-arch\n'
 fi

share/doc/sshyp/changelog

@@ -1,27 +1,55 @@
-sshyp v1.1.1
+sshyp v1.2.0
 
-the sheecrets update - patch one
+the brisk bahh update
 
-this is a polish/bug fix release that makes tweaks to the entry format (without breaking compatibility)
+this release focuses on speeding up the sshyp user experience by adding
+new features that reduce wasted time
 
 compatibility-breaking changes:
 
-- none; the entry format tweaks are backward compatible with sshyp v1.0.0+
+- new configuration options (quick-unlock, offline mode) have been added and
-    ^ the new format is slightly more efficient in terms of storage space
+the configuration files have been reorganized
-        ^ if you would like to upgrade to it, run this script (after updating to v1.1.1):
+    ^ simply running "sshyp tweak" and following the setup wizard will correct any compatibility
-          https://raw.githubusercontent.com/rwinkhart/sshyp-labs/main/extra/conversion-scripts/sshyp-refresh-1.1.1%2B.py
+    issues
+- for quick-unlock security, device names have been replaced with more secure device ids
+    ^ older device names are still compatible, but for security reasons it is recommended
+    to delete any pre-existing device names from the server and allow "sshyp tweak" to re-register
+    your devices
 
 user-facing features:
 
-- entries (when editing or adding) are now run through the new optimized_edit() function to strip trailing new lines
+- quick-unlock mode has been added
-and ensure the format of the entries is fully compatible with all of sshyp's functions
+    ^ this allows you to use a shortened version of your password by verifying that your device
+    is whitelisted on your sshyp server - it's both faster and more secure than standard unlock,
+    but it requires an active connection to your sshyp server to authenticate (otherwise it will
+    fall back to standard unlock)
+- full support for offline usage
+    ^ though sshyp could be used without a server before, it now can be configured to not attempt
+    to find one ever - this saves time and hides sync failure error messages
+- bash completions have been added
+    ^ if you have bash-completion installed, you can now use the tab key in bash to auto-complete
+    sshyp arguments and entry names (client only, not added for server-specific arguments)
+        ^ if you do not have bash-completion installed, you can source
+        /usr/share/bash-completion/completions/sshyp (Linux/BSD) or
+        /boot/system/data/bash-completion/completions/sshyp (Haiku) in your ~/.bashrc to
+        use this feature
 
-fixes:
+fixes/optimizations:
 
-- when adding a note to an entry, there is no longer a chance the first note line will be added as a url
+- fixed entries with multi-word titles failing to decrypt
-if the entry is using an older format/pass format
+- password generation is now much faster and more resource efficient
-- the gpg auto-generation file temporarily created by sshyp no longer includes extra spaces
+- there is no longer a length limit on generated passwords
-    ^ seems to serve no functional purpose - fixed for the sake of polish
+- improved visual consistency of help menus
+- rarely used modules are now imported only when needed
+- sshyp now uses one fewer configuration file
+
+other notable changes:
+
+- sshyp is now specifically licensed under the GPL-3.0-only (keyword: only)
+- sshyp now has some possible arguments and its own help menu when running in server mode
+- temporary files in /dev/shm are now generated with more complex names
+- sshyp now installs in /usr/lib/sshyp (Linux/BSD) or /system/lib/sshyp (Haiku) instead of
+/usr/bin or /bin (it is still symlinked to the old directories)
 
 <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
 

share/licenses/sshyp/license

@@ -2,9 +2,8 @@
     Copyright (C) 2022  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/>.