test(dgw): cover credential injection reconnect hops - #1938
test(dgw): cover credential injection reconnect hops#1938irvingouj@Devolutions (irvingoujAtDevolution) wants to merge 34 commits into
Conversation
|
Implementation notes:
Note LLM-assisted content (no human feedback). |
There was a problem hiding this comment.
Pull request overview
Adds process-level coverage for Gateway RDP credential injection.
Changes:
- Tests NTLM injection, reconnect attempts, expiration, and fail-closed routing.
- Adds mock KDC and CredSSP integration coverage.
- Extends test configuration and dependencies.
Reviewed changes
Copilot reviewed 5 out of 6 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
Cargo.lock |
Locks new test dependencies. |
testsuite/Cargo.toml |
Adds Kerberos and IronRDP test dependencies. |
testsuite/src/dgw_config.rs |
Exposes Kerberos injection test configuration. |
testsuite/tests/cli/dgw/mod.rs |
Registers new test modules. |
testsuite/tests/cli/dgw/cred_injection.rs |
Adds credential injection lifecycle tests. |
testsuite/tests/cli/dgw/cred_injection_kdc.rs |
Adds mock KDC/CredSSP integration testing. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
db4a034 to
65099a9
Compare
Split rdp_proxy CredSSP into its own module. Delete CredentialService: DgwState holds ProvisioningStore + SyntheticKdcRegistry. from_provisioned builds PreparedCredentialInjection; register_if_kerberos publishes. take() consumes groceries once. Synthetic KDC keeps only fake-KDC runtime; credentials and target_kdc stay on the dish.
Authorize CleanPath tokens before one-shot take, use a registry-wide generation counter, and replace bare clippy allow with expect. SPN remains association-token dst_hst for client-facing CredSSP.
Use association dst_hst for synthetic KDC SPN and target-leg Kerberos hostname instead of conf.hostname. Route RDCleanPath through CredsspSession, peek before one-shot take, and document checkout TTL. Issue: DGW review #1900 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Keep the preinstalled WiX toolset until Chocolatey successfully installs the pinned version. Retry transient feed failures, validate candle.exe, and expose WIXSHARP_WIXDIR so installer builds cannot continue with an empty WiX path. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Keep PR #1900 scoped to the Gateway provisioning and CredSSP refactor. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Keep consumed credential mappings visible until their original expiry so a reused JTI fails explicitly instead of silently falling back to ordinary forwarding. Centralize atomic checkout and CredSSP orchestration, preserve token-only provisioning, and simplify KDC error handling. Record the one-shot contract in PR history without regenerating unchanged OpenAPI artifacts. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Describe time_to_live as the first-checkout window for credential-injection mappings and state that failed attempts require re-provisioning. Regenerate the published specification and clients. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
State that supported credential-injection clients retain association dst_hst as their logical TERMSRV service name even when the transport endpoint is a Gateway listener. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Restore the pre-existing provisioning TTL wording and generated artifacts. The OpenAPI documentation update was outside the requested PR scope. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Token validation already accepts the same association JWT inside jet_reuse, but checkout consumed the mapping on first use. Native RDM reconnects reuse that JWT without DVLS, so injection failed or silently forwarded. Keep encrypted mappings until the token acceptance deadline, authorize before choosing injection, fail closed when required material is gone, and reuse one synthetic KDC per provisioning generation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Mapped insert now caps retention to the association token acceptance deadline, so unsigned preflight fixtures without exp fail as invalid-parameters. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Missing Kerberos krb_kdc must fail closed without dialing the target. Issue: DGW-1900 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
f3aa094 to
2865eda
Compare
bcdeb28 to
370fdce
Compare
370fdce to
3f25aa7
Compare
Capture the lifecycle invariants that guide the credential injection refactor before further implementation changes.
Define checkout, staging, credential replacement, cleanup, and synthetic KDC lifetime expectations.
Keep checked-out credentials and Kerberos session material available for every association-token use that Gateway accepts. Use provisioning TTL only for staging, remove expired material at its deadline, and keep connection-option retention independent. Issue: DVLS-14697
Drop the per-connection credential mapping and synthetic KDC lease as soon as both CredSSP legs finish. RDP forwarding no longer retains secret material for the full session. Issue: DVLS-14697 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add process-level tests for DVLS-like preflight, first inject, jet_reuse reconnect, fail-closed missing mappings, and synthetic KDC generation reuse. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Clippy separated_literal_suffix failed CI lints on the stacked reconnect tests. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Drive CredSSP through a TCP kdc crate and IronRDP acceptor so target-leg Kerberos injection is proven, not just log-matched. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Kerberos credential injection no longer requires __debug__.enable_unstable or kerberos_credential_injection. Those keys still parse so existing configs keep loading. Issue: DVLS-14697 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Prove both CredSSP hops against mock KDC/RDP, NTLM CredSSP both legs, and Kerberos fail-closed when the password, KDC, or krb_kdc is wrong. Token-cache jet_reuse still needs signed JWTs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Decode AS-REQ/TGS-REQ on the mock KDC (cname, realm, TERMSRV/localhost), record CredSSP Finished account names and X.224 cookies, and require /jet/KdcProxy AS-REP plus TGS-REP. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Routing tests now decode X.224 Cookie instead of raw-byte search. Client-leg Kerberos asserts synthetic-KDC AS-REQ cname. Fail-closed Kerberos paths require inject-started then no Finished identity. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Decode X.224 cookies, KdcProxy AS/TGS principals, and attribute KDC-down TCP to Gateway via a separate refusing listener. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Checkout-before-connect on the stack below lets the fail-closed path prove accepted==0. Issue: DGW-1900 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Pin the public CLI release and complete NTLM and Kerberos target CredSSP over ws://127.0.0.1/jet/rdp. Issue: DGW-1900 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Read framed X.224 cookies, bound CredSSP handshakes, and share the localhost TLS fixture. Issue: DVLS-14697 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Keep credential-injection tests focused on public behavior instead of serializing the removed Kerberos debug option. Issue: DVLS-14697 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Treat an expired staging mapping as absent because association tokens do not carry an injection requirement. Verify ordinary forwarding preserves the client X.224 cookie. Issue: DVLS-14697 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
3e5f5ba to
7a6fd9a
Compare
Use the direct rustls dependency added on master so the credential-injection E2E compiles under the workspace unused-qualifications lint. Issue: DVLS-14697 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Keep provisioned injection mappings alive for as long as Gateway still accepts the association token, so native RDP reconnects reuse the same JWT and get injected again. If injection was provisioned but the material is gone, checkout fails closed before we dial the target. Generic RDP and RDCleanPath now share one CredSSP session path. Kerberos uses the token `dst_hst` for the client-facing TERMSRV SPN. I wrote the lifecycle contract down in [src/credential/INTENT.md](https://github.com/Devolutions/devolutions-gateway/blob/85545af64a3f911d0a7e3d3d68ecb8a105a1121f/devolutions-gateway/src/credential/INTENT.md) (following [intent-files.md](https://github.com/Devolutions/devolutions-gateway/blob/master/docs/intent-files.md)) — that's what this PR implements. ### Why this design Credentials live in two phases. Before the first connect, the preflight `time_to_live` bounds how long staged secrets wait in memory. After the first checkout, retention switches to the token acceptance deadline (`exp` + leeway). If Gateway accepts the token for a reconnect, the mapping has to still be there — the old one-shot `take_mapping` broke exactly that. `jet_reuse` starts at disconnect and the TTL starts at preflight, so neither can cap the other; the token deadline is the one clock every connection attempt shares. ### Where to look hardest - [Generation-guarded KDC publication](https://github.com/Devolutions/devolutions-gateway/blob/85545af64a3f911d0a7e3d3d68ecb8a105a1121f/devolutions-gateway/src/credential_injection.rs#L667-L698): re-provisioning the same JTI bumps a generation, and an older in-flight lease can never overwrite a newer published KDC, so the newest provisioning wins deterministically. - [Deadline-driven cleanup](https://github.com/Devolutions/devolutions-gateway/blob/85545af64a3f911d0a7e3d3d68ecb8a105a1121f/devolutions-gateway/src/credential_injection.rs#L774-L835): expired session KDC material is removed by a background task, not lazily on the next checkout, and secrets are zeroized on drop. - [Release after CredSSP](85545af): the per-connection mapping and KDC lease drop as soon as both CredSSP legs finish, so plain forwarding never holds secret material. Tests cover staging expiry, reconnect reuse, generation replacement, and physical removal without a later checkout. Manual run: 22-case DVLS matrix with live NTLM and Kerberos CredSSP through Gateway. E2E hops are stacked on #1938. Issue: DVLS-14697 --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Benoît Cortier (CBenoit)
left a comment
There was a problem hiding this comment.
Thank you, I really appreciate the e2e tests here.
Architecturally-wise, I think the "helpers" are getting big enough that it may warrant some of the code to be moved somewhere under the lib.rs of the testsuite crate. One example could be FakeRdpTarget. If the "TLS fixtures" are meant to be shared, then I think the library side could be the best place.
It’s already pretty close, but make things as self-contained as possible so it’s possible to use the INTENT.md / .intent.md convention for providing some human documentation about the most meaningful abstractions and important properties under test. I would appreciate such files before we merge this PR.
| ironrdp-connector = "0.10" | ||
| ironrdp-core = { version = "0.2", features = ["std"] } | ||
| ironrdp-pdu = { version = "0.9", features = ["std"] } | ||
| ironrdp-tokio = "0.10" | ||
| kdc = "0.1" | ||
| picky-asn1-der = "0.5" | ||
| picky-krb = "0.12" |
There was a problem hiding this comment.
Overview remark: the test is about driving ironrdp-agent, which is already doing all the heavy lifting about RDP connections. Can you evaluate how useful it really is that we depend on these ironrdp dependencies here? I’m thinking ideally we could avoid adding more heavy dependencies, and simply run ironrdp-agent instead.
| fn require_ironrdp_agent() -> anyhow::Result<Option<PathBuf>> { | ||
| let Some(bin) = ironrdp_agent_bin() else { | ||
| eprintln!( | ||
| "skipping RDCleanPath ironrdp-agent test: cargo install ironrdp-agent --version {IRONRDP_AGENT_VERSION}" | ||
| ); | ||
| return Ok(None); | ||
| }; |
There was a problem hiding this comment.
note: This code may have "overfitted" the RDCleanPath test, maybe intentional, but I’m thinking this could be an interesting shared helper if we’re going to have more tests using ironrdp-agent.
thought: I would be in favor of requiring the ironrdp-agent-based tests by default, with an opt-in env variable for skipping them (or similar).
Add process-level Gateway tests for DVLS-like preflight, TCP and RDCleanPath injection, NTLM and Kerberos CredSSP, fail-closed missing mappings, and missing
krb_kdcwithout dialing the target.RDCleanPath cases drive the public
ironrdp-agent0.1.0 CLI overws://127.0.0.1/jet/rdp.Issue: DVLS-14697