You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-7Lines changed: 5 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Security Wrapper — socket-basics
1
+
# Socket Basics
2
2
3
-
Security Wrapper is a small, extensible CLI tool that orchestrates multiple security scanners (SAST, secret scanning, container scanning), normalizes their outputs into a single consolidated Socket facts JSON format, and delivers results to configured notifiers (console, Slack, Jira, webhooks, Sumo Logic, MS Sentinel, etc.).
3
+
Socket Basics is a small, extensible CLI tool that orchestrates multiple security scanners (SAST, secret scanning, container scanning), normalizes their outputs into a single consolidated Socket facts JSON format, and delivers results to configured notifiers (console, Slack, Jira, webhooks, Sumo Logic, MS Sentinel, etc.).
4
4
5
5
This README is a first-time, clean-slate guide to installing, running, configuring, and extending the tool.
6
6
@@ -22,7 +22,7 @@ This README is a first-time, clean-slate guide to installing, running, configuri
22
22
23
23
## Overview
24
24
25
-
Security Wrapper provides:
25
+
Socket Basics provides:
26
26
27
27
- A unified CLI: `socket-basics`
28
28
- A plugin-style connector system for integrating scanners (OpenGrep, Trivy, TruffleHog, etc.)
@@ -87,13 +87,11 @@ INPUT_CONSOLE_ENABLED=true
87
87
INPUT_SOCKET_CONSOLE_MODE=tabular
88
88
```
89
89
90
-
3) Run the container mounting the current directory into `/workspace` and pass the CLI flags you provided. This example runs secrets scanning, JavaScript SAST, requests Socket tier1 reporting, and scans the `trickyhu/sigsci-rule-editor` container image:
90
+
3) Run the container mounting the current directory into `/workspace` and pass the CLI flags you provided. As long as it is a git repo it'll automatically pick up the repo and branch information for the scan. This example runs secrets scanning, JavaScript SAST, requests Socket tier1 reporting, and scans the `trickyhu/sigsci-rule-editor` container image:
91
91
92
92
```sh
93
93
docker run --rm -v "$PWD:/workspace" --env-file .env socket-basics \
94
94
--workspace /workspace \
95
-
--repo node_goat_17 \
96
-
--branch main \
97
95
--secrets \
98
96
--console-tabular-enabled \
99
97
--javascript \
@@ -360,7 +358,7 @@ jobs:
360
358
runs-on: ubuntu-latest
361
359
steps:
362
360
- uses: actions/checkout@v4
363
-
- name: Run security wrapper
361
+
- name: Run Socket Basics
364
362
uses: ./ # when running from the same repo; replace with org/repo@vX for published action
0 commit comments