Updated changelog for release fr3.3

PKGBUILD

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

README.md

@@ -30,11 +30,9 @@ What sshyp definitely won't do:
 - Windows support (I don't use Windows and I have no interest in developing for it)
 
 # Installation
-Arch Linux (x86_64, aarch64)
+Arch Linux (all ISAs)
 
-Note: currently unavailable in the AUR (the older version, "rpass", will remain available until sshyp is stable)
-
-sshyp releases will be available in the Arch User Repository as 'sshyp'.
+sshyp releases are available in the Arch User Repository as 'sshyp'.
 
 Install with your preferred AUR helper or use:
 
@@ -44,17 +42,36 @@ cd sshyp
 makepkg -si
 ```
 
-Packaging for other distributions coming soon.
+Pre-built packages exist for Arch, Debian, and Termux. These can be downloaded from the releases page.
 
-# Usage
-Upon initial installation, be sure to run:
+# Building
+Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation.
+
+A packaging script is included in the root directory of the repo in order to package sshyp for your distribution. To package sshyp from source, simply run:
 
 ```
-sshyp config
+git clone https://github.com/rwinkhart/sshyp.git
+cd sshyp
+./package.sh
+```
+
+The packaging script has been tested on Arch Linux with dpkg as a dependency for Debian and Termux packaging.
+
+The AUR version and the packages attatched to the release tags were already packaged using this script.
+
+Currently, the script can create packages for Arch (PKGBUILD), Debian, Termux, and generic. Packaging for other distributions coming soon.
+
+# Usage
+Upon initial installation (on both the server and client devices), be sure to run:
+
+```
+sshyp tweak
 ```
 
 This command will allow you to configure the settings necessary for sshyp to function.
-As of right now, sshyp is rapidly changing, and as such, it is a good idea to run "sshyp config" after each update.
+As of right now, sshyp is rapidly changing, and as such, it is a good idea to run "sshyp tweak" after each update.
+
+Please note that decrypting and reading entries is disabled on server devices for security reasons. Only devices configured as clients can use the gpg key to decrypt entries.
 
 All available options can be found with:
 
@@ -62,21 +79,31 @@ All available options can be found with:
 sshyp --help
 ```
 
+Or alternatively, in the new manpage:
+
+```
+man sshyp
+```
+
 # Roadmap
 Short-term Goals:
 
-- re-write bad, leftover "rpass" code
 - create new file list w/color and w/o file extensions
-- create a man page
 - overhaul argument system
 - fix lots of bugs!
 - make lots of optimizations!
 
 Medium-term Goals:
 
-- create minimal GUI apps (Linux x86_64, Linux aarch64, Android aarch64)
+- create minimal GUI apps (Linux x86_64, Linux aarch64)
 - auto-completion on tab for CLI version
 
 Long-term Goals:
 
 - seize the thrones, shear the humans
+
+# Known Issues
+
+Currently, files deleted from a client or server may re-appear if another client that had the same file reconnects and later re-uploads it to the server. This will be addressed.
+
+Currently, if a client is missing folders that exist on the server, the contents of the missing folders will fail to download. A temporary workaround is to manually create the folders on the client. This will be addressed.

bin/sshync.py

@@ -1,216 +1,106 @@
 #!/usr/bin/python3
 
-# Main Targets:
-# TODO Make it so that when a new folder is created in sshyp, it is automatically created on the remote server
-# TODO Replace references to sshyp directory with a changeable variable
-# TODO Clean everything up and move sshync to a separate package
-# TODO Add dry run support
-# TODO use partition command instead of split for separating paths
-# TODO use classes!
-
-# sshync 2021.11.05.unreleased5
-# sshync was created to solve a problem with rpass/sshyp, and as such, sshync will be bundled with sshyp until it is
-# polished enough for a standalone release
-
-# sshync is a wrapper around sftp that allows easy remote directory synchronization via Python
-# openssh (on POSIX compliant Unix) is required
-
-# sshync will always overwrite the older files with the newer files, regardless of all other conditions
-#   ^the age is determined by the date and time of the last modification to the files
-
-# syncing via sshync is always done recursively
+# sshync 2022.01.16.unreleased12
 
 # external modules
 
-from os import walk
-from os import system as term
-from os.path import getmtime
-from os.path import join as path_join
+from os import path, system, walk
+from os.path import getmtime, join, expanduser
+from sys import exit as s_exit
+from pathlib import Path
 
 
-# internal modules
+# utility functions
+
+def get_titles_mods(_directory, _destination, _user_data):
+    _title_list, _mod_list = [], []
+    Path(path.expanduser('~/.config/sshync')).mkdir(0o700, parents=True, exist_ok=True)  # create config directory
+    # local fetching
+    if _destination == 'l':
+        open(expanduser('~/.config/sshync/database'), 'w').write('')  # blanks out database file
+        for _root, _directories, _files in walk(_directory):
+            for _filename in _files:
+                _title_list.append(join(_root.replace(_directory, '', 1), _filename))
+                _mod_list.append(int(getmtime(join(_root, _filename))))
+        for _title in _title_list:
+            open(expanduser('~/.config/sshync/database'), 'a').write(str(_title) + '\n')
+        open(expanduser('~/.config/sshync/database'), 'a').write('^&*\n')
+        for _mod in _mod_list:
+            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]} \"python -c 'import sshync"
+               f"; sshync.get_titles_mods(\"'\"{_user_data[4]}\"'\", \"'\"l\"'\", \"'\"{_user_data}\"'\")'\"")
+        system(f"sftp -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:"
+               f"'{expanduser(f'/home/{_user_data[0]}/.config/sshync/database')}' "
+               f"'{expanduser('~/.config/sshync/')}'")
+        _titles, _sep, _mods = ' '.join(open(expanduser('~/.config/sshync/database')).readlines()).replace('\n', '')\
+            .partition('^&*')
+        _title_list, _mod_list = _titles.split(' ')[:-1], _mods.split(' ')[1:]
+    return _title_list, _mod_list
 
 
-# recursively scans a local directory for all files and saves file paths and mod times to lists
-def get_file_paths_mod(directory, name_database, time_database):
-    file_paths = []
-    temp_mod_times = []
-    mod_times = []
-    for root, directories, files in walk(directory):
-        for filename in files:
-            filepath = path_join(root, filename)
-            file_paths.append(filepath)
-            temp_mod_times.append(str(getmtime(filepath)))
-    for time in temp_mod_times:
-        mod_times.append(round(float(time), 2))
-    open(name_database, 'w').write(str(file_paths))
-    open(time_database, 'w').write(str(mod_times))
-    return file_paths, mod_times
+def sort_titles_mods(_list_1, _list_2):
+    _title_list_2_sorted, _mod_list_2_sorted = [], []
+    # title sorting
+    for _title in _list_1[0]:
+        if _title in _list_2[0]:
+            _title_list_2_sorted.append(_title)
+    for _title in _list_2[0]:
+        if _title not in _title_list_2_sorted:
+            _title_list_2_sorted.append(_title)
+    # mod time sorting
+    for _title in _title_list_2_sorted:
+        _mod_list_2_sorted.append(_list_2[1][_list_2[0].index(_title)])
+    return _title_list_2_sorted, _mod_list_2_sorted
 
 
-# recursively scans a remote directory for all files and saves file paths and mod times to lists
-def get_file_paths_mod_remote(profile_dir):
-    # import profile data
-    profile_data = get_profile(profile_dir)
-    user = profile_data[0].replace('\n', '')
-    ip = profile_data[1].replace('\n', '')
-    port = profile_data[2].replace('\n', '')
-    remote_dir = profile_data[4].replace('\n', '')
-    identity = profile_data[5].replace('\n', '')
-    term("ssh -i " + "'" + identity + "'" + " -p " + port + " " + user + "@" + ip + " \"python -c \'import sshync; "
-                                                                                    "sshync.get_file_paths_mod(" +
-         "\"'\"" + remote_dir + "/\"'\", " + "\"'\"/var/lib/sshyp/sshyncdatabase_names\"'\", " +
-         "\"'\"/var/lib/sshyp/sshyncdatabase_times\"'\")\'\"")
-    term(
-        'sftp -P ' + port + ' ' + user + '@' + ip + ':/var/lib/sshyp/sshyncdatabase_names ' +
-        '/var/lib/sshyp/sshyncdatabase_names')
-    term(
-        'sftp -P ' + port + ' ' + user + '@' + ip + ':/var/lib/sshyp/sshyncdatabase_times ' +
-        '/var/lib/sshyp/sshyncdatabase_times')
-    remote_mod_names = (open('/var/lib/sshyp/sshyncdatabase_names').read()).replace('[', '').replace(']', '').replace(
-        ' ', '').replace("'", '').split(',')
-    remote_mod_times = (open('/var/lib/sshyp/sshyncdatabase_times').read()).replace('[', '').replace(']', '').replace(
-        ' ', '').replace("'", '').split(',')
-    return remote_mod_names, remote_mod_times
+def make_profile(_profile_dir, _local_dir, _remote_dir, _identity, _ip, _port, _user):
+    open(_profile_dir, 'w').write(_user + '\n' + _ip + '\n' + _port + '\n' + _local_dir + '\n' + _remote_dir + '\n' +
+                                  _identity + '\n')
 
 
-# regular profiles check the mod time of every individual file in the directory, making them slow but versatile
-def make_profile(profile_dir, local_dir, remote_dir, identity, ip, port, user):
-    open(profile_dir, 'w').write(user + '\n' + ip + '\n' + port + '\n' + local_dir + '\n' + remote_dir + '\n' + identity
-                                 + '\n')
-
-
-# returns the settings for a specified profile
-def get_profile(profile_dir):
+def get_profile(_profile_dir):
     try:
-        profile_data = open(profile_dir).readlines()
+        _profile_data = open(_profile_dir).readlines()
     except (FileNotFoundError, IndexError):
-        profile_data = 0
-    return profile_data
+        print('\nEither the profile does not exist, or it is corrupted.\n')
+        _profile_data = None
+        s_exit()
+    # extract data from profile
+    _user = _profile_data[0].replace('\n', '')
+    _ip = _profile_data[1].replace('\n', '')
+    _port = _profile_data[2].replace('\n', '')
+    _local_dir = _profile_data[3].replace('\n', '')
+    _remote_dir = _profile_data[4].replace('\n', '')
+    _identity = _profile_data[5].replace('\n', '')
+    return _user, _ip, _port, _local_dir, _remote_dir, _identity
 
 
-# sorts name lists so that local and remote are in the same order
-def name_sort(local_names, remote_names):
-    remote_names_new = []
-    for ele in local_names:
-        if ele in remote_names:
-            remote_names_new.append(ele)
-    for ele in remote_names:
-        if ele not in remote_names_new:
-            remote_names_new.append(ele)
-    return remote_names_new
-
-
-# sorts time lists to compensate for name list re-ordering
-def time_sort(old_names, new_names, old_times):
-    remote_mod_times_new = []
-    new_pos = -1
-    for title in new_names:
-        new_pos += 1
-        if title in old_names:
-            old_pos = old_names.index(title)
-            try:
-                remote_mod_times_new.append(old_times[old_pos])
-            except IndexError:
-                pass
-    return remote_mod_times_new
-
-
-getter_loop_count = -1
-
-
-def loop_getter(split_remote_dir):
-    global getter_loop_count
-    getter_loop_count += 1
-    new_var = split_remote_dir[getter_loop_count] + '/'
-    return new_var
-
-
-def run_profile(profile_dir):
-    # import profile data
-    profile_data = get_profile(profile_dir)
-    user = profile_data[0].replace('\n', '')
-    ip = profile_data[1].replace('\n', '')
-    port = profile_data[2].replace('\n', '')
-    local_dir = profile_data[3].replace('\n', '')
-    remote_dir = profile_data[4].replace('\n', '')
-    identity = profile_data[5].replace('\n', '')
-    # get file modification times
-    local_mod_names, local_mod_times = get_file_paths_mod(local_dir + '/', '/var/lib/sshyp/sshyncdatabase_names',
-                                                          '/var/lib/sshyp/sshyncdatabase_times')
-    remote_mod_times = []
-    remote_mod_names, remote_mod_times_temp = get_file_paths_mod_remote('/var/lib/sshyp/sshyp.sshync')
-    try:
-        for time in remote_mod_times_temp:  # remove quotes from remote_mod_times
-            remote_mod_times.append(float(time))
-    except ValueError:
-        pass
-    lmod_short = []
-    rmod_short = []
-    matching_names = []
-    matching_times_local = []
-    matching_times_remote = []
-    for lmod in local_mod_names:
-        lmod_short.append(lmod.replace(local_dir, ''))
-    for rmod in remote_mod_names:
-        rmod_short.append(rmod.replace(remote_dir, ''))
-    rmod_short_old = rmod_short
-    rmod_short = name_sort(lmod_short, rmod_short)
-    remote_mod_times = time_sort(rmod_short_old, rmod_short, remote_mod_times)
-    i = -1
-    for lshort in lmod_short:
-        i += 1
-        if lshort in rmod_short:
-            matching_names.append(lshort)
-            matching_times_local.append(local_mod_times[i])
+def run_profile(_profile_dir):
+    _user_data = get_profile(_profile_dir)
+    _remote_titles_mods_saver = get_titles_mods(_user_data[4], 'r', _user_data)  # saved to prevent re-walking directory
+    _index_l = sort_titles_mods(_remote_titles_mods_saver, get_titles_mods(_user_data[3], 'l', _user_data))
+    _index_r = sort_titles_mods(_index_l, _remote_titles_mods_saver)
+    _i = -1
+    for _title in _index_l[0]:
+        _i += 1
+        if _title in _index_r[0]:
+            # compare mod times and sync
+            if int(_index_l[1][_i]) > int(_index_r[1][_i]):
+                print(f"[{_title}] Local is newer, uploading...")
+                system(f"sftp -p -q -i '{_user_data[5]}' -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:"
+                       f"{_user_data[4]}{'/'.join(_title.split('/')[:-1]) + '/'} <<< $'put {_user_data[3]}{_title}'")
+            elif int(_index_l[1][_i]) < int(_index_r[1][_i]):
+                print(f"[{_title}] Remote is newer, downloading...")
+                system(f"sftp -p -q -i '{_user_data[5]}' -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:"
+                       f"'{_user_data[4]}'{_title} {_user_data[3]}{'/'.join(_title.split('/')[:-1]) + '/'}")
         else:
