Skip to content
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

[FX-5062] Update Product Docs with Blackout Period #592

Merged
merged 22 commits into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from 20 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions content/en/Platform Deep Dive/Scans/blackout-period.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: "Blackout Period"
linkTitle: "Blackout Period"
weight: 45
description: Schedule blackout periods to automatically pause and resume your DAST scans
---

Blackout periods allow you to temporarily pause your DAST scans to avoid conflicts with other activities or to prevent disruptions during sensitive times.

- **Automatic Resumption:** Once the blackout period ends, your DAST scans will automatically resume without any manual intervention.
- **Flexible Scheduling:** Define blackout periods with precise start and end times to fit your specific needs.
- **No Data Loss:** Any scan progress made before the blackout period will be preserved, and the scan will continue from where it left off.

## Use Cases

- **Planned Maintenance:** Suspend scans during scheduled maintenance windows to prevent interference with system updates or infrastructure changes.
- **High-Traffic Events:** Pause scans during peak traffic periods or marketing campaigns to avoid performance impacts on your application.
- **Vulnerability Remediation:** Temporarily disable scans while you're actively fixing identified vulnerabilities to prevent redundant alerts.
- **Third-Party Integrations:** Prevent scans from interfering with scheduled tasks from other tools or services integrated with your application.

## Setting Up the Blackout Period

1. Go to your target's settings.
2. In the Scanner tab, locate the **Blackout Period** section.
3. Enable the feature by toggling the switch component.
{{% image src="/deepdive/scans/blackout-period-disabled.png" alt="Blackout Period - Disabled" %}}
5. Define the start and end time/day in your local timezone for when the scan will be paused and resumed.
{{% image src="/deepdive/scans/blackout-period-enabled.png" alt="Blackout Period - Enabled" %}}
7. Save your changes.
mtsuji-cobalt marked this conversation as resolved.
Show resolved Hide resolved

{{% alert title="Note" color="primary" %}}
Disabling the feature does not delete your saved blackout periods
{{% /alert %}}

## Other Considerations

- While a blackout period is active, no new scans will be initiated, and any in-progress scans will be paused.
- Ensure your blackout periods do not overlap with critical security testing windows to maintain continuous vulnerability assessment.
- Consider setting reminders for upcoming blackout periods to avoid unintended lapses in security coverage.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand which reminders.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI added in this one, and I think it means to just set up reminders for yourself to know when the blackout periods are (not in-app but something nice to do on your own). I can remove it if it's confusing in any way.



mtsuji-cobalt marked this conversation as resolved.
Show resolved Hide resolved
6 changes: 3 additions & 3 deletions content/en/Platform Deep Dive/Scans/reduced-scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ description: Define a specific set of URLs within your target to scan

Rather than scanning the entire target, specify a subset of URLs within your target to scan by defining a Reduced Scope in your target settings. This is particularly useful when you want to focus on specific areas of your application, such as new features or high-risk areas.

### Benefits
## Benefits

- **Faster Feedback:** Get faster feedback on the security of your code changes. This is especially helpful in CI/CD pipelines, where you need to deliver code changes quickly and reliably.
- **Reduced Scan Time:** Scanning a smaller subset of your target can significantly reduce the overall scan time.
- **Focused Scans:** Focus your scans on specific areas of your target that are most important or that have undergone recent changes.
- **Reduced Noise:** Reduce the number of vulnerabilities reported, making it easier to focus on the most critical issues.

### Using a Reduced Scope Partial Scan
## Using a Reduced Scope Partial Scan

1. Go to your target's settings.
2. In the Scanner tab, locate the **Reduced Scope** section.
Expand All @@ -27,7 +27,7 @@ Rather than scanning the entire target, specify a subset of URLs within your tar
{{% image src="/deepdive/scans/partial-scans-modal.png" alt="Reduced Scope Scan Now" %}}
- When starting a scan, you can temporarily enable or disable individual URLs within your Reduced Scope through the checkbox next to each URL.

### Other Considerations
## Other Considerations

- **Target Hostname and Extra Hosts**: Only the target's hostname and defined extra hosts are allowed in the reduced scope.
- **Inaccessible Endpoints**: If you want to test endpoints that are not accessible through your target's root, you will need to add them to the Seeds List module in your target settings.
Expand Down
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recently we've been using red rectangles to highlight buttons or sections in the docs. Like in the integration builder. Would be nice to have similar visuals added in new screenshots.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, the visuals are all over the place in our docs. Historically, the tech writers used the purple to highlight things in screenshots. I think Design needs to set standards around this one.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/deepdive/scans/blackout-period-enabled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading