feat(zgfx): add segment wrapping utilities #1076
Open
+319
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
glamberson
force-pushed
the
zgfx-wrapper
branch
2 times, most recently
from
ae5c877 to
98f8205
Compare
glamberson
force-pushed
the
zgfx-wrapper
branch
from
98f8205 to
956cdd5
Compare
Contributor
Author
|
Since this is just the scaffolding, I'm going to go ahead and submit the core compression PR so you can see the whole package. |
Add wrapper.rs providing ZGFX segment framing utilities for both uncompressed and compressed data: - wrap_uncompressed(): Wraps raw data in ZGFX segment format - wrap_compressed(): Wraps ZGFX-compressed data with COMPRESSED flag Supports both single segments (≤65535 bytes) and multipart segments for larger data. Fully compliant with MS-RDPEGFX specification. This enables server implementations to send EGFX PDUs without compression while maintaining protocol compliance. Refs: Devolutions#1067
glamberson
force-pushed
the
zgfx-wrapper
branch
from
956cdd5 to
dc82d37
Compare
There was a problem hiding this comment.
Pull request overview
Adds server-side ZGFX (RDP8) segment framing helpers to produce spec-shaped ZGFX “segmented data” PDUs, primarily for sending EGFX payloads without compression.
Changes:
- Introduces
wrap_uncompressed()to wrap raw bytes into single or multipart ZGFX segmented PDUs. - Introduces
wrap_compressed()to wrap already-compressed payloads with the COMPRESSED flag set. - Exposes the new wrapper helpers via
ironrdp_graphics::zgfx.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
crates/ironrdp-graphics/src/zgfx/wrapper.rs |
New ZGFX segment wrapping implementation plus unit tests (mostly for uncompressed). |
crates/ironrdp-graphics/src/zgfx/mod.rs |
Wires the wrapper module and re-exports wrap_uncompressed / wrap_compressed. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
CBenoit
reviewed
Feb 12, 2026
Member
CBenoit
left a comment
CBenoit
left a comment
There was a problem hiding this comment.
Looks good to me overall, but can you double check Copilot’s comments? Thanks!
Contributor
Author
Yes I'm wading through it now. Thanks. |
- Restrict wrap_compressed() to single-segment only — a compressed bitstream can't be split at arbitrary byte boundaries - Remove intermediate Vec allocation in multipart path - Add tests for compressed wrapping and oversized rejection - Update module docs to reflect both compressed and uncompressed support
5 tasks
Contributor
Author
|
OK I think it's done now. Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds ZGFX segment wrapping utilities for encoding data in RDP8 format.
Summary
wrap_uncompressed(): Wraps raw data in ZGFX segment structure without compressionwrap_compressed(): Wraps pre-compressed data with the COMPRESSED flag setSupports both single segments (up to 65535 bytes) and multipart segments for larger payloads per MS-RDPEGFX section 2.2.5.3.
Use Case
Enables server implementations to send EGFX PDUs in spec-compliant ZGFX format. This is the wrapping layer; compression support will follow in a separate PR.
Refs: #1067