bingzhilanmo-bowen / containerssh

ContainerSSH: An SSH server that launches containers

ContainerSSH: An SSH server that launches containers

This is a Proof of Concept SSH server written in Go that sends any shell directly into a Docker container or Kubernetes pod instead of launching it on a local machine. It uses an HTTP microservice as an authentication endpoint for SSH connections.

What is this?

This is an SSH server that launches containers for every incoming connection. You can run it on the host or in a container. It needs two things: an authentication server and access to your container environment.

Quick start

This is a quick start guide to get a test server up and running in less than 5 minutes with docker-compose.

To run it grab all files from the example directory and run docker-compose build followed by docker-compose up in that directory. This will run the SSH server on your local machine on port 2222. You can log in with any password using the user "foo" to get an Ubuntu image and "busybox" to get a Busybox image.

Use cases

• Web hosting: Imagine user A has access to site X and Y, user B has access to site Y and Z. You can use ContainerSSH to mount the appropriate sites for the SSH session.
• Practicing environments: Launch dummy containers for practice environment.
• Honeypot: Let attackers into an enclosed environment and observe them.

How does it work?

+------+        +--------------+   2.   +-------------------+
|      |        |              | -----> |    Auth server    |
|      |        |              |        +-------------------+
|      |        |              |   
|      |   1.   |              |   3.   +-------------------+
| User | -----> | ContainerSSH | -----> |   Config server   |
|      |        |              |        +-------------------+
|      |        |              |   
|      |        |              |   4.   +-------------------+
|      |        |              | -----> | Container Backend |
+------+        +--------------+        +-------------------+

1. The user opens an SSH connection to ContainerSSH.
2. ContainerSSH calls the authentication server with the users username and password/pubkey to check if its valid.
3. ContainerSSH calls the config server to obtain backend location and configuration (if configured)
4. ContainerSSH calls the container backend to launch the container with the specified configuration. All input from the user is sent directly to the backend, output from the container is sent to the user.

Curious? Learn more about how this works in my blog post.

Installing & Using / Documentation

If you are ready to give it a go head over to the documentation page.