Skip to content

Commit 8fad7af

Browse files
Code Security Documentation Content Update (#27406)
Co-authored-by: Michael Cretzman <[email protected]>
1 parent 41c44d6 commit 8fad7af

File tree

16 files changed

+122
-179
lines changed

16 files changed

+122
-179
lines changed

content/en/security/code_security/_index.md

+26-22
Original file line numberDiff line numberDiff line change
@@ -5,47 +5,51 @@ aliases:
55
- /code_analysis/
66
---
77

8-
Code Security scans your pre-production code, open source libraries, and repositories to find security vulnerabilities and code quality issues. It encompasses the following capabilities:
8+
Code Security scans your first-party code and open source libraries used in your applications in both your repositories and running services, providing end-to-end visibility from development to production. It encompasses the following capabilities:
99

10-
- [Static Code Analysis (SAST)][1] for your first-party code
11-
- [Software Composition Analysis][2] for open source dependencies in your codebase
10+
- [Static Code Analysis (SAST)][1] for identifying security and quality issues in your first-party code
11+
- [Software Composition Analysis (SCA)][2] for identifying open source dependencies in both your repositories and your services
1212
- [Runtime Code Analysis (IAST)][3] for code-level vulnerabilities in your services
1313

14-
## Static Code Analysis (SAST)
15-
16-
SAST analyzes static pre-production code to identify maintainability and security issues.
17-
18-
SAST has benefits for multiple people in your organization:
19-
14+
Code Security helps teams implement DevSecOps throughout the organization:
2015
- **Developers:** early vulnerablity detection, code quality improvements, faster development as developers spend less time debugging and patching.
21-
- **Site Reliability Engineers (SREs):** system resilience, security compliance, automated security checks as SAST integrates with CI/CD pipelines. Overall, SAST reduces manual overhead for SREs and ensures that each release is thoroughly tested for vulnerabilities.
22-
- **Administrators:** enhanced security posture, improved patch management in response to early vulnerability alerts, and compliance monitoring.
23-
- **Support Representatives:** incident prevention, faster issue resolutions, and customer assurance.
16+
- **Security Administrators:** enhanced security posture, improved patch management in response to early vulnerability alerts, and compliance monitoring.
17+
- **Site Reliability Engineers (SREs):** automated security checks throughout CI/CD workflow, security compliance, and system resilience. SAST reduces manual overhead for SREs and ensures that each release is thoroughly tested for vulnerabilities.
2418

25-
You supports scanning for multiple languages and you can integrate SAST into your development lifecycle using CI providers, source code management tools, and IDEs.
19+
## Static Code Analysis (SAST)
20+
Static Code Analysis (SAST) analyzes pre-production code to identify security and quality issues. You can embed best security and development practices throughout the software development lifecycle with:
21+
- IDE integration to flag violations in real time with deterministic suggested fixes
22+
- In-line GitHub pull request comments with deterministic suggested fixes and incremental/diff-aware scanning
23+
- Ability to open a pull request to fix a violation directly from Datadog
2624

27-
See [Static Code Analysis Setup][6] for more details.
25+
Scans can run via your CI/CD pipelines or directly in Datadog with hosted scanning (GitHub-only).
26+
See [Static Code Analysis Setup][6] to get started.
2827

2928
## Software Composition Analysis
29+
Software Composition Analysis (SCA) analyzes open source libraries in both your repositories and running services. You can track and manage dependencies across the software development lifecycle with:
30+
- IDE integration to flag vulnerabilities affecting libraries running on your services
31+
- Ability to open a pull request to fix a library vulnerability directly from Datadog
32+
- Runtime-informed prioritization of vulnerabilities with the Datadog severity score
3033

31-
Software Composition Analysis (SCA) analyzes open source libraries in both your repositories and running services, providing end-to-end visibility of library vulnerabilities and license management from development to production.
32-
33-
SCA supports [static][4] and [runtime][5] scanning and provides libraries in the most common languages and technologies.
34+
SCA supports both static and runtime dependency detection.
35+
For static scanning, you can scan via your CI/CD pipelines or directly via Datadog with hosted scanning (GitHub-only). See [static setup][4] to get started.
36+
For runtime vulnerability detection, you can easily enable SCA on your services instrumented with Datadog APM. See [runtime setup][5] to get started.
3437

3538
## Runtime Code Analysis (IAST)
39+
Runtime Code Analysis (IAST) identifies code-level vulnerabilities in your running services. It relies on inspection of legitimate application traffic as opposed to external testing that often requires extra configuration or periodic scheduling. IAST provides an up-to-date view of your attack surface area by:
40+
- Monitoring your code's interactions with other components of your stack (such as libraries and infrastructure)
41+
- Providing 100% coverage of the OWASP Top 10
42+
- Runtime-informed prioritization of vulnerabilities with the Datadog severity score
3643

37-
Datadog Runtime Code Analysis (IAST) identifies code-level vulnerabilities in your services and provides actionable insights and recommended fixes.
38-
39-
IAST enables Datadog to identify vulnerabilities using legitimate application traffic instead of relying on external tests that could require extra configuration or periodic scheduling. It also monitors your code’s interactions with other components of your stack, such as libraries and infrastructure, providing an up-to-date view of your attack surface area.
40-
41-
For a list of supported services, see [Runtime Code Analysis][3].
44+
You can enable IAST on your services instrumented with Datadog APM. See [IAST setup][3] to get started.
4245

4346
[1]: /security/code_security/static_analysis/
4447
[2]: /security/code_security/software_composition_analysis/
4548
[3]: /security/code_security/iast/
4649
[4]: /security/code_security/software_composition_analysis/setup_static/
4750
[5]: /security/code_security/software_composition_analysis/setup_runtime/
4851
[6]: /security/code_security/static_analysis/setup/
52+
[7]: /security/code_security/iast/setup/
4953

5054

5155

content/en/security/code_security/dev_tool_int/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Dev tool integrations
2+
title: Developer Tool Integrations
33
disable_toc: false
44

55
---

content/en/security/code_security/dev_tool_int/git_hooks/_index.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ A [Git hook](https://git-scm.com/docs/githooks) is a program executed before a u
1111
or pushes code to a remote location. A Git hook is generally used to run verifications
1212
and enforce requirements on the code before it is pushed to the remote branch.
1313

14-
Datadog Code Security provides a Git hook to check for static analysis
15-
violations or secrets before code is pushed or committed. The Datadog Code Security Git hook
16-
checks the code from the latest commit and the default branch and surfaces
14+
Datadog Code Security provides a Git hook to check for Static Code Analysis (SAST)
15+
violations or secrets before code is pushed or committed. The Code Security Git hook
16+
checks the code from the latest commit and the default branch and flags
1717
any errors it detects.
1818

1919
The Datadog Git hook warns developers before they push any code
@@ -54,6 +54,7 @@ The program accepts the following parameters:
5454
- `--confirmation`: Ask the user for confirmation to override the Git hook check
5555
- `--default-branch`: Specify the name of the default branch.
5656
- `--static-analysis`: Enable Static Code Analysis.
57-
- `--secrets`: Enable secrets detection (private beta).
57+
- `--secrets`: Enable secrets detection (in preview - please reach out to [Datadog Support][1]).
5858
- `--output <file>`: Export the findings found in the commit into a SARIF file.
5959

60+
[1]: https://www.datadoghq.com/support/

content/en/security/code_security/dev_tool_int/github_pull_requests/_index.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ aliases:
99
## Overview
1010

1111
Code Security integrates with GitHub pull requests in two ways:
12-
[Pull request comments to flag violations](#enable-code-security-pr-comments-for-your-repositories)
12+
- [Pull request comments to flag violations](#enable-code-security-pr-comments-for-your-repositories)
1313
{{< img src="ci/static-analysis-pr-comment-example.png" alt="Example of a Code Security comment on a pull request" style="width:90%;" >}}
14-
1514
- [Open a pull request to fix an issue directly from Datadog](#fixing-a-vulnerability-directly-from-datadog): You can create a pull request from the UI to fix a security vulnerability or code quality issue based on Datadog's suggested code fix. This is only available for Static Code Analysis (SAST).
1615
{{< img src="ci/sast_one_click_light.png" alt="Example of one-click remediation for Code Security" style="width:90%;" >}}
1716

@@ -21,7 +20,7 @@ To enable these features, ensure you have the required GitHub permissions (Read
2120

2221
### Enable Datadog Code Security
2322

24-
To use Datadog Code Security, add the appropriate configuration files to your repository, as described in the [setup instructions][1].
23+
To enable Code Security in-app, navigate to the [**Code Security** page][4].
2524

2625
### Configure a GitHub App
2726

content/en/security/code_security/guides/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ disable_toc: false
66

77

88

9-
{{< whatsnext desc="Software Composition Analysis" >}}
9+
{{< whatsnext desc="" >}}
1010
{{< nextlink href="/security/code_security/guides/automate_risk_reduction_sca/" >}}Automate open source risk reduction with Datadog SCA{{< /nextlink >}}
1111

1212
{{< /whatsnext >}}

content/en/security/code_security/iast/_index.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,13 @@ aliases:
77

88
## Overview
99

10-
Datadog Runtime Code Analysis (IAST) identifies code-level vulnerabilities in your services and provides actionable insights and recommended fixes.
11-
12-
For a list of supported services, see the [Library Compatibility Requirements][5].
10+
Datadog Runtime Code Analysis (IAST) identifies code-level vulnerabilities in your services and provides actionable insights and recommended fixes. For a list of supported services, see the [Library Compatibility Requirements][5].
1311

1412
Runtime Code Analysis uses an Interactive Application Security Testing (IAST) approach to find vulnerabilities within your application code based on your Datadog application instrumentation.
1513

1614
IAST enables Datadog to identify vulnerabilities using legitimate application traffic instead of relying on external tests that could require extra configuration or periodic scheduling. It also monitors your code’s interactions with other components of your stack, such as libraries and infrastructure, providing an up-to-date view of your attack surface area.
1715

18-
The Code Security detection rules support the following languages.
16+
IAST detection rules support the following languages.
1917

2018
| Severity | Detection Rule | Java | .NET | Node.js | Python |
2119
| -------- | ------------------------------------- | ----- | ----- | ------- |--------|
@@ -110,7 +108,7 @@ For information on disabling Code Security, see [Disabling Code Security][12].
110108
[2]: /security/code_security/iast/setup/java/
111109
[3]: /integrations/jira/
112110
[4]: /account_management/rbac/permissions/#integrations
113-
[5]: /security/code_security/iast/setup/
111+
[5]: /security/code_security/iast/setup/#using-datadog-tracing-libraries
114112
[6]: https://docs.google.com/forms/d/1wsgbd80eImvJSjXe5y5VCjAW0zzn5p3CoCLsOy0vqsk/
115113
[7]: /integrations/github/
116114
[9]: /security/code_security/iast/setup/

content/en/security/code_security/iast/setup/compatibility/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ further_reading:
1010
text: "How Application Security Management Works in Datadog"
1111
---
1212

13-
The following ASM capabilities are supported relative to each language's tracing library:
13+
The following capabilities are supported relative to each language's tracing library:
1414

15-
| Application Security capability | Java | .NET | Node.js | Python | Go | Ruby | PHP |
15+
| Capability | Java | .NET | Node.js | Python | Go | Ruby | PHP |
1616
|-----------------------------------------------|---------|----------|----------------|---------------|-----------------|---------------|---------------|
17-
| Code Security | 1.15.0 | 2.42.0 | 4.18.0 | Preview | not supported | not supported | not supported |
17+
| Runtime Code Analysis (IAST) | 1.15.0 | 2.42.0 | 4.18.0 | Preview | not supported | not supported | not supported |
1818

1919
Select your application language for details about framework compatibility and feature support.
2020

0 commit comments

Comments
 (0)