Skip to content

Commit 045785f

Browse files
committed
docs: update README
1 parent 4be758a commit 045785f

File tree

2 files changed

+40
-53
lines changed

2 files changed

+40
-53
lines changed

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,11 @@
1111
> [!IMPORTANT]
1212
> Under active development. Not production-ready.
1313
14-
Most documentation lives within component repositories:
14+
Component documentation:
1515

16-
- **[engine/](https://github.com/inferadb/engine/tree/main/docs)** — Engine docs (API, IPL, architecture)
17-
- **[control/](https://github.com/inferadb/control/tree/main/docs)** — Control docs (authentication, entities)
18-
19-
Deployment documentation lives in the [deploy repository](https://github.com/inferadb/deploy/tree/main/docs).
16+
- **[engine/](https://github.com/inferadb/engine/tree/main/docs)** — API, IPL, architecture
17+
- **[control/](https://github.com/inferadb/control/tree/main/docs)** — Authentication, entities
18+
- **[deploy/](https://github.com/inferadb/deploy/tree/main/docs)** — Deployment guides
2019

2120
## Whitepapers
2221

@@ -38,13 +37,8 @@ Deployment documentation lives in the [deploy repository](https://github.com/inf
3837

3938
## Community
4039

41-
Join us on [Discord](https://discord.gg/inferadb) to discuss InferaDB, get help with your projects, and connect with other developers. Whether you have questions, want to share what you're building, or are interested in contributing, we'd love to have you!
40+
Join our [Discord](https://discord.gg/inferadb) to discuss InferaDB, get help, or contribute.
4241

4342
## License
4443

45-
Licensed under either of:
46-
47-
- [Apache License, Version 2.0](LICENSE-APACHE)
48-
- [MIT License](LICENSE-MIT)
49-
50-
at your option.
44+
Dual-licensed under [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE).

whitepapers/InferaDB.md

Lines changed: 34 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,18 @@
44

55
Modern applications demand fine-grained, contextual authorization systems capable
66
of enforcing access control across distributed, multi-tenant, and multi-region
7-
environments. Traditional role-based (RBAC) and attribute-based (ABAC) systems
8-
fail to scale with the complexity of today's ecosystems, where relationships,
9-
hierarchies, and dynamic policies define access semantics.
7+
environments. Traditional RBAC and ABAC systems fail to scale when relationships,
8+
hierarchies, and dynamic policies define access.
109

11-
**InferaDB** is an inference-driven authorization database that unifies
10+
**InferaDB** is an inference-driven authorization database unifying
1211
relationship-based access control (ReBAC), logical policy reasoning, and
13-
standardized interoperability through the **AuthZEN** specification. It draws
14-
inspiration from **Google Zanzibar** [1], incorporates the execution and
15-
co-location principles of **SpacetimeDB** [2], and introduces a modular,
16-
reasoning-first approach to access control through deterministic policy
17-
inference and sandboxed logic execution.
12+
**AuthZEN** interoperability. It draws from **Google Zanzibar** [1] and
13+
**SpacetimeDB's** co-location model [2], adding deterministic policy inference
14+
and sandboxed logic execution.
1815

19-
Built entirely in **Rust** for low-latency and strong consistency, with a
20-
**TypeScript** dashboard for developer accessibility, InferaDB delivers
21-
authorization that is **explainable, auditable, and composable** — by design.
16+
Built in **Rust** for low latency and strong consistency, with a **TypeScript**
17+
dashboard, InferaDB delivers **explainable, auditable, composable**
18+
authorization — by design.
2219

2320
## Executive Summary
2421

@@ -41,10 +38,10 @@ InferaDB addresses three critical challenges in modern authorization:
4138

4239
## Motivation
4340

44-
Authorization is one of the most critical yet under-engineered components of
45-
modern distributed systems. Developers often hardcode access rules, deploy
46-
unverified policy code, or rely on brittle role-based systems that collapse
47-
under the complexity of real-world resource graphs. Common challenges include:
41+
Authorization is critical yet under-engineered in distributed systems.
42+
Developers hardcode access rules, deploy unverified policies, or rely on
43+
brittle role-based systems that break under real-world resource graphs. Common
44+
challenges include:
4845

4946
- Inconsistent authorization logic across services.
5047
- Poor visibility and auditability of decisions.
@@ -57,7 +54,7 @@ relationships and logical inferences, not just static roles or attributes.
5754

5855
## Design Philosophy
5956

60-
The design of InferaDB is guided by five core principles:
57+
Five principles guide InferaDB's design:
6158

6259
| Principle | Description |
6360
| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -138,8 +135,8 @@ graph TD
138135
```
139136

140137
Each **PDP cell** operates autonomously with local data and computation,
141-
reducing cross-region latency while preserving strong consistency through
142-
causally ordered replication.
138+
reducing cross-region latency while preserving consistency through causal
139+
replication.
143140

144141
## Infera Policy Language (IPL)
145142

@@ -178,9 +175,9 @@ permission view = viewer or (is_public == true and time_now < resource.expiry)
178175

179176
## WASM Policy Modules
180177

181-
While declarative policies cover most authorization logic, real-world access
182-
control often depends on **contextual or domain-specific logic**such as IP
183-
ranges, subscription tiers, workflow states, or compliance rules.
178+
Declarative policies cover most authorization logic, but real-world access
179+
control often requires **domain-specific checks**IP ranges, subscription
180+
tiers, workflow states, or compliance rules.
184181

185182
InferaDB supports **WASM Policy Modules**: sandboxed, tenant-scoped logic
186183
extensions that execute in-process within each PDP cell. Each module is:
@@ -225,10 +222,10 @@ consistency and security guarantees.
225222

226223
## Consistency Model
227224

228-
Authorization systems face a fundamental tension: **strong consistency** ensures
229-
correct access decisions, but **global coordination** introduces latency.
230-
InferaDB resolves this through a carefully designed consistency model that
231-
prioritizes correctness while enabling low-latency reads.
225+
Authorization systems face a tension: **strong consistency** ensures correct
226+
decisions, but **global coordination** adds latency. InferaDB resolves this
227+
with a consistency model prioritizing correctness while enabling low-latency
228+
reads.
232229

233230
### The New Enemy Problem
234231

@@ -268,9 +265,8 @@ This design enables **read-your-writes consistency** without global coordination
268265

269266
## Scalability and Performance
270267

271-
InferaDB achieves high throughput and low latency through architectural
272-
decisions that co-locate computation with data and minimize cross-region
273-
coordination.
268+
InferaDB achieves high throughput and low latency by co-locating computation
269+
with data and minimizing cross-region coordination.
274270

275271
### Performance Characteristics
276272

@@ -306,9 +302,8 @@ hashing. Large tenants can be further sharded by namespace or resource type.
306302

307303
## Security Model
308304

309-
InferaDB is designed with a **zero-trust architecture** where every component
310-
assumes compromise of adjacent systems. Security is not an add-on—it's
311-
foundational to the design.
305+
InferaDB uses a **zero-trust architecture**: every component assumes adjacent
306+
systems are compromised. Security is foundational, not an add-on.
312307

313308
### Threat Model
314309

@@ -424,9 +419,8 @@ inferadb/
424419

425420
## Comparison with Alternatives
426421

427-
The authorization landscape includes several mature solutions. InferaDB
428-
differentiates through its combination of inference-based reasoning, standards
429-
compliance, and extensibility.
422+
Several mature authorization solutions exist. InferaDB differentiates with
423+
inference-based reasoning, standards compliance, and extensibility.
430424

431425
| Capability | InferaDB | SpiceDB | OpenFGA | Oso | Cerbos |
432426
| ------------------- | ------------------------ | -------------------------------- | ----------------- | -------------------- | --------------- |
@@ -446,12 +440,11 @@ compliance, and extensibility.
446440

447441
## Conclusion
448442

449-
InferaDB represents a next-generation approach to authorization — where policies
450-
are logic, decisions are proofs, and relationships form the foundation of
451-
access reasoning. By combining the consistency of Zanzibar, the interoperability
452-
of AuthZEN, and the composability of WASM-based modules, InferaDB establishes a
453-
new standard for trust, transparency, and developer experience in distributed
454-
access control.
443+
InferaDB represents next-generation authorization — policies as logic, decisions
444+
as proofs, relationships as the foundation of access reasoning. Combining
445+
Zanzibar's consistency, AuthZEN interoperability, and WASM composability,
446+
InferaDB sets a new standard for trust, transparency, and developer experience
447+
in distributed access control.
455448

456449
> **Authorize by Reason, at Scale.**
457450

0 commit comments

Comments
 (0)