Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add database name, color, and icon options for unlock view #10819

Merged

Conversation

techninja1008
Copy link
Contributor

@techninja1008 techninja1008 commented May 27, 2024

Closes #10783

Adds three database configuration options (stored as public custom data) that allow a database to have a public name/summary, color, and/or icon to be displayed on the unlock screen. This information is configured in the Database Settings and stored in the database public custom data (ie, unencrypted).

The name/summary is stored in KPXC_PUBLIC_NAME, the color is stored in KPXC_PUBLIC_COLOR, and the icon is stored in KPXC_PUBLIC_ICON.

Screenshots

image

image

image

Testing strategy

I have extensively performed manual testing with different values of both the message (empty, short text, long text etc) and color (empty, varying colors, invalid colors etc). I've also tested opening/closing the database, starting keepassxc after it was the last DB opened etc to approach the unlock UI from different code paths.

Type of change

  • ✅ New feature (change that adds functionality)

@droidmonkey

This comment was marked as outdated.

@droidmonkey droidmonkey added this to the v2.8.0 milestone May 27, 2024
@techninja1008 techninja1008 force-pushed the feature/add-public-summary branch from 2592430 to b51c6e7 Compare May 27, 2024 20:01
@techninja1008

This comment was marked as outdated.

@techninja1008
Copy link
Contributor Author

@droidmonkey let me know if there is anything else you need to make this mergeable.

@droidmonkey
Copy link
Member

Seemed fine on first pass good work

@droidmonkey droidmonkey force-pushed the feature/add-public-summary branch from b51c6e7 to 3f9aba1 Compare June 2, 2024 03:04
@droidmonkey droidmonkey changed the title Add user-configurable summary to unlock screen. Add database name and color options for unlock view Jun 2, 2024
@droidmonkey

This comment was marked as outdated.

@droidmonkey droidmonkey force-pushed the feature/add-public-summary branch from 3f9aba1 to 17e67d0 Compare June 2, 2024 03:10
@techninja1008
Copy link
Contributor Author

I quite like both the second and third ones, however I still quite like the original banner style and how in your face it was

@droidmonkey
Copy link
Member

droidmonkey commented Jun 2, 2024

The original was ok, but looked like our warning/error banner to be honest. I wouldn't personally use this feature with the original look, but with the 2nd or 3rd I would. I also wanted to separate the database name from the color since some people would want one or the other. I'll let @phoerious weigh in before I make any more changes.

@RJVB
Copy link

RJVB commented Aug 26, 2024

If the goal is to make it easier to distinguish DBs from the unlock screen, how about showing the icon of the root collection? IMHO that'll work better for that particular purpose than a description, and it's less in-your-face than the big (IMHO aggressive) colour patches shown above.

FWIW, on OSes that support this the main DB icon could even be put in the file metadata so it shows in the Finder/Explorer/WhatEver.

@droidmonkey
Copy link
Member

droidmonkey commented Aug 26, 2024

That is a non-starter, it would expose internal data. However picking one of our standard icons as the "database icon" is not a bad idea if people don't want to use the color option.

@RJVB
Copy link

RJVB commented Aug 26, 2024 via email

@droidmonkey
Copy link
Member

droidmonkey commented Sep 2, 2024

OK, I added support for setting a database icon (choosing from the set of default icons only):

image

image

image

@droidmonkey droidmonkey force-pushed the feature/add-public-summary branch from 17e67d0 to 4cbd9a2 Compare September 2, 2024 20:34
@droidmonkey
Copy link
Member

@phoerious whatcha think?

@RJVB
Copy link

RJVB commented Sep 2, 2024 via email

@droidmonkey
Copy link
Member

The difference is between storing a number outside the encrypted data and storing a binary blob which constitutes the custom icon.

@RJVB
Copy link

RJVB commented Sep 2, 2024 via email

@droidmonkey droidmonkey changed the title Add database name and color options for unlock view Add database name, color, and icon options for unlock view Sep 7, 2024
@droidmonkey droidmonkey force-pushed the feature/add-public-summary branch from 4cbd9a2 to 4382e18 Compare October 7, 2024 03:30
@droidmonkey droidmonkey merged commit dbf9587 into keepassxreboot:develop Oct 8, 2024
11 checks passed
@droidmonkey droidmonkey added the pr: backported Pull request backported to previous release label Oct 12, 2024
droidmonkey added a commit that referenced this pull request Oct 12, 2024
Closes #10783

Adds three database configuration options (stored as public custom data) that allow a database to have a public name/summary, color, and/or icon to be displayed on the unlock screen. This information is configured in the Database Settings and stored in the database public custom data (ie, unencrypted).

The name/summary is stored in KPXC_PUBLIC_NAME, the color is stored in KPXC_PUBLIC_COLOR, and the icon is stored in KPXC_PUBLIC_ICON.

---------

Co-authored-by: Jonathan White <[email protected]>
@phoerious phoerious added pr: new feature Pull request that adds a new feature and removed new feature labels Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pr: backported Pull request backported to previous release pr: new feature Pull request that adds a new feature user interface
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add description / colour label to lock screen
4 participants