Skip to content

Commit feb8a23

Browse files
committed
docs: prepare v0.1.0 release notes
1 parent 3cd141e commit feb8a23

File tree

3 files changed

+42
-2
lines changed

3 files changed

+42
-2
lines changed

CHANGELOG.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## v0.1.0
6+
7+
- Added parser support for `syslog_legacy` and `journalctl_short_full` authentication log input.
8+
- Added rule-based detections for SSH brute force, multi-user probing, and bursty sudo activity.
9+
- Added parser coverage telemetry, including parsed/unparsed counts and unknown-pattern buckets.
10+
- Added repository automation and hardening with CI, CodeQL, pinned GitHub Actions, security policy, and Dependabot for workflow updates.

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,23 @@ C++20 defensive log analysis CLI for Linux authentication logs, with parser cove
77

88
It parses `auth.log` / `secure`-style syslog input and `journalctl --output=short-full`-style input, normalizes authentication evidence, applies configurable rule-based detections, and emits deterministic Markdown and JSON reports.
99

10-
## Overview
10+
## Project Status
1111

12-
LogLens is a defensive, public-safe repository for log parsing and detection engineering. It focuses on parser observability as well as detections: unsupported lines are surfaced as telemetry instead of being silently ignored.
12+
LogLens is an MVP / early release. The repository is stable enough for public review, local experimentation, and extension, but the parser and detection coverage are intentionally narrow.
13+
14+
## Why This Project Exists
15+
16+
Many small security tools can detect a handful of known log patterns. Fewer tools make their parsing limits visible.
17+
18+
LogLens is built around three ideas:
19+
20+
- detection engineering over offensive functionality
21+
- parser observability over silent failure
22+
- repository discipline over throwaway scripts
23+
24+
## Scope
25+
26+
LogLens is a defensive, public-safe repository for log parsing and detection engineering. Unsupported lines are surfaced as telemetry instead of being silently ignored.
1327

1428
The project does not provide exploitation, persistence, credential attack automation, or live offensive capability.
1529

docs/release-v0.1.0.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# LogLens v0.1.0
2+
3+
LogLens v0.1.0 is the first public MVP release of the repository.
4+
5+
## Highlights
6+
7+
- Parses Linux authentication logs in both `syslog_legacy` and `journalctl_short_full` modes.
8+
- Normalizes authentication evidence and applies configurable detections for SSH brute force, multi-user probing, and sudo burst activity.
9+
- Reports parser coverage telemetry so unsupported lines are visible instead of silently ignored.
10+
- Ships with deterministic Markdown and JSON reports, unit tests, CI, CodeQL, and baseline repository hardening.
11+
12+
## Notes
13+
14+
- This release is intentionally narrow in scope and focused on a clean, public-safe baseline.
15+
- Parser coverage is limited to a small set of common `sshd`, `sudo`, and `pam_unix` patterns.
16+
- Repository protections are designed for PR-based development with CI and CodeQL gating merges into `main`.

0 commit comments

Comments
 (0)