Linter Updates: Ignore .env files and redacted keys #245
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
This change only protects against the specific redacted format that Stripe returns which looks something like "sk_live_aa********************1234". It does not attempt to detect other potential ways users can modify the keys nor actually validate that the key is real. This change fixes #220 and #222
gracegoo-stripe
commented
Jun 3, 2021
Comment on lines
+82
to
+103
| prepareLineDiagnostics = | ||
| (message: string) => | ||
| (line: string, index: number): Diagnostic[] => { | ||
| const diagnostics: Diagnostic[] = []; | ||
|
|
||
| let match; | ||
| while ((match = stripeKeysRegex.exec(line)) !== null) { | ||
| const severity = /sk_live/.test(match[0]) | ||
| ? DiagnosticSeverity.Error | ||
| : DiagnosticSeverity.Warning; | ||
|
|
||
| // specify line and character range to draw the squiggly line under the API Key in the document | ||
| const range = new Range(index, match.index, index, match.index + match[0].length); | ||
| // create new diagnostic and add to the list of total diagnostics for this line of code | ||
| const diagnostic = new Diagnostic(range, message, severity); | ||
|
|
||
| this.telemetry.sendEvent('diagnostics.show', severity); | ||
| diagnostics.push(diagnostic); | ||
| } | ||
|
|
||
| return diagnostics; | ||
| }; |
There was a problem hiding this comment.
Sorry about this, please hit "hide whitespace changes"
vcheung-stripe
approved these changes
Jun 3, 2021
Exactly! |
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.
The redaction change is targeted to protect against the specific redacted format that Stripe returns which looks something like "sk_live_aa********************1234".
It does not attempt to detect other potential ways users can modify the keys nor actually validate that the key is real.
This change fixes #220 and #222
Testing
.env file before:
after:
redacted keys before:
after:
