fluencelabs/js-libp2p-secio
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-secio synced 2025-03-15 09:50:55 +00:00
Code Issues Projects Releases Wiki Activity
js-libp2p-secio/README.md

60 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

Initial commit
2016-05-20 21:13:55 +02:00
# js-libp2p-secio
add skeleton
2016-05-20 21:29:53 +02:00
chore: add discourse badge (#105)
2019-04-15 11:43:59 +01:00
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
[![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
[![](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23libp2p)
[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io)
[![](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-secio.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-secio)
[![](https://img.shields.io/travis/libp2p/js-libp2p-secio.svg?style=flat-square)](https://travis-ci.com/libp2p/js-libp2p-secio)
no sauce for you
2017-09-01 14:27:22 +01:00
[![Dependency Status](https://david-dm.org/libp2p/js-libp2p-secio.svg?style=flat-square)](https://david-dm.org/libp2p/js-libp2p-secio)
[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)
Async Crypto Endeavour (+benchmarks!) (#19) * feat: add benchmarks and integrate with new libp2p-crypto * start removing node-forge * less forge * cleanup and fixes * benchmarked and tested * remove unused .aegir * Replace lib multihashing with multihashing-async * cleanup package.json * Using string instead of buffer for proto file * chore: fix benchmarks * docs(readme): update README URLs based on HTTP redirects * ready for next aegir * update aegir * ready * chore: update deps
2016-11-03 10:23:33 +01:00
![](https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square)
feat: p2p addrs situation (#91) * chore: update gitignore * chore: update CI * chore: update deps
2017-09-03 12:30:52 +01:00
![](https://img.shields.io/badge/Node.js-%3E%3D6.0.0-orange.svg?style=flat-square)
Async Crypto Endeavour (+benchmarks!) (#19) * feat: add benchmarks and integrate with new libp2p-crypto * start removing node-forge * less forge * cleanup and fixes * benchmarked and tested * remove unused .aegir * Replace lib multihashing with multihashing-async * cleanup package.json * Using string instead of buffer for proto file * chore: fix benchmarks * docs(readme): update README URLs based on HTTP redirects * ready for next aegir * update aegir * ready * chore: update deps
2016-11-03 10:23:33 +01:00
add skeleton
2016-05-20 21:29:53 +02:00
chore: fix linting
2018-01-07 10:31:38 +00:00
> SECIO implementation in JavaScript
add skeleton
2016-05-20 21:29:53 +02:00
feat(secio): implement with pull-streams, ensure interop with go
2016-06-13 19:10:38 +02:00
This repo contains the JavaScript implementation of secio, an encryption protocol used in libp2p. This is based on this [go implementation](https://github.com/libp2p/go-libp2p-secio).
add skeleton
2016-05-20 21:29:53 +02:00
docs: Lead maintainer (#102) * add lead maintainer * chore: update deps
2018-05-29 15:17:41 +01:00
## Lead Maintainer
[Friedel Ziegelmayer](https://github.com/dignifiedquire/)
Standardize README See ipfs/community#124
2016-06-24 16:05:30 +01:00
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Contribute](#contribute)
- [License](#license)
## Install
```sh
feat(secio): implement with pull-streams, ensure interop with go
2016-06-13 19:10:38 +02:00
npm install libp2p-secio
Standardize README See ipfs/community#124
2016-06-24 16:05:30 +01:00
```
## Usage
```js
feat(secio): implement with pull-streams, ensure interop with go
2016-06-13 19:10:38 +02:00
const secio = require('libp2p-secio')
Standardize README See ipfs/community#124
2016-06-24 16:05:30 +01:00
```
add skeleton
2016-05-20 21:29:53 +02:00
## API
Standardize README See ipfs/community#124
2016-06-24 16:05:30 +01:00
refactor: use async await (#108) * chore: upgrade deps * feat: first iteration of the idea * feat: iterate a layer deeper * feat: rewrite handshake * feat: rewrite propose * feat: rewrite finish * feat: rewrite exchange * feat: rewrite low-level stuff * feat: work on rewriting tests * refactor: browser tests * refactor: .aegir.js * feat: refactor benchmarks * fix: try to make it work * fix: lint * refactor: move tests * refactor: switch deps * refactor: entry file * refactor: a bit more * fix: tests * feat: inital iterables refactor * refactor: streaming * refactor: cleanup * fix: turn bufferlist into buffer * fix: use errors from interfaces * refactor: etm * fix: typo * fix: .read error * fix: satisfy output expectations * fix: it works - WARNING: using varint instead of fixed lp, tests lie * fix: use errors * refactor: benchmarks * fix: add suggestions from review Co-Authored-By: Jacob Heun <jacobheun@gmail.com> * fix: upgrade deps and use correct lp-encoder * refactor: apply changes from review * refactor: apply changes from review * refactor: apply changes from review * chore: remove old tests test: add support tests back * test: fix async benchmarks * chore: clean up deps * fix: use fixed encoding/decoding everywhere fix: exchange final nonce handshake over encryption * test: add verify inbound and outbound secio * test: verify nonces are boxed * chore: add node 12 to ci
2019-11-22 21:18:17 +01:00
This module exposes a crypto interface, as defined in the [js-interfaces](https://github.com/libp2p/js-interfaces)
feat(secio): implement with pull-streams, ensure interop with go
2016-06-13 19:10:38 +02:00
refactor: use async await (#108) * chore: upgrade deps * feat: first iteration of the idea * feat: iterate a layer deeper * feat: rewrite handshake * feat: rewrite propose * feat: rewrite finish * feat: rewrite exchange * feat: rewrite low-level stuff * feat: work on rewriting tests * refactor: browser tests * refactor: .aegir.js * feat: refactor benchmarks * fix: try to make it work * fix: lint * refactor: move tests * refactor: switch deps * refactor: entry file * refactor: a bit more * fix: tests * feat: inital iterables refactor * refactor: streaming * refactor: cleanup * fix: turn bufferlist into buffer * fix: use errors from interfaces * refactor: etm * fix: typo * fix: .read error * fix: satisfy output expectations * fix: it works - WARNING: using varint instead of fixed lp, tests lie * fix: use errors * refactor: benchmarks * fix: add suggestions from review Co-Authored-By: Jacob Heun <jacobheun@gmail.com> * fix: upgrade deps and use correct lp-encoder * refactor: apply changes from review * refactor: apply changes from review * refactor: apply changes from review * chore: remove old tests test: add support tests back * test: fix async benchmarks * chore: clean up deps * fix: use fixed encoding/decoding everywhere fix: exchange final nonce handshake over encryption * test: add verify inbound and outbound secio * test: verify nonces are boxed * chore: add node 12 to ci
2019-11-22 21:18:17 +01:00
[ » API Docs ](https://github.com/libp2p/js-interfaces/tree/master/src/crypto#api)
feat(secio): implement with pull-streams, ensure interop with go
2016-06-13 19:10:38 +02:00
Standardize README See ipfs/community#124
2016-06-24 16:05:30 +01:00
## Contribute
docs(readme): update README URLs based on HTTP redirects
2016-10-04 12:30:47 -04:00
Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/js-libp2p-secio/issues)!
Standardize README See ipfs/community#124
2016-06-24 16:05:30 +01:00
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
## License
[MIT](LICENSE)
Reference in New Issue Copy Permalink