side-channel

What is side-channel?

The side-channel npm package is designed to provide mechanisms for securely handling and transmitting sensitive information within a JavaScript environment. It is particularly useful in contexts where preventing information leakage is critical, such as in cryptographic operations or when handling personal data. The package offers functionalities to create secure channels for data, ensuring that the data is not exposed to unintended scopes or leaked through side channels.

What are side-channel's main functionalities?

Creating a secure side channel

This feature allows the creation of a secure side channel where you can safely store and retrieve data. The `set` method is used to store data associated with a given key, ensuring that the data is not accessible outside the intended scope.

const SideChannel = require('side-channel');
const channel = new SideChannel();
channel.set(key, value);

Retrieving data from a secure side channel

This code snippet demonstrates how to retrieve data from a secure side channel. The `get` method is used to access the data associated with a specific key, ensuring that the operation is safe and the data integrity is maintained.

const value = channel.get(key);

Other packages similar to side-channel

cryptiles

While 'cryptiles' is more focused on cryptographic utilities, it shares the goal of secure data handling with 'side-channel'. 'cryptiles' offers functions for securely generating random strings and fixed-size cryptographic tokens, which can be seen as complementary to the secure data transmission and storage functionalities provided by 'side-channel'.

README

side-channel

Store information about any JS value in a side channel. Uses WeakMap if available.

Changelog

v1.0.4 - 2020-12-29

Commits

• [Tests] migrate tests to Github Actions 10909cb
• [Refactor] Use a linked list rather than an array, and move accessed nodes to the beginning 195613f
• [meta] do not publish github action workflow files 290ec29
• [Tests] run nyc on all tests; use tape runner ea6d030
• [actions] add "Allow Edits" workflow d464d8f
• [Dev Deps] update eslint, @ljharb/eslint-config, aud, auto-changelog 02daca8
• [Refactor] use call-bind and get-intrinsic instead of es-abstract e09d481
• [Deps] update object.assign ee83aa8
• [actions] update rebase action to use checkout v2 7726b0b