Skip to content

Commit 43c41d9

Browse files
authored
Release v4.0 README changes
Why did I make the README all flashy and buzzwordy, that's bad! This is probably the remains of the time I used to work in SEO and all those shenanigans. Being overenthusiastic is not good on the Internet. This commit shows I learned to change.
1 parent 9219ae0 commit 43c41d9

File tree

1 file changed

+57
-109
lines changed

1 file changed

+57
-109
lines changed

Diff for: README.md

+57-109
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,35 @@
1-
<p align="center">
2-
<a href="https://github.com/mufeedvh/basecrack"><img src="https://raw.githubusercontent.com/mufeedvh/basecrack/master/assets/basecrack-logo.png" title="BaseCrack" alt="basecrack" height="100" width="325"></a>
3-
</p>
41
<h1 align="center">BaseCrack</h1>
5-
<h4 align="center">Decoder Tool For Base Encoding Schemes</h4>
2+
<h4 align="center">Decoder For Base Encoding Schemes</h4>
63
<p align="center">
7-
<img src="https://img.shields.io/badge/version-3.0-blue.svg" title="version" alt="version">
4+
<img src="https://img.shields.io/badge/version-4.0-blue.svg" title="version" alt="version">
85
<a href="https://github.com/mufeedvh/basecrack/blob/master/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/mufeedvh/basecrack.svg"></a>
9-
<a href="https://twitter.com/intent/tweet?text=Check%20this%20out!%20A%20tool%20to%20decode%20all%20types%20of%20Base%20Encoding%20Schemes.%20Will%20be%20really%20useful%20for%20CTFs%20and%20Cryptography:&url=https%3A%2F%2Fgithub.com%2Fmufeedvh%2Fbasecrack"><img alt="Twitter" src="https://img.shields.io/twitter/url/https/github.com/mufeedvh/basecrack.svg?style=social"></a>
106
</p>
117

