Update README.md
Browse files
README.md
CHANGED
|
@@ -1,11 +1,23 @@
|
|
| 1 |
-
# Flatseek
|
| 2 |
|
| 3 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 4 |
|
| 5 |
> **Passphrase:** `flatlens_demo_enclosed`
|
| 6 |
-
>
|
| 7 |
-
> K_user derived via PBKDF2(passphrase, salt). Outer container holds K_inner + expiry.
|
| 8 |
-
> Inner FSK is LIC_CHUNKED (per-section encrypted with K_inner).
|
| 9 |
|
| 10 |
| File | Status | Expiry |
|
| 11 |
|------|--------|--------|
|
|
@@ -21,26 +33,14 @@ flatseek serve demo_enclosed_active.fsk \
|
|
| 21 |
--passphrase "flatlens_demo_enclosed"
|
| 22 |
```
|
| 23 |
|
| 24 |
-
## License Dataset (Expired Key Protection)
|
| 25 |
|
| 26 |
> **Embedded key:** `LICENSE_EMBEDDED_KEY=opensourcelicensekey1234567890123456`
|
| 27 |
-
>
|
| 28 |
-
> Token verified via HMAC(embedded_key, "flatseek-license-v1") → derive K_inner → decrypt.
|
| 29 |
-
|
| 30 |
-
| File | Token | Expiry |
|
| 31 |
-
|------|-------|--------|
|
| 32 |
-
| `demo_license.fsk` | Active token | 2027-07-05 |
|
| 33 |
-
| `demo_license.fsk` | Expired token | 2025-07-05 |
|
| 34 |
|
| 35 |
-
|
| 36 |
-
|
| 37 |
-
ZGVtby11c2VyfDE4MTQ3NDU2MDB8MHxtUkJaTkN4WUdLeWhrV2NUMGN3Wlo0MkhUc1IvelNpYXBzUGo4a2tZdVhzPQ==
|
| 38 |
-
``
|
| 39 |
-
|
| 40 |
-
**Expired token:**
|
| 41 |
-
```
|
| 42 |
-
ZGVtby11c2VyfDE3NTE2NzM2MDB8MHxUVDFwQ05tVDVyVDlaVFIwYkxwMEVEV1oxVXRyUzVuM1BjOXVlZU9OWEIwPQ==
|
| 43 |
-
```
|
| 44 |
|
| 45 |
```bash
|
| 46 |
# CLI usage
|
|
|
|
| 1 |
+
# Flatseek Distribution & Licensing Guide
|
| 2 |
|
| 3 |
+
Securely distribute your Flatseek search indexes with flexible encryption and access control models suited for enterprise deployments.
|
| 4 |
+
|
| 5 |
+
---
|
| 6 |
+
|
| 7 |
+
## Overview: Distribution Models
|
| 8 |
+
|
| 9 |
+
| Model | Encryption | Expiry | Access Control | Best For |
|
| 10 |
+
|-------|-----------|--------|----------------|----------|
|
| 11 |
+
| **Plain** | None | — | None | Public data, no sensitivity |
|
| 12 |
+
| **Bucket** | Per-file ChaCha20 | — | Passphrase | Internal teams, trusted users |
|
| 13 |
+
| **License Token** | Full-section ChaCha20 | ✅ Token-based | HMAC token | Subscription content, SaaS |
|
| 14 |
+
| **License + Custom Key** | Full-section ChaCha20 | ✅ Token-based | HMAC token | Tiered distribution, premium tiers |
|
| 15 |
+
| **Enclosed** | Full blob ChaCha20 | ✅ Cryptographic | Passphrase | Single-file distribution, time-limited access |
|
| 16 |
+
|
| 17 |
+
|
| 18 |
+
### Enclosed Datasets (Expired Data Protection)
|
| 19 |
|
| 20 |
> **Passphrase:** `flatlens_demo_enclosed`
|
|
|
|
|
|
|
|
|
|
| 21 |
|
| 22 |
| File | Status | Expiry |
|
| 23 |
|------|--------|--------|
|
|
|
|
| 33 |
--passphrase "flatlens_demo_enclosed"
|
| 34 |
```
|
| 35 |
|
| 36 |
+
### License Dataset (Expired Key Protection)
|
| 37 |
|
| 38 |
> **Embedded key:** `LICENSE_EMBEDDED_KEY=opensourcelicensekey1234567890123456`
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 39 |
|
| 40 |
+
| File | Expiry | Status | Token |
|
| 41 |
+
|------|-------|--------|--------|
|
| 42 |
+
| `demo_license.fsk` | 2027-07-05 | Active | ZGVtby11c2VyfDE4MTQ3NDU2MDB8MHxtUkJaTkN4WUdLeWhrV2NUMGN3Wlo0MkhUc1IvelNpYXBzUGo4a2tZdVhzPQ==
|
| 43 |
+
| `demo_license.fsk` | 2025-07-05 | Expired | ZGVtby11c2VyfDE3NTE2NzM2MDB8MHxUVDFwQ05tVDVyVDlaVFIwYkxwMEVEV1oxVXRyUzVuM1BjOXVlZU9OWEIwPQ==
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 44 |
|
| 45 |
```bash
|
| 46 |
# CLI usage
|