87 lines
3.5 KiB
Markdown
87 lines
3.5 KiB
Markdown
# ColumnLynx
|
|
|
|
ColumnLynx is a VPN protocol designed to be as lightweight as possible.
|
|
|
|
## How does it work
|
|
|
|
ColumnLynx makes use of both **TCP** and **UDP**. **TCP** is used for the initial handshake and commands, which **UDP** is used for actual packet transmission.
|
|
|
|
It operates on port **48042** for both TCP and UDP.
|
|
|
|
### Handshake Procedure
|
|
|
|
*wip*
|
|
|
|
### Packet Exchange
|
|
|
|
*wip*
|
|
|
|
## Packet Structure
|
|
|
|
These are the general packet structures for both the TCP and UDP sides of the protocol. Generally **headers** are **plain-text (unencrypted)** and do not contain any sensitive data.
|
|
|
|
|
|
The **data / payload** section is:
|
|
- For **TCP**: **encrypted** or **plain-text** depending on the **packet type** (packets with **sensitive data** are **encrypted**)
|
|
- For **UDP**: **encrypted**, as they're transfering the actual data
|
|
|
|
### TCP Packets
|
|
|
|
TCP Packets generally follow the structure **Packet ID + Data**. They're only used for the **inital handshake** and **commands sent between the client and server**.
|
|
|
|
#### Packet ID
|
|
|
|
The **Packet ID** is an **8 bit unsigned integer** that is predefined from either the **Client to Server** or **Server to Client** enum set, however they are uniquely numbered as to not collide with each other.
|
|
|
|
**Server to Client** IDs are always below **0xA0** (exclusive) and **Client to Server** IDs are always above **0xA0** (exclusive). **0xFE** and **OxFF** are shared for **GRACEFUL_DISCONNECT** and **KILL_CONNECTION** respectively.
|
|
|
|
#### Data
|
|
|
|
The data section is unspecified. It may change depending on the **Packet ID**. It is encoded as a **raw byte array**
|
|
|
|
#### Final General Structure
|
|
|
|
| Type | Length | Name | Description |
|
|
|:-----|:-------|:-----|:------------|
|
|
| uint8_t | 1 byte | **Header** - Packet Type | General type of packet |
|
|
| uint8_t/byte array | variable | Data | General packet data - changes for packet to packet |
|
|
|
|
### UDP Packets
|
|
|
|
**UDP Packets** follow the same general structure of **Packet ID + Data**, however, they are **encrypted in full** with the exchanged AES key. This is done to prevent any metadata leakage by either the client or the server.
|
|
|
|
The **Data** is generally just the **raw underlying packet** forwarded to the server/client.
|
|
|
|
#### Final General Structure
|
|
|
|
| Type | Length | Name | Description |
|
|
|:-----|:-------|:-----|:------------|
|
|
| uint8_t | 12 bytes | **Header** - Nonce | Random nonce to obfuscate encrypted contents |
|
|
| uint64_t | 8 bytes | **Header** - Session ID | The unique and random session identifier for the client |
|
|
| uint8_t | variable | Data | General data / payload |
|
|
|
|
## Legal
|
|
|
|
Copyright (C) 2025 Jonas Korene Novak
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
|
|
|
DcruBro is the online pseudonym of Jonas Korene Novak. Both refer to the same individual and may be used interchangeably for copyright attribution purposes.
|
|
|
|
### Licensing
|
|
|
|
*See **ATTRIBUTIONS.md** for details.*
|
|
|
|
This project includes the [ASIO C++ Library](https://think-async.com/Asio/),
|
|
distributed under the [Boost Software License, Version 1.0](https://www.boost.org/LICENSE_1_0.txt). |