The dev container image generated a TLS keypair at build time and shipped it inside the image, so every pull of the same image tag was serving the same private key. The entrypoint also reverted to USER 0 to support a dead `createusers.txt` loop and a `chmod u+s` that was a no-op (set on a binary owned by 1001). Net result was that any RCE in the gateway landed as root and the wire-trust posture relied on a shared private key. Stop generating the cert at build time: the runtime image now carries openssl and the entrypoint mints an ephemeral self-signed cert at first start when no cert is mounted at the configured path. Each container instance gets its own key. Drop USER 0 entirely; the entrypoint runs as 1001 throughout. Prune the dead createusers loop and the `chmod u+s`. Separately, the README and the dev compose files publish a small set of literal placeholder values for SessionKey, SessionEncryptionKey, and the various Token*Key fields. Operators copy-paste these into real deployments. Refuse to start when any of those literals appear in the corresponding config field.
5.1 KiB
Upgrading
Unreleased
Container image no longer bakes a TLS cert and runs as UID 1001
Two changes to dev/docker/Dockerfile and the dev image's entrypoint:
- The build step that ran
openssl genrsa/openssl x509and shipped the resulting key/cert in the image is gone. The runtime image now containsopenssland the entrypoint mints an ephemeral self-signed cert at first start when no cert is mounted at the configured path. Each container instance gets its own key. - The entrypoint runs as UID 1001 throughout. The previous
USER 0block, the deadcreateusers.txtloop inrun.sh, and thechmod u+sonrdpgw-auth(which set the bit on a file owned by 1001 and was therefore a no-op anyway) have been removed.
If you mount your own cert (recommended for any non-dev deployment),
make sure RDPGW_SERVER__CERT_FILE and RDPGW_SERVER__KEY_FILE point
to the mounted paths. Otherwise the entrypoint generates a fresh
self-signed pair at the configured locations on first start.
If your deployment relies on rdpgw-auth running with elevated
privileges from the same image, run it from a separate container or
use Linux capabilities -- see
docs/pam-authentication.md for the
privilege-separation model.
Refuse to start when known placeholder secrets are configured
These literal values appearing in Server.SessionKey,
Server.SessionEncryptionKey, Security.PAATokenSigningKey,
Security.PAATokenEncryptionKey, Security.UserTokenSigningKey,
Security.UserTokenEncryptionKey, or Security.QueryTokenSigningKey
will now cause rdpgw to refuse to start:
thisisasessionkeyreplacethisjetzt
thisisasessionkeyreplacethisjetz
thisisasessionkeyreplacethisnunu!
thisisasessionkeyreplacethisnunu
thisisasessionencryptionkey12345
These are the published example values from README.md and the dev
compose files. Replace them with unique 32-character strings.
rdpgw-auth only accepts connections from the daemon's own UID by default
The auth daemon previously created its socket world-writable
(Umask(0)) and accepted any local UID that could connect(2) to it.
Two changes:
- The socket is now created with mode
0660(no access forother). - The daemon reads
SO_PEERCREDon every accepted connection and rejects callers whose UID is not on the allow-list. The default allow-list is the daemon's own UID.
If rdpgw and rdpgw-auth run as the same user, no action is
required. Otherwise, list the gateway's UID (or a shared GID):
./rdpgw-auth -s /tmp/rdpgw-auth.sock --allow-uid 1001
./rdpgw-auth -s /tmp/rdpgw-auth.sock --allow-gid 1100
--allow-uid and --allow-gid are repeatable.
X-Forwarded-For is no longer trusted by default
Previously rdpgw read the first X-Forwarded-For entry into the
request identity unconditionally. The resulting client IP attribute is
later compared against the value embedded in the gateway access
cookie, so any caller reaching rdpgw directly could set
X-Forwarded-For to any value and steer that binding.
After upgrading, X-Forwarded-For is honored only when the request
arrives from a Server.TrustedProxies CIDR. Otherwise the client IP
comes from r.RemoteAddr. The default Server.TrustedProxies is
empty, so by default X-Forwarded-For is ignored entirely.
If your deployment fronts rdpgw with a reverse proxy or load balancer on a known subnet, list it:
Server:
TrustedProxies:
- 10.0.0.0/8 # the proxy's egress subnet
If no proxy fronts rdpgw, leave TrustedProxies empty -- the
request's RemoteAddr is the right source for client identity in
that case.
hostselection: any now refuses non-routable destinations and non-RDP ports by default
Previously, when server.hostselection: any was set, rdpgw forwarded
to whatever ?host= value the request carried with no check on the
target. The gateway would happily relay TCP traffic to loopback,
RFC1918, link-local, or arbitrary high-numbered ports on public hosts.
After upgrading, any mode rejects any destination that resolves to a
loopback / RFC1918 / link-local / IPv6 ULA / unspecified / multicast
address, and any port that is not in AllowedDestinationPorts. The
default port allow-list is [3389].
If your deployment legitimately reaches private destinations or extra
ports through any mode, opt back in:
Server:
HostSelection: any
AllowedDestinationPorts:
- 3389
- 5985 # add what you actually need
AllowPrivateDestinations: true
The other host-selection modes (roundrobin, signed, unsigned)
already use the operator-curated Server.Hosts allow-list and are
unaffected by this change.
Upgrading from 1.X to 2.0
In 2.0 the options for configuring client side RDP settings have been removed in favor of template file. The template file is a RDP file that is used as a template for the connection. The template file is parsed and a few settings are replaced to ensure the client can connect to the server and the correct domain is used.
The format of the template file is as follows:
# <setting>:<type i or s>:<value>
domain:s:testdomain
connection type:i:2
The filename is set under client > defaults.