bashlund
pocket-messaging
A small, eventdriven cryptographic messaging library written in TypeScript for client/server communication over TCP or WebSockets with support for TLS encryption.
Runs in browser and NodeJS.
Background
This is an event-driven cryptographic (Ed25519/Sodium) communications library based on top of pocket-sockets which implements the SSB handshake protocol with some added optional bytes for data exchange.
Rationale:
- Using `pocket-sockets` to have a uniform interface for using both TCP sockets and WebSockets in the application.
- Ed25519 handshake where server public key is the known part (the SSB 4-way handshake protocol).
- Sodium stream encryption.
- The pocket-sockets layer does also support TLS encryption in the sockets layer.
- `pocket-messaging` brings a request/response (indefinite) cycle of communications between peers. This can make application code very sleak.Example
For a quick glimpse of what it looks like to set up two participants exchanging call and response messages and then finalizing the connections, follow the example below:
let [socket1, socket2] = CreatePair();
let messaging1 = new Messaging(socket1);
let messaging2 = new Messaging(socket2);
messaging1.open();
messaging2.open();
// Send message A from participant #1 to participant #2, then close upon reply
(async function() {
const data = Buffer.from("A");
const eventEmitter = messaging1.send("ping", data, 10000, true);
if(eventEmitter) {
const reply = await once(eventEmitter, "reply");
}
messaging1.close();
}) ();
// Send message B from participant #2 to participant #1, then close upon reply
(async function() {
const eventEmitter = messaging2.getEventEmitter();
const event = await once(eventEmitter, "route");
const data = Buffer.from("B");
const eventEmitterSend = messaging2.send(event.fromMsgId, data, 10000);
if(eventEmitterSend) {
const reply = await once(eventEmitterSend, "mixed");
}
messaging2.close();
}) ();For running examples, please refer to the ./example directory.
Reference
Code documentation and API references are available in the official Wiki: https://github.com/bashlund/pocket-messaging/wiki.
Credits
Lib written by @bashlund, tests and wiki nicely crafted by @filippsen.
License
This project is released under the MIT license.