Remediate incidents
Guidelines (& misconceptions)
It is crucial development teams fully understand the problem of secrets-in-code, beyond the simple act of exposing a secret in plain text and committing it to the shared codebase.
Developers need to acknowledge the threats and consequences of secrets sprawl, and picture how collaborating with security teams can strengthen the overall security posture – without compromising speed and productivity.
Collaborating with developers
Involving developers is crucial for the remediation. Developers also have knowledge about the secret itself, since they are the ones who used it. They also understand the system's architecture and the services that may depend on the secret. They can provide insight into affected services and the best way to mitigate issues. This knowledge is essential in creating an effective and efficient remediation plan.
GitGuardian's goal is to enable easy collaboration with your developers by providing flexible ways to share your incidents.
Share the incident
You can collaborate by sharing the incident in two ways:
- Internally, with users registered on the dashboard, via the "Grant access" action. This option is only available for Business workspaces.
- Externally, with non-registered users, via the "Public sharing" action.
More details are available in our dedicated Collaboration and sharing section.
Collect the feedback
The feedback form enables you to collect standardized feedback about an incident. To fill out the form, registered users require the "Can edit" incident permission. They can also edit or delete their own feedback.
Whenever feedback is submitted for an incident, whether by a registered user or a non-registered user, an email notification is sent:
- to the incident assignee, if applicable.
- to all users with access to the incident, if there is no assignee.
Every action taken by the developer will be logged in the incident details timeline.
The feedback form is not customizable yet.
Remediation workflow
Default remediation workflow
Remediating an incident can be complex. That is why a remediation workflow is displayed by default on an incident's details page.
This workflow is intended to guide anyone involved in the remediation of a hardcoded secret incident. It describes the steps that must be followed to mitigate the risks of exposure.
Custom remediation workflow
GitGuardian provides a remediation workflow by default. As each organization has its own context and remediation policies, you have the ability to customize the remediation workflow.
Managing the remediation workflow
As a workspace Manager, you can manage the remediation workflow in the Secrets detection section of your settings.
From here, you can create, edit or delete a custom remediation workflow. You may also have the ability to switch between the default GitGuardian remediation workflow and your custom remediation workflow.
Alternatively, you can access this section directly by clicking the Edit workflow button on any remediation workflow in an incident's details page.
Creating a new custom remediation workflow
By default, there is no custom remediation workflow on your workspace.
You can create one by clicking the Create custom workflow button.
You will be asked to create each step of your remediation workflow:
Remediation workflow steps
Each step is composed of:
- A title (mandatory)
- A description (optional, Markdown syntax is not yet supported)
- A link (optional, this link is a good way to provide direct access to an external resource specific to your company)
Once the fields are filled in, simply click on the Add step button to validate the creation of your step.
Repeat the process to add any other steps.
Note that you can create a maximum of 20 steps for a custom remediation workflow.
Activating a remediation workflow
Once a custom remediation workflow has been created, you are free to select between the default GitGuardian remediation workflow and your own custom remediation workflow.
Once activated, the selected remediation workflow will be immediately displayed on all your incident's details pages. It will also affect any shared incident pages.
Editing a custom remediation workflow
Once created, a custom remediation workflow can be edited by:
- Adding a new step with the
Next Stepbutton - Editing a step with the pen button close to it
- Deleting a step with the thrash button close to it
- Reordering steps by dragging & dropping them
Any modification will be taken into account in real-time.
Deleting your custom remediation workflow
You can delete your custom remediation workflow with the red Delete workflow button.
By doing this, the default GitGuardian remediation workflow will be activated automatically.
This will also allow you to create a new custom remediation workflow.
Custom messages when using GitGuardian CLI (ggshield)
When GitGuardian CLI detects secrets in developers' code, whether in pre-commit or other stages, it is highly beneficial to provide them with clear instructions on using secrets in their code according to company standards (Vaults, Environment variables, ..).
Security teams have the ability to customize these messages, which will be disseminated through the CLI at different stages of the Software Development Life Cycle such as pre-commit, pre-push, and pre-receive.
