DXCDT-316: More self-documenting reveal secret flag #591
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
Widcket
reviewed
Jan 9, 2023
docs/auth0_apps_create.md
Outdated
| @@ -21,29 +21,29 @@ auth0 apps create [flags] | |||
| auth0 apps create --name myapp | |||
| auth0 apps create --name myapp --description <description> | |||
| auth0 apps create --name myapp --description <description> --type [native|spa|regular|m2m] | |||
| auth0 apps create --name myapp --description <description> --type [native|spa|regular|m2m] --reveal | |||
| auth0 apps create --name myapp --description <description> --type [native|spa|regular|m2m] --reveal-client-secret | |||
There was a problem hiding this comment.
Note that when passing the --json flag, the reveal flag will not only show the client secret, but the signing keys as well: https://github.com/auth0/auth0-cli/blob/v1/internal/display/apps.go#L244
Would it make sense to rename it to something a little more generic, like --reveal-secrets?
There was a problem hiding this comment.
Definitely makes sense 👍🏻 , updated in 9a0f016 (#591)
sergiught
force-pushed
the
DXCDT-316-more-descriptive-reveal-flag
branch
from
44d27bf
to
9a0f016
Compare
sergiught
approved these changes
Jan 10, 2023
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.
🔧 Changes
As noted by #488, the
--revealflag in theauth0 clients createandauth0 clients updatecommands is not very descriptive about what it is revealing. This PR is to make the flag more verbose to be clear about what behavior is being triggered. This is also important from a security perspective to reduce any accidental occurrences of revealing the secret unintentionally.While this appears to be a very trivial change, it is important to get as many potential breaking changes in before the upcoming v1.0.0 release.
📚 References
Original issue: #488
🔬 Testing
No functional changes. Appropriate changes made to existing tests.
📝 Checklist