Page MenuHome GnuPG
Create Task
Maniphest T7911

Enhance documentation of VSD Kleopatra settings
Open, Needs TriagePublic
Actions

Description

I checked all current Kleopatra settings described in https://gnupg.com/vsd/kleopatra-settings.html and propose some adjustments:

Config order

  • Update current read order (see https://dev.gnupg.org/T5707#207732 ):
    1. HKEY_LOCAL_MACHINE\Software\Wow6432node\GNU\Kleopatra
    2. HKEY_CURRENT_USER\Software\GNU\Kleopatra
    3. C:\Program Files (x86)\GnuPG VS-Desktop\share\kleopatrarc
    4. %LOCALAPPDATA%\kleopatrarc
  • Maybe instead of read order (technical implementation) use precedence order (probably more user friendly)

Remove options

  • RemarkSettings: The group is obsolete, setting UseTags=false has no effect. The section should be removed.
  • KDE Action Restrictions: some options seem to have no effect (better recheck before removal):
    • action/configure_backend
    • action/help_show_compendium
    • action/tools_start_kwatchgnupg
    • action/view_certificate_overview

Fix options

Add options

Enhance Description

  • Notifications / ShowExpiryNotifications: "Kleopatra will show notifications in some place" -> "on certificate selection"
  • KDE Action Restrictions: Many options don't restrict the described functionality but only remove the actions (menu, shortcuts). Maybe add one sentence to make this clear for the reader.
  • Add current default value if possible
    • CertificateCreationWizard / ValidityPeriodInDaysMin
    • CertificateCreationWizard / ValidityPeriodInDaysMax
    • Certification / CertificationValidityInDays
    • DN / AttributeOrder

Current Bugs (not sure, if this should be documented until it is fixed)

Just for documentation purposes here I'll list the KDE action restrictions, where functionality is still available elsewhere after being set to false:

  • certificates_add_userid: still possible via Certificate Details -> Add User ID
  • certificates_change_expiry: still possible via Certificates Details -> Edit: Valid until, Subkeys -> Change validity
  • certificates_change_passphrase: still possible via Certificates Details -> Change Password
  • certificates_revoke_certification: still possible via Certificates Details / Certifications -> Revoke Certification
  • file_decrypt_verify_files: still possible via Drag&Drop
  • file_export_certificates: still possible via Certificates Details -> Export
  • file_export_secret_keys: subkey export still possible via Certificates Details / Subkeys -> ContextMenu: Export secret subkey
  • file_import_certificates: still possible via Drag&Drop and initial screen on empty keyring
  • file_new_certificate: new smime cert still possible via menu
  • file_sign_encrypt_files: still possible via Drag&Drop
  • file_sign_encrypt_folder: still possible via Drag&Drop
  • tools_refresh_openpgp_certificates: still possible for single certs
  • tools_refresh_x509_certificates: still possible for single certs
  • view_certificate_details: still possible via doubleclick

maybe not as intended:

  • configure_groups: still possible via toolbar icon Groups
  • window_close_tab: still possible via context menu of unselected tab
  • window_duplicate_tab: still possible via context menu of unselected tab
  • window_move_tab_left: still possible via context menu of unselected tab
  • window_move_tab_right: still possible via context menu of unselected tab
  • window_rename_tab: still possible via context menu of unselected tab
  • window_view_hierarchical: menu entry still displayed, but disfunctional

Details

Version
vsd-3.3.3-beta90.29 @ win10

Related Objects

Event Timeline

timegrid created this task.Wed, Nov 5, 9:57 AM
timegrid created this object with edit policy "Contributor (Project)".
timegrid added projects: kleopatra, vsd.
timegrid updated the task description. (Show Details)Wed, Nov 5, 10:13 AM
timegrid updated the task description. (Show Details)Wed, Nov 5, 2:23 PM
timegrid updated the task description. (Show Details)Wed, Nov 5, 2:26 PM
• ikloecker added a comment.EditedWed, Nov 5, 2:44 PM

This looks questionable:

HKEY_LOCAL_MACHINE\Software\Wow6432node\GNU\Kleopatra
HKEY_CURRENT_USER\Software\GNU\Kleopatra

Either both keys use the 32-bit compatibility path Wow6432node\ or both keys don't. 32-bit builds (like VSD 3.x) will use the compatibility path (without being aware of the redirection). 64-bit builds (like Gpg4win 5.x) don't use it. Since Windows mirrors some settings between both registry paths it may not matter.

Regarding KDE Action Restrictions:

  • action/configure_backend; REMOVE; this action has been disabled long ago and the disabled code was finally removed while working on T5404: Kleopatra: OpenPGP LDAP keyserver configuration impossible for at least 2.3
  • action/help_show_compendium; TYPO?; there is help_doc_compendium, but this action is hidden if the Gpg4win Compendium document is not included in the installer; it's probably not included in VSD, so that REMOVE makes sense
  • action/tools_start_kwatchgnupg; KEEP?; this action only exists for Linux-builds; the kwatchgnupg tool isn't really that useful and it messes up the GnuPG configuration files so that it's better to hide it
  • action/view_certificate_overview; KEEP; has been removed with T7361: notepad: Move to an external window, but this won't be backported to VSD 3.x

For VSD 3.x look for actions in this file: https://dev.gnupg.org/source/kleo/browse/gpg4win%252F24.05/src/kleopatra.rc
Some standard actions come from this file: https://invent.kde.org/frameworks/kxmlgui/-/blob/v6.11.0/src/ui_standards.rc?ref_type=tags

• ikloecker added a comment.Wed, Nov 5, 2:50 PM

For settings in VSD 3.x best look at https://dev.gnupg.org/source/kleo/browse/gpg4win%252F24.05/src/kcfg/settings.kcfg (gpg4win/24.05 branch).

• ikloecker added a comment.EditedWed, Nov 5, 2:56 PM

I think there is a misconception about Action Restrictions. Yes, they exclusively disable the corresponding action, i.e. the action is hidden (from menus and toolbars) and the keyboard shortcuts won't do anything. Action restrictions are no means to disable certain functionality as a whole like "Add User ID". Just because somebody listed all available actions in the documentation (which is rather questionable in my opinion) doesn't mean that it makes sense to remove those actions. Maybe only relevant/important actions should be listed so that the readers are not drowned in a huge list of largely irrelevant settings.

Example: Disabling view_certificate_overview would be very stupid because then users wouldn't be able to switch back to the certificate list after they switched to the Notepad. (On the other hand, disabling pad_view makes sense if the users shall not be able to use the Notepad.)

timegrid added a comment.Wed, Nov 5, 3:06 PM

My point about action restrictions was to add one sentence in the docs section to clarify, what exactly is restricted then.

With "remove option" i meant from the documentation (this ticket is about documentation).

timegrid added a comment.Wed, Nov 5, 3:12 PM

So, for the current vsd docs (3.3): https://gnupg.com/vsd/kleopatra-settings.html
This would be more correct, if i understood it right?

HKEY_LOCAL_MACHINE\Software\Wow6432node\GNU\Kleopatra
HKEY_CURRENT_USER\Software\Wow6432node\GNU\Kleopatra