-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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 demo kdbx file (password is secret
)
#3294
Add demo kdbx file (password is secret
)
#3294
Conversation
The demo.kdbx password safe contains a number of realistically looking but imaginary accounts for popular web services (Amazon, eBay, Google, etc.) The owner's name is supposed to be John Doe, his e-mail address is john.doe@example.com. The intended use of this file is: * To try out features (like the upcoming Paper Backup, #3277) without using one's own database. * To have a more-or-less realistic database file. The other kdbx files in the tests/data directory all have some peculiarity or another. * To have a password database from which one can take screenshots in order to demonstrate bugs or new features. So, the recommendation "don't include screen shots of your database" can be changed to "include screen shots of the demo database". * To have something you can mess around with without being afraid to mess up your own database. If you mess up too bad, use git to revert your changes. The location of the demo database is `tests/data/demo.kdbx`. The password is `secret`. So far, the demo database is in the source tree only, to be used by developers. Someone else may decide whether it could be placed in the distribution, or maybe even made available for download from the KeePassXC web site so that new users have something to play around with.
I really like this idea! Although I think its real benefit would only shine if all (most) fields would be filled out. It would be really useful to have a test DB that contain realistic data that would show how people really use the specific fields and features. For example, just off the top of my head:
|
Add a second group that contais more sophisticated items: Attachments, attributes, notes, expiration. Note that the "ssh key" is completely imaginary and cannot be used for anything realistic. For example, the public and private keys don't fit together, the pass phrase and finger print don't match, etc. It's just for demo purposes, like anything in this file.
This will be good to have a consistent DB to use for screenshots in documentation as well. Can you move it outside the tests/data folder and put it in the share folder? Some more things to add:
|
@ba32107 Good point. Added some more sophistication to the demo database. The idea is to be realistic without exploring edge cases, demonstrate without showing off. Show the average case, not the extremes. Be intuitively understandable without much need for explanation. Feedback is welcome, of course, everybody has their own idea of what "realistic" means. |
providing a “demo” password database with a publicly known password to non technical users will lead them to use that database for their own accounts and expose them. |
LOL I doubt it |
I would like to deploy this into the share directory of our release. I foresee this as the future way to implement a form of a tutorial or sandbox that is easily accessed. In the share director the database would open "read-only" and we could explicitly require changing the password if the user did a save-as operation. |
Glad you like it. :) Anything else I can do before it gets merged? |
Still need to describe the demo database in the change log file. In the distribution, in what location will demo.kdbx be installed on the client machines? Would like to mention that in the change log entry. |
Don't worry about the changelog I do that up just before release. This PR does not move the database anywhere, as far as I can recall. |
The demo.kdbx password safe contains a number of realistically looking
but imaginary accounts for popular web services (Amazon, eBay, Google,
etc.) The owner's name is supposed to be John Doe, his e-mail address
is john.doe@example.com.
The intended use of this file is:
using one's own database.
in the tests/data directory all have some peculiarity or another.
order to demonstrate bugs or new features. So, the recommendation
"don't include screen shots of your database" can be changed to
"include screen shots of the demo database".
mess up your own database. If you mess up too bad, use git to revert
your changes.
The location of the demo database is
tests/data/demo.kdbx
. Thepassword is
secret
.So far, the demo database is in the source tree only, to be used
by developers. Someone else may decide whether it could be placed in the
distribution, or maybe even made available for download from the KeePassXC
web site so that new users have something to play around with.
Type of change
Description and Context
See above. Added two files, demo.kdbx with the demo database and demo.key
with the password.
Screenshots
Testing strategy
New database tested manually. No existing components were changed.
Checklist:
-DWITH_ASAN=ON
. [REQUIRED]