diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc index ec13940ca..b96e1eff1 100644 --- a/docs/UserGuide.adoc +++ b/docs/UserGuide.adoc @@ -37,6 +37,8 @@ include::topics/Passkeys.adoc[tags=*] include::topics/AutoType.adoc[tags=*] +include::topics/SecretService.adoc[tags=*] + include::topics/SSHAgent.adoc[tags=*] include::topics/Reference.adoc[tags=*] diff --git a/docs/images/browser_custom_browser_configuration.png b/docs/images/browser_custom_browser_configuration.png index 257c571f1..ed9cad18a 100644 Binary files a/docs/images/browser_custom_browser_configuration.png and b/docs/images/browser_custom_browser_configuration.png differ diff --git a/docs/images/browser_integration_additional_attribute.png b/docs/images/browser_integration_additional_attribute.png new file mode 100644 index 000000000..361b7c30d Binary files /dev/null and b/docs/images/browser_integration_additional_attribute.png differ diff --git a/docs/images/browser_integration_clear_sites.png b/docs/images/browser_integration_clear_sites.png new file mode 100644 index 000000000..1a0234d46 Binary files /dev/null and b/docs/images/browser_integration_clear_sites.png differ diff --git a/docs/images/browser_statistics.png b/docs/images/browser_statistics.png index 1417aeaa9..d0fc60bc0 100644 Binary files a/docs/images/browser_statistics.png and b/docs/images/browser_statistics.png differ diff --git a/docs/images/secretservice_access_dialog.png b/docs/images/secretservice_access_dialog.png new file mode 100644 index 000000000..9a70a6085 Binary files /dev/null and b/docs/images/secretservice_access_dialog.png differ diff --git a/docs/images/secretservice_database_settings.png b/docs/images/secretservice_database_settings.png new file mode 100644 index 000000000..923ede10e Binary files /dev/null and b/docs/images/secretservice_database_settings.png differ diff --git a/docs/images/secretservice_enable_settings.png b/docs/images/secretservice_enable_settings.png new file mode 100644 index 000000000..cb8d7ea07 Binary files /dev/null and b/docs/images/secretservice_enable_settings.png differ diff --git a/docs/topics/BrowserIntegration.adoc b/docs/topics/BrowserIntegration.adoc index c1650fa4b..a561c58b2 100644 --- a/docs/topics/BrowserIntegration.adoc +++ b/docs/topics/BrowserIntegration.adoc @@ -107,12 +107,34 @@ You can then choose to update/add the credentials to your KeePassXC database dir 4. When you have successfully submitted the password on the website, a popup will appear asking you to either update an existing entry or add a new one. // tag::advanced[] -=== Browser statistics -You can see a cross-section of all browser-related settings applied to entries within a database through the Browser Statistics report. To access these, use the _Database_ -> _Database reports..._ menu option then click on _Browser Statistics_ on the left-hand menu. From here you can see all entries with URLs applied to them, explicitly allowed and denied URLs, and any entries with custom browser settings. +=== Browser Integration Report +You can see a cross-section of all browser-related settings applied to entries within a database through the Browser Statistics report. To access, use the _Database_ -> _Database reports..._ menu option then click on _Browser Statistics_ on the left-hand menu. From here you can see all entries with URLs applied to them, explicitly allowed and denied URLs, and any entries with custom browser settings. -.Browser statistics +TIP: You can delete remembered site settings from the report by right clicking the entry you want to reset and selecting "Delete plugin data from entry". + +.Browser Integration Report image::browser_statistics.png[] +=== Additional Fill-In Fields +Sometimes login pages have additional fields you would like to fill (e.g., account number). Use the following instructions to add them: + +1. Edit the entry you want to add fields to. Go to the advanced tab and add the attributes you need. Each attribute *must start with* `KPH:`, but otherwise the name does not matter. If multiple KPH attributes are defined, they are used in alphabetical order (i.e., the order shown in KeePassXC). +2. Within the browser, navigate to the page you want to use the additional fields on. Select the "Choose Custom Login Fields" button from the extension popup window. Choose Username, Password and String Field(s). Confirm the selections. +3. Refresh the web page. The new KPH attribute(s) should be filled to the extra fields. + +.String Fields Selection in Browser +image:browser_integration_additional_attribute.png[] + +=== Clearing Remembered Sites +Entries that you have chosen to remember allow/deny rules are stored in their respect custom data fields. You can clear all of these remembered settings at once through the database settings. Follow these steps: + +1. Go to *Database* → *Database Settings* or click the database settings icon in the toolbar. +2. Go to the *Browser Integration* tab, then click on the *Forget all site-specific settings on entries* button. +3. Confirm this action in the popup dialog. This cannot be undone once the database is saved. ++ +.Clear Remembered Sites +image::browser_integration_clear_sites.png[,100%] + === Advanced Usage You can configure unique browser integration behavior for each entry. This allows you to add multiple URLs to an entry, hide an entry from the browser integration, and more. To access these settings, open an entry for editing then click on _Browser Integration_ option in the left-hand menu *(1)*. diff --git a/docs/topics/SecretService.adoc b/docs/topics/SecretService.adoc new file mode 100644 index 000000000..1938237fa --- /dev/null +++ b/docs/topics/SecretService.adoc @@ -0,0 +1,48 @@ += KeePassXC – Secret Service Integration +include::.sharedheader[] +:imagesdir: ../images + +// tag::content[] +== Secret Service Integration +This feature allows KeePassXC to act as a Secret Service provider over DBus. It enables applications to store and retrieve secrets securely via the https://www.freedesktop.org/wiki/Specifications/secret-storage-spec/[Secret Storage specification]. While running, KeePassXC acts as a Secret Service server registered on DBus so clients like seahorse, python-secretstorage, secret-tool, or other implementations can connect and access the exposed database in KeePassXC. + +=== Enabling the Integration +Only one secret service provider can be enabled at a time. You may have to disable other providers, such as GNOME Keyring or KWallet, to use KeePassXC as a secret service provider. You will see a notice when attempting to enable KeePassXC as the secret service provider if another is already running. + +To replace most third party secret service providers with KeePassXC, run the following shell snippet: + +```bash +mkdir -p "${XDG_DATA_HOME:-${HOME}/.local/share}/dbus-1/services" +cat > "${XDG_DATA_HOME:-${HOME}/.local/share}/dbus-1/services/org.freedesktop.secrets.service" <