feat: add check to detect URL annotations with suspicious characters #399
Conversation
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
Signed-off-by: Nikita Pivkin <nikita.pivkin@smartforce.io>
simar7
reviewed
May 6, 2025
Comment on lines
+9
to
+28
| "valid url": { | ||
| "key": "link.argocd.argoproj.io/external-link", | ||
| "value": "https://valid-url.com", | ||
| "expected": 0, | ||
| }, | ||
| "suspicious characters": { | ||
| "key": "link.argocd.argoproj.io/external-link", | ||
| "value": "http://example.com/#;\ninjection_point", | ||
| "expected": 1, | ||
| }, | ||
| "unsupported annotation": { | ||
| "key": "foo", | ||
| "value": "http://example.com/#;\ninjection_point", | ||
| "expected": 0, | ||
| }, | ||
| "alb oidc": { | ||
| "key": "alb.ingress.kubernetes.io/auth-idp-oidc", | ||
| "value": `'{"issuer":"https://example.com","authorizationEndpoint":"http://example.com/#;\ninjection_point","tokenEndpoint":"https://token.example.com","userInfoEndpoint":"https://userinfo.example.com","secretName":"my-k8s-secret"}'`, | ||
| "expected": 1, | ||
| }, |
There was a problem hiding this comment.
note: since we don't have a way to definitively prove an annotation key would have a value of a URL, we are relying here for two specific keys:
"alb.ingress.kubernetes.io/auth-idp-oidc"which is part of the kubernetes well known URL annotations"link.argocd.argoproj.io/external-link"a commonly used annotation in argoCD.
determining if a key will have a value of a URL is a hard problem. therefore we've started with well-known annotations for now.
WDYT @itaysk?
There was a problem hiding this comment.
I guess that is fine. we could also search for regexp matches across all annotations but I imagine the concern was for performance?
There was a problem hiding this comment.
Performance certainly yes but there could be annotations where a URL is expected as a value but the key may not make it obvious as such.
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.
Related issues: