Update documentation for release v1.3.0

share/doc/sshyp/changelog

@@ -1,55 +1,48 @@
-sshyp v1.2.0
+sshyp v1.3.0
 
-the brisk bahh update
+the serious shepherd update
 
-this release focuses on speeding up the sshyp user experience by adding
-new features that reduce wasted time
+this release ties up many of sshyp's loose ends where there was
+room for major performance, compatibility, and security improvements
 
 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
+- due to a near full re-write of the syncing functionality, all clients and servers
+must be updated to this release (v1.3.0 is not backwards compatible with any prior release)
+- it is recommended to either delete the contents of ~/.config/sshyp/deleted (on the server-side)
+or sync all of your clients before updating
+    ^ old entries in this folder will throw errors with v1.3.0
 
 user-facing features:
 
-- 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
+- none - all changes were under-the-hood - the user experience should be
+exactly the same as v1.2.0 - just faster, less buggy, and more secure
 
-fixes/optimizations:
+major 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
+- a near full re-write of the syncing functionality
+    ^ all syncing logic has been moved into sshync.py (from sshyp.py and sshypRemote.py)
+    ^ in my setup, a dry, local "sshyp sync" went from 2.00+ seconds (v1.2.0) to 0.36 seconds (v1.3.0)
+        ^ the performance improvements are even greater when syncing from outside your local network
+- the following character sequences will no longer break the syncing logic: "@", "^&*", and "*&^"
+    ^ ASCII separator characters 29-31 are now used, instead
+- os.system has been replaced with subprocess.run in all cases, shell=True is no longer used with subprocess.run
+    ^ this protects against shell escape attacks and potentially makes sshyp more compatible with some environments
+- replaced shell commands with python built-in library functions where applicable
+    ^ this brings speed and compatibility improvements
+- sshyp should no longer incorrectly assume an X11 environment when Wayland is in use
+    ^ this fixes clipboard support in some Wayland environments, such as Sway (Plasma/Gnome/Phosh were unaffected)
+- sshyp now uses the default pinentry on Haiku thanks to haikuports/haikuports#7457
+    ^ this brings the Haiku port in-line with the other sshyp packages in terms of security
+- "python3" is now called over ssh, rather than "python"
+    ^ some environments do not have a "python" symlink, or it links to "python2" - changing this increases compatibility
+- fixed an issue from v1.2.0 where renaming threw an error if not in offline mode
 
 other notable changes:
 
-- 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)
+- quick-unlock password input is now hidden while the user is typing
+    ^ user input is now invisible to prevent snooping
+- lots of smaller optimizations not listed here
 
 <><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><><>