Set a better displaylabel for secretservice #324
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #324 +/- ##
==========================================
- Coverage 53.26% 53.10% -0.16%
==========================================
Files 9 9
Lines 674 676 +2
==========================================
Hits 359 359
- Misses 270 272 +2
Partials 45 45 ☔ View full report in Codecov by Sentry. |
crazy-max
approved these changes
Oct 25, 2024
thaJeztah
commented
Oct 25, 2024
secretservice/secretservice.go
Outdated
| @@ -33,8 +33,10 @@ func (h Secretservice) Add(creds *credentials.Credentials) error { | |||
| defer C.free(unsafe.Pointer(username)) | |||
| secret := C.CString(creds.Secret) | |||
| defer C.free(unsafe.Pointer(secret)) | |||
| displayLabel := C.CString("Docker credentials for " + creds.ServerURL) | |||
There was a problem hiding this comment.
looking now at it; should it be either configurable, or more generic? (registry credentials for)?
There was a problem hiding this comment.
Or alternatively, we could use the name of the binary perhaps (docker-credentials-secretservice by default)
Just thinking out loud here 🤗
There was a problem hiding this comment.
Hum yeah "Registry credentials" sounds better indeed
thaJeztah
force-pushed
the
carry_207_friendlier_labels
branch
from
c805249 to
9c54706
Compare
Secretservice entries have a "label". This is intended to be a human-readable description. It's actually called "Description" in UIs like seahorse, and the listing of existing secrets shows this as a name for each one. The entries stored by the credential helper set this to simply the repository URL. This is rather unfriendly, since entries like "gitlab.com" and "index.docker.io/v1" show up. Mixed in with entries from all other applications, it's hard to figure out what application owns each entry. This commit changes the label used when saving entries to be something human-readable (this is the intent of the "label" field, btw). Because of the naming scheme, this also results in all entries being shown together by default (since UIs tend to sort lexicographically). New entries will now be stores as: Registry credentials for $REGISTRY_URL Note that items stored by the secret service have multiple fields inside of them. One of those fields is called "label", and is used by the helper to filter items from the secret service. This "label" field is entirely unrelated to the items' label. The naming is most unfortunate. Signed-off-by: Hugo Osvaldo Barrera <[email protected]> Signed-off-by: Sebastiaan van Stijn <[email protected]>
thaJeztah
force-pushed
the
carry_207_friendlier_labels
branch
from
9c54706 to
5d54c65
Compare
crazy-max
approved these changes
Oct 28, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Secretservice entries have a "label". This is intended to be a human-readable description. It's actually called "Description" in UIs like seahorse, and the listing of existing secrets shows this as a name for each one.
The entries stored by the credential helper set this to simply the repository URL. This is rather unfriendly, since entries like "gitlab.com" and "index.docker.io/v1" show up. Mixed in with entries from all other applications, it's hard to figure out what application owns each entry.
This commit changes the label used when saving entries to be something human-readable (this is the intent of the "label" field, btw). Because of the naming scheme, this also results in all entries being shown together by default (since UIs tend to sort lexicographically).
New entries will now be stores as:
Note that items stored by the secret service have multiple fields inside of them. One of those fields is called "label", and is used by the helper to filter items from the secret service. This "label" field is entirely unrelated to the items' label. The naming is most unfortunate.
- What I did
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)