SecureProc

A secure job worker service that enables authorized users to run arbitrary Linux processes on remote hosts with resource constraints and output streaming capabilities.

The specification for this project can be found at: https://docs.google.com/document/d/1hwHLGNdfZ25PtIlB9fvSlNQ3XgJN5Ce-L0qLHxjZlG4eyY

Tree Organization

The cmd package is contains the main executable programs.

The pkg package contains code that might be reused by some other component. It contains:

• adaptation a collection of APIs that provide shims over standard library functions to enable unit testing of code that depends on those functions.
• cgroup is a collection of APIs to manage cgroups for jobs. Currently this includes only v1. The rationale for that is that on my development box, both cgroup v1 and v2 are available, but v1 is in use.
• command provides the implementation of commands from the cmd package.
• config contains the hard-coded configuration values.
• io contains a collection of components that implement i/o behavior (e.g., buffers, streams).
• jobmanager contains the JobManager components and components for managing individual jobs.

The test package includes a collection of test programs that enable us to test functionality that isn't suitable for unit test (e.g., programs that actually create and manage jobs, create and manage processes)

Notes on running the tests

Currently the build depends on a go compiler in the user's path.

You can run the unit tests with make test. You can run the integration tests with make inttest.

The following integration tests are available:

• test/job/blkiolimit/blkiolimit_test.go A test to illustrate that the blockio cgroup limit controls the job output. This could be extended to also check input limits.

• test/job/memorylimit/memorylimit_test.go A test to illustrate that the memory cgroup limit controls the job output.

• test/job/cpulimit/cpulimit_test.go A test to illustrate that the cpu cgroup limit controls the job output.

• test/job/pidnamespace/pidnamespace_test.go A test to illustrate that the job is running in its own pid namespace

• test/job/networknamespace/networknamespace_test.go A test to illustrate that the job is running in its own network namespace

• test/job/concurrentreads/concurrentreads_test.go A test to illustrate that a single job can have multiple concurrent readers

You can build the cgexec binary using make cgexec. The resulting binary will be stored in build/cgexec.

Notes on Certificates

The certs directory contains some test certificates with which we can experiment.

• ca.cert.pem The root CA used to sign the valid certs

• badca.cert.pem A root CA that was used to sign none of the certs

• server.cert.pem, server.key.pem A valid server certificate/key pair

• administrator.cert.pem, administrator.key.pem A valid administrator certificate/key pair; userID = client1

• client1.cert.pem, client1.key.pem A valid client certificate/key pair, userID = client1

• client2.cert.pem, client2.key.pem A valid client certificate/key pair, userID = client2

• client3.cert.pem, client3.key.pem A valid client certificate/key pair, userID = client3

• weakclient.cert.pem, weakclient.key.pem A client cert/key pair that is too weak

• weakserver.cert.pem, weakserver.key.pem A server cert/key pair that is too weak

• badclient.cert.pem, badclient.key.pem A client cert/key that was not signed by the included root CA

• badserver.cert.pem, badserver.key.pem A server cert/key that was not signed by the included root CA