Skip to content

Commit 087788a

Browse files
committed
docs: fix markdown formatting, tweak phrasing
Signed-off-by: lelia <2418071+lelia@users.noreply.github.com>
1 parent 41d87a0 commit 087788a

File tree

7 files changed

+101
-149
lines changed

7 files changed

+101
-149
lines changed

README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -65,31 +65,20 @@ jobs:
6565

6666
Socket Basics can also run locally or in other CI/CD environments:
6767

68-
> [!NOTE]
69-
> Container and Dockerfile scanning remain part of Socket Basics, but the current
70-
> GitHub Action and pre-built image paths have Trivy-backed support temporarily
71-
> disabled while we complete additional security review of the underlying scanner
72-
> dependency path. If container or Dockerfile scanning is a near-term
73-
> requirement, the [native installation path](docs/local-installation.md) remains
74-
> available as a temporary workaround while the pre-built path is under
75-
> additional review. Review the upstream install path and artifacts carefully
76-
> before adopting it in production CI.
77-
7868
> [!IMPORTANT]
79-
> Interim Trivy guidance outside Socket Basics: the current Socket Basics
80-
> recommendation is to pin independent Trivy usage to `v0.69.3` while we work to
81-
> restore bundled support safely. Aqua's final incident report lists the
82-
> known-safe Trivy binary range as `v0.69.2` to `v0.69.3`; the corresponding
83-
> Docker image tags are `0.69.2` to `0.69.3` without the `v` prefix. We
84-
> standardize on the latest known-safe version, `v0.69.3` / Docker tag `0.69.3`.
69+
> The supported pre-built GitHub Action and Docker image paths currently ship
70+
> _without_ Trivy while we evaluate the safest way to bundle it with Basics
71+
> again.
72+
> If you need Trivy in the meantime, use the native/manual path and pin to
73+
> `v0.69.3` or Docker tag `0.69.3`.
74+
> [Aqua's final incident report](https://www.aquasec.com/blog/trivy-supply-chain-attack-what-you-need-to-know/)
75+
> lists the known-safe Trivy binary range as `v0.69.2` to `v0.69.3`; we
76+
> standardize on the latest known-safe version.
8577
> Do not use `v0.69.4`, and audit any cached Docker Hub images for `0.69.5` and
8678
> `0.69.6`.
87-
> If you use Aqua's own GitHub Actions directly outside Socket Basics, Aqua's
88-
> published safe versions are `aquasecurity/trivy-action@v0.35.0` and
89-
> `aquasecurity/setup-trivy@v0.2.6`, and those should still be pinned to full
90-
> commit SHAs.
91-
> Reference:
92-
> https://www.aquasec.com/blog/trivy-supply-chain-attack-what-you-need-to-know/
79+
> See [Local Installation](docs/local-installation.md#trivy-container-scanning)
80+
> for the detailed version guidance, installation options, and the
81+
> corresponding Aqua action versions.
9382

9483
- **[Pre-Commit Hook](docs/pre-commit-hook.md)** — Catch issues before they're committed
9584
- **[Local Docker Installation](docs/local-install-docker.md)** — Run in Docker with no tool installation required

docs/github-action.md

Lines changed: 36 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -231,20 +231,22 @@ Include these in your workflow's `jobs.<job_id>.permissions` section.
231231
- uses: SocketDev/socket-basics@v2.0.2
232232
with:
233233
github_token: ${{ secrets.GITHUB_TOKEN }}
234-
# Trivy-backed container scanning is temporarily not available in the
235-
# pre-built GitHub Action image. Use a native install if you need it today.
236-
# See docs/local-installation.md.
234+
# The supported pre-built GitHub Action path currently ships without
235+
# Trivy while we evaluate the safest way to bundle it with Basics again.
236+
# Use a native install if you need container scanning today.
237+
# See docs/local-installation.md#trivy-container-scanning.
237238
```
238239

239240
> [!NOTE]
240-
> Container and Dockerfile scanning remain part of Socket Basics, but the current
241-
> GitHub Action and pre-built image paths have Trivy-backed support temporarily
242-
> disabled while we complete additional security review of the underlying scanner
243-
> dependency path. If container or Dockerfile scanning is a near-term
244-
> requirement, the [native installation path](local-installation.md) remains
245-
> available as a temporary workaround while the pre-built path is under
246-
> additional review. Review the upstream install path and artifacts carefully
247-
> before adopting it in production CI.
241+
> The supported pre-built GitHub Action and Docker image paths currently ship
242+
> _without_ Trivy while we evaluate the safest way to bundle it with Basics
243+
> again.
244+
> If you need container or Dockerfile scanning today, use the
245+
> [native installation path](local-installation.md). See
246+
> [Trivy (Container Scanning)](local-installation.md#trivy-container-scanning)
247+
> for the current version guidance and install options, and review the upstream
248+
> install path and artifacts carefully before adopting that path in production
249+
> CI.
248250

249251
**Socket Tier 1 Reachability:**
250252
```yaml
@@ -483,35 +485,16 @@ jobs:
483485

484486
### Container Security Pipeline
485487

486-
> [!NOTE]
487-
> Container and Dockerfile scanning remain part of Socket Basics, but the current
488-
> pre-built GitHub Action path has Trivy-backed support temporarily disabled while
489-
> we complete additional security review of the underlying scanner dependency path.
490-
> If container or Dockerfile scanning is a near-term requirement, the
491-
> [native installation path](local-installation.md) remains available as a
492-
> temporary workaround while the pre-built path is under additional review.
493-
> Review the upstream install path and artifacts carefully before adopting it in
494-
> production CI.
495-
496-
> [!WARNING]
497-
> This fallback path relies on upstream Trivy installation material outside the
498-
> pinned pre-built distribution model. Review the upstream install path and
499-
> artifacts carefully before using it in production CI.
500-
501488
> [!IMPORTANT]
502-
> Customer guidance while Trivy is disabled in the Socket Basics GitHub Action:
503-
> if you must keep using Trivy independently in the same workflow, Socket's
504-
> interim recommendation is to pin the Trivy binary to `v0.69.3`.
505-
> Aqua's final incident report lists `v0.69.2` to `v0.69.3` as the
506-
> known-safe binary range; the corresponding Docker image tags are `0.69.2` to
507-
> `0.69.3` without the `v` prefix. We standardize on `v0.69.3` / Docker tag
508-
> `0.69.3` in our examples.
489+
> The supported pre-built GitHub Action path currently ships _without_ Trivy
490+
> while we evaluate the safest way to bundle it with Basics again.
491+
> If you need Trivy in the meantime, install and run it independently in the
492+
> workflow, pin to `v0.69.3` or Docker tag `0.69.3`, and review the upstream
493+
> install path and artifacts carefully.
509494
> Do not use `v0.69.4`, and audit any Docker Hub use of `0.69.5` and `0.69.6`.
510-
> If you use Aqua's own actions directly outside Socket Basics, use
511-
> `aquasecurity/trivy-action@v0.35.0` and `aquasecurity/setup-trivy@v0.2.6`, and
512-
> pin them to full commit SHAs.
513-
> Reference:
514-
> https://www.aquasec.com/blog/trivy-supply-chain-attack-what-you-need-to-know/
495+
> See [Local Installation](local-installation.md#trivy-container-scanning) for
496+
> the detailed version guidance, corresponding Aqua action versions, and install
497+
> options.
515498

516499
```yaml
517500
name: Container Security
@@ -549,11 +532,6 @@ jobs:
549532
trivy config --exit-code 1 --severity HIGH,CRITICAL Dockerfile
550533
```
551534

552-
If you replace the manual install step with Aqua-maintained actions in your own
553-
workflow outside Socket Basics, Aqua's published safe versions are
554-
`aquasecurity/trivy-action@v0.35.0` and `aquasecurity/setup-trivy@v0.2.6`.
555-
Pin those to full SHAs rather than mutable tags.
556-
557535
### Dockerfile Auto-Discovery
558536

559537
For repositories with multiple Dockerfiles across different directories, you can automatically discover them instead of manually listing each path.
@@ -609,8 +587,9 @@ jobs:
609587
with:
610588
github_token: ${{ secrets.GITHUB_TOKEN }}
611589
# Dockerfile discovery remains useful context for future container
612-
# scanning support, but the current pre-built action image does not
613-
# execute Trivy-backed scans.
590+
# scanning support, but the current pre-built action path currently
591+
# ships _without_ Trivy while we evaluate the safest way to bundle it
592+
# with Basics again.
614593
verbose: 'true'
615594
```
616595

@@ -719,10 +698,12 @@ See [`action.yml`](../action.yml) for the complete list of inputs.
719698

720699
> [!NOTE]
721700
> These inputs remain part of the action interface, but the current pre-built
722-
> GitHub Action path has Trivy-backed support temporarily disabled while we
723-
> complete additional security review of the underlying scanner dependency path.
724-
> Use the [native installation path](local-installation.md) if container scanning
725-
> is a near-term requirement.
701+
> GitHub Action path currently ships _without_ Trivy while we evaluate the
702+
> safest way to bundle it with Basics again.
703+
> Use the [native installation path](local-installation.md) if container
704+
> scanning is a near-term requirement. See
705+
> [Trivy (Container Scanning)](local-installation.md#trivy-container-scanning)
706+
> for the current version guidance and install options.
726707

727708
**Notifications (Enterprise Required):**
728709
- `slack_webhook_url` — Slack webhook
@@ -779,10 +760,12 @@ permissions:
779760

780761
**Solutions:**
781762
> [!NOTE]
782-
> The current pre-built GitHub Action path has Trivy-backed support temporarily
783-
> disabled while the underlying scanner dependency path remains under additional
784-
> security review. If container scanning is a near-term requirement, switch to a
785-
> native Trivy install in the workflow.
763+
> The current pre-built GitHub Action path ships _without_ Trivy while we
764+
> evaluate the safest way to bundle it with Basics again. If container scanning
765+
> is a near-term requirement, switch to a native Trivy install in the workflow.
766+
> See
767+
> [Trivy (Container Scanning)](local-installation.md#trivy-container-scanning)
768+
> for the current version guidance and install options.
786769

787770
1. For private images, add authentication:
788771
```yaml

docs/github-pr-comment-guide.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ All scanners share the same UX enhancements for a consistent, professional exper
1515

1616
> [!NOTE]
1717
> Container-scanning UX is still supported by Socket Basics, but the current
18-
> pre-built GitHub Action image does not emit Trivy-backed container findings
19-
> while we complete additional security review of the underlying scanner
20-
> dependency path.
18+
> pre-built GitHub Action image currently ships _without_ Trivy while we
19+
> evaluate the safest way to bundle it with Basics again. For the current Trivy
20+
> status, version guidance, and temporary self-service path, see
21+
> [Local Installation](local-installation.md#trivy-container-scanning).
2122
2223
## 🎯 Quick Start
2324

docs/local-install-docker.md

Lines changed: 15 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -55,28 +55,15 @@ docker inspect ghcr.io/socketdev/socket-basics:2.0.2 \
5555
# }
5656
```
5757

58-
> [!NOTE]
59-
> Container and Dockerfile scanning remain part of Socket Basics, but the current
60-
> pre-built image path has Trivy-backed support temporarily disabled while we
61-
> complete additional security review of the underlying scanner dependency path.
62-
> If container or Dockerfile scanning is a near-term requirement, the
63-
> [native installation path](local-installation.md) remains available as a
64-
> temporary workaround while the pre-built path is under additional review.
65-
> Review the upstream install path and artifacts carefully before adopting it in
66-
> production CI.
67-
6858
> [!IMPORTANT]
69-
> Socket Basics does not currently publish a pre-built Docker image with Trivy
70-
> enabled. If you need Trivy in the meantime, run it separately from Socket
71-
> Basics and pin the independent Trivy image or binary to `v0.69.3`.
72-
> Aqua's final incident report lists `v0.69.2` to `v0.69.3` as the
73-
> known-safe Trivy binary range; the corresponding Docker image tags are
74-
> `0.69.2` to `0.69.3` without the `v` prefix. Socket's interim recommendation is
75-
> the latest known-safe version, `v0.69.3` / Docker tag `0.69.3`.
59+
> The supported pre-built Docker image currently ships _without_ Trivy while we
60+
> evaluate the safest way to bundle it with Basics again.
61+
> If you need Trivy in the meantime, run it separately from Socket Basics and
62+
> pin to `v0.69.3` or Docker tag `0.69.3`.
7663
> Do not use `v0.69.4`, and audit any Docker Hub pulls or caches for `0.69.5`
7764
> and `0.69.6`.
78-
> Reference:
79-
> https://www.aquasec.com/blog/trivy-supply-chain-attack-what-you-need-to-know/
65+
> See [Local Installation](local-installation.md#trivy-container-scanning) for
66+
> the detailed version guidance and install options.
8067
8168
### Registries
8269

@@ -380,20 +367,15 @@ docker run --rm \
380367

381368
### Container Scanning Status
382369

383-
> [!NOTE]
384-
> Container and Dockerfile scanning remain part of Socket Basics, but the current
385-
> pre-built Docker image path has Trivy-backed support temporarily disabled while
386-
> we complete additional security review of the underlying scanner dependency path.
387-
> If container or Dockerfile scanning is a near-term requirement, the
388-
> [native installation path](local-installation.md) remains available as a
389-
> temporary workaround while the pre-built path is under additional review.
390-
> Review the upstream install path and artifacts carefully before adopting it in
391-
> production CI.
392-
393-
For customers who still need Trivy before it returns to the Socket Basics image,
394-
the interim recommendation is to run a separate `aquasec/trivy:0.69.3` step or a
395-
host-native `trivy` install pinned to `v0.69.3`, rather than rebuilding the
396-
Socket Basics image and re-enabling Trivy ad hoc.
370+
> [!IMPORTANT]
371+
> The supported pre-built Docker image currently ships _without_ Trivy while we
372+
> evaluate the safest way to bundle it with Basics again.
373+
> If you need Trivy before it returns to the image, run a separate
374+
> `aquasec/trivy:0.69.3` step or a host-native `trivy` install pinned to
375+
> `v0.69.3`, rather than rebuilding the Socket Basics image and re-enabling
376+
> Trivy ad hoc.
377+
> See [Local Installation](local-installation.md#trivy-container-scanning) for
378+
> the detailed version guidance.
397379

398380
### Save Results to File
399381

docs/local-installation.md

Lines changed: 24 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,12 @@ trufflehog --version
3838
```
3939

4040
> [!NOTE]
41-
> If container or Dockerfile scanning is a near-term requirement, the native
42-
> installation path remains available as a temporary workaround while the
43-
> pre-built path is under additional review. Review the upstream install path and
44-
> artifacts carefully before adopting it in production CI.
41+
> The supported pre-built GitHub Action and Docker image paths currently ship
42+
> _without_ Trivy while we evaluate the safest way to bundle it with Basics
43+
> again.
44+
> If you need container or Dockerfile scanning today, use the native/manual
45+
> installation guidance below and review the upstream install path and artifacts
46+
> carefully before adopting it in production CI.
4547
4648
For detailed installation instructions, continue reading below.
4749

@@ -187,36 +189,25 @@ export SOCKET_SECURITY_API_KEY="your-api-key"
187189

188190
**Required for:** Container image and Dockerfile vulnerability scanning
189191

190-
> [!NOTE]
191-
> Trivy-backed container and Dockerfile scanning remain part of Socket Basics,
192-
> but the current pre-built GitHub Action and Docker image paths have that
193-
> support temporarily disabled while the underlying scanner dependency path
194-
> remains under additional review. This native installation path remains
195-
> available as a temporary workaround if container scanning is a near-term
196-
> requirement.
197-
198-
> [!WARNING]
199-
> This fallback path pulls installation material directly from upstream. Even when
200-
> you pin the Trivy version, the installer or repository path is a separate trust
201-
> decision. This is one reason Socket Basics has moved toward pre-built, pinned
202-
> container-based distribution where possible. Review the upstream install path
203-
> and artifacts carefully before using this in production CI.
204-
205192
> [!IMPORTANT]
206-
> Socket's interim recommendation for customers who still need Trivy is to pin
207-
> the binary or Docker image to `v0.69.3`.
208-
> Aqua's final incident report lists the known-safe Trivy binary range as
209-
> `v0.69.2` to `v0.69.3`; the corresponding Docker image tags are `0.69.2` to
210-
> `0.69.3` without the `v` prefix. We standardize on `v0.69.3` / Docker tag
211-
> `0.69.3` because it is the latest version Aqua still classifies as known-safe.
212-
> Do not use `v0.69.4`, and audit any cached Docker Hub images for `0.69.5` and
213-
> `0.69.6`.
214-
> If you use Aqua's own GitHub Actions independently of Socket Basics, Aqua's
215-
> published safe versions are `aquasecurity/trivy-action@v0.35.0` and
216-
> `aquasecurity/setup-trivy@v0.2.6`; pin those by full commit SHA rather than by
217-
> tag.
218-
> Reference:
219-
> https://www.aquasec.com/blog/trivy-supply-chain-attack-what-you-need-to-know/
193+
> The supported pre-built GitHub Action and Docker image paths currently ship
194+
> _without_ Trivy while we evaluate the safest way to bundle it with Basics
195+
> again.
196+
>
197+
> If you need Trivy before it formally returns to Socket Basics:
198+
> - Pin the binary to `v0.69.3` or the Docker image to
199+
> `aquasec/trivy:0.69.3`.
200+
> - Do not use `v0.69.4` of the binary.
201+
> - Audit any cached Docker Hub images for `0.69.5` and `0.69.6`.
202+
>
203+
> [Aqua's final incident report](https://www.aquasec.com/blog/trivy-supply-chain-attack-what-you-need-to-know/)
204+
> lists the known-safe Trivy binary range as `v0.69.2` to `v0.69.3`; the
205+
> corresponding Docker image tags are `0.69.2` to `0.69.3` without the `v`
206+
> prefix. We standardize on `v0.69.3` / Docker tag `0.69.3`.
207+
>
208+
> If you use Aqua's own GitHub Actions independently of Socket Basics, pin
209+
> `aquasecurity/trivy-action@v0.35.0` and `aquasecurity/setup-trivy@v0.2.6` by
210+
> full commit SHA rather than by tag.
220211
221212
**Installation:**
222213

docs/parameters.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -296,12 +296,14 @@ socket-basics --secrets --show-unverified
296296
> [!NOTE]
297297
> These parameters remain part of the Socket Basics interface for container
298298
> scanning. In the current pre-built GitHub Action and Docker image paths,
299-
> Trivy-backed support is temporarily disabled while we complete additional
300-
> security review of the underlying scanner dependency path. The parameters still
301-
> apply for the [native installation path](local-installation.md) as a temporary
302-
> workaround, and for future container scanner support in the pre-built paths.
299+
> Socket Basics currently ships _without_ Trivy while we evaluate the safest way
300+
> to bundle it with Basics again. The parameters still apply for the
301+
> [native installation path](local-installation.md) as a temporary workaround,
302+
> and for future container scanner support in the pre-built paths.
303303
> Review the upstream install path and artifacts carefully before adopting that
304-
> workaround in production CI.
304+
> workaround in production CI. See
305+
> [Trivy (Container Scanning)](local-installation.md#trivy-container-scanning)
306+
> for the current version guidance and installation options.
305307
306308
### `--images IMAGES`
307309
Comma-separated list of container images to scan (auto-enables image scanning).

docs/pre-commit-hook.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,10 @@ See [Local Installation Guide](local-installation.md) for detailed instructions
204204
- OpenGrep
205205
- TruffleHog
206206

207+
The Trivy section in that guide also covers the current Basics status and the
208+
recommended self-service version pins:
209+
[Trivy (Container Scanning)](local-installation.md#trivy-container-scanning).
210+
207211
### Setup Steps
208212

209213
**1. Create pre-commit hook:**

0 commit comments

Comments
 (0)