12-
![basecrack tool](https://raw.githubusercontent.com/mufeedvh/basecrack/master/assets/basecrack-tool.png)
13-
14-
------------
15-
168
**BaseCrack** is a tool written in Python that can decode all alphanumeric base encoding schemes. This tool can accept single user input, multiple inputs from a file, input from argument, **multi-encoded bases**, **bases in image EXIF data**, **bases on images with OCR** and decode them incredibly fast.
179

18-
Decode Base16, Base32, Base36, Base58, Base62, Base64, Base64Url, Base85, Ascii85, Base91, Base92 and more with the best base encoding scheme decoding tool in town. It's useful for **CTFs**, **Bug Bounty Hunting**, and **Cryptography** (**NOTE:** Base Encoding is not an "Encryption" hence it doesn't fall under the Cryptography category, it's useful as base scheme encoding are often used in cryptography tools/projects/challenges).
19-
2010
<details>
21-
<summary>Fun Fact!</summary>
22-
<br>
23-
I initially made this after being fed up with lame AF CTF challenges with multi-encoded bases in Cryprography challenges and now some of them started doing that in Steganography challenges so I automated that too smh!
11+
<summary><strong>Fun Fact!</strong></summary>
12+
<br>
13+
I initially made this after being fed up with lame CTF challenges with multi-encoded bases. Now some of them started doing that in Steganography challenges as well so I automated that too smh!
2414
</details>
2515

26-
---
27-
28-
### Jump to [Usage](https://github.com/mufeedvh/basecrack#usage)
29-
30-
---
31-
32-
## Changelog
33-
34-
**What's new in v3.0:**
35-
36-
- **Decode bases in image EXIF data.** 📸
37-
- **Decode bases on images with OCR detection.** 🔎
38-
- Better Accuracy. (+added charset validation along with replacement char checks) 💯
39-
- Magic Mode now works with File Read mode. :fire:
40-
- Magic Mode now works with Wordlist Generator. :fire:
41-
42-
**What's new in v2.0:**
43-
44-
- Now BaseCrack supports both Python2 and Python3.
45-
46-
## Magic Mode 🪄
47-
48-
Now you can **decode multi-encoded bases** of any pattern in a single shot.
49-
50-
Have you ever stumbled upon that one lame CTF challenge that gives you an encoded string which is just encoded over and over with Base64, Base91, Base85 and so on? Just give that to BaseCrack and you're done with it! ;)
51-
52-
<img src="https://raw.githubusercontent.com/mufeedvh/basecrack/master/assets/basecrack-magic-mode.png" alt="basecrack magic mode">
53-
54-
Want to test it out? Just give it this input:
55-
56-
```
57-
IX(Fp@nNG6ef<,*TFE]IT^zdINAb9EVbp,e<u=O6nN)/u+MTnU;Fo#VvQ&cK;mLZI#Jbdook<O{W#+gY%ooe#6pTkTa.9YPU8Uc=pl9BhSM9%kISw2k:8..u/6F2BwNndPZ2o#7NHNP3g,HlZu><*[Nv+T8
58-
```
59-
60-
and see for yourself! :)
61-
62-
### BaseCrack API
63-
64-
BaseCrack can now be used as a library! Just import the `BaseCrack()` class and call the `decode()` function.
65-
66-
See [**API**](https://github.com/mufeedvh/basecrack#api).
67-
68-
**What's new in v1.1:**
69-
70-
I heard your feature requests, now you can generate a wordlist/output with the decoded bases! :)
16+
## Table of Contents
17+
- [Features](#features)
18+
- [Supported Encoding Schemes](#supported-encoding-schemes)
19+
- [Installation](#installation)
20+
- [Usage](#usage)
21+
- [API](#api)
22+
- [Contribution](#contribution)
23+
- [License](#license)
24+
25+
## Features
26+
27+
- Decode multi-encoded bases of any pattern.
28+
- Decode bases in image EXIF data.
29+
- Decode bases on images with OCR detection.
30+
- Can decode multiple base encodings from a file.
31+
- Generate a wordlist/output with the decoded bases.
32+
- Predicts the type of encoding scheme.
7133

7234
## Supported Encoding Schemes
7335
- Base16
@@ -81,26 +43,16 @@ I heard your feature requests, now you can generate a wordlist/output with the d
8143
- Ascii85
8244
- Base91
8345
- Base92
84-
85-
## Main Features
86-
87-
- **Decode multi-encoded bases of any pattern.**
88-
- **Decode bases in image EXIF data.**
89-
- **Decode bases on images with OCR detection.**
90-
- Dan decode multiple base encodings from a file.
91-
- **Generate a wordlist/output with the decoded bases.**
92-
- Predicts the type of encoding scheme.
93-
94-
------------
46+
- [Base100](https://github.com/AdamNiederer/base100) ([#14](https://github.com/mufeedvh/basecrack/issues/14))
9547

9648
## Installation
9749

9850
$ git clone https://github.com/mufeedvh/basecrack.git
9951
$ cd basecrack
100-
$ pip install -r requirements.txt
101-
$ python basecrack.py -h
52+
$ pip3 install -r requirements.txt
53+
$ python3 basecrack.py -h
10254

103-
📝 **NOTE:** Python3 is recommended to use!
55+
**NOTE:** Python3 is recommended to use!
10456

10557
**Linux:**
10658

@@ -120,35 +72,35 @@ OCR Detection is implemented with [Tesseract](https://github.com/tesseract-ocr/t
12072

12173
**Tesseract Docs:** https://tesseract-ocr.github.io/
12274

123-
📝 **NOTE:** I haven't completely tested this tool on Windows so if you stumble upon any issues, please [open an issue](https://github.com/mufeedvh/basecrack/issues/new).
75+
**NOTE:** I haven't completely tested this tool on Windows so if you stumble upon any issues, please [open an issue](https://github.com/mufeedvh/basecrack/issues/new).
12476

12577
## Usage
12678

12779
Get a list of all the arguments:
12880

129-
python basecrack.py -h
81+
python3 basecrack.py -h
13082

13183
To decode a single base encoding from user input:
13284

133-
python basecrack.py
85+
python3 basecrack.py
13486

13587
To decode a single base encoding from argument **(-b/--base)**:
13688

137-
python basecrack.py -b SGVsbG8gV29ybGQh
89+
python3 basecrack.py -b SGVsbG8gV29ybGQh
13890

13991
To decode multiple base encodings from a file **(-f/--file)**:
14092

141-
python basecrack.py -f file.txt
93+
python3 basecrack.py -f file.txt
14294

14395
**Magic Mode:** To decode multi-encoded base of any pattern **(-m/--magic)**:
14496

145-
python basecrack.py --magic
97+
python3 basecrack.py --magic
14698

14799
To input an image for **EXIF/OCR** detection mode **(-i/--image)**:
148100

149-
python basecrack.py -i image.jpg (--exif/--ocr)
101+
python3 basecrack.py -i image.jpg (--exif/--ocr)
150102

151-
**EXIF Data Detection:** To decode bases in image EXIF data **(-e/--exif)**:
103+
**EXIF Data:** To decode bases in image EXIF data **(-e/--exif)**:
152104

153105
python basecrack.py -i image.jpg --exif
154106

@@ -159,6 +111,26 @@ To input an image for **EXIF/OCR** detection mode **(-i/--image)**:
159111
To generate a wordlist/output with the decoded bases **(-o/--output)**:
160112

161113
python basecrack.py -f file.txt -o output-wordlist.txt
114+
115+
## Magic Mode
116+
117+
Now you can **decode multi-encoded bases** of any pattern in a single shot.
118+
119+
Have you ever stumbled upon that one lame CTF challenge that gives you an encoded string which is just encoded over and over with Base64, Base91, Base85 and so on? Just give that to BaseCrack and you're done with it! ;)
120+
121+
Want to test it out? Just give it this input:
122+
123+
```
124+
IX(Fp@nNG6ef<,*TFE]IT^zdINAb9EVbp,e<u=O6nN)/u+MTnU;Fo#VvQ&cK;mLZI#Jbdook<O{W#+gY%ooe#6pTkTa.9YPU8Uc=pl9BhSM9%kISw2k:8..u/6F2BwNndPZ2o#7NHNP3g,HlZu><*[Nv+T8
125+
```
126+
127+
and see for yourself! :)
128+
129+
### BaseCrack API
130+
131+
BaseCrack can now be used as a library! Just import the `BaseCrack()` class and call the `decode()` function.
132+
133+
See [**API**](https://github.com/mufeedvh/basecrack#api).
162134

163135
## API
164136

@@ -192,26 +164,6 @@ Decoded String: spaghetti
192164
Encoding Scheme: Base64
193165
```
194166

195-
Time to integrate this into your automation tools! ;)
196-
197-
## Screenshots
198-
199-
## EXIF Data Detection 📸
200-
201-
![basecrack exif detection](https://raw.githubusercontent.com/mufeedvh/basecrack/master/assets/basecrack-exif-detection.png)
202-
203-
**Try It Yourself!**
204-
205-
python basecrack.py -i examples/exif-example.jpg --exif
206-
207-
## OCR Base Detection 🔎
208-
209-
![basecrack ocr detection](https://raw.githubusercontent.com/mufeedvh/basecrack/master/assets/basecrack-ocr-detection.png)
210-
211-
**Try It Yourself!**
212-
213-
python basecrack.py -i examples/ocr-example.jpg --ocr
214-
215167
## Contribution
216168

217169
Ways to contribute
@@ -221,7 +173,7 @@ Ways to contribute
221173
- Help me document the code
222174
- Spread the word
223175

224-
Before you open a PR, make sure everything's good with a Unit Test:
176+
Before you open a PR, make sure everything's good by running the tests:
225177

226178
**Unit Tests:** (Thanks [@FavasM](https://github.com/mufeedvh/basecrack/pull/8))
227179

@@ -233,10 +185,6 @@ Licensed under the MIT License, see <a href="https://github.com/mufeedvh/basecra
233185
## Liked the project?
234186
Support the author by buying him a coffee!
235187

236-
<a href="https://www.buymeacoffee.com/mufeedvh" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="51px" width="217px"></a>
237-
238-
------------
188+
<a href="https://www.buymeacoffee.com/mufeedvh" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-orange.png" alt="Buy Me A Coffee" height="45" width="170"></a>
239189

240-
***Support this project by starring ⭐, sharing 📲, and contributing 👩‍💻! :heart:***
241-
242-
------------
190+
---

0 commit comments

Comments
 (0)