Skip to content

Commit

Permalink
DOCS(dev): Improve wording and formatting of network protocol docs
Browse files Browse the repository at this point in the history
Drop the 'unreliable' label from UDP. Delivery is not guaranteed, but delivery reliability largely depends on network context. Unreliable makes it sound more negative and error-prone than it is. We use UDP because and with the understanding that in most cases it is quite reliable, or reliable enough, rather than simply being unreliable. The point is that we use it for low-latency. Everything else is technical reasoning.

Prefer short statement sentences over long comma sentences.

'an TLSv1 encrypted connection' -> 'a TLSv1 encrypted connection'

Format message type name as inline code to indicate it being a "type" name.
  • Loading branch information
Kissaki committed Feb 1, 2025
1 parent e4ea26d commit 37aa66b
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/dev/network-protocol/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
Mumble is based on a standard server-client communication model. It
utilizes two channels of communication, the first one is a TCP connection
which is used to reliably transfer control data between the client and the
server. The second one is a UDP connection which is used for unreliable,
server. The second one is a UDP connection which is used for
low latency transfer of voice data.

![Mumble system overview](resources/mumble_system_overview.png)

Both are protected by strong cryptography, this encryption is mandatory and cannot be disabled. The TCP control channel uses TLSv1 AES256-SHA[^1] while the voice channel is encrypted with OCB-AES128[^2].
Both are protected by strong cryptography. This encryption is mandatory and cannot be disabled. The TCP control channel uses TLSv1 AES256-SHA[^1] while the voice channel is encrypted with OCB-AES128[^2].

![Mumble crypt types](resources/mumble_crypt_types.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/dev/network-protocol/protocol_stack_tcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

Mumble has a shallow and easy to understand stack. Basically it
uses Google's Protocol Buffers[^1] with simple prefixing to
distinguish the different kinds of packets sent through an TLSv1
distinguish the different kinds of packets sent through a TLSv1
encrypted connection. This makes the protocol very easily expandable.

![resources/mumble_packet.png](Mumble packet)

The prefix consists out of the two bytes defining the type of the packet
in the payload and 4 bytes stating the length of the payload in bytes
followed by the payload itself. The following packet types are available
in the current protocol and all but UDPTunnel are simple protobuf messages.
If not mentioned otherwise all fields outside the protobuf encoding are big-endian.
in the current protocol and all but `UDPTunnel` are simple protobuf messages.
If not mentioned otherwise all fields outside the protobuf encoding are *big-endian*.

| Type | Payload |
| ---- | ------------------- |
Expand Down

0 comments on commit 37aa66b

Please sign in to comment.