fix(sdk): redact standalone keys and structured credentials #322
+161
−8
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| import { describe, expect, test } from "bun:test"; | ||
| import { redactedErrorMessage } from "../src/errors.js"; | ||
|
|
||
| describe("security error redaction", () => { | ||
| test("redacts standalone and truncated PEM private-key envelopes", () => { | ||
| expect( | ||
| redactedErrorMessage( | ||
| "provider failed: -----BEGIN PRIVATE KEY-----\nSYNTHETIC_PRIVATE_KEY\n-----END PRIVATE KEY----- safe=value", | ||
| ), | ||
| ).toBe("provider failed: [redacted] safe=value"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| "provider failed: -----BEGIN RSA PRIVATE KEY-----\nSYNTHETIC_TRUNCATED_KEY", | ||
| ), | ||
| ).toBe("provider failed: [redacted]"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| "provider failed: -----BEGIN PGP PRIVATE KEY BLOCK-----\nSYNTHETIC_PGP_PRIVATE_KEY\n-----END PGP PRIVATE KEY BLOCK----- safe=value", | ||
| ), | ||
| ).toBe("provider failed: [redacted] safe=value"); | ||
| }); | ||
|
|
||
| test("redacts every parameter from structured authorization schemes", () => { | ||
| expect( | ||
| redactedErrorMessage( | ||
| 'Authorization: Digest username="example", response=SYNTHETIC_DIGEST_SECRET', | ||
| ), | ||
| ).toBe("Authorization: Digest [redacted]"); | ||
| expect( | ||
| redactedErrorMessage("auth=Custom response=SYNTHETIC_AUTH_SECRET"), | ||
| ).toBe("auth=Custom [redacted]"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| "Authorization: Custom key=SYNTHETIC_AUTH_SECRET https://example.test/safe", | ||
| ), | ||
| ).toBe("Authorization: Custom [redacted] https://example.test/safe"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| 'Authorization: Digest username="a\\"b", response="SYNTHETIC_DIGEST_SECRET"', | ||
| ), | ||
| ).toBe("Authorization: Digest [redacted]"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| "Authorization: Digest username*=UTF-8''user, response=SYNTHETIC_DIGEST_SECRET", | ||
| ), | ||
| ).toBe("Authorization: Digest [redacted]"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| 'client_authorization_value=Digest username="example", response="SYNTHETIC_DIGEST_SECRET"', | ||
| ), | ||
| ).toBe("client_authorization_value=Digest [redacted]"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| "Authorization: 0-custom 0nonce=visible, !response=SYNTHETIC_DIGEST_SECRET", | ||
| ), | ||
| ).toBe("Authorization: 0-custom [redacted]"); | ||
| }); | ||
|
|
||
| test("redacts encoded API-key names without consuming other parameters", () => { | ||
| for (const separator of ["%5F", "%2D"]) { | ||
| const value = `https://example.test/?api${separator}key%3DSYNTHETIC_API_KEY%26safe%3Dvisible`; | ||
| expect(redactedErrorMessage(value)).toBe( | ||
| `https://example.test/?api${separator}key%3D[redacted]%26safe%3Dvisible`, | ||
| ); | ||
| } | ||
| }); | ||
|
|
||
| test("redacts plural credential assignments and quoted values", () => { | ||
| expect( | ||
| redactedErrorMessage( | ||
| "credentials=SYNTHETIC_CREDENTIAL clientCredentials=SYNTHETIC_CLIENT apiKeys=SYNTHETIC_KEYS", | ||
| ), | ||
| ).toBe( | ||
| "credentials=[redacted] clientCredentials=[redacted] apiKeys=[redacted]", | ||
| ); | ||
| expect( | ||
| redactedErrorMessage('{"credentials":"correct horse battery staple"}'), | ||
| ).toBe('{"credentials":"[redacted]"}'); | ||
| expect( | ||
| redactedErrorMessage( | ||
| "credentials=[alice:SYNTHETIC_ONE,bob:SYNTHETIC_TWO] safe=visible", | ||
| ), | ||
| ).toBe("credentials=[redacted] safe=visible"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| '{"credentials":["SYNTHETIC_ONE","SYNTHETIC_TWO"],"safe":"visible"}', | ||
| ), | ||
| ).toBe('{"credentials":"[redacted]","safe":"visible"}'); | ||
| expect( | ||
| redactedErrorMessage( | ||
| 'credentials_value=["SYNTHETIC_ONE","SYNTHETIC_TWO"] safe=visible', | ||
| ), | ||
| ).toBe("credentials_value=[redacted] safe=visible"); | ||
| expect( | ||
| redactedErrorMessage( | ||
| '{"api_keys_data":[{"key":"SYNTHETIC_ONE"},{"key":"SYNTHETIC_TWO"}]}', | ||
| ), | ||
| ).toBe('{"api_keys_data":"[redacted]"}'); | ||
| expect( | ||
| redactedErrorMessage("password=prefix\\SYNTHETIC_SECRET safe=visible"), | ||
| ).toBe("password=[redacted] safe=visible"); | ||
| }); | ||
| }); |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The updated matcher now accepts additional token punctuation, but the new
{1,65}ceiling still rejects valid HTTP auth-param names longer than 65 characters. In that case the generic fallback redacts only the first fragment; for example,Authorization: Digest <66-character-name>=foo, response=SECRETbecomesAuthorization: Digest [redacted], response=SECRET. Remove the arbitrary token-length limit so later structured credential parameters cannot leak.Useful? React with 👍 / 👎.