From c3d4208e129ffd6652dd371ba96015feb216ec21 Mon Sep 17 00:00:00 2001 From: Amir Adal Date: Sun, 8 Jun 2025 16:43:13 +0200 Subject: [PATCH] Update README.md --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) diff --git a/README.md b/README.md index b252a12..ae394eb 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ + # 🛡️ HSP Guard **HSP Guard** is a modern OpenID Connect (OIDC) identity provider and access management system for home labs. It provides secure authentication and granular authorization for all your self-hosted services, combining ease of use with enterprise-level control — without any vendor lock-in. @@ -78,3 +79,61 @@ Each user has a unique profile, roles, and group memberships. "roles": ["GUEST"], "permissions": ["dashboard.view", "music.play"] } +``` + +--- + +## 📡 **App Permission Discovery** + +If your app supports permission discovery: +- Expose `/.well-known/guard-configuration` endpoint listing available permissions +- When registering in HSP Guard, auto-fetch and display for approval + +#### **Example guard-configuration JSON** +```json +{ + "permissions": [ + "dashboard.view", + "dashboard.edit", + "dashboard.admin" + ] +} +``` + +--- + +## 🔄 **User & Admin Sessions** + +- List all active sessions (browser, app, device, timestamp) +- Revoke sessions (logout) from user or admin panel + +--- + +## 📦 **Planned Features & Roadmap** + +- [ ] **Group Management** for batch assignments +- [ ] **Audit Logging** of all admin/user actions +- [ ] **Permission Expiry** (time-limited access) +- [ ] **Advanced Web UI** (dark mode, mobile) +- [ ] **External Identity Providers** (login with Google, GitHub, etc.) + +--- + +## 🛠️ **Development** + +- See [CONTRIBUTING.md](CONTRIBUTING.md) for how to contribute! +- Pull requests and issues are welcome. + +--- + +## 📝 **License** + +MIT — open source, for the home lab community. + +--- + +## 💬 **Feedback** + +Open an [issue](https://github.com/yourusername/hsp-guard/issues) or join the discussion! + +---