gsadmin/rustguac
1
0
Fork 0
mirror of https://github.com/sol1/rustguac.git synced 2026-09-10 09:35:45 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
v1.6.3
rustguac/patches
T
History
Dave Kempe ea75470c97 Fix patches for upstream guacamole-server HEAD 
Patches 003 and 004 regenerated against current upstream:
- 003: upstream already added config.h to disp.c and input.c, removed
  those hunks. NULL guards and remaining config.h additions preserved.
- 004: upstream added path_lock field to display layer, adjusted context.
2026-03-28 22:04:11 +11:00
..
001-freerdp3-debian13.patch
Initial public release
2026-02-06 14:38:53 +11:00
002-kerberos-nla.patch
Add Kerberos NLA support for RDP and credential prompting
2026-02-10 10:39:18 +11:00
003-null-guard-and-config-h.patch
Fix patches for upstream guacamole-server HEAD
2026-03-28 22:04:11 +11:00
004-h264-display-worker.patch
Fix patches for upstream guacamole-server HEAD
2026-03-28 22:04:11 +11:00
README.md
v1.0.0: H.264 passthrough, per-entry toggle, Docker fix
2026-03-28 21:52:28 +11:00

README.md

guacamole-server patches

These patches are applied to the apache/guacamole-server source tree before building guacd. They fix compilation and runtime issues when building against FreeRDP 3.x on Debian 13 (Trixie).

001-freerdp3-debian13.patch

Problem: guacamole-server 1.6.1 fails to compile against FreeRDP 3.15+ (as shipped in Debian 13) due to:

  1. Autoconf feature detection failure — FreeRDP 3.15 marks codecs_free() as deprecated. The -Werror flag in configure.ac causes all compile-time feature-detection tests to fail, cascading into 10+ undefined macros and wrong #ifdef code paths.

  2. Deprecated function pointer API — FreeRDP 3.x deprecates direct struct member access for ->input->KeyboardEvent(), ->input->MouseEvent(), etc. behind WITH_FREERDP_DEPRECATED. The safe replacement functions are freerdp_input_send_keyboard_event(), freerdp_input_send_mouse_event(), etc.

  3. NULL pointer dereference in display channel — FreeRDP 3.x fires PubSub ChannelConnected events before guac_rdp_disp is allocated, causing a segfault when the callback writes to disp->requested_width (offset 0x18 of NULL).

Files patched:

File Fix
configure.ac Add -Wno-error=deprecated-declarations to both FreeRDP 2.x and 3.x PKG_CHECK_MODULES blocks so autoconf feature detection works
src/protocols/rdp/Makefile.am Add -Wno-error=deprecated-declarations to all three CFLAGS targets
src/protocols/rdp/tests/Makefile.am Same for test CFLAGS
src/protocols/rdp/keyboard.c Replace ->input->KeyboardEvent(), ->input->UnicodeKeyboardEvent(), ->input->SynchronizeEvent() with safe API functions
src/protocols/rdp/input-queue.c Replace all ->input->MouseEvent() calls with freerdp_input_send_mouse_event()
src/protocols/rdp/channels/disp.c Add NULL guards in guac_rdp_disp_channel_connected() and guac_rdp_disp_channel_disconnected()

002-kerberos-nla.patch

Feature: Adds Kerberos NLA authentication support to guacd's RDP protocol, based on GUACAMOLE-2057 (PR #581). This allows RDP connections to use Kerberos instead of NTLM for NLA, which is required as Microsoft phases out NTLM.

Three new connection parameters:

Parameter Values FreeRDP3 Setting
auth-pkg "" (negotiate), "kerberos", "ntlm" FreeRDP_AuthenticationPackageList
kdc-url KDC server URL (optional) FreeRDP_KerberosKdcUrl
kerberos-cache Path to ccache file (optional) FreeRDP_KerberosCache

Files patched:

File Fix
src/protocols/rdp/settings.h Add guac_rdp_auth_package enum, add auth_pkg, kdc_url, kerberos_cache fields to guac_rdp_settings
src/protocols/rdp/settings.c Add connection parameter parsing, FreeRDP3 settings push, memory cleanup

