Add Go bindflt/silo definitions

This change adds a couple Go bindings for calls and constants from bindfltapi.dll
as well as some silo flags for job objects. Together these allow file bindings
(think bind mounts on Linux) to be performed for a specific job object. The bindings
are only viewable from processes within that specific job.

This change additionally adds a couple unit tests for this behavior.

Signed-off-by: Daniel Canter <[email protected]>

internal/exec/exec_test.go

@@ -127,7 +127,7 @@ func TestExecStdinPowershell(t *testing.T) {
 
 func TestExecsWithJob(t *testing.T) {
 	// Test that we can assign processes to a job object at creation time.
-	job, err := jobobject.Create(context.Background(), &jobobject.Options{Name: "test"})
+	job, err := jobobject.Create(context.Background(), nil)
 	if err != nil {
 		log.Fatal(err)
 	}
@@ -177,7 +177,7 @@ func TestExecsWithJob(t *testing.T) {
 	}
 
 	if len(pids) != 2 {
-		t.Fatalf("should be two pids in job object, got: %d", len(pids))
+		t.Fatalf("should be two pids in job object, got: %d. Pids: %+v", len(pids), pids)
 	}
 
 	for _, pid := range pids {

internal/jobobject/jobobject.go

@@ -3,7 +3,10 @@ package jobobject
 import (
 	"context"
 	"fmt"
+	"os"
+	"path/filepath"
 	"sync"
+	"sync/atomic"
 	"unsafe"
 
 	"github.com/Microsoft/hcsshim/internal/queue"
@@ -24,7 +27,10 @@ import (
 // the job, a queue to receive iocp notifications about the lifecycle
 // of the job and a mutex for synchronized handle access.
 type JobObject struct {
-	handle     windows.Handle
+	handle windows.Handle
+	// All accesses to this MUST be done atomically. 1 signifies that this job
+	// is currently a silo.
+	isAppSilo  uint32
 	mq         *queue.MessageQueue
 	handleLock sync.RWMutex
 }
@@ -56,6 +62,7 @@ const (
 var (
 	ErrAlreadyClosed = errors.New("the handle has already been closed")
 	ErrNotRegistered = errors.New("job is not registered to receive notifications")
+	ErrNotSilo       = errors.New("job is not a silo")
 )
 
 // Options represents the set of configurable options when making or opening a job object.
@@ -68,6 +75,9 @@ type Options struct {
 	// `UseNTVariant` specifies if we should use the `Nt` variant of Open/CreateJobObject.
 	// Defaults to false.
 	UseNTVariant bool
+	// `Silo` specifies to promote the job to a silo. This additionally sets the flag
+	// JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE as it is required for the upgrade to complete.
+	Silo bool
 }
 
 // Create creates a job object.
@@ -134,6 +144,16 @@ func Create(ctx context.Context, options *Options) (_ *JobObject, err error) {
 		job.mq = mq
 	}
 
+	if options.Silo {
+		// This is a required setting for upgrading to a silo.
+		if err := job.SetTerminateOnLastHandleClose(); err != nil {
+			return nil, err
+		}
+		if err := job.PromoteToSilo(); err != nil {
+			return nil, err
+		}
+	}
+
 	return job, nil
 }
 
@@ -436,3 +456,87 @@ func (job *JobObject) QueryStorageStats() (*winapi.JOBOBJECT_BASIC_AND_IO_ACCOUN
 	}
 	return &info, nil
 }
+
+// ApplyFileBinding makes a file binding using the Bind Filter from target to root. If the job has
+// not been upgraded to a silo this call will fail. The binding is only applied and visible for processes
+// running in the job, any processes on the host or in another job will not be able to see the binding.
+func (job *JobObject) ApplyFileBinding(root, target string, merged bool) error {
+	job.handleLock.RLock()
+	defer job.handleLock.RUnlock()
+
+	if job.handle == 0 {
+		return ErrAlreadyClosed
+	}
+
+	if !job.isSilo() {
+		return ErrNotSilo
+	}
+
+	// The parent directory needs to exist for the bind to work.
+	if _, err := os.Stat(filepath.Dir(root)); os.IsNotExist(err) {
+		if err := os.MkdirAll(filepath.Dir(root), 0); err != nil {
+			return err
+		}
+	}
+
+	rootPtr, err := windows.UTF16PtrFromString(root)
+	if err != nil {
+		return err
+	}
+
+	targetPtr, err := windows.UTF16PtrFromString(target)
+	if err != nil {
+		return err
+	}
+
+	flags := winapi.BINDFLT_FLAG_USE_CURRENT_SILO_MAPPING
+	if merged {
+		flags |= winapi.BINDFLT_FLAG_MERGED_BIND_MAPPING
+	}
+
+	if err := winapi.BfSetupFilterEx(
+		flags,
+		job.handle,
+		nil,
+		rootPtr,
+		targetPtr,
+		nil,
+		0,
+	); err != nil {
+		return fmt.Errorf("failed to bind target %q to root %q for job object: %w", target, root, err)
+	}
+	return nil
+}
+
+// PromoteToSilo promotes a job object to a silo. There must be no running processess
+// in the job for this to succeed. If the job is already a silo this is a no-op.
+func (job *JobObject) PromoteToSilo() error {
+	job.handleLock.RLock()
+	defer job.handleLock.RUnlock()
+
+	if job.handle == 0 {
+		return ErrAlreadyClosed
+	}
+
+	if job.isSilo() {
+		return nil
+	}
+
+	_, err := windows.SetInformationJobObject(
+		job.handle,
+		winapi.JobObjectCreateSilo,
+		0,
+		0,
+	)
+	if err != nil {
+		return fmt.Errorf("failed to promote job to silo: %w", err)
+	}
+
+	atomic.StoreUint32(&job.isAppSilo, 1)
+	return nil
+}
+
+// isSilo returns if the job object is a silo.
+func (job *JobObject) isSilo() bool {
+	return atomic.LoadUint32(&job.isAppSilo) == 1
+}

internal/jobobject/jobobject_test.go

@@ -2,7 +2,9 @@ package jobobject
 
 import (
 	"context"
+	"os"
 	"os/exec"
+	"path/filepath"
 	"syscall"
 	"testing"
 	"time"
@@ -68,7 +70,6 @@ func createProcsAndAssign(num int, job *JobObject) (_ []*exec.Cmd, err error) {
 
 func TestSetTerminateOnLastHandleClose(t *testing.T) {
 	options := &Options{
-		Name:          "test",
 		Notifications: true,
 	}
 	job, err := Create(context.Background(), options)
@@ -117,7 +118,6 @@ func TestSetMultipleExtendedLimits(t *testing.T) {
 	// Tests setting two different properties on the job that modify
 	// JOBOBJECT_EXTENDED_LIMIT_INFORMATION
 	options := &Options{
-		Name:          "test",
 		Notifications: true,
 	}
 	job, err := Create(context.Background(), options)
@@ -158,7 +158,6 @@ func TestNoMoreProcessesMessageKill(t *testing.T) {
 	// Test that we receive the no more processes in job message after killing all of
 	// the processes in the job.
 	options := &Options{
-		Name:          "test",
 		Notifications: true,
 	}
 	job, err := Create(context.Background(), options)
@@ -213,7 +212,6 @@ func TestNoMoreProcessesMessageTerminate(t *testing.T) {
 	// Test that we receive the no more processes in job message after terminating the
 	// job (terminates every process in the job).
 	options := &Options{
-		Name:          "test",
 		Notifications: true,
 	}
 	job, err := Create(context.Background(), options)
@@ -265,7 +263,6 @@ func TestNoMoreProcessesMessageTerminate(t *testing.T) {
 func TestVerifyPidCount(t *testing.T) {
 	// This test verifies that job.Pids() returns the right info and works with > 1 process.
 	options := &Options{
-		Name:          "test",
 		Notifications: true,
 	}
 	job, err := Create(context.Background(), options)
@@ -293,3 +290,70 @@ func TestVerifyPidCount(t *testing.T) {
 		t.Fatal(err)
 	}
 }
+
+func TestSilo(t *testing.T) {
+	// Test asking for a silo in the options.
+	options := &Options{
+		Silo: true,
+	}
+	job, err := Create(context.Background(), options)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer job.Close()
+}
+
+func TestSiloFileBinding(t *testing.T) {
+	// Can't use osversion as the binary needs to be manifested for it to work.
+	// Just stat for the bindflt dll.
+	if _, err := os.Stat(`C:\windows\system32\bindfltapi.dll`); err != nil {
+		t.Skip("Bindflt not present on RS5 or lower, skipping.")
+	}
+	// Test upgrading to a silo and binding a file only the silo can see.
+	options := &Options{
+		Silo: true,
+	}
+	job, err := Create(context.Background(), options)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer job.Close()
+
+	target := t.TempDir()
+	hostPath := filepath.Join(target, "bind-test.txt")
+	f, err := os.Create(hostPath)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer f.Close()
+
+	root := t.TempDir()
+	siloPath := filepath.Join(root, "silo-path.txt")
+	if err := job.ApplyFileBinding(siloPath, hostPath, false); err != nil {
+		t.Fatal(err)
+	}
+
+	// First check that we can't see the file on the host.
+	if _, err := os.Stat(siloPath); err == nil {
+		t.Fatalf("expected to not be able to see %q on the host", siloPath)
+	}
+
+	// Now check that we can see it in the silo. Couple second timeout (ping something) so
+	// we can be relatively sure the process has been assigned to the job before we go to check
+	// on the file. Unfortunately we can't use our internal/exec package that has support for
+	// assigning a process to a job at creation time as it causes a cyclical import.
+	cmd := exec.Command("cmd", "/c", "ping", "localhost", "&&", "dir", siloPath)
+	if err := cmd.Start(); err != nil {
+		t.Fatal(err)
+	}
+
+	if err := job.Assign(uint32(cmd.Process.Pid)); err != nil {
+		t.Fatal(err)
+	}
+
+	// Process will have an exit code of 1 if dir couldn't find the file; if we get
+	// no error here we should be A-OK.
+	if err := cmd.Wait(); err != nil {
+		t.Fatal(err)
+	}
+}

internal/winapi/bindflt.go

@@ -0,0 +1,20 @@
+package winapi
+
+const (
+	BINDFLT_FLAG_READ_ONLY_MAPPING        uint32 = 0x00000001
+	BINDFLT_FLAG_MERGED_BIND_MAPPING      uint32 = 0x00000002
+	BINDFLT_FLAG_USE_CURRENT_SILO_MAPPING uint32 = 0x00000004
+)
+
+// HRESULT
+// BfSetupFilterEx(
+//     _In_ ULONG Flags,
+//     _In_opt_ HANDLE JobHandle,
+//     _In_opt_ PSID Sid,
+//     _In_ LPCWSTR VirtualizationRootPath,
+//     _In_ LPCWSTR VirtualizationTargetPath,
+//     _In_reads_opt_( VirtualizationExceptionPathCount ) LPCWSTR* VirtualizationExceptionPaths,
+//     _In_opt_ ULONG VirtualizationExceptionPathCount
+// );
+//
+//sys BfSetupFilterEx(flags uint32, jobHandle windows.Handle, sid *windows.SID, virtRootPath *uint16, virtTargetPath *uint16, virtExceptions **uint16, virtExceptionPathCount uint32) (hr error) = bindfltapi.BfSetupFilterEx?

internal/winapi/jobobject.go

@@ -52,6 +52,7 @@ const (
 	JobObjectLimitViolationInformation       uint32 = 13
 	JobObjectMemoryUsageInformation          uint32 = 28
 	JobObjectNotificationLimitInformation2   uint32 = 33
+	JobObjectCreateSilo                      uint32 = 35
 	JobObjectIoAttribution                   uint32 = 42
 )
 

internal/winapi/winapi.go

@@ -2,4 +2,4 @@
 // be thought of as an extension to golang.org/x/sys/windows.
 package winapi
 
-//go:generate go run ..\..\mksyscall_windows.go -output zsyscall_windows.go user.go console.go system.go net.go path.go thread.go jobobject.go logon.go memory.go process.go processor.go devices.go filesystem.go errors.go
+//go:generate go run ..\..\mksyscall_windows.go -output zsyscall_windows.go bindflt.go user.go console.go system.go net.go path.go thread.go jobobject.go logon.go memory.go process.go processor.go devices.go filesystem.go errors.go