xfox111/backbone repository overview

⁠Backbone

Small ASP.NET web server for one way communication between two clients.

This server is one of the key components of EasyLogon project⁠.

⁠Overview

⁠Endpoints

• SignalR: /ws - WebSocket endpoint for real-time communication.
• POST: /send?id={connectionId} - HTTP POST endpoint for sending data to the receiver.

Body of the /send endpoint must be of type Content-Type: application/json.

⁠Key points

• The arbitrary channel for connectionId tranmission should be as secure as possibe (preferably an offline channel), since posession of connectionId can pose a security threat.
• Connection between Backbone and receiver preferably should be re-established after every transmission to avoid replay attacks.

⁠Related papers

• QR Code Authentication System as an Ultimate Tool for Personal Cybersecurity (2023, IEEE)⁠

⁠Development

⁠Prerequisites

For development you can use Dev Containers⁠ or GitHub Codespaces⁠. Otherwise you will need to install following tools:

• .NET SDK 9⁠
• Docker⁠

⁠Building and debugging

Here're some commonly used commands:

dotnet restore			# Install dependencies
dotnet run				# Start the development server
dotnet build			# Build the project for production

To build a Docker image, run:

docker build -t <tag_name> .

⁠Contributing

There are many ways in which you can participate in the project, for example:

• Submit bugs and feature requests⁠, and help us verify as they are checked in
• Review source code changes⁠
• Review documentation and make pull requests for anything from typos to new content

If you are interested in fixing issues and contributing directly to the code base, please refer to the Contribution Guidelines⁠