Skip to content

Commit 4229f6d

Browse files
committed
Add project files.
1 parent 2dd4082 commit 4229f6d

31 files changed

Lines changed: 248 additions & 0 deletions

File tree

README.md

Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
⚠️ This project is in early development. Preview release expected Q1 2026.
2+
# UltimateAuth
3+
### The Modern Unified Auth Framework for .NET -- Reimagined.
4+
A CodeBeam Project
5+
6+
---
7+
8+
UltimateAuth is an open-source authentication framework that unifies secure session and token based authentication, modern PKCE flows, Blazor/Maui-ready client experiences, and a fully extensible architecture — all with a focus on clarity, lightweight design, and developer happiness.
9+
10+
---
11+
12+
## 🌟 Why UltimateAuth: The Six-Point Principles
13+
14+
### **1) Developer-Centric**
15+
Clean APIs, predictable behavior, minimal ceremony — designed to make authentication *pleasant* for developers.
16+
17+
### **2) Security-Driven**
18+
PKCE, hardened session flows, reuse detection, event-driven safeguards, device awareness, and modern best practices.
19+
20+
### **3) Extensible & Lightweight by Design**
21+
Every component can be replaced or overridden.
22+
No forced dependencies. No unnecessary weight.
23+
24+
### **4) Plug-and-Play Ready**
25+
From setup to production, UltimateAuth prioritizes a frictionless integration journey with sensible defaults.
26+
27+
### **5) User-Friendly Flows**
28+
Authentication should be secure *and* intuitive.
29+
Consistent, predictable, and UX-friendly at every step.
30+
31+
### **6) Blazor & MAUI-Ready for Modern .NET**
32+
Blazor WebApp, Blazor WASM, Blazor Server, and .NET MAUI expose weaknesses in traditional auth systems.
33+
UltimateAuth is engineered from day one to support real-world scenarios across the entire modern .NET UI stack.
34+
35+
---
36+
37+
## 🔑 What UltimateAuth Provides
38+
39+
- A **secure, modern session-based authentication core**
40+
(opaque SessionId, server-managed, real-time revocation, device tracking)
41+
42+
- A **unified architecture** bridging Session, PKCE, and OAuth-style auth flows
43+
44+
- An **override-first design** suitable for enterprise extensions
45+
46+
- A **production-grade client SDK** for Blazor & MAUI
47+
48+
- A **fully interactive sandbox**
49+
where developers can test flows, create accounts, simulate devices, and validate behaviors in real time
50+
51+
---
52+
53+
## 📅 Release Timeline (Targeted)
54+
55+
> _Dates reflect targeted milestones and may evolve with community feedback._
56+
57+
### **Q1 2026 — Preview (v 0.1.0)**
58+
- Core session-based auth engine
59+
60+
### **Q2 2026 — Stable Feature Release**
61+
- Token-based flows
62+
63+
### **Q3 2026 — v 1.0.0 (General Availability)**
64+
- API surface locked
65+
- Production-ready security hardening
66+
- Unified architecture finalized
67+
68+
### **Q4 2026 — v 11.x.x (.NET 11 Alignment Release)**
69+
UltimateAuth adopts .NET platform versioning to align with the broader ecosystem.
70+
71+
---
72+
73+
## 📘 Documentation
74+
75+
Two documentation experiences will be provided:
76+
77+
### **1) Classic Documentation**
78+
Guides, API reference, tutorials
79+
80+
### **2) Interactive Identity Sandbox**
81+
Create accounts, simulate devices, test auth flows, and observe UltimateAuth in action.
82+
83+
---
84+
85+
## 🤝 Contributing
86+
87+
UltimateAuth is a community-first framework.
88+
We welcome proposals, discussions, architectural insights, and contributions of all sizes.
89+
90+
Before contributing, please see:
91+
92+
- `ROADMAP.md` — Release strategy
93+
94+
Discussions are open — your ideas matter.
95+
96+
---
97+
98+
## 🛠 Project Status
99+
100+
UltimateAuth is currently in the design and specification phase.
101+
We are shaping the architecture with real-world requirements, especially from Blazor and MAUI applications.
102+
103+
Early API drafts and prototypes will be published soon.
104+
105+
---
106+
107+
## ⭐ Acknowledgements
108+
109+
UltimateAuth is built with love by CodeBeam and shaped by real-world .NET development —
110+
for teams who want authentication to be secure, predictable, extensible, and a joy to use.
111+
112+
Reimagine how .NET does authentication.
113+
Welcome to UltimateAuth.

