Skip to content

Commit 652ea87

Browse files
committed
docs: update README.md with security warning and CLI documentation enhancements
1 parent 9043473 commit 652ea87

File tree

1 file changed

+30
-11
lines changed

1 file changed

+30
-11
lines changed

README.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ A Go implementation of the kMOSAIC post-quantum cryptographic library.
1111
- [kMOSAIC White Paper](https://github.com/BackendStack21/k-mosaic/blob/main/kMOSAIC_WHITE_PAPER.md) - Detailed technical specification and cryptographic design
1212
- [Developer Guide - TypeScript Reference](https://github.com/BackendStack21/k-mosaic/blob/main/DEVELOPER_GUIDE.md) - Implementation guidelines and best practices
1313

14+
## ⚠️ Security Warning
15+
16+
**kMOSAIC is an experimental cryptographic construction that has NOT been formally verified by academic peer review. DO NOT use in production systems protecting sensitive data.**
17+
1418
## Overview
1519

1620
kMOSAIC (Key Mosaic) is a post-quantum secure cryptographic framework that combines three distinct hard mathematical problems to provide defense-in-depth security:
@@ -35,7 +39,9 @@ go get github.com/BackendStack21/k-mosaic-go
3539

3640
## Command-line Interface
3741

38-
Use the `k-mosaic-cli` for common tasks such as key generation, encryption/decryption, and signing/verification. Quick cheat:
42+
Use the `k-mosaic-cli` for common tasks such as key generation, encryption/decryption, and signing/verification.
43+
44+
### Quick Start
3945

4046
```bash
4147
# Install the CLI
@@ -45,9 +51,22 @@ go install github.com/BackendStack21/k-mosaic-go/cmd/k-mosaic-cli@latest
4551
k-mosaic-cli kem keygen -l 128 -o keys.json
4652
k-mosaic-cli kem encrypt -pk keys.json -m "Secret message" -o enc.json
4753
k-mosaic-cli kem decrypt -sk keys.json -pk keys.json -ct enc.json
54+
55+
# Generate keys, sign, verify
56+
k-mosaic-cli sign keygen -l 128 -o sign.json
57+
k-mosaic-cli sign sign -sk sign.json -pk sign.json -m "Document" -o sig.json
58+
k-mosaic-cli sign verify -pk sign.json -sig sig.json
4859
```
4960

50-
Full CLI documentation and examples are available in `CLI.md` — see: [./CLI.md](CLI.md).
61+
### Full Documentation
62+
63+
For comprehensive CLI documentation, installation methods, security best practices, key management workflows, and detailed command reference, see: **[CLI.md](CLI.md)**
64+
65+
Key topics in CLI.md:
66+
- Installation methods (source, go install, multi-platform builds)
67+
- Complete encryption and signature workflows
68+
- Security best practices and key management
69+
- Troubleshooting and FAQ
5170

5271
## Quick Start
5372

@@ -79,16 +98,16 @@ func main() {
7998

8099
## Benchmarks (Apple M2 Pro)
81100

82-
| Operation | MOS_128 |
83-
| --------------- | --------- |
84-
| KEM KeyGen | ~6.04 ms |
85-
| KEM Encapsulate | ~304 μs |
86-
| KEM Decapsulate | ~337 μs |
87-
| Sign KeyGen | ~6.11 ms |
88-
| Sign | ~11.66 μs |
89-
| Verify | ~2.36 ms |
101+
| Operation | MOS_128 | MOS_256 |
102+
| --------------- | --------- | --------- |
103+
| KEM KeyGen | 6.29 ms | 22.43 ms |
104+
| KEM Encapsulate | 0.32 ms | 0.95 ms |
105+
| KEM Decapsulate | 0.38 ms | 1.06 ms |
106+
| Sign KeyGen | 6.22 ms | 22.49 ms |
107+
| Sign | 12.07 μs | 21.95 μs |
108+
| Verify | 2.44 ms | 9.13 ms |
90109

91-
_See [BenchmarkReport.md](BenchmarkReport.md) for full detailed benchmark results and methodology._
110+
_See [BenchmarkReport.md](BenchmarkReport.md) for comprehensive detailed benchmark results, performance analysis, and methodology._
92111

93112
## API Reference
94113

0 commit comments

Comments
 (0)