forked from QPQ-AG/enoise
WIP: Reorientation
This commit is contained in:
@@ -1,17 +1,17 @@
|
||||
enoise
|
||||
zNoise
|
||||
=====
|
||||
|
||||
An Erlang implementation of the [Noise protocol](https://noiseprotocol.org/)
|
||||
|
||||
`enoise` provides a generic handshake mechanism, that can be used in a couple
|
||||
of different ways. There is also a plain `gen_tcp`-wrapper, where you can
|
||||
`zNoise` provides a generic handshake mechanism, that can be used in a couple
|
||||
of different ways. There is also a plain `gen_tcp` wrapper, where you can
|
||||
"upgrade" a TCP socket to a Noise socket and use it in much the same way as you
|
||||
would use `gen_tcp`.
|
||||
|
||||
Interactive handshake
|
||||
---------------------
|
||||
|
||||
When using `enoise` to do an interactive handshake, `enoise` will only take
|
||||
When using `zNoise` to do an interactive handshake, `zNoise` will only take
|
||||
care of message composition/decompositiona and encryption/decryption - i.e. the
|
||||
user has to do the actual sending and receiving.
|
||||
|
||||
@@ -29,19 +29,3 @@ RX channel and a TX channel respectively.
|
||||
|
||||
The provided `gen_tcp`-wrapper is implemented using the generic handshake, see
|
||||
`src/enoise.erl`.
|
||||
|
||||
Build
|
||||
-----
|
||||
|
||||
$ rebar3 compile
|
||||
|
||||
Test
|
||||
----
|
||||
|
||||
$ rebar3 eunit
|
||||
|
||||
Typecheck
|
||||
---------
|
||||
|
||||
$ rebar3 dialyzer
|
||||
$ elp --eqwalize-all --rebar
|
||||
|
||||
Reference in New Issue
Block a user