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

identity: improve the documentation for Principal.Name() #579

Merged

Conversation

nsmith5
Copy link
Contributor

@nsmith5 nsmith5 commented May 12, 2022

Summary

Clarifies that Name must match the proof of possession.

@haydentherapper let me know if you can thing of a better name for the method. Happy to add that in here. Thought I'd at least improve the docs while I remembered to.

Clarify that the must match proof of possession

Signed-off-by: Nathan Smith <[email protected]>
@codecov-commenter
Copy link

Codecov Report

Merging #579 (3b7c790) into main (8d307b5) will decrease coverage by 0.67%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #579      +/-   ##
==========================================
- Coverage   44.29%   43.62%   -0.68%     
==========================================
  Files          21       21              
  Lines        1517     1513       -4     
==========================================
- Hits          672      660      -12     
- Misses        771      781      +10     
+ Partials       74       72       -2     
Impacted Files Coverage Δ
pkg/ca/x509ca/common.go 0.00% <0.00%> (-32.61%) ⬇️
pkg/ca/googleca/v1/googleca.go 52.25% <0.00%> (ø)
pkg/challenges/challenges.go 29.71% <0.00%> (+0.93%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8d307b5...3b7c790. Read the comment docs.

Copy link
Contributor

@haydentherapper haydentherapper left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the added documentation. I think this is good for now - Naming is hard :)

Ideally I'd like to call this Subject, but it's not accurate in terms of OIDC.

@haydentherapper haydentherapper merged commit 8e2f0e1 into sigstore:main May 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants