https://github.com/ecies/js-ciphers
Node/Pure JavaScript symmetric ciphers adapter
https://github.com/ecies/js-ciphers
aes cryptography
Last synced: 3 months ago
JSON representation
Node/Pure JavaScript symmetric ciphers adapter
- Host: GitHub
- URL: https://github.com/ecies/js-ciphers
- Owner: ecies
- License: mit
- Created: 2024-10-11T08:50:56.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-10-30T11:09:27.000Z (9 months ago)
- Last Synced: 2024-10-30T12:17:18.442Z (9 months ago)
- Topics: aes, cryptography
- Language: TypeScript
- Homepage: https://ecies.org/js-ciphers
- Size: 52.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# @ecies/ciphers
[](https://github.com/ecies/js-ciphers)
[](https://www.npmjs.com/package/@ecies/ciphers)
[](https://npm-stat.link/@ecies/ciphers)
[](https://packagephobia.com/result?p=@ecies/ciphers)
[](https://github.com/ecies/js-ciphers/actions)
[](https://codecov.io/gh/ecies/js-ciphers)
Node/Pure JavaScript symmetric ciphers adapter.
If native implementations are available on some platforms (e.g. node, deno, bun), it'll use [`node:crypto`](https://nodejs.org/api/crypto.html#cryptocreatecipherivalgorithm-key-iv-options) for efficiency.
Otherwise (e.g. browser, react native), it'll use [`@noble/ciphers`](https://github.com/paulmillr/noble-ciphers) for compatibility.
| | aes | chacha |
| ------------ | ---------------- | ---------------- |
| Node | `node:crypto` ⚡ | `node:crypto` ⚡ |
| Bun | `node:crypto` ⚡ | `@noble/ciphers` |
| Deno | `node:crypto` ⚡ | `@noble/ciphers` |
| Browser | `@noble/ciphers` | `@noble/ciphers` |
| React Native | `@noble/ciphers` | `@noble/ciphers` |
> [!NOTE]
> You may need to polyfill [`crypto.getRandomValues`](https://github.com/LinusU/react-native-get-random-values) for React Native.
>
> There are some limitations, see [Known limitations](#known-limitations) below.
>
> This library is tree-shakeable, unused code will be excluded by bundlers.
Check the [example](./example/) folder for bun/deno usage.
## Quick start
```js
import { aes256gcm } from "@ecies/ciphers/aes";
import { randomBytes } from "@noble/ciphers/webcrypto";
const TEXT = "hello world🌍!";
const encoder = new TextEncoder();
const decoder = new TextDecoder();
const msg = encoder.encode(TEXT);
const key = randomBytes();
const nonce = randomBytes(16);
const cipher = aes256gcm(key, nonce);
console.log("decrypted:", decoder.decode(cipher.decrypt(cipher.encrypt(msg))));
```
The API follows `@noble/ciphers`'s API for ease of use, you can check their [examples](https://github.com/paulmillr/noble-ciphers#examples) as well.
## Supported ciphers
- `aes-256-gcm`
- Both 16 bytes and 12 bytes nonce are supported.
- `aes-256-cbc`
- **Only for legacy applications**. You should use `xchacha20-poly1305` or `aes-256-gcm` as possible.
- Nonce is always 16 bytes.
- `chacha20-poly1305`
- Nonce is always 12 bytes.
- `xchacha20-poly1305`
- Nonce is always 24 bytes.
If key is fixed and nonce is less than 16 bytes, avoid randomly generated nonce.
## Known limitations
- `xchacha20-poly1305` is implemented with pure JS [`hchacha20`](https://datatracker.ietf.org/doc/html/draft-irtf-cfrg-xchacha#section-2.2) function and `node:crypto`'s `chacha20-poly1305` on node.
- Currently (Mar 2025), `node:crypto`'s `chacha20-poly1305` is not supported on deno and [bun](https://github.com/oven-sh/bun/issues/8072), `@noble/ciphers`'s implementation is used on both platforms instead.
- Some old versions of `deno` [do not support](https://github.com/denoland/deno/discussions/17964#discussioncomment-10917259) **indirect** conditional exports. If you use this library to build another library, client code of your library may fall back to the `node:crypto` implementation and not work properly, specifically `aes-256-gcm` (16 bytes nonce) and `chacha20-poly1305`. If you found such a problem, upgrade deno to the latest version.