Skip to content

Latest commit

 

History

History
113 lines (82 loc) · 3.49 KB

README.md

File metadata and controls

113 lines (82 loc) · 3.49 KB
Raw

kira

kira is a remote docker based sandbox code execution engine written in Go.

Currently it supports the following languages:

python, javascript, golang, java, bash, c, c++

Installation

For the installation of kira, you need to have Docker and Go installed.

It is required for the sandbox environment to have a docker image that exposes an API that includes all the functionality for executing the code. For that, you need to execute the following command to build the image and start the container:

docker compose up

You can also set the environment by adjust the KIRA_ENV while running docker compose. The default value is development and will use the .env.development file.

KIRA_ENV=production docker compose up

If you run the described command above, you need to create a rest/.env.production.local with the contents of the rest/.env.development file.

Usage

You can feel free to run the REST API by executing the main.go file in the rest directory with the following command:

$ go run rest/main.go

The REST API will start on port :9090.

Environment Variables

Name Description Default Value Required
LANGUAGES Languages that are supported by the API empty 🟩
PORT Port on which the REST API will run 9090 🟥
ORIGINS Origins that are allowed to access the API * 🟥
AUTH_KEY Authentication key for the API empty 🟥

If you want to secure the API with an AUTH_KEY, you need to make sure that this key is never exposed to the client side. Because the key is delivered through the query parameter token=<AUTH_KEY> in the REST API, it can be insecure to use it in a production environment. If you want to use it in a production environment, you need to make sure that the API is only accessible through a proxy server like nginx and the key is only delivered through the proxy server encrypted with TSL.

REST API endpoints

The following section contains all the REST API endpoints. The JSON body and endpoints follow the CLI structure.

POST /execute

The execute endpoint will execute code in a containerized sandbox. Tests for the printed output can also be specified.

This JSON structure is an example for the request body:

{
    "language": "python",
    "content": "print(\"42 Hello World\")",
    "tests": [
      { "name": "First test case", "stdin": [], "actual": "42 Hello World" },
      { "name": "Second test case", "stdin": [], "actual": "42 Hello World" }
    ]
}

You can also add an optional query parameter called bypass_cache and set it to true, if you want to bypass the cache.

GET /languages

Will return all languages that are possible for remote execution.

This JSON structure is an example for the response body:

[
    {
        "name": "python",
        "version": "3.7.10",
        "extension": ".py",
        "timeout": 10
    },
    {
        "name": "javascript",
        "version": "16.3.1",
        "extension": ".js",
        "timeout": 10
    },
    // ...
]

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT