Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,12 @@ RUN curl -fsSL https://deb.nodesource.com/setup_22.x | bash - && \
RUN npm install -g socket

# Install Trivy
RUN curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b /usr/local/bin v0.67.2
ARG TRIVY_VERSION=v0.67.2
RUN curl -sfL https://raw.githubusercontent.com/aquasecurity/trivy/main/contrib/install.sh | sh -s -- -b /usr/local/bin "${TRIVY_VERSION}"

# Install Trufflehog
RUN curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin
ARG TRUFFLEHOG_VERSION=v3.93.3
RUN curl -sSfL https://raw.githubusercontent.com/trufflesecurity/trufflehog/main/scripts/install.sh | sh -s -- -b /usr/local/bin "${TRUFFLEHOG_VERSION}"

# Install OpenGrep (connector/runtime dependency)
RUN curl -fsSL https://raw.githubusercontent.com/opengrep/opengrep/main/install.sh | bash
Expand Down
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Run Socket Basics
uses: SocketDev/socket-basics@1.0.28
uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -120,7 +120,7 @@ Configure scanning policies, notification channels, and rule sets for your entir

**Dashboard-Configured (Enterprise):**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand All @@ -131,7 +131,7 @@ Configure scanning policies, notification channels, and rule sets for your entir

**CLI-Configured:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand All @@ -147,16 +147,25 @@ Configure scanning policies, notification channels, and rule sets for your entir

```bash
# Build with version tag
docker build -t socketdev/socket-basics:1.0.28 .
docker build -t socketdev/socket-basics:1.0.29 .

# Run scan
docker run --rm -v "$PWD:/workspace" socketdev/socket-basics:1.0.28 \
docker run --rm -v "$PWD:/workspace" socketdev/socket-basics:1.0.29 \
--workspace /workspace \
--python-sast-enabled \
--secret-scanning-enabled \
--console-tabular-enabled
```

Tip: If you need specific Trivy or TruffleHog versions, you can override them at build time:

```bash
docker build \
--build-arg TRIVY_VERSION=v0.67.2 \
--build-arg TRUFFLEHOG_VERSION=v3.93.3 \
-t socketdev/socket-basics:1.0.29 .
```

📖 **[View Docker Installation Guide](docs/local-install-docker.md)**

### CLI
Expand Down Expand Up @@ -281,4 +290,3 @@ We welcome contributions! To add new features:
---

**Need help?** Visit our [documentation](docs/) or contact [Socket Support](https://socket.dev/support).

40 changes: 20 additions & 20 deletions docs/github-action.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Run Socket Basics
uses: SocketDev/socket-basics@1.0.28
uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -79,7 +79,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.

**SAST (Static Analysis):**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Enable SAST for specific languages
Expand All @@ -93,7 +93,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.

**Secret Scanning:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
secret_scanning_enabled: 'true'
Expand All @@ -105,7 +105,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.

**Container Scanning:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Scan Docker images (auto-enables container scanning)
Expand All @@ -116,7 +116,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.

**Socket Tier 1 Reachability:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_tier_1_enabled: 'true'
Expand All @@ -125,7 +125,7 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.
### Output Configuration

```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
python_sast_enabled: 'true'
Expand Down Expand Up @@ -155,7 +155,7 @@ Configure Socket Basics centrally from the [Socket Dashboard](https://socket.dev

**Enable in workflow:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand All @@ -167,7 +167,7 @@ Configure Socket Basics centrally from the [Socket Dashboard](https://socket.dev

> **Note:** You can also pass credentials using environment variables instead of the `with:` section:
> ```yaml
> - uses: SocketDev/socket-basics@1.0.28
> - uses: SocketDev/socket-basics@1.0.29
> env:
> SOCKET_SECURITY_API_KEY: ${{ secrets.SOCKET_SECURITY_API_KEY }}
> with:
Expand All @@ -185,7 +185,7 @@ All notification integrations require Socket Enterprise.

**Slack Notifications:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand All @@ -197,7 +197,7 @@ All notification integrations require Socket Enterprise.

**Jira Issue Creation:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand All @@ -212,7 +212,7 @@ All notification integrations require Socket Enterprise.

**Microsoft Teams:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand All @@ -224,7 +224,7 @@ All notification integrations require Socket Enterprise.

**Generic Webhook:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand All @@ -236,7 +236,7 @@ All notification integrations require Socket Enterprise.

**SIEM Integration:**
```yaml
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
socket_org: ${{ secrets.SOCKET_ORG }}
Expand Down Expand Up @@ -272,7 +272,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Run Socket Basics
uses: SocketDev/socket-basics@1.0.28
uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -318,7 +318,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Run Full Security Scan
uses: SocketDev/socket-basics@1.0.28
uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -369,10 +369,10 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Build Docker Image
run: docker build -t myapp:1.0.28:${{ github.sha }} .
run: docker build -t myapp:1.0.29:${{ github.sha }} .

- name: Scan Container
uses: SocketDev/socket-basics@1.0.28
uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -435,7 +435,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Run Socket Basics
uses: SocketDev/socket-basics@1.0.28
uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -487,7 +487,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Run Socket Basics
uses: SocketDev/socket-basics@1.0.28
uses: SocketDev/socket-basics@1.0.29
env:
GITHUB_PR_NUMBER: ${{ github.event.pull_request.number || github.event.issue.number }}
with:
Expand Down Expand Up @@ -580,7 +580,7 @@ env:
```yaml
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 - Must be first
- uses: SocketDev/socket-basics@1.0.28
- uses: SocketDev/socket-basics@1.0.29
```

### PR Comments Not Appearing
Expand Down
Loading