@vollcrypt/files-node 0.1.1 → 0.9.1

package/index.d.ts

@@ -40,6 +40,9 @@ export interface WrapEntry {
   ciphertextMlKem?: Buffer
   groupId?: Buffer
   wrappedKey: Buffer
+  t?: number
+  n?: number
+  shareSetId?: Buffer
 }
 export declare function wrapDekWithPassword(dek: Uint8Array, password: string, kdf: KdfChoice): WrapEntry
 export declare function unwrapDekWithPassword(wrap: WrapEntry, password: string): Buffer
@@ -57,6 +60,21 @@ export declare function wrapKeyToRecipient(key: Uint8Array, recipientId: Uint8Ar
 export declare function unwrapKeyWithRecipientKey(wrap: WrapEntry, recipientSk: KeySubpair): Buffer
 export declare function wrapDekForGroup(dek: Uint8Array, groupId: Uint8Array, gkVersion: number, gk: Uint8Array): WrapEntry
 export declare function unwrapDekWithGroupKey(wrap: WrapEntry, gk: Uint8Array): Buffer
+export interface WrapThresholdResult {
+  wrap: WrapEntry
+  shares: Array<string>
+}
+export interface ShareJson {
+  shareSetId: Buffer
+  t: number
+  n: number
+  x: number
+  y: Buffer
+}
+export declare function wrapDekWithThreshold(dek: Buffer, fileId: Buffer, t: number, n: number, cipherSuiteId: number): WrapThresholdResult
+export declare function unwrapDekWithThresholdShares(wrap: WrapEntry, fileId: Buffer, shares: Array<string>, cipherSuiteId: number): Buffer
+export declare function encodeShare(share: ShareJson): string
+export declare function decodeShare(s: string): ShareJson
 export interface Ed25519KeypairObj {
   publicKey: Buffer
   secretKey: Buffer
@@ -64,6 +82,13 @@ export interface Ed25519KeypairObj {
 export declare function ed25519KeypairGenerate(): Ed25519KeypairObj
 export declare function ed25519Sign(sk: Uint8Array, message: Uint8Array): Buffer
 export declare function ed25519Verify(pk: Uint8Array, message: Uint8Array, signature: Uint8Array): boolean
+export interface HybridKeypairObj {
+  publicKey: Buffer
+  secretKey: Buffer
+}
+export declare function hybridKeypairGenerate(): HybridKeypairObj
+export declare function hybridSign(sk: Uint8Array, pk: Uint8Array, domain: string, context: Uint8Array, payload: Uint8Array): Buffer
+export declare function hybridVerify(pk: Uint8Array, domain: string, context: Uint8Array, payload: Uint8Array, signature: Uint8Array): boolean
 export interface MemberPublicKeyObj {
   recipient: KeySubpair
   signingPk: Buffer
@@ -78,6 +103,8 @@ export interface SignedMetadata {
   iv?: Buffer
   sealedPayload?: Buffer
   sealedTag?: Buffer
+  sealedMode?: number
+  reason?: string
 }
 export interface HeaderObj {
   version: number
@@ -87,6 +114,7 @@ export interface HeaderObj {
   chunkSize: number
   plaintextSize: number
   merkleRoot: Buffer
+  hashAlgorithm: number
   wraps: Array<WrapEntry>
   signedMetadata?: SignedMetadata
   signature?: Buffer
@@ -104,7 +132,7 @@ export declare function cryptoShredHeader(headerBytes: Uint8Array): Buffer
 export declare function signHeaderPlain(header: HeaderObj, signerPk: Uint8Array, signerSk: Uint8Array, keyLogId: Uint8Array, timestamp: number): HeaderObj
 export declare function signHeaderSealed(header: HeaderObj, signerPk: Uint8Array, signerSk: Uint8Array, keyLogId: Uint8Array, timestamp: number, sealedGroupId: Uint8Array, sealedGkVersion: number, sealedGk: Uint8Array): HeaderObj
 export declare function verifyHeaderSignaturePlain(header: HeaderObj): Buffer
-export declare function verifyHeaderSignatureSealed(header: HeaderObj, sealedGk: Uint8Array): Buffer
+export declare function verifyHeaderSignatureSealed(header: HeaderObj, sealedGk: Uint8Array, keyLog: KeyLog): Buffer
 export interface KeyLogEntry {
   kind: string
   userId?: Buffer
@@ -125,16 +153,49 @@ export interface SenderInfo {
 export declare function resolveSender(header: HeaderObj, keyLog: KeyLog, sealedGk?: Uint8Array | undefined | null): SenderInfo
 export interface PipelinedSignInfoObj {
   kind: string
-  signerEd25519Pk: Buffer
-  signerEd25519Sk: Buffer
+  signerPk: Buffer
+  signerSk: Buffer
   keyLogId: Buffer
   timestamp: number
   sealedGroupId?: Buffer
   sealedGkVersion?: number
   sealedGk?: Buffer
 }
-export declare function encryptFilePipelinedAsync(sourcePath: string, destPath: string, dek: Uint8Array, fileId: Uint8Array, chunkSize: number, wraps: Array<WrapEntry>, mode: number, numWorkers: number, signInfo?: PipelinedSignInfoObj | undefined | null): Promise<unknown>
-export declare function decryptFilePipelinedAsync(sourcePath: string, destPath: string, dek: Uint8Array, numWorkers: number): Promise<unknown>
+export interface IoWriteModeObj {
+  mode: string
+  batchSize?: number
+}
+export interface NapiSealOptions {
+  mode: string
+  reason?: string
+  signInfo?: PipelinedSignInfoObj
+}
+export interface NapiShieldPolicy {
+  releaseMode: string
+  signature?: string
+  rollbackPin?: number
+  founderAnchor?: boolean
+  onTamper?: string
+  verifySealedMarker?: boolean
+}
+export interface SealedInspectionObj {
+  version: number
+  fileId: Buffer
+  chunkSize: number
+  plaintextSize: number
+  merkleRoot: Buffer
+  hashAlgorithm: number
+  sealedMode?: number
+  reason?: string
+  timestamp?: number
+  ciphertextPresent: boolean
+}
+export declare function sealContainer(path: string, options: NapiSealOptions): Promise<unknown>
+export declare function isSealed(header: HeaderObj): boolean
+export declare function inspectSealedContainer(path: string): Promise<unknown>
+export declare function verifyContainer(path: string, policy: NapiShieldPolicy): string
+export declare function encryptFilePipelinedAsync(sourcePath: string, destPath: string, dek: Uint8Array, fileId: Uint8Array, chunkSize: number, wraps: Array<WrapEntry>, mode: number, numWorkers: number, signInfo?: PipelinedSignInfoObj | undefined | null, writeMode?: IoWriteModeObj | undefined | null): Promise<unknown>
+export declare function decryptFilePipelinedAsync(sourcePath: string, destPath: string, dek: Uint8Array, numWorkers: number, shield?: NapiShieldPolicy | undefined | null): Promise<unknown>
 export declare class GroupManifest {
   static genesis(groupId: Uint8Array, initialGk: Uint8Array, founderMemberId: Uint8Array, founderRecipientPk: KeySubpair, founderEd25519Pk: Uint8Array, founderEd25519Sk: Uint8Array, timestamp: number): GroupManifest
   static parse(bytes: Uint8Array): GroupManifest

package/index.js

@@ -310,7 +310,7 @@ if (!nativeBinding) {
   throw new Error(`Failed to load native binding`)
 }
 
-const { generateDek, generateFileId, generateSalt, generateGk, encryptChunk, decryptChunk, chunkLeafHash, merkleRoot, merkleProof, verifyMerkleProof, wrapDekWithPassword, unwrapDekWithPassword, unwrapDekWithPasswordAsync, generateRecipientKeypair, wrapKeyToRecipient, unwrapKeyWithRecipientKey, wrapDekForGroup, unwrapDekWithGroupKey, ed25519KeypairGenerate, ed25519Sign, ed25519Verify, GroupManifest, HeaderClass, rewrapDekInHeader, cryptoShredHeader, signHeaderPlain, signHeaderSealed, verifyHeaderSignaturePlain, verifyHeaderSignatureSealed, KeyLog, resolveSender, encryptFilePipelinedAsync, decryptFilePipelinedAsync } = nativeBinding
+const { generateDek, generateFileId, generateSalt, generateGk, encryptChunk, decryptChunk, chunkLeafHash, merkleRoot, merkleProof, verifyMerkleProof, wrapDekWithPassword, unwrapDekWithPassword, unwrapDekWithPasswordAsync, generateRecipientKeypair, wrapKeyToRecipient, unwrapKeyWithRecipientKey, wrapDekForGroup, unwrapDekWithGroupKey, wrapDekWithThreshold, unwrapDekWithThresholdShares, encodeShare, decodeShare, ed25519KeypairGenerate, ed25519Sign, ed25519Verify, hybridKeypairGenerate, hybridSign, hybridVerify, GroupManifest, HeaderClass, rewrapDekInHeader, cryptoShredHeader, signHeaderPlain, signHeaderSealed, verifyHeaderSignaturePlain, verifyHeaderSignatureSealed, KeyLog, resolveSender, sealContainer, isSealed, inspectSealedContainer, verifyContainer, encryptFilePipelinedAsync, decryptFilePipelinedAsync } = nativeBinding
 
 module.exports.generateDek = generateDek
 module.exports.generateFileId = generateFileId
@@ -330,9 +330,16 @@ module.exports.wrapKeyToRecipient = wrapKeyToRecipient
 module.exports.unwrapKeyWithRecipientKey = unwrapKeyWithRecipientKey
 module.exports.wrapDekForGroup = wrapDekForGroup
 module.exports.unwrapDekWithGroupKey = unwrapDekWithGroupKey
+module.exports.wrapDekWithThreshold = wrapDekWithThreshold
+module.exports.unwrapDekWithThresholdShares = unwrapDekWithThresholdShares
+module.exports.encodeShare = encodeShare
+module.exports.decodeShare = decodeShare
 module.exports.ed25519KeypairGenerate = ed25519KeypairGenerate
 module.exports.ed25519Sign = ed25519Sign
 module.exports.ed25519Verify = ed25519Verify
+module.exports.hybridKeypairGenerate = hybridKeypairGenerate
+module.exports.hybridSign = hybridSign
+module.exports.hybridVerify = hybridVerify
 module.exports.GroupManifest = GroupManifest
 module.exports.HeaderClass = HeaderClass
 module.exports.rewrapDekInHeader = rewrapDekInHeader
@@ -343,5 +350,9 @@ module.exports.verifyHeaderSignaturePlain = verifyHeaderSignaturePlain
 module.exports.verifyHeaderSignatureSealed = verifyHeaderSignatureSealed
 module.exports.KeyLog = KeyLog
 module.exports.resolveSender = resolveSender
+module.exports.sealContainer = sealContainer
+module.exports.isSealed = isSealed
+module.exports.inspectSealedContainer = inspectSealedContainer
+module.exports.verifyContainer = verifyContainer
 module.exports.encryptFilePipelinedAsync = encryptFilePipelinedAsync
 module.exports.decryptFilePipelinedAsync = decryptFilePipelinedAsync

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vollcrypt/files-node",
-  "version": "0.1.1",
+  "version": "0.9.1",
   "description": "Cross-platform, quantum-resistant file encryption engine for Node.js - native binding",
   "main": "index.js",
   "types": "index.d.ts",
@@ -38,7 +38,12 @@
   "files": [
     "index.d.ts",
     "index.js",
-    "vollcrypt-files-node.*.node"
+    "vollcrypt-files-node.*.node",
+    "README.md",
+    "LICENSE",
+    "LICENSE-COMMERCIAL.md",
+    "LICENSE-GPL",
+    "CHANGELOG.md"
   ],
   "keywords": [
     "vollcrypt",
@@ -57,9 +62,9 @@
   "author": "Berat Vural <berat.vural.tr@gmail.com>",
   "license": "GPL-3.0-only OR LicenseRef-Commercial",
   "devDependencies": {
-    "@napi-rs/cli": "^2.18.4",
-    "@types/node": "^20.11.0",
-    "tsx": "^4.7.0",
-    "typescript": "^5.3.3"
+    "@napi-rs/cli": "2.18.4",
+    "@types/node": "20.11.0",
+    "tsx": "4.7.0",
+    "typescript": "5.3.3"
   }
 }