-            print('Uploading ' + lshort)
-            lshort_split = lshort.replace('/', '', 1).split('/')
-
-            c = -1
-            for _ in lshort_split:
-                c += 1
-
-            global getter_loop_count
-            getter_loop_count = -1
-            q = ''
-            for _ in range(c):
-                q += loop_getter(lshort_split)
-
-            term('sftp -p -i ' + "'" + identity + "' " + '-P ' + port + ' ' + user + '@' + ip + ':' + remote_dir + q +
-                 " <<< $'put " + local_dir + lshort.replace('/', '', 1) + "'")
-    i = -1
-    for rshort in rmod_short:
-        i += 1
-        if rshort in lmod_short:
-            matching_times_remote.append(float(remote_mod_times[i]))
-        else:
-            print('Downloading ' + rshort)
-            term('sftp -p -i ' + "'" + identity + "' " + '-P ' + port + ' ' + user + '@' + ip + ':' + remote_dir +
-                 rshort.replace('/', '', 1) + ' ' + local_dir + rshort.replace('/', '', 1))
-    i = -1
-    for ltime in matching_times_local:
-        i += 1
-        ltime = int(ltime)
-        if ltime == int(matching_times_remote[i]):
-            print('Local ' + matching_names[i] + ' is up to date, not syncing.')
-        elif ltime > int(matching_times_remote[i]):
-            print('Local ' + matching_names[i] + ' is newer, uploading.')
-            matching_names_split = matching_names[i].replace('/', '', 1).split('/')
-
-            c = -1
-            for _ in matching_names_split:
-                c += 1
-
-            getter_loop_count = -1
-            q = ''
-            for _ in range(c):
-                q += loop_getter(matching_names_split)
-
-            term('sftp -p -i ' + "'" + identity + "' " + '-P ' + port + ' ' + user + '@' + ip + ':' + remote_dir + q +
-                 " <<< $'put " + local_dir + matching_names[i].replace('/', '', 1) + "'")
-
-        elif ltime < int(matching_times_remote[i]):
-            print('Local ' + matching_names[i] + ' is older, downloading.')
-            term('sftp -p -i ' + "'" + identity + "' " + '-P ' + port + ' ' + user + '@' + ip + ':' + remote_dir +
-                 matching_names[i].replace('/', '', 1) + ' ' + local_dir + matching_names[i].replace('/', '', 1))
+            print(f"[{_title}] Not on remote server, uploading...")
+            system(f"sftp -p -q -i '{_user_data[5]}' -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:{_user_data[4]}"
+                   f"{'/'.join(_title.split('/')[:-1]) + '/'} <<< $'put {_user_data[3]}{_title}'")
+    for _title in _index_r[0]:
+        if _title not in _index_l[0]:
+            print(f"[{_title}] Not in local directory, downloading...")
+            system(f"sftp -p -q -i '{_user_data[5]}' -P {_user_data[2]} {_user_data[0]}@{_user_data[1]}:"
+                   f"'{_user_data[4]}{_title}' {_user_data[3]}{'/'.join(_title.split('/')[:-1]) + '/'}")

