node-seal - GitLite

KO | EN

gitlite — search

#javascript #python #ai #typescript #go #deep-learning #macos #awesome #kubernetes #pytorch #security #ios #openai #open-source

node-seal

(★ 217)

Homomorphic Encryption for TypeScript or JavaScript - Microsoft SEAL

File Explorer

Download Latest Version (.zip)

- - bug_report.md
- - cd.yml
  - ci.yml
- wasm.html
- em-update.sh
- postrollup.sh
- seal-build-wasm.sh
- seal-clean.sh
- seal-cmake.sh
- seal-make.sh
- submodule-update.sh
- - batch-encoder.test.ts
  - ciphertext.test.ts
  - ckks-encoder.test.ts
  - coeff-modulus.test.ts
  - compr-mode-type.test.ts
  - context.test.ts
  - encrypt-decrypt.test.ts
  - encryption-parameters.test.ts
  - evaluator-bfv.test.ts
  - evaluator-bgv.test.ts
  - evaluator-ckks.test.ts
  - galois-keys.test.ts
  - key-generator.test.ts
  - memory-pool-handle.test.ts
  - modulus.test.ts
  - parms-id-type.test.ts
  - plain-modulus.test.ts
  - plaintext.test.ts
  - public-key.test.ts
  - relin-keys.test.ts
  - scheme-type.test.ts
  - secret-key.test.ts
  - security-level.test.ts
  - transparent-allows.test.ts
  - transparent-throws.test.ts
  - vectorModulus.test.ts
- .gitignore
- index_allows.ts
- index_throws.ts
- emsdk
- SEAL
.gitignore
.gitmodules
.n-node-version
.prettierignore
.prettierrc
BENCHMARK.md
CHANGES.md
CITATION.cff
CODE_OF_CONDUCT.md
CONTRIBUTING.md
FULL-EXAMPLE.md
LICENSE
package-lock.json
package.json
README.md
tsconfig.json
USAGE.md
vite.config.ts

# Installation Guide

1. Get the code

git clone https://github.com/s0l0ist/node-seal

Downloads the entire project code from GitHub to your computer.

cd node-seal

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install node-seal

Downloads and installs the libraries listed in package.json.

yarn add node-seal

Type this command into your terminal and run it.

pnpm add node-seal

Type this command into your terminal and run it.

npm run seal:build:bench

Type this command into your terminal and run it.

npm run benchmark

Type this command into your terminal and run it.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# [node-seal](https://github.com/s0l0ist/node-seal) &middot; [![GitHub license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/s0l0ist/node-seal/blob/main/LICENSE) [![npm version](https://badge.fury.io/js/node-seal.svg)](https://www.npmjs.com/package/node-seal) [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fs0l0ist%2Fnode-seal.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fs0l0ist%2Fnode-seal?ref=badge_shield&issueType=license)

**node-seal** is an ESM-first, WebAssembly-powered wrapper around the C++
[Microsoft SEAL](https://github.com/microsoft/SEAL) homomorphic encryption
library, for TypeScript and JavaScript.

> **v7.0.0 is a breaking release.** The custom JS wrapper layer was removed —
> the package now exposes the Emscripten-generated bindings directly. That makes
> the package ~96% smaller and faster, but it also means some imports and helper
> methods changed.

- **WebAssembly:** Fast, direct bindings to Microsoft SEAL
- **ESM-first:** Modern module layout, no bundling
- **Node.js + browser + edge (CF Workers):** Everything you need (JS glue,
  .wasm, and typings) is in the package, so you can run it anywhere WASM is
  allowed.
- **Low-level, close to C++:** Method names and types now map much more directly
  to SEAL

**Currently aligned with Microsoft SEAL 4.1.2.**

## Table of Contents

- [Installation](#installation)
- [Quick Start](#quick-start)
- [What Changed in v7](#what-changed-in-v7)
- [Environment Notes](#environment-notes)
  - [React Native](#react-native)
- [Demo](#demo)
- [Usage](#usage)
- [Documentation](#documentation)
- [Examples](#examples)
- [Benchmarking](#benchmarking)
- [Caveats](#caveats)
- [Contributing](#contributing)
- [License](#license)

## Installation

Install from npm:

```sh
npm install node-seal
# or
yarn add node-seal
# or
pnpm add node-seal
```

Because v7 is ESM-first and publishes the `.wasm` alongside the JS glue and
TypeScript definitions, most modern bundlers can import it directly without
extra configuration.

## Quick Start

In v7, the default import gives you a factory; call it to get the SEAL runtime:

```ts
import SEAL from 'node-seal'

const seal = await SEAL()
```

Variants:

```ts
// recommended and default: throws on transparent ciphertexts
import SEAL from 'node-seal/throws'
const seal = await SEAL()

// allow transparent ciphertexts (only if you know you need this)
import SEAL from 'node-seal/allows'
const seal = await SEAL()
```

## What Changed in v7?

See [here](CHANGES.md).

## Environment Notes

### React Native

You could use something like the
[react-native-webassembly](https://github.com/cawfree/react-native-webassembly)
lib, but this has not been tested.

## Demo

Go to the [sandbox](https://s0l0ist.github.io/seal-sandbox/)

This sandbox was built for users to experiment and learn how to use Microsoft
SEAL featuring node-seal.

- **Encryption Parameters:** experiment with many settings to prototype a
  SEALContext.
- **Keys:** Create, download, upload Secret/Public Keys - even for
  Relinearization and Galois Keys.
- **Variables:** Create, download, upload PlainTexts or CipherTexts
- **Functions:** Create a list of HE functions to execute!
- **Code Generation:** After your experimentation is complete, generate working
  code to use!

> Note: the sandbox targets an earlier version of `node-seal`, so generated code
> may need adjustments for v7.

## Usage

Checkout the [basics](USAGE.md)

## Documentation

`v7` doesn't have a dedicated documentation page. Instead, you refer to the [C++
bindings](https://github.com/s0l0ist/SEAL/blob/master/native/src/seal/bindings.cpp)
for additional information. The best examples and explanations are found in
Microsoft SEAL's
[repository](https://github.com/s0l0ist/SEAL/tree/master/native/examples).

View the docs from `v6.0.3` and earlier
[here](https://s0l0ist.github.io/node-seal)

## Examples

Check out the [Sandbox](https://s0l0ist.github.io/seal-sandbox/) to try out HE
operations and even generate example code. Just a heads-up: the sandbox was
built against an older version of `node-seal`, so while the demos still work,
the code it generates isn't compatible with v7.

If you'd rather read an example, take a look [here](FULL-EXAMPLE.md).

For more exhaustive examples, view the [tests](src/__tests__).

## Changes

For changes in this library, take a look [here](CHANGES.md).

For changes in Microsoft SEAL, take a look at their [list of
changes](https://github.com/microsoft/SEAL/blob/master/CHANGES.md).

## Benchmarking

```sh
npm run seal:build:bench
npm run benchmark
```

See also: `BENCHMARK.md`.

## Caveats

- **Memory**: saving large keys in the browser is expensive; try a different
  compression mode if you get OOMs.
- **Manual cleanup**: call `.delete()` or `.deleteLater()` on created objects to
  free C++ resources.

## Contributing

See `CONTRIBUTING.md`.

## License

node-seal is [MIT licensed](LICENSE).

[![FOSSA
Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fs0l0ist%2Fnode-seal.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fs0l0ist%2Fnode-seal?ref=badge_large&issueType=license)