X Server Prohibits Byte-swapped Clients
X server implementations (e.g. Xorg and Xwayland) will (by default) no longer allow clients with different endianess to connect.
- Name: Peter Hutterer
- Email: firstname.lastname@example.org
- Targeted release: Fedora Linux 38
- Last updated: 2023-05-19
- devel thread
- FESCo issue: #2927
- Tracker bug: #2159489
- Release notes tracker: #949
X server implementations (e.g. Xorg and Xwayland) allow clients with an endianess different to that of the server to connect. Protocol messages to and from these clients are byte-swapped by the X server. However, the code in the X server that does this is virtually untested, providing a large attack surface for malicious clients. One needs to only look at e.g. this X.Org security advisory and count the
SProc mentions for an indication on how bad this is. A simple solution to remove this attack surface is to prohibit clients with a different endianess. These clients will simply fail, in a matter similar to failing to authenticate against an X server.
The use-case for clients with different endianess is very niche. The vast majority of users never run a remote client, let alone a remote client on a machine with a different endianess. Fedora only supports one Big Endian architecture (s390x), so the only Fedora users affected by this change are those running remote applications on an s390x.
- this only affects use-cases where the server runs on a little endian host and the client on a Big Endian host (or vice versa).
- this is a change in the default behavior only and can be changed via configuration options (for
Xorg) and/or commandline arguments (all X servers).
- this is a change in the upstream default behavior that Fedora will follow along with. This Change is primarily to increase the exposure of this new behavior.
Benefit to Fedora
This change removes a large potential attack surface that can be used by malicious clients to expose memory locations, crash the X server and/or do other entertaining things malicious programs like to do.
- Proposal owners:
- Merge upstream PR - complete
- Backport patch to Fedora's
xorg-x11-server-Xwaylandpackages - complete
- Other developers:
- For systems running
/usr/bin/Xorg, no further changes are needed. Users/system administrators can configure the new option in the
- Wayland compositors that manage
/usr/bin/Xwayland(all of them?) that want to (re-)enable support for byte-swapped clients need to provide a configuration option to users that appends the
+byteswappedclientsoption to the
- GNOME 44 mutter provides the gsettings
xwayland-allow-byte-swapped-clientsoption, see this PR
- GNOME 44 mutter provides the gsettings
- Release engineering: #Releng issue number
- This feature does not require coordination with release engineering
- Policies and guidelines: N/A (not needed for this Change)
- Trademark approval: N/A (not needed for this Change)
- Alignment with Objectives:
For the use-case of users that run X clients on a remote machine with a different endianess, these clients will no longer be able to connect by default. Such clients will print an error message to stderr:
Prohibited client endianess, see the Xserver man page.
For Xorg, the following
xorg.conf.d snippet will re-enable the old behavior:
Section "ServerFlags" Option "AllowByteSwappedClients" "on" EndSection
Wayland users (and thus Xwayland) need to employ compositor-specific configuration to pass the
+byteswappedclients flag to Xwayland. At the time of writing, Wayland compositors do not yet provide such a configuration.
How To Test
To test the impact of this change, you need:
- an X server running on a little endian architecture and an X client running on a Big Endian architecture (or the other way around)
- set up the X server to accept remote connections, either via TCP or through SSH
- run the X client which will fail to connect
Alternatively, a test client is available in the upstream PR. This test client pretends to be BigEndian and will fail to connect when run against a little endian X server.
For virtually all users, there is no change in behavior.
Users of Xorg with the server and client on two differently-byte-ordered machines must add the
xorg.conf.d snippet shown above on affected systems. For users of a Wayland compositor and thus Xwayland, they need to pass the
+byteswappedclients option to Xwayland. This is a configuration option that must be provided by the respective compositor.
No other RPMs depend on this change.
This change depends on whether upstream merges this new default behavior. If upstream does not merged the feature in time, this Change will be postponed until the next Fedora version to avoid potential incompatibilities between configurations or commandline options.
- Contingency mechanism: keep current behavior, try again with next Fedora version
- Contingency deadline: beta freeze
- Blocks release? No
N/A (not a System Wide Change)
X server implementations (e.g. Xorg and Xwayland) no longer accept connections from remote clients with a byte endianess different to that of the X server **by default**. This removes a large attack surface in the X server that can be exploited by malicious clients. Users that require this particular use-case can re-enable this feature with the
AllowByteSwappedClients option (see the xorg.conf man page), or passing
+byteswappedclients to the X server invocation (see the Xserver man page).
This change does users that do not use X forwarding (with or without ssh).