-
Notifications
You must be signed in to change notification settings - Fork 19
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix scan image multiple creds #200
Conversation
Signed-off-by: Amir Malka <amirm@armosec.io>
Signed-off-by: Amir Malka <amirm@armosec.io>
|
GitGuardian id | Secret | Commit | Filename | |
---|---|---|---|---|
9273905 | Generic High Entropy Secret | f14d7b5 | core/services/scan_test.go | View secret |
9273906 | Generic High Entropy Secret | f14d7b5 | core/services/scan_test.go | View secret |
9273907 | Generic High Entropy Secret | f14d7b5 | core/services/scan_test.go | View secret |
🛠 Guidelines to remediate hardcoded secrets
- Understand the implications of revoking this secret by investigating where it is used in your code.
- Replace and store your secrets safely. Learn here the best practices.
- Revoke and rotate these secrets.
- If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.
To avoid such incidents in the future consider
- following these best practices for managing and storing secrets including API keys and other credentials
- install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.
🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.
Our GitHub checks need improvements? Share your feedbacks!
PR Description updated to latest commit (03f126b) |
PR Analysis
PR Feedback💡 General suggestions: The PR is well-structured and the changes are well explained. It's good to see that tests have been added for the new functions. However, it would be better to handle errors more explicitly in the new functions, instead of silently returning default values. 🤖 Code feedback:
✨ Usage guide:Overview:
With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
…age-multiple-creds Signed-off-by: Amir Malka <amirm@armosec.io>
Summary:
|
User description
Overview
This PR fixes an issue when working with multiple sets of image registry credentials when scanning an image:
append
was called multiple times in a loop onRegistryOptions.Credentials
, causing invalid credential objectsserveraddress
instead of theauth
field which is a base64 encoded string of "user:pass".Type
Bug fix, Tests
Description
This PR addresses an issue with handling multiple sets of image registry credentials when scanning an image. The main changes include:
registryCredentialsFromCredentialsList
that creates a list ofRegistryCredentials
from a list ofAuthConfig
.parseAuthorityFromServerAddress
to extract the authority from the server address.credentialsLog
to create a string representation of the credentials without the password and token for logging purposes.registryCredentialsFromCredentialsList
andparseAuthorityFromServerAddress
.Changes walkthrough
scan.go
core/services/scan.go
The changes in this file mainly revolve around the handling
of registry credentials. The previous approach of appending
credentials in a loop was replaced with a new function
registryCredentialsFromCredentialsList
that creates a listof
RegistryCredentials
from a list ofAuthConfig
. Thisfunction also includes a call to
parseAuthorityFromServerAddress
which extracts theauthority from the server address. Additionally, a new
function
credentialsLog
was added to create a stringrepresentation of the credentials without the password and
token for logging purposes.
scan_test.go
core/services/scan_test.go
This file includes new tests for the functions
registryCredentialsFromCredentialsList
andparseAuthorityFromServerAddress
that were added inscan.go
. The tests ensure that the functions are correctlycreating
RegistryCredentials
fromAuthConfig
and parsingthe authority from the server address.
✨ Usage guide:
Overview:
The
describe
tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.When commenting, to edit configurations related to the describe tool (
pr_description
section), use the following template:With a configuration file, use the following template:
Enabling\disabling automation
meaning the
describe
tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.the tool will replace every marker of the form
pr_agent:marker_name
in the PR description with the relevant content, wheremarker_name
is one of the following:type
: the PR type.summary
: the PR summary.walkthrough
: the PR walkthrough.Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the
describe
tool are quite generic: [Bug fix
,Tests
,Enhancement
,Documentation
,Other
].If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:
Main topic:performance
- pr_agent:The main topic of this PR is performanceNew endpoint
- pr_agent:A new endpoint was added in this PRSQL query
- pr_agent:A new SQL query was added in this PRDockerfile changes
- pr_agent:The PR contains changes in the DockerfileThe list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Utilizing extra instructions
The
describe
tool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.