Sh4yy/Socket-Rendezvous

A General-Use Rendezvous Server for UDP Punchholing.

Socket Rendezvous Server

A general purpose socket Rendezvous server for managing and implementing peer to peer connections.

UDP Heartbeating

• Port: 5024
• Heartbeat Interval: 30 seconds
• Error Time: 3 minutes

Payload Design

| 32 byte private_key |

Response

Response code is in Network (Big Endian) format
| 1 byte response code |

Response Codes

1020: Pulse was successful and on time
1050: Must re-verify you're address
1060: Client address was not found\

Routes

Register a new Client

Register a new client on the server
Route: /register
Method : POST
Port : 5025

Response:

{
    "client_id": "hex string",
    "private_id": "hex string",
    "timestamp": "unix timestamp",
    "ok": true
}

Re-Verify a Client

Re-Verify the client address after not being responsive for less than
(Error Time) + (1 x Pulse Interval)
Route: /verify
Method : POST
Port : 5025

Headers:

{ "Authorization": "Bearer private_key" }

Response:

{
    "client_id": "hex string",
    "timestamp": "unix timestamp",
    "ok": true
}

Logout the Client

Logout the client from the Server
Route: /logout
Method : POST
Port : 5025

Headers:

{ "Authorization": "Bearer private_key" }

Response:

{
    "client_id": "hex string",
    "ok": true
}

Get another Client's UDP Address

Get another client's UDP address to perform peer to peer connection
Route: /peer/<client_id>/udp
Method : GET
Port : 5025

Query Parameters

• client_id: Target's client id

Headers:

{ "Authorization": "Bearer private_key" }

Response:

{
    "client_id": "hex string",
    "host": "ipv4 host address",
    "port": "int",
    "timestamp": "unix timestamp",
    "ok": true
}

Get another Client's status

Get the time interval since the last pulse from the target
Route: /peer/<client_id>/udp/status
Method : GET
Port : 5025

Query Parameters

• client_id: Target's client id

Headers:

{ "Authorization": "Bearer private_key" }

Response:

{
    "client_id": "hex string",
    "status": "ONLINE, PENDING",
    "last_online": "seconds since last pulse",
    "timestamp": "unix timestamp"
}

Status Values

• ONLINE: the client has been pulsing the server on the correct intervals\
• PENDING: the client has not sent a pulse to the server for over the default Pulse Interval and the server is waiting for the fixed Error time before loging out the client from the server.