Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/athena-os/athena-core-docker

Official Athena OS docker core images.
https://github.com/athena-os/athena-core-docker

Last synced: 21 days ago
JSON representation

Official Athena OS docker core images.

Awesome Lists containing this project

README 

        
# Athena OS Docker Image



![athena-banner](https://user-images.githubusercontent.com/83867734/221656804-51b13a4f-876b-4ca8-856e-288d2209a949.png)



Athena OS container brings you to live a funny hacking experience in a containerized environment:



* Select your favourite **InfoSec role** between **Bug Bounty Hunter**, **Red Teamer**, **OSINT Specialist** and **much more**

* Play **Hack The Box** machines for improving your skills

* Explore more than **2800+ hacking tools** retrievable by **Arch Linux** and **BlackArch** repositories

* Make your **Capture The Flag** or **ethical hacking** activity efficient



Find us at:



* [Discord](https://discord.gg/DNjvQkb5Ad) - realtime support / chat with the community and the team.

* [GitHub](https://github.com/Athena-OS) - view the source for all of our repositories.



## Usage



![image](https://github.com/Athena-OS/athena-core-docker/assets/83867734/c6d0be74-2014-4ab7-96d7-9b152d6f6561)



Athena OS container has been developed in order to be run also by podman. The choice to use podman comes from its advantages over docker, one of most important: security.



According to your preference, install `docker` and `docker-compose` packages or `podman` package for your Linux environment.



In case you are using podman, edit `/etc/containers/registries.conf` and add:

```

[registries.search]

registries = ['docker.io']

```

in order to allow podman to search for images in Docker Hub.



### Hack The Box API Token



Athena OS container allows you to learn and play on Hack The Box platform. It is possible to access to Hack The Box by using your App Token. Retrieve your App Token from the Hack The Box website in your Profile Settings.



### Docker



Store your App Token in a file called `htb-api-file` in your current directory, save and close it.



You can run the container by `docker-compose` (recommended) or `docker run`.



#### docker-compose



The `docker-compose.yml` file should have the following content:

```yaml

version: '3.4'



services:

  athena:

    image: athenaos/core

    cap_add:

      - net_admin

    devices:

      - /dev/net/tun

    sysctls:

      - net.ipv6.conf.all.disable_ipv6=0

    secrets:

       - source: htb-api

    tmpfs:

      - /run

      - /tmp

    restart: unless-stopped



secrets:

  htb-api:

    file: ./htb-api-file

```

and the `htb-api-file` must be in the same directory, otherwise you can change its path in `docker-compose.yml`.



Run the container by:

```

sudo docker-compose run athena

```



#### docker run



```bash

docker run -ti \

  --name athena \

  --volume ./htb-api-file:/run/secrets/htb-api:ro \

  --cap-add NET_ADMIN \

  --device /dev/net/tun \

  --sysctl net.ipv6.conf.all.disable_ipv6=0 \

  --restart unless-stopped \

  docker.io/athenaos/core:latest

```

or

```

docker run -ti --name athena --volume ./htb-api-file:/run/secrets/htb-api:ro --cap-add NET_ADMIN --device /dev/net/tun --sysctl net.ipv6.conf.all.disable_ipv6=0 --restart unless-stopped docker.io/athenaos/core:latest

```



In case you exit the container and need to re-enter, run:

```

docker exec --user athena -ti athena /bin/zsh

```

In case the container is not running, run:

```

docker start athena

```



For stopping the container, run:

```

docker stop athena

```



For deleting the container, run:

```

docker container rm athena

```



### Podman



Store your App Token in a file called `htb-api-file`, save and close it, and then run:



```

podman secret create htb-api htb-api-file

```

In this manner, podman will store securely your API key. Now, you can delete the `htb-api-file` by `rm -rf htb-api-file`.



You can run the container by `podman run`.



#### podman run



```bash

podman run -ti \

  --name athena \

  --secret htb-api \

  --cap-add NET_RAW \

  --cap-add NET_ADMIN \

  --device /dev/net/tun \

  --restart unless-stopped \

  docker.io/athenaos/core:latest

```

or

```

podman run -ti --name athena --secret htb-api --cap-add NET_RAW --cap-add NET_ADMIN --device /dev/net/tun --restart unless-stopped docker.io/athenaos/core:latest

```

Podman will automatically replicate `/etc/hosts` and `/etc/hostname` files of your host. For preventing this, add `--no-hosts` argument to the `podman run` command above.



In case you exit the container and need to re-enter, run:

```

podman exec --user athena -ti athena /bin/zsh

```

In case the container is not running, run:

```

podman start athena

```



For stopping the container, run:

```

podman stop athena

```



For deleting the container, run:

```

podman container rm athena

```

### Default Credentials



```

athena:athena

```



## Parameters



Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.



| Parameter | Function |

| ---- | --- |

| `--secret htb-api` | usage of App Token on the container |

| `--cap-add=NET_RAW ` | needed for running ping command |

| `--cap-add NET_ADMIN` | needed for running OpenVPN |

| `--device /dev/net/tun` | needed for creating tun interface used by OpenVPN |



## Updating Info



Below are the instructions for updating containers:



### Via Podman Run



* Update the image: `podman pull docker.io/athenaos/core:latest`

* Stop the running container: `podman stop athena`

* Delete the container: `podman rm athena`

* Recreate a new container with the same podman run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)

* You can also remove the old dangling images: `podman image prune`



## Building locally



If you want to make local modifications to these images for development purposes or just to customize the logic:



```bash

git clone https://github.com/Athena-OS/athena-core-docker.git

cd athena-core-docker

docker buildx build \

  --no-cache \

  --network host \

  --pull \

  -t docker.io/athenaos/core:latest .

```



For pushing to Docker Hub, first login to it:



```bash

docker login

```



and then:



```

docker push athenaos/core:latest

```



The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`



```bash

docker run --rm --privileged multiarch/qemu-user-static:register --reset

```



Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`. This method has not been tested yet.