Skip to content

Commit 0b6bb17

Browse files
committed
Snapshot local work before sync
1 parent e440fbd commit 0b6bb17

2 files changed

Lines changed: 43 additions & 4 deletions

File tree

PRIORITY.adoc

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,29 @@
2525
|PENDING
2626
|===
2727

28+
== PORTFOLIO AUDIT ADDITIONS (2026-03-30)
29+
30+
[cols="1,3,1"]
31+
|===
32+
|ID |Task |Status
33+
34+
|A1
35+
|Align production-ready wording with executed validation evidence and actual release state
36+
|PENDING
37+
38+
|A2
39+
|Publish an executable validation report for the headline XSS, SSRF, and coverage claims in the docs
40+
|PENDING
41+
42+
|A3
43+
|Decide and document release posture: beta until Packagist publication and environment-backed validation are complete
44+
|PENDING
45+
46+
|A4
47+
|Demote or remove non-executed 100% completion language where the remaining test work is still open
48+
|PENDING
49+
|===
50+
2851
== SHOULD (Important - High Value)
2952

3053
[cols="1,3,1"]

README.adoc

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,18 @@ image:https://img.shields.io/badge/RSR-Compliant-gold.svg[RSR Compliant]
1414

1515
**A PHP security and hardening toolkit providing input validation, sanitization, and security utilities.**
1616

17+
== Current Status
18+
19+
php-aegis is the nearest thing in this portfolio to a publishable security utility, but it is not yet a finished public release.
20+
21+
* Core validation, sanitization, headers, and Turtle escaping are implemented.
22+
* Remaining work is concentrated in release evidence rather than broad architecture:
23+
** complete the remaining critical tests
24+
** execute and publish validation evidence for the headline claims
25+
** complete packaging and publication work
26+
27+
Use link:PRIORITY.adoc[PRIORITY.adoc] and link:validation/FINDINGS-AND-RECOMMENDATIONS.md[validation/FINDINGS-AND-RECOMMENDATIONS.md] together when judging readiness.
28+
1729
== Overview
1830

1931
php-aegis provides a collection of security-focused utilities for PHP applications. Named after the mythological shield of Zeus, it aims to protect your applications from common web vulnerabilities.
@@ -39,8 +51,8 @@ See link:POSITIONING.md[POSITIONING.md] for detailed guidance.
3951
* **Input Validation** - Strict validation for emails, URLs, IPs, UUIDs, and more
4052
* **Context-Aware Sanitization** - HTML, JS, CSS, URL, and JSON output escaping
4153
* **Security Headers** - Easy CSP, HSTS, X-Frame-Options, and more
42-
* **Rate Limiting** - Token bucket algorithm with file/memory backends
43-
* **IndieWeb Security** - Micropub, IndieAuth, Webmention with SSRF prevention
54+
* **Rate Limiting** - Planned and partially documented, but not yet a release-complete core feature
55+
* **IndieWeb Security** - Important roadmap area; implementation and validation depth still need to catch up to the docs
4456
* **RDF/Turtle Escaping** - Unique W3C-compliant semantic web security (no other PHP lib does this)
4557
* **Cerro Torre Integration** - Verified container packaging with cryptographic provenance
4658
* **WordPress Integration** - 23 adapter functions + MU-plugin
@@ -62,13 +74,17 @@ php-aegis follows the principle that security should be:
6274

6375
== Installation
6476

65-
=== Via Composer
77+
=== From Source
6678

6779
[source,bash]
6880
----
69-
composer require hyperpolymath/php-aegis
81+
git clone https://github.com/hyperpolymath/php-aegis.git
82+
cd php-aegis
83+
composer install
7084
----
7185

86+
Packagist publication is still pending. Do not assume `composer require hyperpolymath/php-aegis` works until the release and publication tasks in link:PRIORITY.adoc[PRIORITY.adoc] are complete.
87+
7288
=== Requirements
7389

7490
* PHP 8.1 or higher

0 commit comments

Comments
 (0)