Skip to content

Commit 5c157a4

Browse files
authored
Update README.md
1 parent ae6cab4 commit 5c157a4

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,30 @@
33
[![CI](https://img.shields.io/badge/CI-GitHub_Actions-blue)](./.github/workflows/ci.yml)
44
[![CodeQL](https://img.shields.io/badge/CodeQL-code_scanning-blue)](./.github/workflows/codeql.yml)
55

6+
LogLens is a C++20 defensive log analysis CLI for Linux authentication logs.
7+
8+
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.
9+
10+
## Why this project exists
11+
12+
Many small security tools can detect a handful of known log patterns. Fewer tools make their parsing limits visible.
13+
14+
LogLens is designed around three ideas:
15+
16+
- detection engineering over offensive functionality
17+
- parser observability over silent failure
18+
- repository discipline over throwaway scripts
19+
20+
The project reports suspicious login activity while also surfacing parser coverage, unknown-line buckets, CI status, and code scanning hygiene.
21+
22+
## Scope
23+
24+
LogLens is a defensive, public-safe repository.
25+
It is intended for log parsing, detection experiments, and engineering practice.
26+
It does not provide exploitation, persistence, credential attack automation, or live offensive capability.
27+
28+
---
29+
630
LogLens is a defensive C++20 CLI that parses Linux authentication logs and produces concise Markdown and JSON reports for suspicious authentication activity. The project is intended for portfolio-grade detection engineering work, not offensive security or attack automation.
731

832
These badges are local workflow markers in this working copy because the repository does not currently have a configured GitHub remote. After publishing the repository, replace them with repository-specific GitHub status badge URLs.

0 commit comments

Comments
 (0)