Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS(dev): Improve wording and formatting of network protocol docs #6719

Merged
merged 1 commit into from
Feb 1, 2025
Merged

DOCS(dev): Improve wording and formatting of network protocol docs #6719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/dev/network-protocol/overview.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading