Restrict the rdpgw-auth socket to its own UID by default (#190)

The auth daemon's gRPC socket was world-writable and accepted any
local UID that could connect to it. On a multi-tenant host any user
on the box could speak the gRPC API and run an arbitrary username/
password through PAM -- effectively an unauthenticated PAM oracle.

Create the socket with mode 0660 (Umask(0117)) and gate Accept on
SO_PEERCRED: only the daemon's own UID is allowed by default, plus
any operator-supplied --allow-uid / --allow-gid. Privilege-separated
deployments (rdpgw and rdpgw-auth as different users) need to list
the gateway's UID, or share a group; the existing path otherwise
would have been permissive.

The peer-credentials check is Linux-only; the non-Linux build keeps
the listener as-is and logs a warning, since rdpgw-auth itself
requires libpam and is effectively Linux-only in practice.
This commit is contained in:
bolkedebruin
2026-04-30 18:59:48 +02:00
committed by GitHub
parent 13323f56cb
commit de31bfe8a0
8 changed files with 264 additions and 3 deletions

View File

@@ -24,7 +24,9 @@ const (
var opts struct {
ServiceName string `short:"n" long:"name" default:"rdpgw" description:"the PAM service name to use"`
SocketAddr string `short:"s" long:"socket" default:"/tmp/rdpgw-auth.sock" description:"the location of the socket"`
ConfigFile string `short:"c" long:"conf" default:"rdpgw-auth.yaml" description:"users config file for NTLM (yaml)"`
ConfigFile string `short:"c" long:"conf" default:"rdpgw-auth.yaml" description:"users config file for NTLM (yaml)"`
AllowUID []int `long:"allow-uid" description:"additional UIDs allowed to connect to the socket; the daemon's own UID is always allowed (repeatable)"`
AllowGID []int `long:"allow-gid" description:"GIDs allowed to connect to the socket (repeatable)"`
}
type AuthServiceImpl struct {
@@ -127,12 +129,19 @@ func main() {
}
cleanup()
oldUmask := syscall.Umask(0)
oldUmask := syscall.Umask(0117)
listener, err := net.Listen(protocol, opts.SocketAddr)
syscall.Umask(oldUmask)
if err != nil {
log.Fatal(err)
}
// The daemon's own UID is always permitted; additional callers must
// be enumerated by the operator. This stops any local user on a
// shared host from speaking gRPC against the PAM oracle.
allowedUIDs := append([]int{os.Getuid()}, opts.AllowUID...)
listener = newGatedListener(listener, allowedUIDs, opts.AllowGID)
server := grpc.NewServer()
db := database.NewConfig(conf.Users)
service := NewAuthService(opts.ServiceName, db)

View File

@@ -0,0 +1,89 @@
//go:build linux
package main
import (
"fmt"
"log"
"net"
"golang.org/x/sys/unix"
)
// gatedListener wraps a unix-socket net.Listener and accepts only
// connections whose peer UID/GID is on the allow-list. The check is
// applied at Accept(), before any application data is read, so the
// gRPC server never sees an unauthorized caller.
type gatedListener struct {
net.Listener
allowedUIDs map[uint32]struct{}
allowedGIDs map[uint32]struct{}
}
func newGatedListener(l net.Listener, uids []int, gids []int) net.Listener {
uidSet := make(map[uint32]struct{}, len(uids))
for _, u := range uids {
uidSet[uint32(u)] = struct{}{}
}
gidSet := make(map[uint32]struct{}, len(gids))
for _, g := range gids {
gidSet[uint32(g)] = struct{}{}
}
return &gatedListener{Listener: l, allowedUIDs: uidSet, allowedGIDs: gidSet}
}
func (l *gatedListener) Accept() (net.Conn, error) {
for {
conn, err := l.Listener.Accept()
if err != nil {
return nil, err
}
ucred, err := peerCred(conn)
if err != nil {
log.Printf("rejecting connection: cannot read peer credentials: %s", err)
conn.Close()
continue
}
if !l.allowed(ucred) {
log.Printf("rejecting connection from uid=%d gid=%d pid=%d", ucred.Uid, ucred.Gid, ucred.Pid)
conn.Close()
continue
}
return conn, nil
}
}
func (l *gatedListener) allowed(c *unix.Ucred) bool {
if _, ok := l.allowedUIDs[c.Uid]; ok {
return true
}
if _, ok := l.allowedGIDs[c.Gid]; ok {
return true
}
return false
}
func peerCred(conn net.Conn) (*unix.Ucred, error) {
uc, ok := conn.(*net.UnixConn)
if !ok {
return nil, fmt.Errorf("connection is not a *net.UnixConn (got %T)", conn)
}
raw, err := uc.SyscallConn()
if err != nil {
return nil, err
}
var (
ucred *unix.Ucred
credErr error
)
ctrlErr := raw.Control(func(fd uintptr) {
ucred, credErr = unix.GetsockoptUcred(int(fd), unix.SOL_SOCKET, unix.SO_PEERCRED)
})
if ctrlErr != nil {
return nil, ctrlErr
}
if credErr != nil {
return nil, credErr
}
return ucred, nil
}

View File

@@ -0,0 +1,103 @@
//go:build linux
package main
import (
"net"
"os"
"path/filepath"
"syscall"
"testing"
"time"
)
func startGatedListener(t *testing.T, allowUIDs, allowGIDs []int) (string, <-chan struct{}) {
t.Helper()
dir := t.TempDir()
addr := filepath.Join(dir, "auth.sock")
old := syscall.Umask(0117)
raw, err := net.Listen("unix", addr)
syscall.Umask(old)
if err != nil {
t.Fatalf("listen: %v", err)
}
t.Cleanup(func() { raw.Close() })
accepted := make(chan struct{}, 1)
gated := newGatedListener(raw, allowUIDs, allowGIDs)
go func() {
for {
conn, err := gated.Accept()
if err != nil {
return
}
accepted <- struct{}{}
conn.Close()
}
}()
return addr, accepted
}
func TestGatedListenerAcceptsCurrentUID(t *testing.T) {
addr, accepted := startGatedListener(t, []int{os.Getuid()}, nil)
conn, err := net.DialTimeout("unix", addr, 1*time.Second)
if err != nil {
t.Fatalf("dial: %v", err)
}
defer conn.Close()
select {
case <-accepted:
case <-time.After(500 * time.Millisecond):
t.Fatalf("listener did not accept connection from current UID %d", os.Getuid())
}
}
func TestGatedListenerRejectsForeignUID(t *testing.T) {
// Allow a UID we are not running as.
addr, accepted := startGatedListener(t, []int{os.Getuid() + 1}, nil)
conn, err := net.DialTimeout("unix", addr, 1*time.Second)
if err != nil {
t.Fatalf("dial: %v", err)
}
defer conn.Close()
if err := conn.SetReadDeadline(time.Now().Add(500 * time.Millisecond)); err != nil {
t.Fatalf("set read deadline: %v", err)
}
buf := make([]byte, 1)
if _, err := conn.Read(buf); err == nil {
t.Fatal("expected EOF / closed conn after gate rejection, got data")
}
select {
case <-accepted:
t.Fatal("Accept handed a connection from a UID outside the allow-list to the application")
case <-time.After(200 * time.Millisecond):
}
}
func TestSocketModeUmask0117(t *testing.T) {
dir := t.TempDir()
addr := filepath.Join(dir, "auth.sock")
old := syscall.Umask(0117)
l, err := net.Listen("unix", addr)
syscall.Umask(old)
if err != nil {
t.Fatalf("listen: %v", err)
}
defer l.Close()
st, err := os.Stat(addr)
if err != nil {
t.Fatalf("stat socket: %v", err)
}
mode := st.Mode().Perm()
if mode&0007 != 0 {
t.Errorf("socket mode = %#o, expected no permissions for `other`", mode)
}
}

View File

@@ -0,0 +1,16 @@
//go:build !linux
package main
import (
"log"
"net"
)
// On non-Linux platforms SO_PEERCRED isn't portable, so we don't gate by
// peer credentials. rdpgw-auth itself depends on PAM and is effectively
// Linux-only; this file just keeps the build green if anyone tries.
func newGatedListener(l net.Listener, _, _ []int) net.Listener {
log.Printf("rdpgw-auth: peer-credential gating is not implemented on this platform; relying on socket file mode for access control")
return l
}