No longer package Fedora with the "All" option (to ensure Fedora is only packaged from itself)

Former-commit-id: 84a32263eb6ceb32063ba0c3fd6ecc49c59fc579 [formerly 90454645e0]
Former-commit-id: 8e57ca2e811b3cbf73c9356c103ae189022f9a9f

README.md

@@ -1,12 +1,14 @@
-# sshyp
+![sshyp](https://github.com/rwinkhart/sshyp/blob/main/extra/sshyp-linux-banner.png)
-A very simple self-hosted, synchronized password manager for UNIX(-like) systems (currently Haiku/FreeBSD/Linux). Alternative to (and compatible with) pass/password-store.
 
-Compatible with entries created by pass/password-store.
+sshyp is a very simple self-hosted, synchronized password manager for UNIX(-like) systems (currently Haiku/FreeBSD/Linux).
 
-The only password-store compatible CLI password manager available for Haiku.
+sshyp is compatible with entries created by pass/password-store, as its original goal was to be like pass/password-store, but far more user-friendly to synchronize with a self-hosted server.
 
-"sshyp" stands for "sshync passwords", or "ssh sync passwords".
+sshyp is (as of writing) the only password-store compatible CLI password manager available for Haiku.
-"sshync" is the custom syncing backend (based on sftp) used by "sshyp".
+
+sshyp makes use of a custom sftp wrapper, called sshync (ssh+sync), to reliably sync user entries with a local or remote server.
+
+The name "sshyp" is a combination of its syncing library, "sshync", and "passwords".
 
 # WARNING
 It is your responsibility to assess the security and stability of "sshyp" before using it and ensure it meets your needs.
@@ -26,7 +28,7 @@ What sshyp can do:
 
 What sshyp will likely do:
 
-- (planned v1.1.0) 2FA/MFA management (was previously not on the roadmap, but could be beneficial in reducing phone usage)
+- (planned v1.1.0) 2FA/MFA management (beneficial for reducing phone usage)
 - (planned v1.2.0) everything it already does, but also in a GUI for Linux/Haiku
 
 What sshyp definitely won't do:
@@ -34,19 +36,11 @@ What sshyp definitely won't do:
 - Non-UNIX(-like) support, e.g. Windows (I'd be happy to link to third-party ports, if someone were to make them)
 
 # Installation
-Arch Linux (all ISAs)
+Please see the [installation guide](https://github.com/rwinkhart/sshyp/wiki/Installation) in the sshyp wiki for directions specific to your distribution/OS.
 
-sshyp releases are available in the Arch User Repository as 'sshyp'.
+Pre-built packages exist for Haiku, FreeBSD, Arch Linux, Debian/Ubuntu Linux, Fedora Linux, and Termux. These can be downloaded from the releases page.
 
-Install with your preferred AUR helper or use:
+Requests for additional distribution/OS support can be filed as issues.
-
-```
-git clone https://aur.archlinux.org/sshyp.git
-cd sshyp
-makepkg -si
-```
-
-Pre-built packages exist for Haiku, FreeBSD, Arch Linux, Debian Linux, Red Hat Linux, and Termux. These can be downloaded from the releases page.
 
 # Building
 Since sshyp is written entirely in Python, it doesn't need to be compiled. It does, however, need to be packaged for installation.
@@ -59,13 +53,13 @@ cd sshyp
 ./package.sh
 ```
 
-The packaging script has been tested on Arch Linux with "dpkg" as a dependency for Debian and Termux packaging and "freebsd-pkg" as a dependency for FreeBSD packaging.
+The packaging script has been tested on Arch Linux with "dpkg" as a dependency for Debian/Ubuntu and Termux packaging and "freebsd-pkg" as a dependency for FreeBSD packaging.
 
-Haiku packaging must be done from within Haiku.
+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 Linux, Red Hat Linux, Termux, and generic. Packaging for other systems coming soon.
+Currently, the script can create packages for Haiku, FreeBSD, 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:
@@ -74,8 +68,7 @@ Upon initial installation (on both the server and client devices), be sure to ru
 sshyp tweak
 ```
 
-This command will allow you to configure the settings necessary for sshyp to function.
+This command will allow you to configure the settings necessary for sshyp to function. To ensure configuration compatibility, it is a good idea to run 'sshyp tweak' after each major update.
-To ensure configuration compatibility, it is a good idea to run 'sshyp tweak' after each major update.
 
 Please note that decrypting and reading entries is disabled on server devices for security reasons. Only devices configured as clients can use the gpg key to decrypt entries.
 
@@ -95,7 +88,7 @@ man sshyp
 Short-term Goals:
 
 - 2FA/MFA management
-- create minimal GUI apps (Linux x86_64, Linux aarch64)
+- create minimal GUI apps (Linux x86_64, Linux aarch64, Haiku x86_64)
 - various optimizations/bug fixes
 
 Long-term Goals:

bin/sshyp

@@ -130,7 +130,12 @@ def pass_gen():
         if __special < __min_special:
             __gen = _pass_gen_function(__complexity, __length)
         return __gen
-    _length = int(input('password length: '))
+    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')
@@ -189,7 +194,7 @@ def tweak():  # runs configuration wizard
     Path(path.expanduser('~/.password-pasture')).mkdir(0o700, parents=True, exist_ok=True)
     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':
+        if uname()[0] == 'Haiku' or uname()[0] == 'FreeBSD':
             system(f"ln -s /tmp {path.expanduser('~/.config/sshyp/tmp')}")
         elif Path("/data/data/com.termux").exists():
             system(f"ln -s '/data/data/com.termux/files/usr/tmp' {path.expanduser('~/.config/sshyp/tmp')}")
@@ -293,8 +298,8 @@ def print_info():  # prints help text based on argument
         print(' update/-u               generate a password for an existing entry\n')
         print("\u001b[1mtip:\u001b[0m you can quickly read an entry with 'sshyp /<entry name>'")
     elif argument_list[0] == 'version' or argument_list[0] == '-v':
-        print('\nsshyp is a simple, self-hosted, sftp-synchronized password manager\nfor unix(-like) systems (currently'
+        print('\nsshyp is a simple, self-hosted, sftp-synchronized password manager\nfor unix(-like) systems (haiku/'
-              ' haiku/linux/termux)\n\nsshyp is a viable alternative to (and compatible with) pass/password-store\n')
+              'freebsd/linux/termux)\n\nsshyp is a viable alternative to (and compatible with) pass/password-store\n')
         print("                ..       \u001b[38;5;9m♥♥ ♥♥\u001b[0m       ..\n         .''.''/()\\     \u001b[38;5;13m"
               "♥♥♥♥♥♥♥\u001b[0m     /()\\''.''.\n        *       :        \u001b[38;5;9m♥♥♥♥♥\u001b[0m        :       *"
               "\n         `..'..'          \u001b[38;5;13m♥♥♥\u001b[0m          `..'..'\n         //   \\\\           "
@@ -379,7 +384,7 @@ def sync():  # calls sshync to sync changes to the user's server
     try:
         _deletion_database = open(path.expanduser('~/.config/sshyp/deletion_database')).readlines()
     except (FileNotFoundError, IndexError):
-        print('\n\u001b[38;5;9merror: the deletion database does not exist or is corrupted.\u001b[0m\n')
+        print('\n\u001b[38;5;9merror: the deletion database does not exist or is corrupted\u001b[0m\n')
         _deletion_database = None
         s_exit(1)
     for _file in _deletion_database:
@@ -407,7 +412,7 @@ def sync():  # calls sshync to sync changes to the user's server
     try:
         _folder_database = open(path.expanduser('~/.config/sshyp/folder_database')).readlines()
     except (FileNotFoundError, IndexError):
-        print('\n\u001b[38;5;9merror: the folder database does not exist or is corrupted.\u001b[0m\n')
+        print('\n\u001b[38;5;9merror: the folder database does not exist or is corrupted\u001b[0m\n')
         _folder_database = None
         s_exit(1)
     for _folder in _folder_database:
@@ -429,6 +434,9 @@ def add_entry():  # adds a new entry
         _entry_name = entry_name_fetch('name of new entry: ')
     else:
         _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)
     if argument_list[1] == 'note' or argument_list[1] == '-n':
         _shm_folder, _shm_entry = shm_gen()
         system(f"nano {tmp_dir}{_shm_folder}/{_shm_entry}-n")
@@ -467,10 +475,14 @@ def rename():  # renames an entry or folder
         _entry_name = entry_name_fetch('entry/folder to rename/relocate: ')
     else:
         _entry_name = entry_name_fetch(2)
-    if not Path(f"{directory}{_entry_name}.gpg").exists():
+    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)
     _new_name = str(input('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)
     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}"
@@ -528,9 +540,12 @@ def gen():  # generates a password for a new or an existing entry
             s_exit(1)
     else:
         _entry_name = entry_name_fetch(1)
+    if len(argument_list) == 1 or (not argument_list[1] == 'update' and not argument_list[1] == '-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)
         _username = str(input('username: '))
-    _password = pass_gen()
+        _password = pass_gen()
-    if not argument_list[1] == 'update' and not argument_list[1] == '-u':
         _url = str(input('url: '))
         _add_note = input('add a note to this entry? (y/N) ')
         _shm_folder, _shm_entry = shm_gen()
@@ -545,6 +560,7 @@ def gen():  # generates a password for a new or an existing entry
         entry_reader(f"{tmp_dir}{_shm_folder}/{_shm_entry}")
         encrypt(_shm_folder, _shm_entry, _entry_name)
     else:
+        _password = pass_gen()
         _shm_folder, _shm_entry = shm_gen()
         decrypt(directory + _entry_name, _shm_folder, _shm_entry)
         replace_line(f"{tmp_dir}{_shm_folder}/{_shm_entry}", 0, _password + '\n')

extra/changelog-total

@@ -8,7 +8,7 @@ As such, it is being crowned "v1.0.0", and is considered a stable base for futur
 Features:
 
 - sshyp has been modified to run on Haiku, an open-source re-implementation of BeOS
-    ^ new package formats have been added for Haiku, FreeBSD, and Red Hat distributions (such as Fedora)
+    ^ new package formats have been added for Haiku, FreeBSD, and Fedora Linux
 - the entry format has been changed to support entries created in pass/password-store
     ^ this change requires existing entry libraries to be converted - see the sshyp v1.0.0 release page on GitHub for a conversion script
 - majorly overhauled visual experience for sshyp
@@ -27,6 +27,7 @@ Changes:
 - rename function now properly allows for renaming folders
 - renaming an entry/folder will now properly delete the old entry/folder from the server
 - entry previews at the time of entry creation/editing no longer require entering the gpg password more times than necessary
+- entries will no longer be overwritten if attempting to create a new entry that uses an already existing name
 - the clipboard now automatically clears after 30 seconds
 - sshyp server no longer needs to create copies of its libraries in ~/
 - added more and improved existing exceptions

extra/manpage

@@ -1,4 +1,4 @@
-.TH sshyp 1 "17 June 2022" "v1.0.0" "sshyp man page"
+.TH sshyp 1 "20 June 2022" "v1.0.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
@@ -73,7 +73,7 @@ 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, the ssh server was not installed as a dependency and needs to 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
@@ -82,7 +82,7 @@ Server setup:
 Client setup:
     Install sshyp
     Run "sshyp tweak" and follow the prompts
-    Copy the generated public SSH key to the server using preferred method (manually adding to authorized_keys, ssh-copy-id, etc.)
+    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"
     Done!
 

extra/sshyp-linux-banner.png.REMOVED.git-id

@@ -0,0 +1 @@
+af6236472791614ed41bf13318a2d1c41228855c

package.sh

@@ -1,13 +1,14 @@
 #!/bin/bash
 
-# This script packages sshyp (from source) for various UNIX environments.
+# This script packages sshyp (from source) for various UNIX(-like) environments.
-# Dependencies (Arch Linux): dpkg (packaging for Debian/Termux), rpmdevtools (packaging for Red Hat), freebsd-pkg (packaging for FreeBSD)
+# Dependencies (Arch Linux): dpkg (packaging for Debian/Termux), freebsd-pkg (packaging for FreeBSD)
+# Dependencies (Fedora) (can only package for self): rpmdevtools
 # NOTE It is recommended to instead use the latest officially packaged and tagged release.
 
 echo -e '\nOptions (please enter the number only):'
-echo -e '\nPackage Formats:\n\n1. Haiku\n2. Debian\n3. Red Hat\n4. FreeBSD\n5. Termux\n6. Generic (used for PKGBUILD/APKBUILD)'
+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, as this must be done on Haiku) and build scripts)\n'
+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'
@@ -85,7 +86,7 @@ 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
+Installed-Size: 185
 " > 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/
@@ -109,7 +110,7 @@ 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
+Installed-Size: 185
 " > 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/
@@ -135,8 +136,8 @@ if [ "$distro" == "3" ] || [ "$distro" == "4" ] || [ "$distro" == "6" ] || [ "$d
     echo -e "\nGeneric packaging complete.\n"
 fi
 
-if [ "$distro" == "3" ] || [ "$distro" == "8" ]; then
+if [ "$distro" == "3" ]; then
-    echo -e '\nPackaging for Red Hat...\n'
+    echo -e '\nPackaging for Fedora...\n'
     rm -rf ~/rpmbuild
     rpmdev-setuptree
     cp packages/sshyp-"$version".tar.xz ~/rpmbuild/SOURCES
@@ -170,7 +171,7 @@ cp -r %{_sourcedir}/usr %{buildroot}
 rpmbuild -bb ~/rpmbuild/SPECS/sshyp.spec
 mv ~/rpmbuild/RPMS/noarch/* packages/
 rm -rf ~/rpmbuild
-echo -e "\nRed Hat packaging complete.\n"
+echo -e "\nFedora packaging complete.\n"
 fi
 
 if [ "$distro" == "4" ] || [ "$distro" == "8" ]; then

share/doc/sshyp/changelog

@@ -8,7 +8,7 @@ As such, it is being crowned "v1.0.0", and is considered a stable base for futur
 Features:
 
 - sshyp has been modified to run on Haiku, an open-source re-implementation of BeOS
-    ^ new package formats have been added for Haiku, FreeBSD, and Red Hat distributions (such as Fedora)
+    ^ new package formats have been added for Haiku, FreeBSD, and Fedora Linux
 - the entry format has been changed to support entries created in pass/password-store
     ^ this change requires existing entry libraries to be converted - see the sshyp v1.0.0 release page on GitHub for a conversion script
 - majorly overhauled visual experience for sshyp
@@ -27,6 +27,7 @@ Changes:
 - rename function now properly allows for renaming folders
 - renaming an entry/folder will now properly delete the old entry/folder from the server
 - entry previews at the time of entry creation/editing no longer require entering the gpg password more times than necessary
+- entries will no longer be overwritten if attempting to create a new entry that uses an already existing name
 - the clipboard now automatically clears after 30 seconds
 - sshyp server no longer needs to create copies of its libraries in ~/
 - added more and improved existing exceptions