extra/changelog-total

@@ -1,5 +1,424 @@
 <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
 
+sshyp 2022.01.17.fr3.3
+
+The Boxing Update - Patch 3
+
+This release is a hotfix for 2022.01.16.fr3.2. It fixes major bugs, especially with Termux.
+
+Changes:
+
+- the temporary directory for Termux is now sym-linked with its full path (no longer dangling)
+- the copy function can now properly detect if Termux is being used
+- ~/.config is created, if it does not already exist
+- "sshyp shear" now functions again, as a bug with the lock file has been fixed
+- sshync -should- now properly detect the database file on all platforms (was broken on Termux)
+- total lines of code have been slightly reduced with various small optimizations
+
+Additions planned for minor releases:
+
+** updated the manpage with more information regarding how sshyp works and how to set it up
+** ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+** reduced total lines of code with small optimizations
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+** sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+** sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+** allow for multi-client deletion... somehow (in sshync)
+** when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+** imporove password generator to guarantee more secure results
+** enforce permissions on the server-side
+** allow for copying entire notes (not just first line)
+** ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+** create separate gui frontend targetting mobile and desktop Linux
+** auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.16.fr3.2
+
+The Boxing Update - Patch 2
+
+This release is a hotfix for 2022.01.16.fr3.1. It fixes major bugs, including one massively impacting Termux.
+
+Changes:
+
+- sshyp now uses a symlink to the temporary storage directory, allowing for easy implementation of different temporary directories on different platforms
+    ^ the first usage of this is enabling the use of temporary storage on Termux
+- sshync now properly auto-generates its config directory 
+
+Additions planned for minor releases:
+
+** updated the manpage with more information regarding how sshyp works and how to set it up
+** ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+** reduced total lines of code with small optimizations
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+** sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+** sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+** allow for multi-client deletion... somehow (in sshync)
+** when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+** imporove password generator to guarantee more secure results
+** enforce permissions on the server-side
+** allow for copying entire notes (not just first line)
+** ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+** create separate gui frontend targetting mobile and desktop Linux
+** auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.16.fr3.1
+
+The Boxing Update - Patch 1
+
+This release is a hotfix for 2022.01.13.fr3. It fixes sshync/syncing support after the changes in the last release.
+
+Changes:
+
+- sshync has been updated to work with the new config directory
+- sshync now uses its own directory to store the database file
+    ^ this is preperation for separating sshync into its own package
+- expanduser lines in sshyp have been simplified (no user-facing impact)
+
+Additions planned for minor releases:
+
+** updated the manpage with more information regarding how sshyp works and how to set it up
+** ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+** reduced total lines of code with small optimizations
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+** sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+** sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+** allow for multi-client deletion... somehow (in sshync)
+** when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+** imporove password generator to guarantee more secure results
+** enforce permissions on the server-side
+** allow for copying entire notes (not just first line)
+** ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+** create separate gui frontend targetting mobile and desktop Linux
+** auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.13.fr3
+
+The Boxing Update
+
+This release adapts sshyp to be compatible with Termux and allows for packaging for various distributions in addition to Arch Linux.
+
+Features:
+
+- the copy function now has support for termux-clipboard-set from termux-api
+    ^ this allows clipboard functionality to work on Termux
+
+Changes:
+
+- sshyp no longer writes to/reads from /var
+    ^ configuration files are now stored under the user's home directory in ~/.config/sshyp
+    ^ this change allows for compatibility with less standard environments, such as Termux on Android
+
+Additions planned for minor releases:
+
+** updated the manpage with more information regarding how sshyp works and how to set it up
+** ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+** reduced total lines of code with small optimizations
+
+&&
+
+Planned for next major update (fr4, The sshyp Doing a Split Update):
+
+sshyp:
+** sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
+
+sshync:
+** sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+** allow for multi-client deletion... somehow (in sshync)
+** when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+** imporove password generator to guarantee more secure results
+** enforce permissions on the server-side
+** allow for copying entire notes (not just first line)
+** ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+** create separate gui frontend targetting mobile and desktop Linux
+** auto-completion on tab (currently unsure of best way to make this work)
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2022.01.10.fr2.3
+
+The Lighter Update - Patch 3
+
+This release is a hotfix for 2021.12.01.fr2.2. It features critical security fixes and quality-of-life improvements.
+
+New features:
+
+- a man page has been added
+
+Changes:
+
+- folders in /dev/shm are no longer created before input from the user (fixes critical security flaws)
+- fixed syncing of files (specifically downloading) with special characters, such as '('
+- fixed program still continuing after trying to edit an entry that doesn't exist
+- the gen command has been updated to use the newer notetaking system
+- printing functions in sshyp have been combined into one function (arguments determine section to print, fewer lines of code)
+- file not found exceptions have been re-implemented
+- .lower() is now used to remove casing when checking inputs
+- removed an old reference to "rsync" in the configuration dialog
+
+Planned for next major update (The Fluffier Update):
+
+- new visual features
+    ^ this includes the new file list and thematic text art. sshyp will be
+    getting a retro computing theme.
+- packages for more environments
+    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
+    Debian/Ubuntu and Fedora packaging will come later.
+- imporove password generator to guarantee more secure results
+- when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+
+Planned for next, next major update (The Shears Update Pt. 1):
+
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- allow for multi-client deletion... somehow (in sshync)
+- detatch sshync and make it a separate package
+
+Planned for next, next, next major update (The Shears Update Pt. 2):
+
+- ability to pass entries as arguments for more functions
+- auto-completion on tab (currently unsure of best way to make this work)
+
+Backlog:
+
+- package for more Linux distributions, such as Debian and Fedora
+- create separate gui frontend targetting mobile and desktop Linux
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2021.12.01.fr2.2
+
+The Lighter Update - Patch 2
+
+This release is a hotfix for 2021.12.01.fr2.1.
+
+Changes:
+
+- a major fix for "/var/lib/sshync_database" needing to already exist server-side
+- a major fix for syncing functionality  (it should actually work now)
+- silenced some sftp output
+
+An fr2.3 patch is planned for this version. It will include the following:
+
+- fixes for any new bugs that may be discovered in the new sshyp and sshync code
+- the gen command in sshyp will be updated to use the newer notetaking system
+- printing functions in sshyp will be combined into one function (arguments will determine section to print)
+- file not found exceptions will be re-implemented
+- when syncing, a check will be made to see if any folders are not on all devices and this will be corrected
+
+Planned for next major update (The Fluffier Update):
+
+- new visual features
+    ^ this includes the new file list and thematic text art. sshyp will be
+    getting a retro computing theme.
+- packages for more environments
+    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
+    Debian/Ubuntu and Fedora packaging will come later.
+- imporove password generator to guarantee more secure results
+
+Planned for next, next major update (The Shears Update Pt. 1):
+
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- allow for multi-client deletion... somehow
+- detatch sshync and make it a separate package
+- manpage
+
+Planned for next, next, next major update (The Shears Update Pt. 2):
+
+- ability to pass entries as arguments for more functions
+- auto-completion on tab (currently unsure of best way to make this work)
+
+Backlog:
+
+- package for more Linux distributions, such as Debian and Fedora
+- create separate gui frontend targetting mobile and desktop Linux
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2021.12.01.fr2.1
+
+The Lighter Update - Patch 1
+
+This release is a hotfix for 2021.12.01.fr2.
+
+Changes:
+
+- fixed a bug where "sshyp tweak" would not function on new installations
+- moved the argument parser to the global process
+- running "sshyp version" or "sshyp -v" no longer triggers syncing
+- folders are now created natively with Python, rather than through system commands
+
+An fr2.2 patch is planned for this version. It will include the following:
+
+- fixes for any new bugs that may be discovered in the new sshyp and sshync code
+- the gen command in sshyp will be updated to use the newer notetaking system
+- printing functions in sshyp will be combined into one function (arguments will determine section to print)
+- file not found exceptions will be re-implemented
+
+Planned for next major update (The Fluffier Update):
+
+- new visual features
+    ^ this includes the new file list and thematic text art. sshyp will be
+    getting a retro computing theme.
+- packages for more environments
+    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
+    Debian/Ubuntu and Fedora packaging will come later.
+- imporove password generator to guarantee more secure results
+
+Planned for next, next major update (The Shears Update Pt. 1):
+
+- enforce permissions on the server-side
+- allow for copying entire notes (not just first line)
+- allow for multi-client deletion... somehow
+- detatch sshync and make it a separate package
+- manpage
+
+Planned for next, next, next major update (The Shears Update Pt. 2):
+
+- ability to pass entries as arguments for more functions
+- auto-completion on tab (currently unsure of best way to make this work)
+
+Backlog:
+
+- package for more Linux distributions, such as Debian and Fedora
+- create separate gui frontend targetting mobile and desktop Linux
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
+sshyp 2021.12.01.fr2
+
+The Lighter Update
+
+This release features a major re-write of old "rpass" code.
+sshyp is now more reliable and better documented.
+
+New features:
+
+- a full re-write of the old "rpass" code used in the last release
+    ^ includes more reliable argument parsing and various optimizations
+- a full re-write of "sshync", many issues fixed
+    ^fixed many instances where sshync would refuse to upload/download
+    ^fixed errors that were being thrown despite sshync working as intended
+- new folders are now also created on the server
+
+Changes:
+
+- nested folders actually work now
+- multi-word entry and folder titles are fixed
+
+An fr2.1 patch is planned for this version. It will include the following:
+
+- fixes for any new bugs that may be discovered in the new sshyp and sshync code
+- the gen command in sshyp will be updated to use the newer notetaking system
+- printing functions in sshyp will be combined into one function (arguments will determine section to print)
+- file not found exceptions will be re-implemented
+- the argument parser will be moved to the global process (no need for it to be in a function)
+- folders will be created natively in python
+
+Planned for next major update (The Fluffier Update):
+
+- new visual features
+    ^ this includes the new file list and thematic text art. sshyp will be
+    getting a retro computing theme.
+- packages for more environments
+    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
+    Debian/Ubuntu and Fedora packaging will come later.
+- imporove password generator to guarantee more secure results
+
+Planned for next, next major update (The Shears Update Pt. 1):
+
+- allow for copying entire notes (not just first line)
+- allow for multi-client deletion... somehow
+- detatch sshync and make it a separate package
+- manpage
+
+Planned for next, next, next major update (The Shears Update Pt. 2):
+
+- ability to pass entries as arguments for more functions
+- auto-completion on tab (currently unsure of best way to make this work)
+
+Backlog:
+
+- package for more Linux distributions, such as Debian and Fedora
+- create separate gui frontend targetting mobile and desktop Linux
+
+<><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
+
 sshyp 2021.11.05.fr1
 
 First public release of sshyp.

extra/manpage

@@ -0,0 +1,74 @@
+.TH sshyp 1 "10 January 2022" "2021.12.01.fr2.3" "sshyp man page"
+.SH NAME
+sshyp \- A very simple self-hosted, synchronized password manager. Alternative to GNU pass. 
+.SH SYNOPSIS
+sshyp [OPTION] [[FLAG]] [/<entry name>]
+.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
+Setting up sshyp for the first time or altering its configuration (also recommended after major updates):
+    sshyp tweak
+    *follow the prompts
+
+Reading an existing entry saved as ~/.password-pasture/development/github.gpg:
+    sshyp /development/github
+
+Copying the password of an existing entry saved as ~/.password-pasture/financial/bank.gpg:
+    sshyp copy -p
+    *answer the prompt with "/financial/bank"
+    *enter decryption password
+
+Editing the username of an existing entry saved as ~/.password-pasture/game.gpg:
+    sshyp edit -u
+    *answer the first prompt with "game"
+    *follow the prompts
+
+Making a new entry using the built-in password generator:
+    sshyp gen
+    *follow the prompts
+
+Creating a note-only entry:
+    sshyp add -n
+    *follow the prompts
+
+Syncing entries with the server:
+    sshyp sync
+
+.SH OPTIONS
+In order to quickly read an existing entry, just run "sshyp </entry name>".
+
+Options for other operations are as follows:
+
+ help/--help/-h           bring up the help menu
+ version/-v               display sshyp version info
+ tweak                    configure sshyp
+ add                      add an entry
+ gen                      generate a new password
+ edit                     edit an existing entry
+ copy                     copy details of an entry to your clipboard
+ shear/-rm                delete an existing entry
+ sync/-s                  manually sync the entry directory via sshync
+.SH FLAGS
+add:
+ password/-p             add a password entry
+ note/-n                 add a note entry
+ folder/-f               add a new folder for entries
+edit:
+ rename/relocate/-r      rename or relocate an entry
+ username/-u             change the username of an entry
+ password/-p             change the password of an entry
+ note/-n                 change the note attached to an entry
+ url/-l                  change the url attached to an entry
+copy:
+ username/-u             copy the username of an entry to your clipboard
+ password/-p             copy the password of an entry to your clipboard
+ url/-l                  copy the URL of an entry to your clipboard
+ note/-n                 copy the note of an entry to your clipboard
+gen:
+ update/-u               generate a password for an existing entry
+.SH BUGS
+This is more of a current limitation than a bug, but:
+
+Currently, if multiple clients are connected to a single server and a client deletes an entry, the entry is correctly deleted from the client and the server, but since the entry still exists on the other client, the next time it syncs the file will be re-uploaded. This will be fixed in an upcoming release of the syncing backend, sshync.
+.SH AUTHOR
+Randall Winkhart (https://github.com/rwinkhart)

package.sh

@@ -0,0 +1,125 @@
+#!/bin/bash
+
+# This script packages sshyp (from source) for various Linux environments.
+
+# NOTE It is recommended to instead use the latest officially packaged and tagged release.
+# NOTE If using Arch, it is recommended to install from the AUR or from the PKGBUILD attatched to the latest official release.
+# NOTE As of release fr4, sshync will become a separate package and thus a dependency for sshyp. sshync is automatically installed with the PKGBUILD version.
+
+echo -e '\nOptions (please enter the number only):'
+echo -e '\nDistribution Packages:\n\n1. Debian\n2. Termux\n3. Generic (used for PKGBUILD/APKBUILD)'
+echo -e '\nBuild Scripts:\n\n4. Alpine Linux (APKBUILD)\n5. Arch Linux (PKGBUILD, also builds local generic package)'
+echo -e '\nOther:\n\n6. All (generates all distribution packages 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" == "4" ] || [ "$distro" == "5" ] || [ "$distro" == "6" ]; 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
+
+if [ "$distro" == "1" ] || [ "$distro" == "6" ]; then
+    echo -e '\nPackaging for Debian...\n'
+    mkdir -p packages/debiantemp/sshyp_"$version"-"$revision"_all/{DEBIAN,usr}
+    mkdir -p packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1
+    echo "Package: sshyp
+Version: $version
+Section: utils
+Architecture: all
+Maintainer: Randall Winkhart <idgr at tutanota dot com>
+Description: A light-weight, self-hosted, synchronized password manager
+Depends: python3, gnupg, openssh-client, nano, xclip, wl-clipboard
+Priority: optional
+Installed-Size: 35
+" > packages/debiantemp/sshyp_"$version"-"$revision"_all/DEBIAN/control
+    cp -r bin packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/
+    cp -r share packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/
+    cp extra/manpage packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
+    gzip packages/debiantemp/sshyp_"$version"-"$revision"_all/usr/share/man/man1/sshyp.1
+    dpkg-deb --build --root-owner-group packages/debiantemp/sshyp_"$version"-"$revision"_all/
+    mv packages/debiantemp/sshyp_"$version"-"$revision"_all.deb packages/
+    rm -rf packages/debiantemp
+    echo -e "\nDebian packaging complete.\n"
+fi
+
+if [ "$distro" == "2" ] || [ "$distro" == "6" ]; then
+    echo -e '\nPackaging for Termux...\n'
+    mkdir -p packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/{data,DEBIAN}
+    mkdir -p packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux/data/data/com.termux/files/usr/share/man/man1
+    echo "Package: sshyp
+Version: $version
+Section: utils
+Architecture: all
+Maintainer: Randall Winkhart <idgr at tutanota dot com>
+Description: A light-weight, self-hosted, synchronized password manager
+Depends: python, gnupg, openssh, nano, termux-api, termux-am
+Priority: optional
+Installed-Size: 35
+" > packages/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 share packages/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
+    gzip packages/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/
+    mv packages/termuxtemp/sshyp_"$version"-"$revision"_all_termux.deb packages/
+    rm -rf packages/termuxtemp
+    echo -e "\nTermux packaging complete.\n"
+fi
+
+if [ "$distro" == "3" ] || [ "$distro" == "5" ] || [ "$distro" == "6" ]; then
+    echo -e '\nPackaging as generic...\n'
+    mkdir -p packages/archtemp/usr
+    cp -r bin packages/archtemp/usr/
+    cp -r share packages/archtemp/usr/
+    mkdir -p packages/archtemp/usr/share/man/man1
+    cp extra/manpage packages/archtemp/usr/share/man/man1/sshyp.1
+    gzip packages/archtemp/usr/share/man/man1/sshyp.1
+    tar -C packages/archtemp -cvf packages/sshyp-"$version".tar.xz usr/
+    rm -rf packages/archtemp
+    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" == "5" ] || [ "$distro" == "6" ]; then
+    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=('GPL3')
+depends=(python gnupg openssh nano xclip wl-clipboard)
+
+source=(\""$source"\")
+sha512sums=('"$sha512"')
+
+package() {
+
+    tar xf sshyp-"\"\$pkgver\"".tar.xz -C "\"\${pkgdir}\""
+
+}
+" > packages/PKGBUILD
+    echo -e "\nPKGBUILD generated.\n"
+fi
+
+if [ "$distro" == "4" ]; then
+    echo -e '\nThis packaging format is not yet supported, but will be in the near future!\n'
+fi

share/doc/sshyp/changelog

@@ -1,49 +1,62 @@
-sshyp 2021.11.05.fr1
+sshyp 2022.01.17.fr3.3
 
-First public release of sshyp.
+The Boxing Update - Patch 3
 
-This release fixes major bugs from rpass and rebrands the project.
-
-New features:
-
-- an entirely new syncing back-end called sshync (custom Python wrapper around sftp)
-    ^ in thoery, all syncing-related data loss should now be fixed, however, this new
-    system has just been created and is still under testing. Maybe wait for a few patches
-    before trusting this system.
+This release is a hotfix for 2022.01.16.fr3.2. It fixes major bugs, especially with Termux.
 
 Changes:
 
-- branding has been updated to reflect new project name and goals
-- custom directories, custom ssh keys, and offline only mode are removed (may be temporary)
-    ^ the configuration wizard is being re-written in the next major update
+- the temporary directory for Termux is now sym-linked with its full path (no longer dangling)
+- the copy function can now properly detect if Termux is being used
+- ~/.config is created, if it does not already exist
+- "sshyp shear" now functions again, as a bug with the lock file has been fixed
+- sshync -should- now properly detect the database file on all platforms (was broken on Termux)
+- total lines of code have been slightly reduced with various small optimizations
 
-Planned for next update (The Fluffy Update):
+Additions planned for minor releases:
 
-- modularized and optimized code
-    ^ some older, bad code from "rpass" will be re-written.
-- new visual features
-    ^ this includes the new file list and thematic text art. sshyp will be
-    getting a retro computing theme.
-- packages for more environments
-    ^ "sshyp" will be officially packaged for Arch Linux, Alpine Linux, and Termux (Android).
-    Debian/Ubuntu and Fedora packaging will come later.
+** updated the manpage with more information regarding how sshyp works and how to set it up
+** ensured that it is now impossible for ghosts of entires to remain in /dev/shm
+** reduced total lines of code with small optimizations
 
-Planned for next update (The Sheep w/Shears Update):
+&&
 
-- allow for copying entire notes (not just first line)
-- allow for multi-client deletion... somehow
-- ability to pass entries as arguments for more functions
-- detatch sshync and make it a separate package
-- manpage
+Planned for next major update (fr4, The sshyp Doing a Split Update):
 
-Planned, no timeline:
+sshyp:
+** sshyp has recieved a major visual overhaul
+    ^ this includes the new file list and thematic text art
 
-- create separate gui frontend targetting mobile devices (Android + Linux phones)
-    ^ the gui will also function on desktop linux
-- package for more Linux distributions, such as Debian and Fedora)
-- auto-completion on tab (currently unsure of best way to make this work)
+sshync:
+** sshync has been split into a separate package and now has standalone functionality as a backup/syncing utility
+    ^ more details will be available in the sshync repo, once it is created
+
+&&
+
+Planned for next, next major update (fr5, The Farmer Shearing the sshyp Update):
+
+** allow for multi-client deletion... somehow (in sshync)
+** when syncing, a check is made to see if any folders are not on all devices - if the check comes back true, it is corrected (in sshyp)
+** imporove password generator to guarantee more secure results
+** enforce permissions on the server-side
+** allow for copying entire notes (not just first line)
+** ability to pass entries as arguments for more functions
+
+&&
+
+Backlog:
+
+** create separate gui frontend targetting mobile and desktop Linux
+** auto-completion on tab (currently unsure of best way to make this work)
 
 <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>
 
-The full history of changes to "sshyp" and "rpass" can be found on the following page:
+The full history of changes to "sshyp" can be found on the following page:
 https://raw.githubusercontent.com/rwinkhart/sshyp/main/extra/changelog-total
+
+Legend:
+
+** = feature/change not yet finished/implemented
+-  = feature/change implemented and pushed upstream
+^  = note regarding the above feature/change
+&& = visual separater for patch notes for different planned major version releases