Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

A new docker container is made for each code uploaded #11

Open
wants to merge 2 commits into
base: rajat-hiten-ankit
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
npm-debug.log
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
node_modules
23 changes: 23 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
FROM ubuntu
WORKDIR /usr/src/app
COPY package*.json ./
COPY . .
RUN apt-get update
RUN apt-get install curl -y
RUN curl -sL https://deb.nodesource.com/setup_10.x | bash
RUN apt-get install nodejs -y
RUN npm install -y
RUN apt-get install \
apt-transport-https \
ca-certificates \
curl \
gnupg-agent \
software-properties-common -y
RUN curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add -
RUN add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
$(lsb_release -cs) \
stable"
RUN apt-get update
RUN apt-get install docker-ce docker-ce-cli containerd.io -y
CMD ["npm","run","dev"]
4 changes: 4 additions & 0 deletions Dockerfiles/DockerCPP
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
FROM ubuntu
WORKDIR /usr/src/app
RUN apt-get update
RUN apt-get install build-essential -y
4 changes: 4 additions & 0 deletions Dockerfiles/DockerJava
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
FROM ubuntu
WORKDIR /usr/src/app
RUN apt-get update
RUN apt-get install openjdk-8-jdk -y
7 changes: 7 additions & 0 deletions Dockerfiles/DockerPython
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
FROM ubuntu
WORKDIR /usr/src/app
RUN apt-get update
RUN apt-get install software-properties-common -y
RUN add-apt-repository ppa:deadsnakes/ppa -y
RUN apt-get update
RUN apt-get install python3.8 -y
42 changes: 21 additions & 21 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
MIT License

Copyright (c) 2020 Abhigyan Abhikaushalam Students' Forum

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
MIT License
Copyright (c) 2020 Rajat Maheshwari
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
184 changes: 182 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,182 @@
# Remote Code Executor
- Server Side Code for a Remote Code Executor
<p align="center">
<a href="https://github.com/rajatmaheshwari2512/remote-code-exec">
</a>

<h3 align="center">Remote Code Executor</h3>

<p align="center">
Server-side code of a Remote Code Executor
<br />
<a href="https://github.com/rajatmaheshwari2512/remote-code-exec/issues">Report Bug</a>
·
<a href="https://github.com/rajatmaheshwari2512/remote-code-exec/issues">Request Feature</a>
</p>
</p>

<!-- TABLE OF CONTENTS -->
<details open="open">
<summary><h2 style="display: inline-block">Table of Contents</h2></summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
</ol>
</details>

<!-- ABOUT THE PROJECT -->

## About The Project

This is the server-side code of a Remote Code Executor. This is a project assigned by the Coding forum of my college and is similar to the Online IDEs of websites like CodeChef and Leetcode.

Salient Features:

- Code Sanitisation
- An individual Docker Container is created for every code posted on the API, so no code interferes with any other code
- All Async code so that the server can handle multiple requests without error

### Built With

<a href="https://nodejs.org" target="_blank"> <img src="https://devicons.github.io/devicon/devicon.git/icons/nodejs/nodejs-original-wordmark.svg" alt="nodejs" width="40" height="40"/> </a>
<a href="https://www.docker.com/" target="_blank"> <img src="https://devicons.github.io/devicon/devicon.git/icons/docker/docker-original-wordmark.svg" alt="docker" width="40" height="40"/> </a>

<!-- GETTING STARTED -->

## Getting Started

To get a local copy up and running follow these simple steps.

### Prerequisites

- npm
```sh
npm install npm@latest -g
```
- docker
```sh
curl -fsSL https://get.docker.com -o get-docker.sh
```
```sh
sudo sh get-docker.sh
```

### Installation
#### If you are on a Linux(preferably Ubuntu) Machine
1. Clone the repo
```sh
git clone https://github.com/rajatmaheshwari2512/remote-code-exec
```
2. Install NPM packages
```sh
npm install
```
3. To build the docker images
```sh
cd Dockerfiles
```
```sh
docker build -t cpp:v1 -f DockerCPP .
```
```sh
docker build -t python:v1 -f DockerPython .
```
```sh
docker build -t java:v1 -f DockerJava .
```
#### If you are on any other Machine
1. Clone the repo
```sh
git clone https://github.com/rajatmaheshwari2512/remote-code-exec
```
2. Install NPM packages
```sh
npm install
```
3. Build the Server's Dockerfile
```sh
docker build -t rceserver:v1 .
```
4. Run the Docker Image
```sh
docker run --privileged=true -v /var/run/docker.sock:/var/run/docker.sock -d -p 3000:3000 rceserver:v1
```
5. Create a shell to the created Docker Container
```sh
docker ps
```
```sh
docker exec -it <container_id> /bin/bash
```
6. Build the Images inside the Container
```sh
cd Dockerfiles
```
```sh
docker build -t cpp:v1 -f DockerCPP .
```
```sh
docker build -t python:v1 -f DockerPython .
```
```sh
docker build -t java:v1 -f DockerJava .
```
<!-- USAGE EXAMPLES -->

