feat(terraform): Add hyphen and non-ASCII support for domain names in credential extraction #6108
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
…s-in-credential-extraction
simar7
reviewed
Feb 14, 2024
Comment on lines
139
to
161
| func getPrivateRegistryTokenFromEnvVars(hostname string) (string, error) { | ||
| token := "" | ||
| asciiHostname, err := idna.ToASCII(hostname) | ||
| if err != nil { | ||
| return "", fmt.Errorf("Could not convert hostname %s to a punycode encoded ASCII string so cannot find token for this registry", hostname) | ||
| } else { | ||
| envVar := fmt.Sprintf("TF_TOKEN_%s", strings.ReplaceAll(asciiHostname, ".", "_")) | ||
| token = os.Getenv(envVar) | ||
|
|
||
| // Dashes in the hostname can optionally be converted to double underscores | ||
| if token == "" { | ||
| envVar = strings.ReplaceAll(envVar, "-", "__") | ||
| token = os.Getenv(envVar) | ||
| } | ||
|
|
||
| if token == "" { | ||
| return "", fmt.Errorf("No token was found for the registry at %s", hostname) | ||
| } else { | ||
| return token, nil | ||
| } | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
How about if we drop the trailing else?
Suggested change
| func getPrivateRegistryTokenFromEnvVars(hostname string) (string, error) { | |
| token := "" | |
| asciiHostname, err := idna.ToASCII(hostname) | |
| if err != nil { | |
| return "", fmt.Errorf("Could not convert hostname %s to a punycode encoded ASCII string so cannot find token for this registry", hostname) | |
| } else { | |
| envVar := fmt.Sprintf("TF_TOKEN_%s", strings.ReplaceAll(asciiHostname, ".", "_")) | |
| token = os.Getenv(envVar) | |
| // Dashes in the hostname can optionally be converted to double underscores | |
| if token == "" { | |
| envVar = strings.ReplaceAll(envVar, "-", "__") | |
| token = os.Getenv(envVar) | |
| } | |
| if token == "" { | |
| return "", fmt.Errorf("No token was found for the registry at %s", hostname) | |
| } else { | |
| return token, nil | |
| } | |
| } | |
| } | |
| func getPrivateRegistryTokenFromEnvVars(hostname string) (string, error) { | |
| token := "" | |
| asciiHostname, err := idna.ToASCII(hostname) | |
| if err != nil { | |
| return "", fmt.Errorf("Could not convert hostname %s to a punycode encoded ASCII string so cannot find token for this registry", hostname) | |
| } | |
| envVar := fmt.Sprintf("TF_TOKEN_%s", strings.ReplaceAll(asciiHostname, ".", "_")) | |
| token = os.Getenv(envVar) | |
| // Dashes in the hostname can optionally be converted to double underscores | |
| if token == "" { | |
| envVar = strings.ReplaceAll(envVar, "-", "__") | |
| token = os.Getenv(envVar) | |
| } | |
| if token == "" { | |
| return "", fmt.Errorf("No token was found for the registry at %s", hostname) | |
| } | |
| return token, nil | |
| } | |
There was a problem hiding this comment.
Agree, added
simar7
approved these changes
Feb 14, 2024
nikpivkin
reviewed
Feb 14, 2024
| "github.com/stretchr/testify/assert" | ||
| ) | ||
|
|
||
| func Test_getPrivateRegistryTokenFromEnvVars(t *testing.T) { |
There was a problem hiding this comment.
How about using a table test here? Here's an example https://github.com/aquasecurity/trivy/blob/main/pkg/licensing/classifier_test.go#L15
There was a problem hiding this comment.
Done, see what you think
…tial-extraction' of https://github.com/adam-carruthers/trivy into hyphen-and-non-ascii-support-for-domain-names-in-credential-extraction
…s-in-credential-extraction
|
Sorry, was on holiday! Sorry it took me a little bit to get back to it. |
simar7
approved these changes
Feb 23, 2024
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.
Description
Related issues
Related PRs
TF_TOKEN: Optionally transform-character in hostname for TF_TOKEN to__trivy-iac#95 - This PR was open and almost accepted in trivy-iac, but that repo was merged into the main trivy repo very recentlyChecklist