13 |
51 |
52 |
53 |
--------------------------------------------------------------------------------
/DistributedChatSimulationServer/Sources/DistributedChatSimulationServer/configure.swift:
--------------------------------------------------------------------------------
1 | import Leaf
2 | import Vapor
3 |
4 | // configures your application
5 | public func configure(_ app: Application) throws {
6 | app.middleware.use(FileMiddleware(publicDirectory: app.directory.publicDirectory))
7 |
8 | app.views.use(.leaf)
9 |
10 | // register routes
11 | try routes(app)
12 | }
13 |
--------------------------------------------------------------------------------
/DistributedChatSimulationServer/Sources/DistributedChatSimulationServer/routes.swift:
--------------------------------------------------------------------------------
1 | import Vapor
2 |
3 | func routes(_ app: Application) throws {
4 | app.get { req in
5 | req.view.render("index", [
6 | "title": "Distributed Chat Simulation Server"
7 | ])
8 | }
9 |
10 | let handler = MessagingHandler()
11 | app.webSocket("messaging") { req, ws in
12 | handler.connect(ws)
13 | }
14 | }
15 |
--------------------------------------------------------------------------------
/DistributedChatSimulationServer/Sources/DistributedChatSimulationServerMain/main.swift:
--------------------------------------------------------------------------------
1 | import DistributedChatSimulationServer
2 | import Vapor
3 |
4 | var env = try Environment.detect()
5 | try LoggingSystem.bootstrap(from: &env)
6 | let app = Application(env)
7 | defer { app.shutdown() }
8 | try configure(app)
9 | try app.run()
10 |
--------------------------------------------------------------------------------
/DistributedChatSimulationServer/Tests/DistributedChatSimulationServerTests/DistributedChatSimulationServerTests.swift:
--------------------------------------------------------------------------------
1 | @testable import DistributedChatSimulationServer
2 | import XCTVapor
3 |
4 | final class DistributedChatSimulationServerTests: XCTestCase {
5 | var app: Application!
6 |
7 | override func setUpWithError() throws {
8 | app = Application(.testing)
9 | try configure(app)
10 | }
11 |
12 | override func tearDown() {
13 | app.shutdown()
14 | }
15 |
16 | func testWebFrontend() throws {
17 | try app.test(.GET, "/", afterResponse: { res in
18 | XCTAssertEqual(res.status, .ok)
19 | XCTAssert(res.body.string.contains("#(title)
14 |
15 |
35 |
48 |
49 |
50 | Distributed Chat Simulation Server
")) 20 | }) 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /DistributedChatSimulationServer/docker-compose.yml: -------------------------------------------------------------------------------- 1 | # Docker Compose file for Vapor 2 | # 3 | # Install Docker on your system to run and test 4 | # your Vapor app in a production-like environment. 5 | # 6 | # Note: This file is intended for testing and does not 7 | # implement best practices for a production deployment. 8 | # 9 | # Learn more: https://docs.docker.com/compose/reference/ 10 | # 11 | # Build images: docker-compose build 12 | # Start app: docker-compose up app 13 | # Stop all: docker-compose down 14 | # 15 | version: '3.7' 16 | 17 | x-shared_environment: &shared_environment 18 | LOG_LEVEL: ${LOG_LEVEL:-debug} 19 | 20 | services: 21 | app: 22 | image: test:latest 23 | build: 24 | context: . 25 | environment: 26 | <<: *shared_environment 27 | ports: 28 | - '8080:8080' 29 | # user: '0' # uncomment to run as root for testing purposes even though Dockerfile defines 'vapor' user. 30 | command: ["serve", "--env", "production", "--hostname", "0.0.0.0", "--port", "8080"] 31 | -------------------------------------------------------------------------------- /Images/channel.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fwcd/distributed-chat/14c51e5d9f19c68fdbff3c2e013ce4fb34fe3302/Images/channel.png -------------------------------------------------------------------------------- /Images/channels.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fwcd/distributed-chat/14c51e5d9f19c68fdbff3c2e013ce4fb34fe3302/Images/channels.png -------------------------------------------------------------------------------- /Images/lockscreen.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fwcd/distributed-chat/14c51e5d9f19c68fdbff3c2e013ce4fb34fe3302/Images/lockscreen.png -------------------------------------------------------------------------------- /Images/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 88 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Distributed Chat 2 | 3 | [](https://github.com/fwcd/distributed-chat/actions/workflows/kit.yml) 4 | [](https://github.com/fwcd/distributed-chat/actions/workflows/bluetooth.yml) 5 | [](https://github.com/fwcd/distributed-chat/actions/workflows/app.yml) 6 | [](https://github.com/fwcd/distributed-chat/actions/workflows/cli.yml) 7 | [](https://github.com/fwcd/distributed-chat/actions/workflows/simulation-protocol.yml) 8 | [](https://github.com/fwcd/distributed-chat/actions/workflows/simulation-server.yml) 9 | 10 |
11 |
21 |
22 | A distributed chat messenger that uses Bluetooth LE mesh networks.
23 |
24 | * Fully decentralized architecture, no server or Internet connection required
25 | * Message caching, delayed transmission
26 | * Public and private end-to-end-encrypted messaging channels
27 | * Voice messages, image, file and contact attachments
28 | * Full simulation environment with configurable nodes, links and much more included
29 | * Cross-platform, portable core
30 |
31 | ## Components
32 |
33 | The project consists of the following components:
34 |
35 | * `DistributedChatKit`: The abstract application, platform-independent, transport-independent (uses interface for broadcasting/receiving messages)
36 | * `DistributedChatBluetooth`: An abstraction over platform-specific Bluetooth LE transports
37 | * `DistributedChatApp`: The iOS/macOS implementation, uses Bluetooth LE as transport, does **not** require a server
38 | * `DistributedChatCLI`: The CLI implementation, uses either HTTP/WebSockets as transport with the simulation server or Bluetooth LE (WIP)
39 | * `DistributedChatSimulationProtocol`: The high-level JSON-based protocol used between CLI and simulation server
40 | * `DistributedChatSimulationServer`: The companion server for the CLI, relays messages between connected CLI nodes, provides web-interface for configuring links between nodes
41 | * `Scripts`: Scripts for launching CLI instances conveniently and for testing the BLE transport
42 |
43 | The dependency graph between these packages looks like this:
44 |
45 | ```mermaid
46 | %%{init: {"flowchart": {"defaultRenderer": "elk"}} }%%
47 | flowchart BT
48 | subgraph cross-platform
49 | DistributedChatBluetooth --> DistributedChatKit
50 | DistributedChatCLI --> DistributedChatKit
51 | DistributedChatCLI --> DistributedChatBluetooth
52 | DistributedChatCLI --> DistributedChatSimulationProtocol
53 | DistributedChatSimulationServer --> DistributedChatSimulationProtocol
54 | end
55 | subgraph "Apple platforms"
56 | DistributedChatApp --> DistributedChatKit
57 | DistributedChatApp --> DistributedChatBluetooth
58 | end
59 | ```
60 |
61 | ## Building and Running
62 |
63 | First, make sure to have Swift 5.10+ or newer installed. Recent versions for Ubuntu and macOS can be found [here](https://swift.org/download/).
64 |
65 | ### Simulation Server
66 |
67 | To run the simulation server, navigate into the directory `DistributedChatSimulationServer` and execute:
68 |
69 | ```sh
70 | swift run
71 | ```
72 |
73 | The web interface should now be accessible at `http://localhost:8080`.
74 |
75 | ### CLI
76 |
77 | To start a single instance of the CLI, make sure that the simulation server is running, navigate into `DistributedChatCLI` and execute:
78 |
79 | ```sh
80 | swift run distributed-chat --name Alice
81 | ```
82 |
83 | You can substitute any name for Alice. Once the CLI has started, the chosen name should show up as a node in the simulation server's web interface.
84 |
85 | For convenience, there is a bash script for starting multiple instances of the CLI together in a single `tmux` session. To use it, navigate into the root directory of this repository and run
86 |
87 | ```sh
88 | Scripts/start_clis Alice Bob Charles Dave
89 | ```
90 |
91 | ...or however many clients you want to start. To stop all clients at once, press `Ctrl + B` then type `:kill-session` and press enter.
92 |
93 | ### iOS app
94 |
95 | Building and running the iOS app is only possible on macOS, so make sure to have the following available:
96 |
97 | * Xcode 15.4+
98 | * Swift 5.10+ (should be included with Xcode)
99 | * optionally an iOS device
100 |
101 | The open the `DistributedChatApp` subdirectory in Xcode and build/run the project.
102 |
--------------------------------------------------------------------------------
/Scripts/.gitignore:
--------------------------------------------------------------------------------
1 | connect_l2cap
2 |
--------------------------------------------------------------------------------
/Scripts/README.md:
--------------------------------------------------------------------------------
1 | # Scripts
2 |
3 | A collection of scripts useful for developing or testing the Distributed Chat app.
4 |
--------------------------------------------------------------------------------
/Scripts/js-test-client/.editorconfig:
--------------------------------------------------------------------------------
1 | [*]
2 | indent_size = 2
3 |
--------------------------------------------------------------------------------
/Scripts/js-test-client/README.md:
--------------------------------------------------------------------------------
1 | # JS Test Client
2 |
3 | Acts as a GATT server and client for exchanging chat messages with real iOS nodes.
4 |
5 | ## Usage
6 |
7 | First make sure to have Node.js 8.9.0 installed (you can use a version manager like `n` for this), then run
8 |
9 | ```
10 | sudo apt-get install bluetooth bluez libbluetooth-dev libudev-dev
11 | ```
12 |
13 | to install the system dependencies, finally
14 |
15 | ```
16 | npm install
17 | ```
18 |
19 | to install the npm dependencies. Now you can either...
20 |
21 | * Launch the GATT server/peripheral using `sudo npm run server`
22 | * Launch the GATT client/central using `sudo npm run client`
23 |
--------------------------------------------------------------------------------
/Scripts/js-test-client/gatt_client.js:
--------------------------------------------------------------------------------
1 | // Acts as a GATT client/central for
2 | // exchanging chat messages with real iOS nodes.
3 |
4 | const noble = require('@abandonware/noble'); // Central/GATT client
5 | const readline = require('readline');
6 | const { v4: uuid4 } = require('uuid');
7 | const {
8 | serviceUUID,
9 | inboxCharacteristicUUID,
10 | userIDCharacteristicUUID,
11 | userNameCharacteristicUUID,
12 | myID,
13 | myName
14 | } = require('./gatt_constants');
15 |
16 | const rl = readline.createInterface({ input: process.stdin, output: process.stdout });
17 |
18 | function question(query) {
19 | return new Promise(resolve => {
20 | rl.question(query, answer => {
21 | resolve(answer);
22 | });
23 | });
24 | }
25 |
26 | // GATT client
27 |
28 | noble.on('discover', async peripheral => {
29 | console.log(`Found peripheral ${peripheral}`);
30 | await noble.stopScanningAsync();
31 | await peripheral.connectAsync();
32 |
33 | const { characteristics } = await peripheral.discoverSomeServicesAndCharacteristicsAsync([serviceUUID], [inboxCharacteristicUUID, userNameCharacteristicUUID, userIDCharacteristicUUID]);
34 | const inboxChar = characteristics.find(c => c.uuid === inboxCharacteristicUUID);
35 | const userNameChar = characteristics.find(c => c.uuid === userNameCharacteristicUUID);
36 | const userIDChar = characteristics.find(c => c.uuid === userIDCharacteristicUUID);
37 |
38 | if (inboxChar && userNameChar && userIDChar) {
39 | console.log(`Discovered our characteristics!`);
40 | const userName = (await userNameChar.readAsync()).toString('utf-8');
41 | const userID = (await userIDChar.readAsync()).toString('utf-8');
42 | let logicalClock = 0;
43 |
44 | while (true) {
45 | const content = await question('Please enter a message: ');
46 | const timestamp = Date.now() / 1000.0;
47 | const json = JSON.stringify({
48 | id: uuid4(),
49 | timestamp: timestamp,
50 | sourceUserId: myID,
51 | visitedUsers: [],
52 | logicalClock: logicalClock,
53 | addedChatMessages: [
54 | {
55 | id: uuid4(),
56 | timestamp: timestamp,
57 | author: {
58 | id: myID,
59 | name: myName,
60 | logicalClock: logicalClock
61 | },
62 | content: {
63 | type: 'text',
64 | data: content
65 | }
66 | }
67 | ]
68 | }) + '\n';
69 | await inboxChar.writeAsync(Buffer.from(json, 'utf-8'), false);
70 | logicalClock++;
71 | }
72 | }
73 | });
74 |
75 | noble.on('stateChange', async state => {
76 | if (state === 'poweredOn') {
77 | console.log('Scanning for devices...');
78 | await noble.startScanningAsync([serviceUUID], false);
79 | }
80 | });
81 |
--------------------------------------------------------------------------------
/Scripts/js-test-client/gatt_constants.js:
--------------------------------------------------------------------------------
1 | module.exports = {
2 | serviceUUID: '59553ceb2ffa40188a6c453a5292044d',
3 | inboxCharacteristicUUID: '440a594c3cc2494aa08abe8dd23549ff',
4 | userNameCharacteristicUUID: 'b2234f402c0b401b8145c612b9a7bae1',
5 | userIDCharacteristicUUID: '13a4d26e0a754fde93404974e3da3100',
6 | myName: 'Test Client',
7 | myID: 'e12ccc30-cb41-48e1-b293-48e365642d44'
8 | };
9 |
--------------------------------------------------------------------------------
/Scripts/js-test-client/gatt_server.js:
--------------------------------------------------------------------------------
1 | // Acts as a GATT server/peripheral for
2 | // exchanging chat messages with real iOS nodes.
3 |
4 | // NOTE: Accepting service discovery requests seems
5 | // to have some issues with bluetoothd currently,
6 | // see https://github.com/noble/bleno/issues/24.
7 | // The workaround (for now) is to manually disable
8 | // bluetoothd via systemd, then re-enable it directly:
9 | //
10 | // sudo systemctl stop bluetooth
11 | // sudo hciconfig hci0 up
12 | //
13 | // Once you are done, remember to restart bluetoothd:
14 | //
15 | // sudo systemctl start bluetooth
16 |
17 | const bleno = require('@abandonware/bleno'); // Peripheral/GATT server
18 | const {
19 | serviceUUID,
20 | inboxCharacteristicUUID,
21 | userIDCharacteristicUUID,
22 | userNameCharacteristicUUID,
23 | myID,
24 | myName
25 | } = require('./gatt_constants');
26 |
27 | function handle(error) {
28 | if (error) {
29 | console.log(error);
30 | return false;
31 | }
32 | return true;
33 | }
34 |
35 | // GATT server
36 |
37 | bleno.on('advertisingStart', err => {
38 | if (!handle(err)) return;
39 |
40 | console.log('Setting services...');
41 | bleno.setServices([
42 | new bleno.PrimaryService({
43 | uuid: serviceUUID,
44 | characteristics: [
45 | new bleno.Characteristic({
46 | uuid: inboxCharacteristicUUID,
47 | properties: ['write'],
48 | secure: [],
49 | descriptors: []
50 | }),
51 | new bleno.Characteristic({
52 | uuid: userNameCharacteristicUUID,
53 | properties: ['read'],
54 | secure: [],
55 | value: Buffer.from(myName, 'utf-8'),
56 | descriptors: []
57 | }),
58 | new bleno.Characteristic({
59 | uuid: userIDCharacteristicUUID,
60 | properties: ['read'],
61 | secure: [],
62 | value: Buffer.from(myID, 'utf-8'),
63 | descriptors: []
64 | })
65 | ]
66 | })
67 | ]);
68 | });
69 |
70 | bleno.on('stateChange', state => {
71 | if (state === 'poweredOn') {
72 | console.log('Starting to advertise...');
73 | bleno.startAdvertising(myName, [serviceUUID], err => handle(err));
74 | }
75 | });
76 |
--------------------------------------------------------------------------------
/Scripts/js-test-client/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "js-test-client",
3 | "version": "1.0.0",
4 | "description": "Distributed Chat test client for Node.js",
5 | "main": "gatt_client.js",
6 | "scripts": {
7 | "client": "node ./gatt_client.js",
8 | "server": "node ./gatt_server.js",
9 | "start": "node ./gatt_client.js"
10 | },
11 | "author": "fwcd",
12 | "license": "MPL-2.0",
13 | "dependencies": {
14 | "@abandonware/bleno": "^0.5.1-3",
15 | "@abandonware/noble": "^1.9.2-11",
16 | "readline": "^1.3.0",
17 | "uuid": "^8.3.2"
18 | }
19 | }
20 |
--------------------------------------------------------------------------------
/Scripts/python-test-client/README.md:
--------------------------------------------------------------------------------
1 | # Python Test Client
2 |
3 | Acts as a GATT client for sending chat messages to real iOS nodes.
4 |
5 | ## Usage
6 |
7 | First make sure to have Python 3 and Pip installed, then run
8 |
9 | ```
10 | pip3 install bluepy
11 | ```
12 |
13 | to install the dependencies and
14 |
15 | ```
16 | python3 test_client.py
17 | ```
18 |
19 | to launch the client.
20 |
--------------------------------------------------------------------------------
/Scripts/python-test-client/gatt_constants.py:
--------------------------------------------------------------------------------
1 | SERVICE_UUID = '59553ceb-2ffa-4018-8a6c-453a5292044d' # Distributed Chat GATT service UUID
2 | CHARACTERISTIC_UUID = '440a594c-3cc2-494a-a08a-be8dd23549ff' # 'Message inbox' GATT characteristic
3 | # Is part of the mentioned GATT service
4 |
--------------------------------------------------------------------------------
/Scripts/python-test-client/test_client.py:
--------------------------------------------------------------------------------
1 | # This is a small script that acts as test client for
2 | # sending chat messages to real iOS nodes running the
3 | # DistributedChat service.
4 | #
5 | # Once our DistributedChat service has been discovered, it
6 | # prompts for a string to write to our 'message inbox'
7 | # characteristic.
8 | #
9 | # Note that the script only acts as a GATT central and
10 | # NOT a peripheral, i.e. it does not expose such a service
11 | # with a 'message inbox' itself (thereby making it only
12 | # possible to send chat messages, not receive).
13 | #
14 | # To use, run 'pip3 install bluepy', then 'python3 test_client.py'.
15 | # NOTE: This script MUST run as root!
16 |
17 | import json
18 | import time
19 | from bluepy.btle import Scanner, Peripheral
20 | from uuid import uuid4
21 | from gatt_constants import SERVICE_UUID, CHARACTERISTIC_UUID
22 |
23 | scanner = Scanner()
24 |
25 | while True:
26 | print('Scanning for devices...')
27 | devices = scanner.scan(10.0)
28 | for dev in devices:
29 | print(f'Device {dev.addr} (RSSI: {dev.rssi})')
30 | for (adtype, desc, value) in dev.getScanData():
31 | print(f'Adtype: {adtype}, desc: {desc}, value: {value}')
32 | if adtype == 7 and value == SERVICE_UUID:
33 | print(' >> Found the DistributedChat service, finding characteristics...')
34 | peripheral = Peripheral(dev.addr, dev.addrType, dev.iface)
35 | characteristics = peripheral.getCharacteristics(uuid=CHARACTERISTIC_UUID)
36 | if characteristics:
37 | my_name = 'Test Client'
38 | my_id = str(uuid4())
39 | logical_clock = 0
40 | while True:
41 | content = input(f' >> Enter a chat message to send: ')
42 | # See ChatProtocol.Message in DistributedChat package for a
43 | # description of the JSON message structure.
44 | timestamp = time.time()
45 | s = (json.dumps({
46 | 'id': str(uuid4()),
47 | 'timestamp': timestamp,
48 | 'logicalClock': logical_clock,
49 | 'sourceUserId': my_id,
50 | 'visitedUsers': [],
51 | 'addedChatMessages': [
52 | {
53 | 'id': str(uuid4()),
54 | 'timestamp': timestamp,
55 | 'author': {
56 | 'id': my_id,
57 | 'name': my_name,
58 | 'logicalClock': logical_clock
59 | },
60 | 'content': {
61 | 'type': 'text',
62 | 'data': content
63 | }
64 | }
65 | ]
66 | }) + '\n').encode('utf8')
67 | c = characteristics[0]
68 | c.write(s, withResponse=True)
69 | print(' >> Wrote successfully!')
70 | logical_clock += 1
71 | else:
72 | print(' >> Could not find our characteristic. :(')
73 | peripheral.disconnect()
74 |
--------------------------------------------------------------------------------
/Scripts/start_clis:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | # A small script to start multiple instances of
3 | # the CLI using the list of names provided as
4 | # arguments.
5 |
6 | CLI_DIR="$(dirname $(dirname "${BASH_SOURCE[0]}"))/DistributedChatCLI"
7 | command=""
8 |
9 | for name in $@; do
10 | if [ -z "$command" ]; then
11 | subcommand="new-session"
12 | else
13 | subcommand="split-window -v"
14 | fi
15 | command+="$subcommand 'cd $CLI_DIR && swift run distributed-chat --name $name' \; "
16 | done
17 |
18 | if [ -n "$command" ]; then
19 | command="tmux $command select-layout even-vertical \; attach"
20 | eval $command
21 | else
22 | echo "Usage: $0 [name...]"
23 | fi
24 |
--------------------------------------------------------------------------------
12 | 
13 |
16 | 
17 | 
18 | 
19 |