https://github.com/chainsafe/js-libp2p-noise

Noise libp2p handshake for js-libp2p
https://github.com/chainsafe/js-libp2p-noise

encryption javascript libp2p network noise

Last synced: about 4 hours ago
JSON representation

Noise libp2p handshake for js-libp2p

• Host: GitHub
• URL: https://github.com/chainsafe/js-libp2p-noise
• Owner: ChainSafe
• License: other
• Created: 2019-10-30T11:12:37.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T10:51:23.000Z (17 days ago)
• Last Synced: 2024-11-07T22:48:33.896Z (7 days ago)
• Topics: encryption, javascript, libp2p, network, noise
• Language: TypeScript
• Size: 2.82 MB
• Stars: 37
• Watchers: 12
• Forks: 31
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# @chainsafe/libp2p-noise

![npm](https://img.shields.io/npm/v/@chainsafe/libp2p-noise)

[![](https://img.shields.io/github/actions/workflow/status/ChainSafe/js-libp2p-noise/js-test-and-release.yml?branch=master)](https://github.com/ChainSafe/js-libp2p-noise/actions)

[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](https://libp2p.io/)

![](https://img.shields.io/github/issues-raw/ChainSafe/js-libp2p-noise)

[![License Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

[![License MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

![](https://img.shields.io/badge/npm-%3E%3D7.0.0-orange.svg?style=flat-square)

![](https://img.shields.io/badge/Node.js-%3E%3D16.0.0-orange.svg?style=flat-square)

![](https://img.shields.io/badge/browsers-last%202%20versions%2C%20not%20ie%20%3C%3D11-orange)

[![Twitter](https://img.shields.io/twitter/follow/ChainSafeth.svg?label=Twitter)](https://twitter.com/ChainSafeth)

[![Discord](https://img.shields.io/discord/593655374469660673.svg?label=Discord\&logo=discord)](https://discord.gg/Q6A3YA2)

> Noise libp2p handshake for js-libp2p

# About

This repository contains TypeScript implementation of noise protocol, an encryption protocol used in libp2p.

## Usage

Install with `yarn add @chainsafe/libp2p-noise` or `npm i @chainsafe/libp2p-noise`.

Example of using default noise configuration and passing it to the libp2p config:

```ts

import {createLibp2p} from "libp2p"

import {noise} from "@chainsafe/libp2p-noise"

//custom noise configuration, pass it instead of `noise()`

//x25519 private key

const n = noise({ staticNoiseKey });

const libp2p = await createLibp2p({

  connectionEncrypters: [noise()],

  //... other options

})

```

See the [NoiseInit](https://github.com/ChainSafe/js-libp2p-noise/blob/master/src/noise.ts#L22-L30) interface for noise configuration options.

## API

This module exposes an implementation of the [ConnectionEncrypter](https://libp2p.github.io/js-libp2p/interfaces/_libp2p_interface.ConnectionEncrypter.html) interface.

## Bring your own crypto

You can provide a custom crypto implementation (instead of the default, based on [@noble](https://paulmillr.com/noble/)) by adding a `crypto` field to the init argument passed to the `Noise` factory.

The implementation must conform to the `ICryptoInterface`, defined in 

# Install

```console

$ npm i @chainsafe/libp2p-noise

```

## Browser `` tag

Loading this module through a script tag will make its exports available as `ChainsafeLibp2pNoise` in the global namespace.

```html

<script src="https://unpkg.com/@chainsafe/libp2p-noise/dist/index.min.js">

```

# API Docs

- 

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/ChainSafe/js-libp2p-noise/LICENSE-APACHE) / )

- MIT ([LICENSE-MIT](https://github.com/ChainSafe/js-libp2p-noise/LICENSE-MIT) / )

# Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.