From: =?utf-8?q?Jeremy_B=C3=ADcha?= Date: Sun, 13 Apr 2025 12:04:33 -0400 Subject: Revert "Add QuickUnlock with fingerprint support" This reverts commit bf8276570599acb4a925af97d0ac016b8d2aaf4b. asyncio requires pygobject 3.52 --- data/gtk/settings_dialog.ui | 14 -- data/gtk/unlock_database.ui | 14 -- .../status/fingerprint-detection-symbolic.svg | 3 - data/org.gnome.World.Secrets.gschema.xml.in | 10 - data/resources.gresource.xml.in | 1 - data/style.css | 64 ------ flatpak/org.gnome.World.Secrets.Devel.json | 3 +- gsecrets/config_manager.py | 18 -- gsecrets/database_manager.py | 5 +- gsecrets/fingerprint_verifier.py | 238 --------------------- gsecrets/settings_dialog.py | 7 - gsecrets/unlock_database.py | 174 +-------------- 12 files changed, 4 insertions(+), 547 deletions(-) delete mode 100644 data/icons/scalable/status/fingerprint-detection-symbolic.svg delete mode 100644 gsecrets/fingerprint_verifier.py diff --git a/data/gtk/settings_dialog.ui b/data/gtk/settings_dialog.ui index f74661d..5e66adf 100644 --- a/data/gtk/settings_dialog.ui +++ b/data/gtk/settings_dialog.ui @@ -30,20 +30,6 @@ True - - - Enable Quick Unlock - Re-unlock using the last four characters of the password for a single attempt. - settings.quick-unlock - - - - - Enable Fingerprint Unlock - Use the fingerprint reader to quickly unlock the safe. - settings.fingerprint-quick-unlock - - diff --git a/data/gtk/unlock_database.ui b/data/gtk/unlock_database.ui index 9472c72..651cfb8 100644 --- a/data/gtk/unlock_database.ui +++ b/data/gtk/unlock_database.ui @@ -30,20 +30,6 @@ vertical 12 - 250 - - - center - True - Fingerprint Unlock available - False - fingerprint-detection-symbolic - 36 - - - diff --git a/data/icons/scalable/status/fingerprint-detection-symbolic.svg b/data/icons/scalable/status/fingerprint-detection-symbolic.svg deleted file mode 100644 index 00e31cc..0000000 --- a/data/icons/scalable/status/fingerprint-detection-symbolic.svg +++ /dev/null @@ -1,3 +0,0 @@ - - - diff --git a/data/org.gnome.World.Secrets.gschema.xml.in b/data/org.gnome.World.Secrets.gschema.xml.in index 3f10ea8..e69c55f 100644 --- a/data/org.gnome.World.Secrets.gschema.xml.in +++ b/data/org.gnome.World.Secrets.gschema.xml.in @@ -107,15 +107,5 @@ Separator when generating a passphrase Word separator to use when generating a passphrase. - - false - Enable Quick Unlock - With quick unlock enabled, a safe can be re-entered using the last four characters of the password. If the first try is wrong, the full password is needed to unlock the safe. - - - false - Enable Fingerprint Quick Unlock - Use the fingerprint reader to quick unlock a locked safe. - diff --git a/data/resources.gresource.xml.in b/data/resources.gresource.xml.in index 11bd5c1..0e18731 100644 --- a/data/resources.gresource.xml.in +++ b/data/resources.gresource.xml.in @@ -44,7 +44,6 @@ icons/scalable/status/external-link-symbolic.svg icons/scalable/status/eye-not-looking-symbolic.svg icons/scalable/status/eye-open-negative-filled-symbolic.svg - icons/scalable/status/fingerprint-detection-symbolic.svg icons/scalable/status/info-outline-symbolic.svg icons/scalable/status/money-symbolic.svg icons/scalable/status/notepad-symbolic.svg diff --git a/data/style.css b/data/style.css index 567fc16..0f33cfd 100644 --- a/data/style.css +++ b/data/style.css @@ -135,67 +135,3 @@ textview { min-height: 24px; margin: 3px; } - -/* Fingerprint */ -.fingerprint-img { - transition-property: color; - transition-duration: 250ms; - color: var(--view-fg-color); -} - -.fingerprint-img.success { - transition-property: color; - transition-duration: 250ms; - color: var(--success-color); -} - -@keyframes wiggle { - /* Unfortunately we can't use translation or xalign, so here's the workaround */ - 0% { padding-left: 0; padding-right: 0; } - 10% { padding-left: 0; padding-right: 2px; } - 20% { padding-left: 4px; padding-right: 0; } - 30% { padding-left: 0; padding-right: 8px; } - 40% { padding-left: 8px; padding-right: 0; } - 50% { padding-left: 0; padding-right: 8px; } - 60% { padding-left: 8px; padding-right: 0; } - 70% { padding-left: 0; padding-right: 8px; } - 80% { padding-left: 4px; padding-right: 0; } - 90% { padding-left: 0; padding-right: 2px; } - 100% { padding-left: 0; padding-right: 0; } -} - -.fingerprint-img.retry { - animation: wiggle; - animation-duration: 850ms; - animation-timing-function: ease-in; - animation-iteration-count: 1; -} - -@keyframes warning-wiggle { - /* Unfortunately we can't use translation or xalign, so here's the workaround */ - 0% { padding-left: 0; padding-right: 0; color: var(--view-fg-color); } - 10% { padding-left: 0; padding-right: 2px; } - 20% { padding-left: 4px; padding-right: 0; } - 30% { padding-left: 0; padding-right: 8px; color: var(--warning-color); } - 40% { padding-left: 8px; padding-right: 0; } - 50% { padding-left: 0; padding-right: 8px; } - 60% { padding-left: 8px; padding-right: 0; } - 70% { padding-left: 0; padding-right: 8px; color: var(--warning-color); } - 80% { padding-left: 4px; padding-right: 0; } - 90% { padding-left: 0; padding-right: 2px; } - 100% { padding-left: 0; padding-right: 0; color: var(--view-fg-color); } -} - -.fingerprint-img.warning { - animation: warning-wiggle; - animation-duration: 850ms; - animation-timing-function: ease-in; - animation-iteration-count: 1; -} - -.fingerprint-img.error { - transition-property: color; - transition-duration: 250ms; - color: var(--error-color); -} - diff --git a/flatpak/org.gnome.World.Secrets.Devel.json b/flatpak/org.gnome.World.Secrets.Devel.json index fe3ad62..645f75a 100644 --- a/flatpak/org.gnome.World.Secrets.Devel.json +++ b/flatpak/org.gnome.World.Secrets.Devel.json @@ -18,8 +18,7 @@ "--share=ipc", "--socket=fallback-x11", "--socket=pcsc", - "--socket=wayland", - "--system-talk-name=net.reactivated.Fprint" + "--socket=wayland" ], "cleanup": [ "*.a", diff --git a/gsecrets/config_manager.py b/gsecrets/config_manager.py index 0fdc965..04cc3ed 100644 --- a/gsecrets/config_manager.py +++ b/gsecrets/config_manager.py @@ -31,8 +31,6 @@ GENERATOR_LENGTH = "generator-length" GENERATOR_WORDS = "generator-words" GENERATOR_SEPARATOR = "generator-separator" LOCK_ON_SESSION_LOCK = "lock-on-session-lock" -FINGERPRINT_QUICK_UNLOCK = "fingerprint-quick-unlock" -QUICK_UNLOCK = "quick-unlock" def get_lock_on_session_lock() -> bool: @@ -199,19 +197,3 @@ def get_development_backup_mode(): def set_development_backup_mode(value): setting.set_boolean(DEV_BACKUP_MODE, value) - - -def get_fingerprint_quick_unlock(): - return setting.get_boolean(FINGERPRINT_QUICK_UNLOCK) - - -def set_fingerprint_quick_unlock(value: bool) -> None: - setting.set_boolean(FINGERPRINT_QUICK_UNLOCK, value) - - -def get_quick_unlock(): - return setting.get_boolean(QUICK_UNLOCK) - - -def set_quick_unlock(value: bool) -> None: - setting.set_boolean(QUICK_UNLOCK, value) diff --git a/gsecrets/database_manager.py b/gsecrets/database_manager.py index 0439644..6305ec7 100644 --- a/gsecrets/database_manager.py +++ b/gsecrets/database_manager.py @@ -318,10 +318,7 @@ class DatabaseManager(GObject.Object): @property def password(self) -> str: """Get the current password or '' if not set.""" - if db := self.db: - return db.password or "" - - return "" + return self.db.password or "" @password.setter def password(self, new_password: str | None) -> None: diff --git a/gsecrets/fingerprint_verifier.py b/gsecrets/fingerprint_verifier.py deleted file mode 100644 index 6141cd0..0000000 --- a/gsecrets/fingerprint_verifier.py +++ /dev/null @@ -1,238 +0,0 @@ -from __future__ import annotations - -import logging -from typing import TYPE_CHECKING - -if TYPE_CHECKING: - from collections.abc import Callable -from typing import Any, cast - -from gi.repository import Gio, GLib - -BUS_NAME = "net.reactivated.Fprint" -DBUS_TIMEOUT = 500 # In milliseconds -VERIFY_STATUS_TUPLE = 2 - - -class FingerprintVerifier: - """Provides easy access to a fingerprint device.""" - - def __init__( - self, - on_success: Callable, - on_retry: Callable, - on_failure: Callable, - ) -> None: - """Constructor. - - Might throw an exception if dbus is unavailable, fprintd is missing or - no device is available. - - Arguments: - --------- - on_success: Function to be called on success. - on_retry: Function to be called if the fingerprint sensor suggests retrying. - on_failure: Function to be called if the fingerprint did not match or the - hardware refused in the process. - - """ - self.on_success = on_success - self.on_retry = on_retry - self.on_failure = on_failure - - self._is_claimed = False - self._device_proxy = None - self._signal = None - - def connect(self, cb: Gio.Callback) -> None: - """Initializes the connection to the fingerprint device. - - Shouldn't be called manually unless disconnect was called on the object before. - - Might throw an exception if dbus is unavailable, fprindt is missing - or no device is available. - """ - if self._is_claimed: - return - - async def connect_fingerprint(): - con = await Gio.bus_get(Gio.BusType.SYSTEM, None) - - manager_proxy = await Gio.DBusProxy.new( - con, - Gio.DBusProxyFlags.NONE, - None, - BUS_NAME, - "/net/reactivated/Fprint/Manager", - "net.reactivated.Fprint.Manager", - None, - ) - if manager_proxy is None: - logging.debug("Fprintd not available.") - return - - try: - device_str = await manager_proxy.call( - "GetDefaultDevice", - None, - Gio.DBusCallFlags.NO_AUTO_START, - DBUS_TIMEOUT, - None, - )[0] - except GLib.GError: - logging.exception("Failed to get default fingerprint device") - return - - if device_str == "": - logging.debug("No fingerprint sensor found!") - return - - self._device_proxy = await Gio.DBusProxy.new( - con, - Gio.DBusProxyFlags.NONE, - None, - BUS_NAME, - device_str, - "net.reactivated.Fprint.Device", - None, - ) - if self._device_proxy is None: - logging.debug("Failed to find the default fingerprint device.") - return - - self._signal = self._device_proxy.connect("g-signal", self._signal_handler) - logging.debug("Successfully connected to the fingerprint device.") - - cb() - - app = Gio.Application.get_default() - app.create_asyncio_task(connect_fingerprint()) - - def disconnect(self) -> None: - """Removes the handlers from the signal. - - Should be called when the class is not needed anymore. - """ - if self._is_claimed or self._device_proxy is None: - return - - self._is_claimed = False - self._device_proxy.disconnect(self._signal) - self._signal = None - self._device_proxy = None - logging.debug("Disconnected from the fingerprint device.") - - async def verify_start(self) -> bool: - """Starts the fingerprint verification process. - - Returns: True if the fingerprint verification started. - - """ - if self._device_proxy is None: - return False - - try: - await self._claim_device() - except GLib.Error: - logging.exception("Failed to claim device") - return False - - self._is_claimed = True - try: - await self._verify_start() - except GLib.Error: - logging.exception("Failed to start fingerprint verification on the device") - return False - - logging.debug("Claimed fingerprint device, verification ongoing...") - return True - - async def verify_stop(self) -> None: - """Stops the fingerprint verification process.""" - if not self._is_claimed: - return - - self._is_claimed = False - - try: - await self._verify_stop() - await self._release_device() - logging.debug("Stopped verification, released fingerprint device.") - except GLib.Error as err: - logging.debug("Exception while releasing fingerprint device: %s", err) - - # - # Internal methods - # - - async def _claim_device(self) -> None: - if self._device_proxy: - await self._device_proxy.call( - "Claim", - GLib.Variant("(s)", ("",)), - Gio.DBusCallFlags.NO_AUTO_START, - DBUS_TIMEOUT, - None, - ) - - async def _release_device(self) -> None: - if self._device_proxy: - await self._device_proxy.call( - "Release", - None, - Gio.DBusCallFlags.NO_AUTO_START, - DBUS_TIMEOUT, - None, - ) - - async def _verify_start(self) -> None: - if self._device_proxy: - await self._device_proxy.call( - "VerifyStart", - GLib.Variant("(s)", ("any",)), - Gio.DBusCallFlags.NO_AUTO_START, - DBUS_TIMEOUT, - None, - ) - - async def _verify_stop(self) -> None: - if self._device_proxy: - await self._device_proxy.call( - "VerifyStop", - None, - Gio.DBusCallFlags.NO_AUTO_START, - DBUS_TIMEOUT, - None, - ) - - retry_results = [ - "verify-retry-scan", - "verify-swipe-too-short", - "verify-finger-not-centered", - "verify-remove-and-retry", - ] - - def _signal_handler( - self, - _proxy: Gio.DBusProxy, - _sender: str, # pylint: disable=unused-argument - signal: str, - args: tuple[Any], - ) -> None: - if signal != "VerifyStatus" or len(args) != VERIFY_STATUS_TUPLE: - return - - result, done = cast(tuple[str, bool], args) # see mypy/issues/1178 - - if result in self.retry_results and not done: - self.on_retry() - - if done: - if result != "verify-disconnected": - app = Gio.Application.get_default() - app.create_asyncio_task(self.verify_stop()) - - if result == "verify-match": - self.on_success() - else: - self.on_failure() diff --git a/gsecrets/settings_dialog.py b/gsecrets/settings_dialog.py index a7f6d10..7a48a9f 100644 --- a/gsecrets/settings_dialog.py +++ b/gsecrets/settings_dialog.py @@ -106,13 +106,6 @@ class SettingsDialog(Adw.PreferencesDialog): self._on_remember_composite_key, ) - quick_unlock_action = settings.create_action("quick-unlock") - action_group.add_action(quick_unlock_action) - fingerprint_quick_unlock_action = settings.create_action( - "fingerprint-quick-unlock", - ) - action_group.add_action(fingerprint_quick_unlock_action) - self.insert_action_group("settings", action_group) def _on_remember_composite_key(self, action, _param): diff --git a/gsecrets/unlock_database.py b/gsecrets/unlock_database.py index d48991b..48da162 100644 --- a/gsecrets/unlock_database.py +++ b/gsecrets/unlock_database.py @@ -12,7 +12,6 @@ import gsecrets.config_manager from gsecrets import const from gsecrets.database_manager import DatabaseManager from gsecrets.err import QUARK, ErrorType -from gsecrets.fingerprint_verifier import FingerprintVerifier from gsecrets.unlocked_database import UnlockedDatabase from gsecrets.utils import compare_passwords @@ -36,9 +35,6 @@ class UnlockDatabase(Adw.Bin): unlock_button = Gtk.Template.Child() banner = Gtk.Template.Child() _progress = Gtk.Template.Child() - fingerprint_img = Gtk.Template.Child() - - FPRINT_MAX_TRIES = 3 def __init__(self, window: Window, database_file: Gio.File) -> None: super().__init__() @@ -65,26 +61,6 @@ class UnlockDatabase(Adw.Bin): if gsecrets.const.IS_DEVEL: self.status_page.props.icon_name = gsecrets.const.APP_ID - self.fprint: FingerprintVerifier | None = None - self.fprint_tries = 0 - if gsecrets.config_manager.get_fingerprint_quick_unlock(): - self._map_fingerprint_reader() - - self.quick_unlock_failed = False - - self.event_controller = Gtk.EventControllerFocus.new() - self.add_controller(self.event_controller) - self.event_controller.connect("enter", self.on_enter) - self.event_controller.connect("leave", self.on_leave) - - settings = self.window.application.settings - settings.connect( - "changed::fingerprint-quick-unlock", - self._on_fingerprint_settings_changed, - ) - - self.window.set_default_widget(self.unlock_button) - for key_provider in self.window.key_providers.get_key_providers(): if key_provider.available: widget = key_provider.create_unlock_widget(self.database_manager) @@ -93,26 +69,6 @@ class UnlockDatabase(Adw.Bin): def do_unmap(self): # pylint: disable=arguments-differ Gtk.Widget.do_unmap(self) self._progress.end_pulse() - self.remove_controller(self.event_controller) - self._unmap_fingerprint_reader() - - def on_enter(self, _user_data): - if self.database_manager and self.database_manager.password != "": - if ( - gsecrets.config_manager.get_quick_unlock() - and not self.quick_unlock_failed - ): - self.window.show_banner(_("Quick Unlock active")) - self.provider_group.props.visible = False - # only start reading if there are still tries left - if self.fprint_tries < self.FPRINT_MAX_TRIES: - self._start_fingerprint_reader() - else: - logging.debug("Quick unlock disabled as no password is available.") - - def on_leave(self, _user_data): - if self.fprint_tries < self.FPRINT_MAX_TRIES: - self._stop_fingerprint_reader() def grab_entry_focus(self): self.password_entry.grab_focus() @@ -157,18 +113,10 @@ class UnlockDatabase(Adw.Bin): self._open_database() return - quick_unlock = ( - gsecrets.config_manager.get_quick_unlock() - and not self.quick_unlock_failed - and entered_pwd == self.database_manager.password[-4:] - ) - - full_unlock = ( + if ( compare_passwords(entered_pwd, self.database_manager.password) and self.database_manager.composition_key == self.composition_key - ) - - if quick_unlock or full_unlock: + ): self.database_manager.props.locked = False self.database_manager.add_to_history() else: @@ -254,9 +202,6 @@ class UnlockDatabase(Adw.Bin): self._progress.end_pulse() - self.quick_unlock_failed = True - self.provider_group.props.visible = True - def _set_sensitive(self, sensitive): delegate = self.password_entry.get_delegate() if delegate.has_focus() and not sensitive: @@ -313,118 +258,3 @@ class UnlockDatabase(Adw.Bin): def close_banner(self): self.banner.set_revealed(False) - - # - # Fingerprint-related stuff - # - - def _on_fingerprint_settings_changed(self, _settings, _key): - if gsecrets.config_manager.get_fingerprint_quick_unlock(): - logging.debug("Fingerprint got enabled, mapping fingerprint reader...") - self._map_fingerprint_reader() - else: - logging.debug("Fingerprint got disabled, unmapping fingerprint reader...") - self._unmap_fingerprint_reader() - - def _start_fingerprint_reader_cb(self) -> None: - if not self.fprint: - return - - async def cb(): - if await self.fprint.verify_start(): - self.fingerprint_img.props.visible = True - - app = Gio.Application.get_default() - app.create_asyncio_task(cb()) - - def _start_fingerprint_reader(self) -> None: - if not self.fprint: - return - self.fprint.connect(self._start_fingerprint_reader_cb) - - def _stop_fingerprint_reader(self) -> None: - if not self.fprint: - return - - async def disconnect(): - await self.fprint.verify_stop() - self.fprint.disconnect() - self.fingerprint_img.props.visible = False - - app = Gio.Application.get_default() - app.create_asyncio_task(disconnect()) - - def _map_fingerprint_reader(self) -> None: - logging.debug("Connecting to the fingerprint device...") - try: - self.fprint = FingerprintVerifier( - self._on_fingerprint_success, - self._on_fingerprint_retry, - self._on_fingerprint_failure, - ) - except RuntimeError as err: - logging.debug("Failed initialize fingerprint: %s", err) - - def _unmap_fingerprint_reader(self) -> None: - if not self.fprint: - return - logging.debug("Disconnecting the fingerprint device...") - self._stop_fingerprint_reader() - self.fprint = None - - def _on_fingerprint_success(self): - """Success callback of the the FingerprintVerifier.""" - self.fingerprint_img.add_css_class("success") - GLib.timeout_add(250, self._after_fingerprint_success) - logging.debug("Fingerprint success") - - def _after_fingerprint_success(self): - """Unlocks database after animation of _on_fingerprint_success.""" - self.database_manager.props.locked = False - - def _on_fingerprint_retry(self): - """Retry callback of the the FingerprintVerifier.""" - self.fingerprint_img.add_css_class("retry") - GLib.timeout_add(850, self._after_fingerprint_retry) - logging.debug("Fingerprint retry") - - def _after_fingerprint_retry(self): - """Cleans up animation after _on_fingerprint_retry.""" - self.fingerprint_img.remove_css_class("retry") - - def _on_fingerprint_failure(self): - """Failure callback of the the FingerprintVerifier.""" - self.fprint_tries += 1 - - async def start_fprint(): - status = await self.fprint.verify_start() - if not status: - # in case fingerprint sensor itself refuses - self.fingerprint_img.add_css_class("error") - self.window.send_notification(_("Please unlock using the password.")) - logging.debug( - "Retry after verify-no-match failed. Fingerprint disabled.", - ) - - if self.fprint_tries >= self.FPRINT_MAX_TRIES: - # at most 3 tries for unlocking with the fingerprint sensor - self.fingerprint_img.add_css_class("error") - self.window.send_notification( - _("Maximum tries reached. Please unlock using the password."), - ) - self.fprint.disconnect() - logging.debug("Max tries reached. Fingerprint disabled.") - else: - # else start verification again - self.fingerprint_img.add_css_class("warning") - GLib.timeout_add(850, self._after_fingerprint_warning) - logging.debug("Fingerprint no-match for try %i", self.fprint_tries) - app = Gio.Application.get_default() - app.create_asyncio_task(start_fprint()) - - def _after_fingerprint_warning(self): - """Cleans up. - - Animation after _on_fingerprint_failure if FPRINT_MAX_TRIES not reached - """ - self.fingerprint_img.remove_css_class("warning")