Skip to content

Commit

Permalink
remove npm package
Browse files Browse the repository at this point in the history
  • Loading branch information
bwesterb committed Jun 20, 2024
1 parent 9107410 commit 908f007
Show file tree
Hide file tree
Showing 8 changed files with 0 additions and 362 deletions.
40 changes: 0 additions & 40 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
# Kyber
[![Build Status](https://github.com/Argyle-Software/kyber/actions/workflows/kat.yml/badge.svg)](https://github.com/bwesterb/argyle-kyber/actions)
[![Crates](https://img.shields.io/crates/v/safe_pqc_kyber)](https://crates.io/crates/safe_pqc_kyber)
[![NPM](https://img.shields.io/npm/v/pqc-kyber?color=yellow)](https://www.npmjs.com/package/safe_pqc_kyber)
[![License](https://img.shields.io/crates/l/safe_pqc_kyber)](https://github.com/Argyle-Software/kyber/blob/master/LICENSE-MIT)
[![dependency status](https://deps.rs/crate/safe_pqc_kyber/0.6.2/status.svg)](https://deps.rs/crate/safe_pqc_kyber/0.6.2)

Expand Down Expand Up @@ -177,45 +176,6 @@ The fuzzing suite uses honggfuzz, installation and instructions are on the [fuzz

---

## WebAssembly

This library has been compiled into web assembly and published as a npm package. Usage instructions are here:

https://www.npmjs.com/package/pqc-kyber

Which is also located here in the [wasm readme](./pkg/readme.md)

To install:

```shell
npm i pqc-kyber
```

To compile the wasm files yourself you need to enable the `wasm` feature.

For example, using [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/):

```shell
wasm-pack build -- --features wasm
```

Which will export the wasm, javascript and typescript files into [./pkg/](./pkg/readme.md).

To compile a different variant into a separate folder:
```shell
wasm-pack build --out-dir pkg_kyber512/ -- --features "wasm kyber512"
```

There is also a basic html demo in the [www](./www/readme.md) folder.

From the www folder run:

```shell
npm run start
```

---

## Security Considerations

While much care has been taken porting from the C reference codebase, this library has not undergone any third-party security auditing nor can any guarantees be made about the potential for underlying vulnerabilities in LWE cryptography or potential side-channel attacks arising from this implementation.
Expand Down
5 changes: 0 additions & 5 deletions www/bootstrap.js

This file was deleted.

53 changes: 0 additions & 53 deletions www/index.html

This file was deleted.

104 changes: 0 additions & 104 deletions www/index.js

This file was deleted.

39 changes: 0 additions & 39 deletions www/package.json

This file was deleted.

79 changes: 0 additions & 79 deletions www/readme.md

This file was deleted.

28 changes: 0 additions & 28 deletions www/style.css

This file was deleted.

14 changes: 0 additions & 14 deletions www/webpack.config.js

This file was deleted.

0 comments on commit 908f007

Please sign in to comment.