Class PackageCipher

Index

Constructors

Methods

decrypt decryptBytes decryptFiles encrypt encryptBytes encryptCap

Constructors

constructor

new PackageCipher(
    fs?: FileSystem,
    archive?: CapArchive,
    random?: (bytes: number) => Uint8Array,
): PackageCipher
Parameters
- fs: FileSystem = ...
- archive: CapArchive = ...
- random: (bytes: number) => Uint8Array = randomBytes
Returns PackageCipher
- Defined in capsium-js/packages/packager/src/package-cipher.ts:76

Methods

decrypt

decrypt(capPath: string, privateKeyPem: string, outPath: string): Promise<void>
Decrypt an encrypted .cap file, writing the inner .cap to outPath.
Parameters
- capPath: string
- privateKeyPem: string
- outPath: string
Returns Promise<void>
- Defined in capsium-js/packages/packager/src/package-cipher.ts:133

decryptBytes

decryptBytes(
encBytes: Uint8Array,
privateKeyPem: string,
): Promise<Uint8Array<ArrayBufferLike>>
Decrypt encrypted .cap bytes into the inner .cap bytes.
Parameters
- encBytes: Uint8Array
- privateKeyPem: string
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in capsium-js/packages/packager/src/package-cipher.ts:138

decryptFiles

decryptFiles(
files: ReadonlyMap<string, Uint8Array<ArrayBufferLike>>,
privateKeyPem: string,
): Promise<Uint8Array<ArrayBufferLike>>
Decrypt an unpacked §6b envelope file map into the inner .cap bytes.
Parameters
- files: ReadonlyMap<string, Uint8Array<ArrayBufferLike>>
- privateKeyPem: string
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in capsium-js/packages/packager/src/package-cipher.ts:143

encrypt

encrypt(
    packagePath: string,
    publicKeyPem: string,
    outPath: string,
): Promise<void>
Encrypt a package into the §6b envelope: packagePath may be a package directory (packed first, so checksums are in place) or a .cap file. Writes the encrypted .cap to outPath.
Parameters
- packagePath: string
- publicKeyPem: string
- outPath: string
Returns Promise<void>
- Defined in capsium-js/packages/packager/src/package-cipher.ts:87

encryptBytes

encryptBytes(
capBytes: Uint8Array,
publicKeyPem: string,
): Promise<Uint8Array<ArrayBufferLike>>
Encrypt .cap bytes into the §6b envelope layout (as zip bytes).
Parameters
- capBytes: Uint8Array
- publicKeyPem: string
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in capsium-js/packages/packager/src/package-cipher.ts:102

encryptCap

encryptCap(
packagePath: string,
publicKeyPem: string,
): Promise<Uint8Array<ArrayBufferLike>>
Encrypt a directory or .cap into encrypted .cap bytes (§6b).
Parameters
- packagePath: string
- publicKeyPem: string
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in capsium-js/packages/packager/src/package-cipher.ts:92