Skip to content

Commit

Permalink
Merge branch 'default/tag' of github.com:ravi-prakash1907/custom-kali…
Browse files Browse the repository at this point in the history
…-meta into default/tag
  • Loading branch information
ravi-prakash1907 committed Sep 30, 2023
2 parents 7f795ae + 47c9366 commit d82582a
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 103 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/dockerhub-image-default.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Docker Image (default) for Dockerhub
name: custom-kali-linux:default

on:
push:
Expand Down Expand Up @@ -29,4 +29,4 @@ jobs:
with:
push: true
tags: ${{ secrets.DOCKER_USERNAME }}/custom-kali-linux:default


107 changes: 6 additions & 101 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,21 @@
# `custom-kali-meta` 💀
# `custom-kali-linux:default` 💀

![Docker Pulls](https://img.shields.io/docker/pulls/raviprakash1907/custom-kali-linux) [![Build and Push to dockerhub](https://github.com/ravi-prakash1907/custom-kali-meta/actions/workflows/dockerhub-image.yml/badge.svg)](https://github.com/ravi-prakash1907/custom-kali-meta/actions/workflows/dockerhub-image.yml)
![Docker Pulls](https://img.shields.io/docker/pulls/raviprakash1907/custom-kali-linux) [![Build and Push to dockerhub](https://github.com/ravi-prakash1907/custom-kali-meta/actions/workflows/dockerhub-image.yml/badge.svg)](https://github.com/ravi-prakash1907/custom-kali-meta/actions/workflows/dockerhub-image-default.yml)

`custom-kali-meta` is one of the four varients of `custom-kali-linux`, i.e., a collection of customized Kali Linux images for various use cases. These all images are available on docke-hub at [https://hub.docker.com/r/raviprakash1907/custom-kali-linux](https://hub.docker.com/r/raviprakash1907/custom-kali-linux). These images are based on [`kalilinux/kali-rolling`](https://hub.docker.com/r/kalilinux/kali-rolling), but they differ in terms of the packages used during the build process. There are two main packages used:
`custom-kali-linux:default` is a custom Kali Linux image built with docker, based on the `kali-linux-default` package.

1. `kali-desktop-core` 🖥️
2. `kali-linux-default` 🛡️

For more information about the different Kali Linux packages, please visit the [official metapackages page](https://www.kali.org/docs/general-use/metapackages/).

### Tags 🏷️

All images in this repository provide access to the server via **RDP** (port 13389) 🖥️, **VNC** (port 5908) 🖥️, and **SSH** (port 20022) 🔐. The repository offers three main tags:

1. **`core`:** These images are built with the `kali-linux-core` package and have minimal dependencies (related to text editing and version control). They provide lightweight instances and correspond to the Long Term Support (LTS) version of `custom-kali-linux`. Updates are less frequent. 🌱

2. **`default`:** This image is built with the `kali-linux-default` package and includes additional CLI tools for cybersecurity. It is also tagged as `latest`. 🚀

3. **`meta`:** Built from the base image `raviprakash1907/custom-kali-linux:default`, this image is designed for metaverse and extended reality (XR) development and is expected to receive frequent updates. 🌟

## Using `custom-kali-linux` 💀
## Using `custom-kali-linux:default` 💀

The easiest way to use this image is by running the following `docker run` command:

```sh
$ docker run -it --rm raviprakash1907/custom-kali-linux:<tag>
```

This command provides minimal access to the container via the terminal. To access it via RDP, VNC, and SSH clients, use this command instead:

```sh
$ docker run -it --rm -p 5908:5908 -p 13389:13389 -p 20022:20022 raviprakash1907/custom-kali-linux:<tag>
```

To bind volumes when using the image, you can execute the following command:

```sh
$ docker run \
-it \
--rm \
--name kali-custom \
-p 5908:5908 -p 13389:13389 -p 20022:20022 \
--mount type=bind,src="$(pwd)/kali",target=/home/trustworthy \
raviprakash1907/custom-kali-linux:<tag>
raviprakash1907/custom-kali-linux:default
```

## Default Credentials 🔑
Expand All @@ -51,72 +24,4 @@ $ docker run \
> Password: `trustworthy`
> User: `root`
> Password: **To be set**
### Setting the root user's password:

1. Switch to the `root` user with the following command:

```sh
$ sudo su
```

2. Reset the `root` password:

```sh
$ passwd root
```

3. You'll be prompted to set a new password.

Now, you can switch between users (`root` and `trustworthy`) using:

```sh
$ su <username>
```

---

## Using with `docker-compose` 🐳

Here, we provide a sample `Dockerfile` used to build the image:

```Dockerfile
FROM raviprakash1907/custom-kali-linux:meta

# Switching to root for installation
USER root

## Exposing additional ports for dynamically binding services while testing (beyond port 49151)
EXPOSE 55510

# Start
RUN /bin/sh
```

And a `docker-compose.yml` file:

```yaml
version: "3.0"

services:
kali:
build: .
container_name: custom-kali-meta:<tag>
ports:
- 13389:13389
- 20022:20022
- 5908:5908
- 55510:55510
volumes:
- ./kali/:/home/trustworthy
command: /bin/sh
meta:
image: raviprakash1907/custom-kali-linux:meta
```

You can build and use the container with a single command:

```sh
$ docker-compose up
```
> Password: `toor`

0 comments on commit d82582a

Please sign in to comment.