22 Commits

Author SHA1 Message Date
mdaleo404 94c13c44e4 Fix repo name in security-scan workflow
Security Scan / security-scan (push) Successful in 1m20s
2026-03-25 16:37:08 +00:00
mdaleo404 fcc9d19ae4 Exclude unfixed vulnerabilities from security workflow results 2026-03-25 16:34:37 +00:00
mdaleo404 8f80aba914 Switch Trivy scan to Syft and Grype 2026-03-25 16:13:49 +00:00
mdaleo404 32a009c85a Disable trivy scan workflow 2026-03-23 08:02:35 +00:00
mdaleo404 1b9d4cb903 Update pre-commit hooks version
Trivy Scan / security-scan (push) Successful in 27s
2026-03-21 07:25:47 +00:00
mdaleo404 d7063266ae Ping Trivy docker image to 0.69.3@sha256:bcc376de8d77cfe086a917230e818dc9f8528e3c852f7b1aff648949b6258d1c 2026-03-21 07:05:58 +00:00
mdaleo404 c090320e47 Update filelock and virtualenv
Trivy Scan / security-scan (push) Successful in 26s
2026-01-15 17:05:08 +00:00
mdaleo404 c7a07f8327 Add trivy-scan workflow 2026-01-15 16:50:25 +00:00
mdaleo404 31f91fcd28 Merge pull request 'Make pip-audit run inside Poetry' (#7) from pip_audit_tweak into main
Reviewed-on: #7
2025-12-25 10:30:06 +00:00
mdaleo404 5268e5834b Make pip-audit run inside Poetry
Lint & Security / precommit-and-security (pull_request) Successful in 59s
2025-12-25 10:28:46 +00:00
mdaleo404 532cc68fb3 Add logo file, update README 2025-12-21 08:44:09 +00:00
mdaleo404 e36228c308 Merge remote-tracking branch 'refs/remotes/origin/main' 2025-12-15 15:45:42 +00:00
mdaleo404 c016a45b82 Version bump 0.4.0 2025-12-15 15:43:48 +00:00
mdaleo404 860e8a668f Merge pull request 'Add globstar filtering' (#6) from add_globstar into main
Reviewed-on: #6
2025-12-15 15:42:15 +00:00
mdaleo404 5e9a55dcc6 Add globstar filtering
Lint & Security / precommit-and-security (pull_request) Successful in 1m28s
2025-12-15 15:39:14 +00:00
mdaleo404 7daa2175e8 Fix repository's URL to point ad Gitea 2025-12-14 16:42:43 +00:00
mdaleo404 67a6af2ddb Fix installation instructions 2025-12-09 16:11:49 +00:00
mdaleo404 25ea1fec63 Merge pull request 'Update README and pyproject.toml' (#5) from update_filedust_20251209 into main
Reviewed-on: #5
2025-12-09 15:27:51 +00:00
mdaleo404 dc66700f1e Edit badges, update installation instructions, swap github.com entries to git.sysmd.uk
Lint & Security / precommit-and-security (pull_request) Successful in 48s
2025-12-09 15:26:16 +00:00
mdaleo404 1eb082fc52 Merge pull request 'Rename .github folder to .gitea' (#4) from rename_github_folder into main
Reviewed-on: #4
2025-12-09 13:10:37 +00:00
mdaleo404 c2f52b8049 Use pre-commit directly instead of action
Lint & Security / precommit-and-security (pull_request) Successful in 1m3s
2025-12-09 13:08:10 +00:00
mdaleo404 6ebef8e058 Rename .github folder to .gitea
Lint & Security / precommit-and-security (pull_request) Has been cancelled
2025-12-09 12:56:06 +00:00
10 changed files with 338 additions and 32 deletions
+5 -2
View File
@@ -2,9 +2,12 @@
# Place at: ~/.filedust.conf
#
# Use this file to customize cleanup behavior.
# Only keys matter (no values). Paths are relative to $HOME.
#
# Patterns (globs) are allowed.
# Patterns are matched against paths relative to $HOME
# Supports:
# * = one path segment
# ** = zero or more path segments (recursive)
# Matching is case-sensitive
[exclude]
# Add directories or patterns you want filedust to ignore.
@@ -20,10 +20,17 @@ jobs:
run: pip install pre-commit
- name: Run pre-commit hooks
uses: pre-commit/action@v3.0.1
run: pre-commit run --all-files --color always
- name: Install Poetry
run: |
pip install poetry
poetry self add poetry-plugin-export
- name: Install pip-audit
run: pip install pip-audit
- name: Run pip-audit
run: pip-audit
- name: Audit dependencies (Poetry lockfile)
run: |
poetry export -f requirements.txt --without-hashes \
| pip-audit -r /dev/stdin
+188
View File
@@ -0,0 +1,188 @@
name: Security Scan
on:
schedule:
- cron: 27 8 * * *
workflow_dispatch:
jobs:
security-scan:
runs-on: running-man
env:
TARGET_DIR: .
COSIGN_VERSION: v3.0.5
SYFT_VERSION: v1.42.3
GRYPE_VERSION: v0.110.0
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Install Cosign (bootstrap)
run: |
set -euo pipefail
FILE="cosign-linux-amd64"
curl -fLO https://github.com/sigstore/cosign/releases/download/${COSIGN_VERSION}/${FILE}
chmod +x ${FILE}
mv ${FILE} /usr/local/bin/cosign
cosign version
- name: Install Syft (verified)
run: |
set -euo pipefail
VERSION_NO_V="${SYFT_VERSION#v}"
FILE="syft_${VERSION_NO_V}_linux_amd64.tar.gz"
BASE_URL="https://github.com/anchore/syft/releases/download/${SYFT_VERSION}"
curl -fLO ${BASE_URL}/${FILE}
curl -fLO ${BASE_URL}/syft_${VERSION_NO_V}_checksums.txt
curl -fLO ${BASE_URL}/syft_${VERSION_NO_V}_checksums.txt.sig
curl -fLO ${BASE_URL}/syft_${VERSION_NO_V}_checksums.txt.pem
cosign verify-blob \
--signature syft_${VERSION_NO_V}_checksums.txt.sig \
--certificate syft_${VERSION_NO_V}_checksums.txt.pem \
--certificate-identity-regexp "https://github.com/anchore/syft" \
--certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
syft_${VERSION_NO_V}_checksums.txt
CHECKSUM_LINE=$(grep " ${FILE}$" syft_${VERSION_NO_V}_checksums.txt)
if [ -z "$CHECKSUM_LINE" ]; then
echo "Missing checksum entry for ${FILE}"
exit 1
fi
echo "$CHECKSUM_LINE" | sha256sum -c -
tar -xzf ${FILE}
mv syft /usr/local/bin/
syft version
- name: Install Grype (verified)
run: |
set -euo pipefail
VERSION_NO_V="${GRYPE_VERSION#v}"
FILE="grype_${VERSION_NO_V}_linux_amd64.tar.gz"
BASE_URL="https://github.com/anchore/grype/releases/download/${GRYPE_VERSION}"
curl -fLO ${BASE_URL}/${FILE}
curl -fLO ${BASE_URL}/grype_${VERSION_NO_V}_checksums.txt
curl -fLO ${BASE_URL}/grype_${VERSION_NO_V}_checksums.txt.sig
curl -fLO ${BASE_URL}/grype_${VERSION_NO_V}_checksums.txt.pem
cosign verify-blob \
--signature grype_${VERSION_NO_V}_checksums.txt.sig \
--certificate grype_${VERSION_NO_V}_checksums.txt.pem \
--certificate-identity-regexp "https://github.com/anchore/grype" \
--certificate-oidc-issuer "https://token.actions.githubusercontent.com" \
grype_${VERSION_NO_V}_checksums.txt
CHECKSUM_LINE=$(grep " ${FILE}$" grype_${VERSION_NO_V}_checksums.txt)
if [ -z "$CHECKSUM_LINE" ]; then
echo "Missing checksum entry for ${FILE}"
exit 1
fi
echo "$CHECKSUM_LINE" | sha256sum -c -
tar -xzf ${FILE}
mv grype /usr/local/bin/
grype version
- name: Generate SBOM
working-directory: ${{ env.TARGET_DIR }}
run: |
syft dir:. -o json > sbom.json
- name: Show SBOM contents
working-directory: ${{ env.TARGET_DIR }}
run: |
echo "Packages discovered by Syft:"
jq -r '.artifacts[] | "\(.name)@\(.version) [\(.type)]"' sbom.json | sort
- name: Run Grype scan (JSON)
id: audit
continue-on-error: true
working-directory: ${{ env.TARGET_DIR }}
run: |
grype sbom:sbom.json -o json > grype.json
echo "Vulnerabilities (fixable only):"
jq -r '
.matches[]
| select((.vulnerability.fix.versions | length) > 0)
| "\(.artifact.name)@\(.artifact.version) -> \(.vulnerability.id) [\(.vulnerability.severity)] | fixed: \(.vulnerability.fix.versions[0])"
' grype.json
# Fail only on fixable MEDIUM/HIGH/CRITICAL
jq -e '
[
.matches[]?
| select(
(
.vulnerability.severity == "Medium" or
.vulnerability.severity == "High" or
.vulnerability.severity == "Critical"
)
and
(
(.vulnerability.fix.versions | length) > 0
)
)
]
| length == 0
' grype.json
- name: Show full Grype table
working-directory: ${{ env.TARGET_DIR }}
run: |
echo "Full Grype report:"
grype sbom:sbom.json -o table
- name: Notify Node-RED on vulnerabilities
if: steps.audit.outcome == 'failure'
working-directory: ${{ env.TARGET_DIR }}
run: |
jq '
{
repo: "guardutils/filedust",
summary: (
"Total: " +
(
[
.matches[]
| select((.vulnerability.fix.versions | length) > 0)
] | length | tostring
)
),
vulnerabilities: [
.matches[]
| select((.vulnerability.fix.versions | length) > 0)
| {
library: .artifact.name,
cve: .vulnerability.id,
severity: .vulnerability.severity,
installed: .artifact.version,
fixed: (.vulnerability.fix.versions[0]),
title: .vulnerability.description,
url: .vulnerability.dataSource
}
]
}
' grype.json \
| curl -s -X POST https://nodered.sysmd.uk/vulns-alert \
-H "Content-Type: application/json" \
--data-binary @-
- name: Fail workflow if vulnerabilities found
if: steps.audit.outcome == 'failure'
run: exit 1
+3 -3
View File
@@ -1,19 +1,19 @@
repos:
- repo: https://github.com/PyCQA/bandit
rev: 1.7.9
rev: 1.9.4
hooks:
- id: bandit
files: ^src/mirro/
args: ["-lll", "-iii", "-s", "B110,B112"]
- repo: https://github.com/psf/black-pre-commit-mirror
rev: 25.11.0
rev: 26.3.1
hooks:
- id: black
language_version: python3.13
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.4.0
rev: v6.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
+76 -7
View File
@@ -1,11 +1,13 @@
[![License](https://img.shields.io/github/license/guardutils/filedust?style=flat)](LICENCE)
[![Language](https://img.shields.io/github/languages/top/guardutils/filedust.svg)](https://github.com/guardutils/filedust/)
[![GitHub Release](https://img.shields.io/github/v/release/guardutils/filedust?display_name=release&logo=github)](https://github.com/guardutils/filedust/releases)
[![PyPI - Version](https://img.shields.io/pypi/v/filedust?logo=pypi)](https://pypi.org/project/filedust/#history)
[![PyPI downloads](https://img.shields.io/pypi/dm/filedust.svg)](https://pypi.org/project/filedust/)
[![Licence](https://img.shields.io/badge/GPL--3.0-orange?label=Licence)](https://git.sysmd.uk/guardutils/filedust/src/branch/main/LICENCE)
[![Gitea Release](https://img.shields.io/gitea/v/release/guardutils/filedust?gitea_url=https%3A%2F%2Fgit.sysmd.uk%2F&style=flat&color=orange&logo=gitea)](https://git.sysmd.uk/guardutils/filedust/releases)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-blue?logo=pre-commit&style=flat)](https://git.sysmd.uk/guardutils/filedust/src/branch/main/.pre-commit-config.yaml)
# filedust
<div align="center">
<img src="filedust.png" alt="filedust logo" width="256" />
</div>
**filedust** is a small, fast, and safe command-line tool that scans your filesystem for obvious junk — things like Python __pycache__ folders, build artifacts, editor backup files, and leftover temporary files — and cleans them up.
Think of it as “`autoremove` for files.”
@@ -42,6 +44,63 @@ Shows how much disk space can be freed.
## Installation
### From GuardUtils package repo
This is the preferred method of installation.
### Debian/Ubuntu
#### 1) Import the GPG key
```bash
sudo mkdir -p /usr/share/keyrings
curl -fsSL https://repo.sysmd.uk/guardutils/guardutils.gpg | sudo gpg --dearmor -o /usr/share/keyrings/guardutils.gpg
```
The GPG fingerprint is `0032C71FA6A11EF9567D4434C5C06BD4603C28B1`.
#### 2) Add the APT source
```bash
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/guardutils.gpg] https://repo.sysmd.uk/guardutils/debian stable main" | sudo tee /etc/apt/sources.list.d/guardutils.list
```
#### 3) Update and install
```
sudo apt update
sudo apt install filedust
```
### Fedora/RHEL
#### 1) Import the GPG key
```
sudo rpm --import https://repo.sysmd.uk/guardutils/guardutils.gpg
```
#### 2) Add the repository configuration
```
sudo tee /etc/yum.repos.d/guardutils.repo > /dev/null << 'EOF'
[guardutils]
name=GuardUtils Repository
baseurl=https://repo.sysmd.uk/guardutils/rpm/$basearch
enabled=1
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://repo.sysmd.uk/guardutils/guardutils.gpg
EOF
```
#### 4) Update and install
```
sudo dnf upgrade --refresh
sudo dnf install filedust
```
### From PyPI
```
pip install filedust
@@ -49,7 +108,7 @@ pip install filedust
### From this repository
```
git clone https://github.com/guardutils/filedust.git
git clone https://git.sysmd.uk/guardutils/filedust.git
cd filedust/
poetry install
```
@@ -57,7 +116,7 @@ poetry install
### Custom config
You can download the example and add your custom rule
```
wget -O ~/.filedust.conf https://raw.githubusercontent.com/guardutils/filedust/main/.filedust.conf.example
wget -O ~/.filedust.conf https://git.sysmd.uk/guardutils/filedust/raw/branch/main/.filedust.conf.example
```
### TAB completion
@@ -69,3 +128,13 @@ And then
```
source ~/.bashrc
```
## pre-commit
This project uses [**pre-commit**](https://pre-commit.com/) to run automatic formatting and security checks before each commit (Black, Bandit, and various safety checks).
To enable it:
```
poetry install
poetry run pre-commit install
```
This ensures consistent formatting, catches common issues early, and keeps the codebase clean.
BIN
View File
Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Generated
+7 -7
View File
@@ -173,13 +173,13 @@ test = ["pytest (>=6)"]
[[package]]
name = "filelock"
version = "3.20.0"
version = "3.20.3"
description = "A platform independent file lock."
optional = false
python-versions = ">=3.10"
files = [
{file = "filelock-3.20.0-py3-none-any.whl", hash = "sha256:339b4732ffda5cd79b13f4e2711a31b0365ce445d95d243bb996273d072546a2"},
{file = "filelock-3.20.0.tar.gz", hash = "sha256:711e943b4ec6be42e1d4e6690b48dc175c822967466bb31c0c293f34334c13f4"},
{file = "filelock-3.20.3-py3-none-any.whl", hash = "sha256:4b0dda527ee31078689fc205ec4f1c1bf7d56cf88b6dc9426c4f230e46c2dce1"},
{file = "filelock-3.20.3.tar.gz", hash = "sha256:18c57ee915c7ec61cff0ecf7f0f869936c7c30191bb0cf406f1341778d0834e1"},
]
[[package]]
@@ -533,18 +533,18 @@ files = [
[[package]]
name = "virtualenv"
version = "20.35.4"
version = "20.36.1"
description = "Virtual Python Environment builder"
optional = false
python-versions = ">=3.8"
files = [
{file = "virtualenv-20.35.4-py3-none-any.whl", hash = "sha256:c21c9cede36c9753eeade68ba7d523529f228a403463376cf821eaae2b650f1b"},
{file = "virtualenv-20.35.4.tar.gz", hash = "sha256:643d3914d73d3eeb0c552cbb12d7e82adf0e504dbf86a3182f8771a153a1971c"},
{file = "virtualenv-20.36.1-py3-none-any.whl", hash = "sha256:575a8d6b124ef88f6f51d56d656132389f961062a9177016a50e4f507bbcc19f"},
{file = "virtualenv-20.36.1.tar.gz", hash = "sha256:8befb5c81842c641f8ee658481e42641c68b5eab3521d8e092d18320902466ba"},
]
[package.dependencies]
distlib = ">=0.3.7,<1"
filelock = ">=3.12.2,<4"
filelock = {version = ">=3.20.1,<4", markers = "python_version >= \"3.10\""}
platformdirs = ">=3.9.1,<5"
typing-extensions = {version = ">=4.13.2", markers = "python_version < \"3.11\""}
+3 -3
View File
@@ -1,12 +1,12 @@
[tool.poetry]
name = "filedust"
version = "0.3.1"
version = "0.4.1"
description = "Opinionated junk cleaner for dev machines (caches, build artifacts, editor backups)."
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
license = "GPL-3.0-or-later"
readme = "README.md"
homepage = "https://github.com/guardutils/filedust"
repository = "https://github.com/guardutils/filedust"
homepage = "https://git.sysmd.uk/guardutils/filedust"
repository = "https://git.sysmd.uk/guardutils/filedust"
packages = [{ include = "filedust", from = "src" }]
[tool.poetry.dependencies]
+46 -7
View File
@@ -20,6 +20,7 @@ def load_user_rules() -> UserRules:
if cfg_path.exists():
parser = configparser.ConfigParser(allow_no_value=True)
parser.optionxform = str
parser.read(cfg_path)
if parser.has_section("include"):
@@ -32,8 +33,46 @@ def load_user_rules() -> UserRules:
def matches_any(patterns: list[str], relpath: Path) -> bool:
posix = relpath.as_posix()
return any(fnmatch(posix, p) for p in patterns)
"""
True globstar matcher.
Rules:
- * matches exactly one path segment
- ** matches zero or more segments
- Patterns are relative to $HOME
"""
path_parts = relpath.parts
for pat in patterns:
pat = pat.strip("/")
pat_parts = tuple(pat.split("/"))
if _match_parts(pat_parts, path_parts):
return True
return False
def _match_parts(pat: tuple[str, ...], path: tuple[str, ...]) -> bool:
"""Recursive glob matcher with ** support."""
if not pat:
return not path
if pat[0] == "**":
# ** matches zero or more segments
return _match_parts(pat[1:], path) or (
bool(path) and _match_parts(pat, path[1:])
)
if not path:
return False
if fnmatch(path[0], pat[0]):
return _match_parts(pat[1:], path[1:])
return False
@dataclass
@@ -148,11 +187,11 @@ def iter_junk(root: Path, rules: UserRules | None = None) -> Iterable[Finding]:
for dirpath, dirnames, filenames in os.walk(root, followlinks=False):
dirpath_p = Path(dirpath)
# Fast relative path computation
if dirpath == root_str:
rel_dir = Path(".")
else:
rel_dir = Path(dirpath[len(root_str) :].lstrip("/"))
try:
rel_dir = dirpath_p.resolve().relative_to(HOME)
except ValueError:
# Should never happen due to earlier checks
continue
# USER EXCLUDE → skip entire subtree
if matches_any(rules.exclude, rel_dir):