Skip to content

Commit

Permalink
makefile symlink to build client added; readme fix and main readme fix
Browse files Browse the repository at this point in the history
  • Loading branch information
virgula0 committed Jan 27, 2025
1 parent 2c21baf commit 4c70504
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 14 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The provided `docker-compose.yml` file already includes all necessary environmen
**Default credentials:** `admin:test1234`
This account can be used on the frontend to upload and submit WPA handshakes for cracking.

> While the software is primarily designed for **Linux**, GPU capabilities can potentially be shared with a containerized `client` via **WSL** on Windows. Future improvements may include native support for additional operating systems.
> While the software is primarily designed for **Linux**, GPU capabilities can potentially be shared with a `client` via **WSL** on Windows. Future improvements may include native support for additional operating systems but it has tested out to work with both containers and compiled code from **WSL** (version 2).
---

Expand Down Expand Up @@ -480,4 +480,5 @@ Ignoring gRPC and other basic deps
- **Gopacket** `github.com/google/gopacket` Parse `.PCAP` files as layers
- **Wifi** `github.com/mdlayher/wifi` used by daemon for understanding if we're connected to our local network
- **Cobra** `github.com/spf13/cobra` used for parsing command line arguments easily in daemon
- **bubbletea** `https://github.com/charmbracelet/bubbletea` tui for login used by daemon
- Other dependencies could be implicitly downloaded and used because of these deps
13 changes: 13 additions & 0 deletions client/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,15 @@ links-build:
fi; \
if [ ! -e "build/hashcat.hctune" ]; then \
ln -s /usr/local/share/hashcat/hashcat.hctune build/hashcat.hctune; \
echo "Created symbolic link for hashcat.hctune"; \
fi; \
if [ ! -e "build/modules" ]; then \
ln -s /usr/local/share/hashcat/modules build/modules; \
echo "Created symbolic link for modules"; \
fi; \
if [ ! -e "build/hashcat.hcstat2" ]; then \
ln -s /usr/local/share/hashcat/hashcat.hcstat2 build/hashcat.hcstat2; \
echo "Created symbolic link for hashcat.hcstat2"; \
fi; \
}
.PHONY: links-build
Expand All @@ -34,9 +40,15 @@ links:
fi; \
if [ ! -e "hashcat.hctune" ]; then \
ln -s /usr/local/share/hashcat/hashcat.hctune hashcat.hctune; \
echo "Created symbolic link for hashcat.hctune"; \
fi; \
if [ ! -e "modules" ]; then \
ln -s /usr/local/share/hashcat/modules modules; \
echo "Created symbolic link for modules"; \
fi; \
if [ ! -e "hashcat.hcstat2" ]; then \
ln -s /usr/local/share/hashcat/hashcat.hcstat2 hashcat.hcstat2; \
echo "Created symbolic link for hashcat.hcstat2"; \
fi; \
}
.PHONY: links
Expand All @@ -46,6 +58,7 @@ clean:
rm -rf modules
rm -rf kernels
rm -f *.hctune
rm -f hashcat.hcstat2
rm -f *.dictstat*
rm -f main
.PHONY: clean
Expand Down
29 changes: 17 additions & 12 deletions client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,22 +93,18 @@ While this solution works for our current requirements, future improvements coul
> The following dependencies needs to be installed before proceeding, even if you're using compiled binaries from releases
```bash
apt update -y && \
apt install -y --no-install-recommends \
protobuf-compiler
sudo apt update -y && \
sudo apt install -y --no-install-recommends \
protobuf-compiler \
libminizip-dev \
ocl-icd-libopencl1 \
opencl-headers \
pocl-opencl-icd \
build-essential \
wget \
git \
dumb-init \
ca-certificates \
libz-dev \
libssl-dev \
dbus \
# Graphic libraries for raylib
libgl1-mesa-dev libxi-dev libxcursor-dev libxrandr-dev libxinerama-dev libwayland-dev libxkbcommon-dev
```

Expand All @@ -118,9 +114,7 @@ apt update -y && \
Follow these steps to compile and run the client, run it from project root dir

```bash
git submodule init
git submodule update --init --remote --recursive
git pull --recurse-submodule
```

1. **You need to install `hashcat` 6.1.1. This step is necesary only for the first time.**
Expand All @@ -132,24 +126,35 @@ sudo make set-user-permissions USER=${USER}
cd ../../
```

2. **Build with**
2. **Install protobuf**

> ![NOTE]
> This was tested out using go `1.23.4`. Other version may have problems.
```bash
go install google.golang.org/protobuf/cmd/[email protected] &&
go install google.golang.org/grpc/cmd/[email protected]
```

3. **Build client**

```bash
cd client
make build
```

Produces the following files tree
Produces the following files tree in `build`

```
├── client
├── hashcat.hctune -> /usr/local/share/hashcat/hashcat.hctune
├── hashcat.hcstat2 -> /usr/local/share/hashcat/hashcat.hcstat2
├── libhcxpcapngtool.so
├── modules -> /usr/local/share/hashcat/modules
└── OpenCL -> /usr/local/share/hashcat/OpenCL
```

3. **Run with**
4. **Run with**

```bash
make run-compiled
Expand Down
2 changes: 1 addition & 1 deletion externals/hcxtools
Submodule hcxtools updated 1 files
+4 −0 README.md

0 comments on commit 4c70504

Please sign in to comment.