forked from cerc-io/ipld-eth-server
63 lines
2.8 KiB
Markdown
63 lines
2.8 KiB
Markdown
|
# go-conn-security-multistream
|
||
|
|
|
||
|
|
[](http://ipn.io)
|
||
|
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
||
|
|
[](http://ipfs.io/)
|
||
|
|
[](https://github.com/RichardLitt/standard-readme)
|
||
|
|
[](https://godoc.org/github.com/libp2p/go-conn-security-multistream)
|
||
|
|
[](https://coveralls.io/github/libp2p/go-conn-security-multistream?branch=master)
|
||
|
|
[](https://travis-ci.org/libp2p/go-conn-security-multistream)
|
||
|
|
|
||
|
|
> Connection security multistream multiplexer
|
||
|
|
|
||
|
|
This package provides a multistream multiplexed [security transport](https://github.com/libp2p/go-conn-security). It:
|
||
|
|
|
||
|
|
1. Selects a security security transport using multistream-select.
|
||
|
|
2. Secures the stream using the selected transport.
|
||
|
|
|
||
|
|
Known libp2p security transports include:
|
||
|
|
|
||
|
|
* [go-libp2p-secio](https://github.com/libp2p/go-libp2p-secio)
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
`go-conn-security-multistream` is a standard Go module which can be installed with:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
go get github.com/libp2p/go-conn-security-multistream
|
||
|
|
```
|
||
|
|
|
||
|
|
Note that `go-conn-security-multistream` is packaged with Gx, so it is recommended to use Gx to install and use it (see the Usage section).
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
This module is packaged with [Gx](https://github.com/whyrusleeping/gx). In order to use it in your own project it is recommended that you:
|
||
|
|
|
||
|
|
```sh
|
||
|
|
go get -u github.com/whyrusleeping/gx
|
||
|
|
go get -u github.com/whyrusleeping/gx-go
|
||
|
|
cd <your-project-repository>
|
||
|
|
gx init
|
||
|
|
gx import github.com/libp2p/go-conn-security-multistream
|
||
|
|
gx install --global
|
||
|
|
gx-go --rewrite
|
||
|
|
```
|
||
|
|
|
||
|
|
Please check [Gx](https://github.com/whyrusleeping/gx) and [Gx-go](https://github.com/whyrusleeping/gx-go) documentation for more information.
|
||
|
|
|
||
|
|
For more information about how `go-conn-security-multistream` is used in the libp2p context, you can see the [go-libp2p-conn](https://github.com/libp2p/go-libp2p-conn) module.
|
||
|
|
|
||
|
|
## Contribute
|
||
|
|
|
||
|
|
Feel free to join in. All welcome. Open an [issue](https://github.com/libp2p/go-conn-security-multistream/issues)!
|
||
|
|
|
||
|
|
This repository falls under the IPFS [Code of Conduct](https://github.com/libp2p/community/blob/master/code-of-conduct.md).
|
||
|
|
|
||
|
|
### Want to hack on IPFS?
|
||
|
|
|
||
|
|
[](https://github.com/ipfs/community/blob/master/contributing.md)
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
MIT
|