## Usage

1. To run the server in dev mode use
```sh
npm run dev
```
2. To run the server in production mode
```sh
npm start
```
3. Note that dev mode uses nodemon so that the server can be changed and restarted easily

<!-- ROADMAP -->

## Roadmap

See the [open issues](https://github.com/rajatmaheshwari2512/remote-code-exec/issues) for a list of proposed features (and known issues).

<!-- CONTRIBUTING -->

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<!-- LICENSE -->

## License

Distributed under the MIT License. See `LICENSE` for more information.

<!-- CONTACT -->

## Contact

Rajat Maheshwari - [email protected]

Project Link: [https://github.com/rajatmaheshwari2512/remote-code-exec](https://github.com/rajatmaheshwari2512/remote-code-exec)
3 changes: 3 additions & 0 deletions app.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ var cookieParser = require("cookie-parser");
var logger = require("morgan");
var codeRouter = require("./routes/codeUpload");
var cors = require("cors");
var swaggerUi = require("swagger-ui-express"),
swaggerDocument = require("./swagger.json");

var app = express();

Expand All @@ -14,6 +16,7 @@ app.use(cookieParser());
app.use(cors());

app.use("/codeupload", codeRouter);
app.use("/", swaggerUi.serve, swaggerUi.setup(swaggerDocument));

app.use(function (req, res, next) {
next(createError(404));
Expand Down
2 changes: 1 addition & 1 deletion bin/www
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ function onError(error) {

function onListening() {
console.log("Server running on localhost:" + port);
}
}
47 changes: 28 additions & 19 deletions languages/cpp.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,34 @@ const util = require("util");
const exec = util.promisify(require("child_process").exec);
var fs = require("fs");

const cpp = (input, res) => {
fs.writeFile("input.txt", input, (err) => {
const cpp = (input, res, name) => {
fs.writeFile(`${name}.txt`, input, (err) => {
if (err) res.json({ error: err });
exec("g++ input.cpp && ./a.out <input.txt", {
timeout: 5000,
maxBuffer: 50000,
})
.then((result) => {
res.json(result);
exec("rm input.cpp && rm a.out").then((resp) =>
console.log("CPP File Deleted")
);
exec("rm input.txt").then((resp) => console.log("Input CPP Deleted"));
})
.catch((err) => {
res.json(err);
exec("rm input.cpp").then((resp) => console.log("CPP File Deleted"));
exec("rm input.txt").then((resp) => console.log("Input CPP Deleted"));
});
exec("docker run -d -it cpp:v1 /bin/bash").then((resp) => {
var id = resp.stdout.substring(0, 12);
exec(
`docker cp ${name}.cpp ${id}:/usr/src/app/test.cpp && docker cp ${name}.txt ${id}:/usr/src/app/input.txt && docker exec ${id} bash -c "g++ test.cpp && ./a.out<input.txt"`,
{ timeout: 10000, maxBuffer: 50000 }
)
.then((resp) => {
res.json(resp);
exec(`rm ${name}.cpp && rm ${name}.txt`).then((resp) =>
console.log("Files removed")
);
exec(`docker kill ${id}`).then((resp) =>
console.log("Container Stopped")
);
})
.catch((err) => {
res.json(err);
exec(`rm ${name}.cpp && rm ${name}.txt`).then((resp) =>
console.log("Files removed")
);
exec(`docker kill ${id}`).then((resp) =>
console.log("Container Stopped")
);
});
});
});
};
module.exports = cpp;
module.exports = cpp;
35 changes: 35 additions & 0 deletions languages/java.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
const util = require("util");
const exec = util.promisify(require("child_process").exec);
var fs = require("fs");

const java = (input, res, name) => {
fs.writeFile(`${name}.txt`, input, (err) => {
if (err) res.json({ error: err });
exec("docker run -d -it java:v1 /bin/bash").then((resp) => {
var id = resp.stdout.substring(0, 12);
exec(
`docker cp ${name}.java ${id}:/usr/src/app/test.java && docker cp ${name}.txt ${id}:/usr/src/app/input.txt && docker exec ${id} bash -c "javac test.java && java test<input.txt"`,
{ timeout: 15000, maxBuffer: 50000 }
)
.then((resp) => {
res.json(resp);
exec(`rm ${name}.java && rm ${name}.txt`).then((resp) =>
console.log("Files removed")
);
exec(`docker kill ${id}`).then((resp) =>
console.log("Container Stopped")
);
})
.catch((err) => {
res.json(err);
exec(`rm ${name}.java && rm ${name}.txt`).then((resp) =>
console.log("Files removed")
);
exec(`docker kill ${id}`).then((resp) =>
console.log("Container Stopped")
);
});
});
});
};
module.exports = java;
Loading