> The intention of keyring is that the default behavior _should_ be suitable.
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 30/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- backend-api-design, security
Research direction
Start by reviewing keyring's chainer behavior and the existing get_keyring() entry point. Evaluate the proposed APIs for listing supported password safes and persisting a selected backend, including how application-specific selection should work. Done means the API design and configuration behavior are clearly specified and supported by appropriate tests.
Written by the indexing model from the issue text.
Description
> The intention of keyring is that the default behavior _should_ be suitable.
If the presence of the chainer is causing problems, it probably shouldn't be enabled by default
or at the very least should have an escape hatch (a way for a library like backintime to disable its usage).
I'd be happy to support such a thing in keyring if simply honoring chainer as "appropriate" isn't suitable.
chainer is a cool thing and my challenge is now that the keyring API and configuration should more or less be hidden to end users since it is meant for developers or customizers (it should be a black box to end users IMHO).
So I have to give the end-user of Back In Time a simply way to configure this from the Back-in-Time-app point of view (user should not need to learn internals of keyring).
keyring's chainer uses some "heuristics" that seems to work non-deterministically from the Application point-of-view since external installations or settings may influence the priority value (I still have not completely browsed the keyring code so this is still more opinion than fact based I admit).
So the end user just want's to specify and persist the used "password safe" instead of a technical backend of an App-internal library.
And until the user does specify a "password safe" the "best guess" is the chainer so the default is good IMHO.
What would be nice in keyring to improve embedding it into an CLI or GUI app:
-
Add a public method to query for supported "password safes" (internally asking all available backends)
return a list of the "pretty-labeled" password safes and a list of responsible backend names for each password safe
to be used internally by 2.This would allow to fill a GUI widget more easily.
Open question: How to cope with the 1:n nature of password safe to backends in the GUI then.
The end user must take a decision for a backend finally, but based on which information? -
Add a public method to persist the chosen backend without editing a file.
An app (askeyringclient) shoudn't have to know the storage location and file format (= encapsulate this inkeyring).
Optionally this setting could be valid only for a app (could be passed as key) but I assume that the selection
should be right for every app/client then. -
I assume we don't need to add an API to read the config file since the active backend (dominated by an existing config file)
can already be queried withget_keyring().
~/.config/python_keyring/keyringrc.cfg containing ... necessary to “steer” the keyring system to using the correct backend.
If honoring an environment variable or some other mechanism would help,
keyring would be interested in exploring making this use-case simpler.
I think a persistence API would be more helpful than another env var (see proposal 2).
Originally posted by @aryoda in https://github.com/bit-team/backintime/issues/990#issuecomment-1272014311
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 208
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from jaraco/keyring
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
-
macOS: denied keychain prompt on delete raises PasswordDeleteError instead of KeyringLockedPossibly taken @r3wretrhy claimed this 46 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
Difficulty 3/5 1-2 days Newbie friendliness 50/100
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
Remove B018 suppressions after adopting skeleton's B018 ignorePossibly taken @Madin-H23 claimed this 26 days ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 78/100
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 86/100
benchflow-ai/skillsbench#1090 ·
-
Missing unit tests for human-readable date/time formatters in utils/datetime.pyPossibly taken @prabhleen2317 claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
apache/iceberg-python#4387 ·
Maintainers usually reply within 1 day
-
[BUG] Hermes MCP adapter drops cwd, extra passthrough keys and the SSE transport when writing config.yamlPossibly taken @Parth-Vasave claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
microsoft/apm#3749 · 1 comment ·
Maintainers usually reply within 1 day
-
backend bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
NVIDIA/numba-cuda-mlir#467 · 1 comment ·
Maintainers usually reply within 3 days