ROADMAP.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
# UltimateAuth Roadmap
2+
This document outlines the planned development phases of UltimateAuth.
3+
Dates are targets and may evolve based on community feedback and real-world usage.
4+
5+
---
6+
7+
## 🟣 Q1 2026 — Preview (v 0.1.0)
8+
The first public preview of UltimateAuth:
9+
- Core session-based auth engine
10+
- Secure opaque SessionId tokens
11+
- Basic login / logout / refresh and PKCE flows
12+
- Blazor & MAUI client foundations
13+
- Initial server abstractions and extension points
14+
- Early documentation and samples
15+
16+
---
17+
18+
## 🟣 Q2 2026 — Stable Feature Release
19+
Focus on stabilization, developer experience, and broader platform support:
20+
- Hardened session lifecycle
21+
- Expanded testing and validation
22+
- Improved client SDK flows
23+
- ASP.NET Core middleware polishing
24+
- More complete documentation
25+
- First public samples for real applications
26+
27+
---
28+
29+
## 🟣 Q3 2026 — Version 1.0.0 (General Availability)
30+
UltimateAuth reaches production-readiness:
31+
- API surface finalized and locked
32+
- Full PKCE/OAuth-style flow support
33+
- Unified architecture across client & server
34+
- Performance improvements
35+
- Security review & hardening
36+
- Real-world feedback applied
37+
- Long-term support model established
38+
39+
---
40+
41+
## 🟣 Q4 2026 — .NET 11 Alignment (v11.x.x)
42+
UltimateAuth aligns its versioning and platform features with .NET 11:
43+
- Framework-wide modernization updates
44+
- Future-proof API adjustments
45+
- Compatibility refinements
46+
47+
---
48+
49+
## 🟣 Beyond 2026 — Long-Term Vision
50+
- Advanced OAuth integrations
51+
- External identity provider modules
52+
- Enhanced build-in security features (MFA, biometrics)
53+
- Extended session storage providers
54+
- Developer tooling & templates
55+
- Deep Blazor/Maui experience enhancements
56+
- Distributed session management options
57+
58+
---
59+
60+
UltimateAuth is developed openly and shaped by community feedback.
61+
Thank you for helping us build the next-generation authentication framework for .NET.

UltimateAuth.slnx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<Solution>
2+
<Folder Name="/Solution Items/">
3+
<File Path="Readme.md" />
4+
<File Path="Roadmap.md" />
5+
</Folder>
6+
<Project Path="src/CodeBeam.UltimateAuth.AspNetCore/CodeBeam.UltimateAuth.AspNetCore.csproj" Id="30d5db36-6dc8-46f6-9139-8b6b3d6053d5" />
7+
<Project Path="src/CodeBeam.UltimateAuth.Client/CodeBeam.UltimateAuth.Client.csproj" Id="eb60a3b7-ba9d-48c9-98ad-b28e879b23bf" />
8+
<Project Path="src/CodeBeam.UltimateAuth.Core/CodeBeam.UltimateAuth.Core.csproj" />
9+
<Project Path="src/CodeBeam.UltimateAuth.Server/CodeBeam.UltimateAuth.Server.csproj" Id="0a8cdd12-a8c4-4530-87e8-ae778c46322b" />
10+
</Solution>

docs/.gitkeep

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<Project Sdk="Microsoft.NET.Sdk">
2+
3+
<PropertyGroup>
4+
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
5+
<ImplicitUsings>enable</ImplicitUsings>
6+
<Nullable>enable</Nullable>
7+
<GenerateDocumentationFile>true</GenerateDocumentationFile>
8+
</PropertyGroup>
9+
10+
</Project>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+


0 commit comments

Comments
 (0)