Skip to content

Commit 279346d

Browse files
authored
Merge pull request #1 from stacknil/codex/repo-security-policy
chore: add repository security policy
2 parents 5c157a4 + 8a10cdf commit 279346d

4 files changed

Lines changed: 82 additions & 5 deletions

File tree

.github/dependabot.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: "github-actions"
4+
directory: "/"
5+
schedule:
6+
interval: "weekly"
7+
open-pull-requests-limit: 3
8+
commit-message:
9+
prefix: "chore"
10+
include: "scope"

README.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# LogLens
22

3-
[![CI](https://img.shields.io/badge/CI-GitHub_Actions-blue)](./.github/workflows/ci.yml)
4-
[![CodeQL](https://img.shields.io/badge/CodeQL-code_scanning-blue)](./.github/workflows/codeql.yml)
3+
[![CI](https://github.com/stacknil/LogLens/actions/workflows/ci.yml/badge.svg)](https://github.com/stacknil/LogLens/actions/workflows/ci.yml)
4+
[![CodeQL](https://github.com/stacknil/LogLens/actions/workflows/codeql.yml/badge.svg)](https://github.com/stacknil/LogLens/actions/workflows/codeql.yml)
55

6-
LogLens is a C++20 defensive log analysis CLI for Linux authentication logs.
6+
C++20 defensive log analysis CLI for Linux authentication logs, with parser coverage telemetry, configurable detection rules, CI, and CodeQL.
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

@@ -29,8 +29,6 @@ It does not provide exploitation, persistence, credential attack automation, or
2929

3030
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.
3131

32-
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.
33-
3432
## Repository Checks
3533

3634
LogLens includes two minimal GitHub Actions workflows:

SECURITY.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
LogLens is a small public repository under active development.
6+
7+
| Version | Supported |
8+
| ------- | --------- |
9+
| main | Yes |
10+
| older commits / snapshots | No |
11+
12+
At this stage, security fixes are applied to the `main` branch only.
13+
Historical commits, experimental branches, and stale forks should be treated as unsupported.
14+
15+
## Reporting a Vulnerability
16+
17+
Please do **not** open a public issue for undisclosed security vulnerabilities.
18+
19+
Use GitHub's **private vulnerability reporting** feature for this repository if it is enabled.
20+
If private reporting is unavailable for any reason, contact the maintainer through a private channel listed in the repository profile or repository documentation.
21+
22+
When reporting, please include:
23+
24+
- a clear description of the issue
25+
- affected files, workflows, or code paths
26+
- reproduction steps or a minimal proof of concept
27+
- impact assessment
28+
- any suggested remediation, if available
29+
30+
## Scope
31+
32+
This repository is a defensive log-analysis CLI for Linux authentication logs.
33+
34+
Relevant security reports may include, for example:
35+
36+
- unsafe workflow behavior
37+
- supply-chain risks in CI or repository automation
38+
- unsafe parsing behavior that could cause security-relevant misreporting
39+
- vulnerabilities in repository-integrated tooling or update automation
40+
41+
Out of scope for vulnerability reports:
42+
43+
- feature requests
44+
- parser support for additional benign log variants
45+
- general false positives / false negatives that do not create a security vulnerability
46+
- issues in third-party software outside this repository unless they directly affect this repository's shipped code or workflows
47+
48+
## Disclosure Expectations
49+
50+
Please allow time for triage and remediation before any public disclosure.
51+
52+
The maintainer will try to:
53+
54+
- acknowledge receipt of a report within a reasonable timeframe
55+
- assess severity and impact
56+
- coordinate remediation privately when appropriate
57+
- disclose fixes responsibly after mitigation is available
58+
59+
## Notes
60+
61+
This repository is intended for defensive engineering and public-safe research.
62+
Reports that seek offensive use beyond the repository's stated scope may be declined.

docs/repo-hardening.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,10 @@ When updating a pinned action:
3030
2. replace the full SHA in the workflow
3131
3. keep the inline version comment in sync
3232
4. verify CI and CodeQL still run cleanly
33+
34+
## Security Workflow
35+
36+
- CI and CodeQL gate merges into `main`
37+
- GitHub Actions are pinned by full SHA
38+
- Updates for workflow dependencies are managed with Dependabot
39+
- Vulnerabilities should be reported through private vulnerability reporting

0 commit comments

Comments
 (0)