Skip to content

Commit 27a4d62

Browse files
Update README.md
Updated README.MD to reflect new workflows and secret scanning tools
1 parent 8197ba8 commit 27a4d62

File tree

1 file changed

+36
-19
lines changed

1 file changed

+36
-19
lines changed

README.md

Lines changed: 36 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,23 @@
33
<b>PROJECT NAME:&emsp;&emsp;&emsp;&emsp;&nbsp;MSDO Central Repo<br>
44
CREATED BY:&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;THEANGRYTECH-GIT<br>
55
REPO:&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;[([MSDO Repo](https://github.com/theangrytech-git/MSDO))]<br><br>
6-
DESCRIPTION:</b>&emsp;&emsp;&emsp;&emsp;&emsp;&nbsp;This repo is used to centrally manage and deploy<br>GitHub Action-based Microsoft Security DevOps (MSDO) scanning pipelines,<br> including secret scanning and SARIF reporting.<br>
6+
DESCRIPTION:</b>&emsp;&emsp;&emsp;&emsp;&emsp;&nbsp;This repository centrally <br>manages reusable GitHub Action workflows for secure DevOps pipelines <br>using Microsoft Security DevOps (MSDO), Gitleaks, and SARIF reporting.
7+
8+
It is designed for organizations with restricted environments and **does not <br>rely on any external GitHub Actions**.<br>
79
<br>
810
*******************************************************************************<br>
911
<br>
12+
<b>FEATURES</b><br>
13+
<br>
14+
- 🔍 Microsoft Security DevOps (MSDO) scanning <br>
15+
- Tools like `ESLint`, `Bandit`, `Binskim`, `Checkov`, `Credscan`, `Templateanalyzer`, `Terrascan`, `Trivvy`, etc<br>
16+
- 🔐 Secret scanning<br>
17+
- `Credscan` for code-level secrets<br>
18+
- `Trufflehog` for detecting API keys, passwords, and other sensitive data in source code using entropy and regex-based rules<br>
19+
- `Gitleaks` for Git history, tokens, config, and sensitive patterns<br>
20+
- 📦 Custom SARIF uploader (no marketplace action)<br>
21+
- 🌐 Defender for Cloud integration supported<br>
22+
- 🚫 No external marketplace dependencies — fully self-contained<br>
1023
<br>
1124

1225
*******************************************************************************
@@ -15,30 +28,17 @@ DESCRIPTION:</b>&emsp;&emsp;&emsp;&emsp;&emsp;&nbsp;This repo is used to central
1528
<b>Use this section to clone or fork this repo and configure GitHub Security <br>
1629
DevOps scanning tools (MSDO) in your own environment.</b><br>
1730
<br>
18-
-Built with no external GitHub Actions — works in restricted org environments <br>
19-
-Includes secret scanning, SARIF upload, and Defender for Cloud integration<br>
20-
<br>
21-
---<br>
22-
<br>
23-
<b>WHAT'S INCLUDED:</b><br>
24-
- Microsoft Security DevOps scanning (`credscan`, `binskim`, `checkov`, etc.)<br>
25-
- Secret scanning using `credscan`<br>
26-
- Self-hosted SARIF uploader (composite GitHub Action)<br>
27-
- Manual .NET 6 install (no external dependencies)<br>
28-
- Fully functional SARIF upload to GitHub Code Scanning<br>
29-
<br>
30-
---<br>
31-
<br>
3231
<b>HOW TO SET UP:</b><br>
3332
<br>
3433
<ol>
3534
<li><strong>Create a Central MSDO Security Repo:</strong><br>
36-
Create a new repository in your org called <code>MSDO-Security</code> (or a name of your choosing), and copy these files from this repository:
35+
Create a new repository in your org called <code>MSDO-Security</code> (or a name of your choosing),<br>and copy these files from this repository:
3736
<ul>
3837
<li><code>.github/workflows/msdo-main-pipeline.yml</code></li>
3938
<li><code>.github/workflows/msdo-reusable.yml</code></li>
4039
<li><code>.github/workflows/secret-scanning.yml</code></li>
41-
<li><code>.github/actions/upload-sarif/</code> (folder)</li>
40+
<li><code>.github/actions/upload-sarif/ ← composite action for native SARIF upload</code></li>
41+
<li><code>gitleaks.toml ← centralized scanning config </code></li>
4242
</ul>
4343
</li><br>
4444
<li><strong>Add a GH_TOKEN secret (if needed):</strong><br>
@@ -64,7 +64,10 @@ DevOps scanning tools (MSDO) in your own environment.</b><br>
6464
<tr><td><code>msdo-main-pipeline.yml</code></td><td>Orchestrates all security scans + uploads</td></tr>
6565
<tr><td><code>msdo-reusable.yml</code></td><td>Performs MSDO scans on infra/code/containers</td></tr>
6666
<tr><td><code>msdo-secret-scanning.yml</code></td><td>Runs <code>credscan</code> for secret detection</td></tr>
67-
<tr><td><code>.github/actions/upload-sarif/</code></td><td>Composite action to upload SARIF locally</td></tr>
67+
<tr><td><code>msdo-trufflehog.yml</code></td><td>Runs <code>Trufflehog</code> to detect passwords and secrets using entropy and regex-based rules</td></tr>
68+
<tr><td><code>msdo-gitleaks.yml</code></td><td>Git-aware secret scanning using Gitleaks</td></tr>
69+
<tr><td><code>upload-sarif action</code></td><td>Composite action to upload SARIF locally</td></tr>
70+
<tr><td><code>gitleaks.toml</code></td><td>Custom rule config for Gitleaks</td></tr>
6871
<tr><td><code>msdo-repo-pipeline.yml</code></td><td>To be added into each Repo you want to scan as a Workflow Action</td></tr>
6972
</table>
7073
---<br>
@@ -81,6 +84,8 @@ DevOps scanning tools (MSDO) in your own environment.</b><br>
8184
- Runner: <code>ubuntu-latest</code><br>
8285
- .NET 6 SDK is installed via script in workflow<br>
8386
- <code>gh</code> CLI is available by default on GitHub-hosted runners<br>
87+
- Gitleaks downloaded and run as part of pipeline<br>
88+
- No GitHub Marketplace dependencies required
8489
<br>
8590
---<br>
8691
<br>
@@ -122,4 +127,16 @@ Daily: £0.00<br>
122127
Weekly: £0.00<br>
123128
Monthly: £0.00<br>
124129
Yearly: £0.00<br>
125-
130+
<br>
131+
*******************************************************************************<br>
132+
&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;&emsp;Roadmap (Planned)<br>
133+
*******************************************************************************<br>
134+
<br>
135+
Add Slack/MS Teams alerting<br>
136+
<br>
137+
Upload SARIF as downloadable artifacts<br>
138+
<br>
139+
Add cloud cost scanning support<br>
140+
<br>
141+
Add GitHub Enterprise integration templates<br>
142+
<br>

0 commit comments

Comments
 (0)