@zkim-platform/file-format 1.1.0 → 1.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +21 -9
  2. package/package.json +3 -2
  3. package/zkim-logo.png +0 -0
package/README.md CHANGED
@@ -1,14 +1,26 @@
1
- # @zkim-platform/file-format
1
+ <p align="center">
2
+ <img src="./zkim-logo.png" alt="ZKIM" width="120" height="120" />
3
+ </p>
4
+
5
+ <h1 align="center">@zkim-platform/file-format</h1>
6
+
7
+ <p align="center">
8
+ <a href="https://www.npmjs.com/package/@zkim-platform/file-format"><img src="https://img.shields.io/npm/v/@zkim-platform/file-format" alt="npm version" /></a>
9
+ <a href="https://www.npmjs.com/package/@zkim-platform/file-format"><img src="https://img.shields.io/npm/dm/@zkim-platform/file-format" alt="npm downloads" /></a>
10
+ <a href="./LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue" alt="License" /></a>
11
+ <a href="https://www.typescriptlang.org/"><img src="https://img.shields.io/badge/TypeScript-5.9-blue" alt="TypeScript" /></a>
12
+ <a href="https://nodejs.org/"><img src="https://img.shields.io/badge/Node.js-18%2B-green" alt="Node.js" /></a>
13
+ <img src="https://img.shields.io/badge/coverage-92%25-brightgreen" alt="Test Coverage" />
14
+ <a href="https://github.com/zkdotim/zkim-file-format/actions/workflows/ci.yml"><img src="https://github.com/zkdotim/zkim-file-format/actions/workflows/ci.yml/badge.svg?branch=main" alt="Build Status" /></a>
15
+ </p>
16
+
17
+ <p align="center">
18
+ Post-quantum secure file format with three-layer encryption, ML-KEM-768/ML-DSA-65 cryptography, and privacy-preserving search.
19
+ </p>
2
20
 
3
- ![npm version](https://img.shields.io/npm/v/@zkim-platform/file-format)
4
- ![npm downloads](https://img.shields.io/npm/dm/@zkim-platform/file-format)
5
- ![License](https://img.shields.io/badge/license-MIT-blue)
6
- ![TypeScript](https://img.shields.io/badge/TypeScript-5.9-blue)
7
- ![Node.js](https://img.shields.io/badge/Node.js-18%2B-green)
8
- ![Test Coverage](https://img.shields.io/badge/coverage-92%25-brightgreen)
9
- ![Build Status](https://github.com/zkdotim/zkim-file-format/actions/workflows/ci.yml/badge.svg?branch=main)
21
+ ---
10
22
 
11
- Post-quantum secure file format using ML-KEM-768 (FIPS 203) for key exchange and ML-DSA-65 (FIPS 204) for signatures, with XChaCha20-Poly1305 symmetric encryption protected by post-quantum key derivation. Three-layer encryption with privacy-preserving search capabilities. Platform and user layer keys are derived from ML-KEM-768 shared secrets using BLAKE3. Content layer keys are cryptographically random for per-file perfect forward secrecy.
23
+ Protect your files against future quantum computer attacks. Built on NIST-standardized cryptography (FIPS 203/204) with an auditable, open-source design and verifiable builds.
12
24
 
13
25
  ## Installation
14
26
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zkim-platform/file-format",
3
- "version": "1.1.0",
3
+ "version": "1.1.2",
4
4
  "description": "Secure, post-quantum encrypted file format with three-layer encryption, ML-KEM-768/ML-DSA-65 cryptography, and privacy-preserving search capabilities",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -17,7 +17,8 @@
17
17
  "dist",
18
18
  "README.md",
19
19
  "LICENSE",
20
- "CHANGELOG.md"
20
+ "CHANGELOG.md",
21
+ "zkim-logo.png"
21
22
  ],
22
23
  "scripts": {
23
24
  "build": "tsup",
package/zkim-logo.png ADDED
Binary file