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
4 changes: 2 additions & 2 deletions CLAUDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ required check on `main`.
| `internal/rulesdoc/` | Renders the rule reference `docs/rules.md` and the fact reference `docs/facts.md` from the built-in rules, profiles and collectors |
| `internal/output/` | Terminal, JSON, SARIF, JUnit and HTML output |
| `rules/` | Built-in checks (YAML), embedded in the binary |
| `profiles/` | Versioned control mappings per standard edition (e.g. `kisa-2026`), embedded |
| `profiles/` | Versioned control mappings per standard edition (e.g. `kisa-2026`; `stig-ubuntu2204` names its OS with `os:`), embedded |
| `schema/` | JSON Schema of the result document (ADR 0006), with a valid example |
| `testdata/` | Fixture root filesystems per distro (hardened and default) |
| `e2e/` | Docker-based scans of every supported distribution (stock and hardened), image scans, and the golden results |
Expand All @@ -67,7 +67,7 @@ required check on `main`.
| `packaging/container/` | The Dockerfile of the release image on ghcr.io (`.github/workflows/container.yml`) |
| `install.sh` | The installer: downloads a release, verifies it, installs the binary |
| `scripts/` | Release checks, the translation check, lint guards and the live demo build (`check-release.sh`, `check-translations.sh`, `lint-guards.sh`, `build-demo.sh`) |
| `site/` | The project page for GitHub Pages (English, and `ko/`, with the generated KISA page `ko/kisa/`) and the live demo `demo/` (built, not committed); published by `.github/workflows/pages.yml` |
| `site/` | The project page for GitHub Pages (English, and `ko/`, with the generated pages `ko/kisa/` and `stig/ubuntu2204/`, both from `internal/rulesdoc/site.go` by `make docs`) and the live demo `demo/` (built, not committed); published by `.github/workflows/pages.yml` |
| `.goreleaser.yaml` | Release build: archives, packages, SBOMs, checksums and signing (docs/RELEASING.md) |

## Security invariants — never violate
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ snapshot: $(GORELEASER) ## Build the release artifacts into dist/ without publis
$(GORELEASER) release --snapshot --clean --skip=$(SNAPSHOT_SKIP)

docs: ## Regenerate docs/rules.md and docs/facts.md from rules/, profiles/ and the collectors
go test ./internal/rulesdoc -run 'TestRulesDocIsUpToDate|TestRulesKoDocIsUpToDate|TestKISASiteKoIsUpToDate|TestFactsDocIsUpToDate' -update
go test ./internal/rulesdoc -run 'TestRulesDocIsUpToDate|TestRulesKoDocIsUpToDate|TestKISASiteKoIsUpToDate|TestStigSiteIsUpToDate|TestFactsDocIsUpToDate' -update

# E2E_RUN selects distributions (e.g. debian-12); E2E_UPDATE=1 rewrites their goldens.
E2E_RUN ?=
Expand Down
4 changes: 2 additions & 2 deletions README.ko.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- translated from README.md @ 854a824 -->
<!-- translated from README.md @ 9d41982 -->
# vmsctl

[![CI](https://github.com/with-developer/vmsctl/actions/workflows/ci.yml/badge.svg)](https://github.com/with-developer/vmsctl/actions/workflows/ci.yml)
Expand Down Expand Up @@ -195,7 +195,7 @@ sudo vmsctl scan --config vmsctl.yaml

## 무엇을 점검하나

`kisa-2026` 프로파일은 KISA 가이드(2026년판)의 Unix 점검 항목 67개를 모두 담았습니다. 점검 항목별 점검 내용, 매개변수,
`kisa-2026` 프로파일은 KISA 가이드(2026년판)의 Unix 점검 항목 67개를 모두 담았고, `stig-ubuntu2204`는 미국 DISA의 Ubuntu 22.04 STIG 중 vmsctl이 판정할 수 있는 27개를 담았습니다([점검 범위](docs/stig.ko.md)). 점검 항목별 점검 내용, 매개변수,
조치 방법은 [규칙 참조](docs/rules.ko.md)에 한국어로 있고, KISA 점검 항목만 모은 [웹 페이지](https://with-developer.github.io/vmsctl/ko/kisa/)도 있습니다.

- **계정 관리 (U-01–U-13):** root 원격 접속, 비밀번호 길이·복잡도·사용 기간, 계정 잠금, 비밀번호
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,8 @@ or a scan that could not run, 130 when interrupted.

## What it checks

The `kisa-2026` profile maps all 67 Unix controls of the KISA guide (2026 edition); the
The `kisa-2026` profile maps all 67 Unix controls of the KISA guide (2026 edition), and `stig-ubuntu2204` the 27 controls
of the US DISA STIG for Ubuntu 22.04 that vmsctl can decide ([what it covers](docs/stig.md)); the
[rule reference](docs/rules.md) lists every control with the checks, parameters and fixes behind it:

- **Accounts (U-01–U-13):** remote root login, password length, complexity and aging, lockout,
Expand Down
3 changes: 2 additions & 1 deletion docs/README.ko.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!-- translated from docs/README.md @ 34e8911 -->
<!-- translated from docs/README.md @ 9d41982 -->
# vmsctl 문서

[English](README.md)
Expand All @@ -12,6 +12,7 @@
| [vmsctl을 컨테이너로 실행하기](container.ko.md) | 릴리스 이미지, 점검할 수 있는 것, 이미지 검증 |
| [서버와 대시보드](fleet.ko.md) | 결과 보내기, 요청 시 스캔용 에이전트, 토큰, 서명된 결과, API, 서버 운영 |
| [설정](configuration.ko.md) | `vmsctl.yaml`: 매개변수, 예외, 증명 |
| [DISA STIG 프로파일](stig.ko.md) | `stig-ubuntu2204`: Ubuntu 22.04용 미국 기준, 어디까지 점검하고 무엇은 점검하지 않는지 |
| [정책 팩](packs.ko.md) | 직접 만드는 점검과 프로파일 |
| [hostlint에서 옮기기](migrating-from-hostlint.ko.md) | v0.27의 이름 변경 |
| [다른 도구와 비교](comparison.ko.md) | Lynis, OpenSCAP, Wazuh와 비교하고, 어떤 경우에 그쪽을 고를지 |
Expand Down
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
| [Running vmsctl as a container](container.md) | the release image, what it can scan, verifying it |
| [The fleet server and dashboard](fleet.md) | pushing results, the agent for on-demand scans, tokens, signed results, the API, running the server |
| [Configuration](configuration.md) | `vmsctl.yaml`: parameters, waivers, attestations |
| [The DISA STIG profile](stig.md) | `stig-ubuntu2204`: the US baseline for Ubuntu 22.04, what it covers and what it does not |
| [Policy packs](packs.md) | your own checks and profiles |
| [Moving from hostlint](migrating-from-hostlint.md) | the rename in v0.27 |
| [How vmsctl compares](comparison.md) | with Lynis, OpenSCAP and Wazuh, and when to pick them |
Expand Down
Loading
Loading