Skip to content
Merged
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 .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.env
sonar-project.properties
21 changes: 15 additions & 6 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -1,18 +1,27 @@
FROM debian:bullseye-20251229-slim
FROM kalilinux/kali-rolling@sha256:b1f67719a6d2c62f08ceadaebf2daf64a32cb56b5dbf5c6307ac48cd84cda3d4
ARG DEBIAN_FRONTEND=noninteractive
ENV PATH="/root/osmedeus-base/external-binaries:/root/.local/bin:${PATH}"
ENV LANG="en_US.UTF-8" \
LANGUAGE="en_US:en" \
LC_ALL="en_US.UTF-8"
RUN sed -i 's/main/main contrib non-free/' /etc/apt/sources.list && \
apt-get update && \
apt-get -yq install apt-utils locales curl && \
RUN apt-get update && \
apt-get -yq install \
apt-utils \
locales \
curl \
git \
rsync \
massdns \
assetfinder && \
sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
locale-gen && \
apt-get -yqu dist-upgrade && \
bash -c "$(curl -fsSL https://raw.githubusercontent.com/osmedeus/osmedeus-base/master/install.sh)" && \
bash -c "$(curl -sSL http://www.osmedeus.org/install.sh)" && \
osmedeus install base --preset && \
osmedeus health && \
apt-get -y autoremove && \
apt-get clean && \
rm -rf /var/lib/{apt,dpkg,cache,log}
WORKDIR /root
EXPOSE 8000
EXPOSE 8002
CMD ["osmedeus"]
44 changes: 23 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,65 +1,67 @@
# docker-osmedeus v4
# docker-osmedeus v5

## Description

Docker image for Osmedeus, a fully automated offensive security tool for reconnaissance and vulnerability scanning (<https://github.com/j3ssie/Osmedeus>). This image is built upon Debian's Bullseye slim image.

On 1st January 2022, Osmedeus' main developer (j3ssie) launched a beta of the new 4.0 version, which supersedes the previous v2 based on Django. While this README covers v4, the [READMEv2](READMEv2.md) file covers both the 1.5 and the 2.x versions.

From v4.0.0 on, the Docker image `latest` tag references the newest 4.x available version.
Docker image for Osmedeus, a fully automated offensive security tool for reconnaissance and vulnerability scanning (<https://github.com/j3ssie/Osmedeus>). This image is built upon Kali Linux rolling image.

## How to use this image

The image launches Osmedeus' CLI tool without any arguments, so you have to provide your own to modify Osmedeus execution. Have a look at the inline help and the official documentation for basic and advanced usage examples.
The image launches Osmedeus' CLI tool without any arguments, so you have to provide your own to customise Osmedeus execution. Have a look at the inline help and the official documentation for basic and advanced usage examples.

This will show Osmedeus inline help:
This will show the inline help:

```bash
~ docker run -it --rm mablanco/osmedeus
docker run -it --rm mablanco/osmedeus
```

This will start an analysis on domain `example.com` with logs on the console and deleting the container after finishing:
You can also get all usage examples:

```bash
~ docker run -it --rm mablanco/osmedeus osmedeus scan -t example.com
docker run -it --rm mablanco/osmedeus osmedeus --usage-example
```

In case you want to persist the results of your analysis, you can create a volume for that purpose:
This will start a fast analysis of domain `example.com` with logs on the console, deleting the container after finishing:

```bash
~ docker volume create osmedeus_workspaces
docker run -it --rm mablanco/osmedeus osmedeus run -f fast -t example.com
```

In case you want to add persistance to your Osmedeus analysis, create the required volumes and mount them appropiately:

```bash
~ docker run -it --rm -v osmedeus_workspaces:/root/.osmedeus/workspaces mablanco/osmedeus osmedeus scan -t example.com
docker volume create osmedeus_base
docker volume create osmedeus_workspaces
docker run -it --rm -v osmedeus_base:/root/osmedeus-base -v osmedeus_workspaces:/root/workspaces-osmedeus mablanco/osmedeus osmedeus run -t example.com
```

## Web UI

You can start the Web UI, as a daemonized process, with the following command:

```bash
~ docker run -d --name osmedeus-server -p 8000:8000 mablanco/osmedeus osmedeus server
docker run -d --name osmedeus-server -p 8002:8002 mablanco/osmedeus osmedeus server
```

Now the Web UI is accesible at `https://127.0.0.1:8000/`. You can access an already existing volume containing Osmedeus workspaces adding the above volume parameters.
Now the Web UI is accesible at `http://127.0.0.1:8002/`. You can access an already existing volume containing Osmedeus workspaces adding the volume parameters described above.

The password to access the Web UI can be obtained executing this command:
The credentials to access the Web UI can be obtained executing these commands while the serve is running:

```bash
~ docker exec -it osmedeus-server grep password /root/.osmedeus/config.yaml | head -1
docker exec -it osmedeus-server osmedeus config view server.username
docker exec -it osmedeus-server osmedeus config view server.password

```

## Building the image

Use the following command to build the image with the `latest` tag:

```bash
~ docker build -t mablanco/osmedeus .
docker build -t mablanco/osmedeus --progress=plain .
```

In case you want to tag the image with a different version, use this command:
In case you want to tag the image with a custom version, use this command:

```bash
~ docker build -t mablanco/osmedeus:<release> .
docker build -t mablanco/osmedeus:<version> --progress=plain .
```
91 changes: 0 additions & 91 deletions READMEv2.md

This file was deleted.

Loading