This repository contains the code for the Rathernet project. Rathernet is a acoustic userspace network stack for Windows, built from the ground up covering all five layers of the OSI model. It is designed for educational purposes and is not intended to be used in production environments.

To install Rathernet, the following software is required:

1. Visual Studio 2022
2. LLVM 13.0.0
3. AsioAll Driver
4. Winpcap

After installing the required software, clone the repository and change the path in env.ps1 to the location of your LLVM installation. Then, run the following command in PowerShell:

./env.ps1

cargo build --release

At this point, you should be able to run the binaries in the target/release directory.

Rathernet is split into five components, described as follows:

1. Raudio: this is the lowest layer of the network stack, and is responsible for sending and receiving audio packets. It is implemented using the AsioAll driver in an asynchronous manner.

2. Rather: this is the second layer of the network stack, and is responsible for sending and receiving Athernet packets. It is not responsible for multiple access control, which is handled by the third layer. Athernet is a custom protocol designed for Rathernet, and is not compatible with Ethernet.

3. Racsma: this is the third layer of the network stack, and is responsible for multiple access control. It is implemented using the CSMA/CD algorithm.

4. Rateway: this is the fourth layer of the network stack, and is responsible for routing packets. It includes an adapter to integrate with the Windows operating system and a NAT to interact with the Internet.

5. Raftp: this is the fifth layer of the network stack, and is responsible for sending and receiving files. It is implemented using the File Transfer Protocol as an application on top of the network stack.

Raudio includes a library and a client. The library implements two core structs:

• AudioInputStream - this struct wraps an audio input stream. It implements the Stream trait from the futures crate, and can be used to asynchronously read audio samples from the input stream.
• AudioOutputStream - this struct wraps an audio output stream. It implements the Sink trait from the futures crate, and can be used to asynchronously write audio samples to the output stream.

The client is a command line interface that can be used to test the library. It can be used to record audio from a microphone and play it back through the speakers. It can also be used to play audio from a file. Use the --help flag to see the available options.

Rather includes a library and a client. The library implements two core structs:

• AtherInputStream - this struct wraps an audio input stream. It implements the Stream trait from the futures crate, and can be used to asynchronously read Athernet frames from the input stream.
• AtherOutputStream - this struct wraps an audio output stream. It implements the Sink trait from the futures crate, and can be used to asynchronously write Athernet frames to the output stream.

It also contains utilities for signal processing and error correction, covered in the signal and conv modules respectively.

The client is a command line interface that can be used to test the library. It can be used to send and receive Athernet frames. Use the --help flag to see the available options.

Racsma includes a library and a client. The library implements three core structs:

• AtewayIoSocket - this struct creates a reader and a writer on the CSMA/CD daemon, which can be used to asynchronously send and receive frames.
• AtewaySocketReader - this struct wraps a reader on the CSMA/CD daemon. It provides a read method, which can be used to asynchronously read a packet from the daemon.
• AtewaySocketWriter - this struct wraps a writer on the CSMA/CD daemon. It provides a write method, which can be used to asynchronously write a packet to the daemon.

The client is a command line interface that can be used to test the library. It can be used to send and receive packets. Use the --help flag to see the available options.

Rateway includes a library and a client. The library implements three core structs:

• AtewayIoAdapter - this struct creates an tunneled adapter on the operating system, which redirects packets from the operating system to the network stack and vice versa.
• AtewayIoNAT - this struct creates a network address translator, which translates packets from the network stack to the Internet and vice versa.
• AtewayIoSocket - this struct is a raw socket that can be used to send and receive packets from the Internet, implemented based on the Winpcap library as a workaround for the TCP packet limitaion in Winsock.

The client is a command line interface that can be used to test the library. It can be used to send and receive data from and to the Internet. Use the --help flag to see the available options.

Raftp is a FTP client that can be used to send and receive files. It is implemented using the File Transfer Protocol as an application on top of the network stack. It is not a library, and is not intended to be used as such. As an application, it does not depend on the network stack, and can be used with any network stack that implements the five layers of the OSI model.

The following benchmarks were performed on a machine with the following specifications:

• CPU: Intel Core i5-10600K @ 4.10GHz
• RAM: 16GB DDR4 @ 3200MHz
• OS: Windows 11 Pro 23H2

The benchmark results are as follows:

Surf the Internet with Rathernet

This project is licensed under the MPL-2.0 license. See the LICENSE file for details.