Differences from upstream PR #581:

  • Dropped FreeRDP2 code path (not needed on Debian 13)
  • Fixed guac_strdup() leak in freerdp_settings_set_string() calls (FreeRDP3 copies internally)
  • Fixed typos ("NTML" -> "NTLM", "negotiatoin" -> "negotiation")

Requires: FreeRDP 3.x built with Kerberos support (-DWITH_KRB5=ON). Debian 13's freerdp3-dev includes this by default.

003-null-guard-and-config-h.patch

Problem: Two related issues causing RDP display resize to silently fail:

  1. Missing config.h include — Several RDP channel source files and input.c do not include config.h, so ENABLE_COMMON_SSH is undefined in those compilation units. This causes the guac_rdp_client struct to have a different layout (missing 3 SSH pointer fields = 24 bytes), making all field accesses after the #ifdef ENABLE_COMMON_SSH block read/write wrong memory offsets. Specifically, rdp_client->disp reads NULL (actually the recording field), so RDP display resizing silently fails.

  2. Early size instructions — Browser may send size instructions before the RDP connection is fully established, causing NULL pointer dereferences in the resize handler.

Files patched:

File Fix
src/protocols/rdp/channels/common-svc.c Add #include "config.h"
src/protocols/rdp/channels/disp.c Add #include "config.h", add NULL guard in guac_rdp_disp_set_size()
src/protocols/rdp/channels/pipe-svc.c Add #include "config.h"
src/protocols/rdp/channels/rdpei.c Add #include "config.h"
src/protocols/rdp/channels/rdpgfx.c Add #include "config.h"
src/protocols/rdp/input.c Add #include "config.h", add NULL guard in guac_rdp_user_size_handler()

004-h264-display-worker.patch

Feature: H.264 passthrough via guac_display worker integration. When the RDP server sends AVC420/AVC444 encoded frames (H.264), the raw NAL units are passed through to the browser's WebCodecs VideoDecoder instead of being decoded server-side and re-encoded as JPEG/PNG/WebP.

Architecture: The SurfaceCommand callback intercepts H.264 data and stores it on the display layer. During the normal frame flush cycle (guac_display_plan_apply), the H.264 data is sent to clients as a custom h264 instruction before worker threads start encoding. All IMG operations for the H.264 layer are skipped, eliminating the decode→re-encode overhead.

This approach avoids the socket contention issue that occurred when H.264 was sent directly from FreeRDP's SurfaceCommand callback thread, which raced with guac_display's worker threads writing to the same socket.

Files patched:

File Fix
src/libguac/display-priv.h Add H.264 buffer fields to guac_display_layer (data, length, keyframe, rect)
src/libguac/guacamole/display.h Add guac_display_layer_set_h264() public API
src/libguac/display-layer.c Implement guac_display_layer_set_h264() with lock management
src/libguac/display-layer-list.c Free H.264 data in layer cleanup
src/libguac/display-plan.c Send H.264 data during plan apply, skip IMG ops for H.264 layers
src/protocols/rdp/channels/rdpgfx.c Wrap SurfaceCommand to store H.264 on display layer after GDI decode
src/protocols/rdp/settings.c Enable GfxH264 and GfxAVC444 in FreeRDP settings

Requires: RDP server with H.264 support (xrdp with x264, or Windows with AVC hardware encoder). Browser must support WebCodecs VideoDecoder (Chrome/Edge 94+, Firefox 130+).

Applying patches

Patches are applied automatically by all build scripts (build-deb.sh, build-rpm.sh, install.sh, dev.sh, Dockerfile). To apply manually:

cd ../guacamole-server
git apply ../rustguac/patches/001-freerdp3-debian13.patch

To check if patches are already applied:

cd ../guacamole-server
git apply --check ../rustguac/patches/001-freerdp3-debian13.patch 2>&1 || echo "Already applied or conflict"

Adding new patches

  1. Make changes in the ../guacamole-server working tree
  2. Export: cd ../guacamole-server && git diff > ../rustguac/patches/NNN-description.patch
  3. Patches are applied in numeric order by the build scripts
Reference in New Issue View Git Blame Copy Permalink