Prepare for publication

This commit is contained in:
Victor 2020-10-20 03:54:30 +03:00
parent 697ee3d4aa
commit ee771562a6
5 changed files with 100 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
*.nims

25
Makefile Normal file
View File

@ -0,0 +1,25 @@
PREFIX ?= /usr
BINDIR = $(DESTDIR)$(PREFIX)/bin
SRCDIR = src
TARGET = wpspin
SOURCE = $(SRCDIR)/wpspin.nim
.PHONY: all install uninstall
all: $(TARGET)
$(TARGET): $(SOURCE)
nimble install -y argparse
nim compile --gc:none --checks:off --out:$@ $(SOURCE)
strip $@
nimble uninstall -y argparse
install: $(TARGET)
install -d $(DESTDIR)$(BINDIR)
install -m 755 $< $(DESTDIR)$(BINDIR)
uninstall:
rm $(BINDIR)/$(TARGET)
clean:
rm -f $(TARGET)

59
README.md Normal file
View File

@ -0,0 +1,59 @@
# WPS PIN generator
![GitHub](https://img.shields.io/github/license/drygdryg/wpspin-nim)
![GitHub All Releases](https://img.shields.io/github/downloads/drygdryg/wpspin-nim/total)
[![nimble](https://raw.githubusercontent.com/yglukhov/nimble-tag/master/nimble.png)](https://github.com/yglukhov/nimble-tag)
## Overview
WPS PIN generator uses known MAC address based algorithms commonly found in routers firmware to generate their default PIN codes. PIN codes can be used with programs like [Reaver](https://github.com/t6x/reaver-wps-fork-t6x), [Bully](https://github.com/aanarchyy/bully) or [OneShot](https://github.com/drygdryg/OneShot) to recover Wi-Fi passwords.
## Installation
### Installing on Debian >= 11 or Ubuntu >= 20.04
```
sudo apt install -y nim
git clone https://github.com/drygdryg/wpspin-nim
cd wpspin-nim/
make
sudo make install
```
### Installing on older versions of Debian/Ubuntu
Download universal Linux executable from the [releases](https://github.com/drygdryg/wpspin-nim/releases)
### Installing on Arch Linux or Manjaro
![AUR version](https://img.shields.io/aur/version/wpspin)
```
yay -S wpspin
```
### Installing on [Termux](https://play.google.com/store/apps/details?id=com.termux)
```
pkg install nim
git clone https://github.com/drygdryg/wpspin-nim
cd wpspin-nim/
make && make install
```
### Installing on Windows
Download Windows executable from the [releases](https://github.com/drygdryg/wpspin-nim/releases)
### Installing with Nimble (platform-independent)
```
nimble install wpspin
```
## Usage
Basic usage
```
wpspin 60:A4:4C:D0:D5:80
```
To generate all PIN codes in addition to the suggested ones use `-A`
```
wpspin -A 60:A4:4C:D0:D5:80
```
To use algorithms for testing use `-T`
```
wpspin -A -T 60:A4:4C:D0:D5:80
```
*More detailed usage: `wpspin --help`*
## Credits
3WiFi offline WPS PIN generator: https://3wifi.stascorp.com/wpspin

15
wpspin.nimble Normal file
View File

@ -0,0 +1,15 @@
# Package
version = "0.3.0"
author = "Victor Golovanenko (drygdryg)"
description = "Full-featured WPS PIN generator"
license = "MIT"
srcDir = "src"
bin = @["wpspin"]
# Dependencies
requires "nim >= 0.20.0"
requires "argparse >= 0.10.1"