Skip to content

Commit

Permalink
improving README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
m4n3dw0lf committed Dec 23, 2017
1 parent 5299f31 commit 07c8d09
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# node-dtls-proxy

Node.js DTLS Proxy, library to connect plain-text UDP clients with plain-text UDP servers over an encrypted UDP tunnel..
Node.js DTLS Proxy, library and tools to connect plain-text UDP clients with plain-text UDP servers over an encrypted tunnel..

![](https://img.shields.io/badge/version-v0.0.3-yellow.svg)
![](https://img.shields.io/badge/version-v0.0.4-yellow.svg)

## Requirements

Expand All @@ -27,22 +27,29 @@ sudo apt-get install nodejs

## Package Installation

#### From npm
```
$ npm install -g node-dtls-proxy
```

#### From Source

```
$ git clone https://github.com/m4n3dw0lf/node-dtls-tunnel
$ cd node-dtls-tunnel
$ sudo npm install -g
$ openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout cert.key -out cert.crt -subj '/CN=node-dtls-tunnel/O=m4n3dw0lf/C=BR'
```

## PoC
## Example

- Create 2 VMs, one for the Server and one for the Client and install the package.

### Server-side

- On a terminal
```
$ dtls2udp <DTLS_LISTEN_PORT> <UDP_LISTEN_PORT> <UDP_ENDPOINT_IP> <UDP_ENDPOINT_PORT>
$ dtls2udp <DTLS_LISTEN_PORT> <UDP_LISTEN_PORT> <UDP_ENDPOINT_IP> <UDP_ENDPOINT_PORT>
e.g:
Expand Down Expand Up @@ -70,7 +77,7 @@ $ udp2dtls 5687 localhost 5684
$ node examples/client/udp_client.js
```

## Docker-Compose PoC
## Docker-Compose Example

### run `docker-compose up`

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "node-dtls-proxy",
"version": "0.0.3",
"description": "A node UDP-2-DTLS Proxy",
"version": "0.0.4",
"description": "Node.js DTLS Proxy, library and tools to connect plain-text UDP clients with plain-text UDP servers over an encrypted tunnel.. ",
"main": "index.js",
"repository": {
"type": "git",
Expand Down

0 comments on commit 07c8d09

Please sign in to comment.