Skip to content

Commit 3977769

Browse files
authored
Update README.md
1 parent 7e2235a commit 3977769

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,37 @@
1-
# padding_oracle.py
1+
# Padding Oracle Python Automation Script
22

33
![python-package-badge](https://github.com/djosix/padding_oracle.py/actions/workflows/python-package.yml/badge.svg)
44

5-
Fast threaded [padding oracle](https://en.wikipedia.org/wiki/Padding_oracle_attack) attack automation script for Python 3.
5+
The padding_oracle.py is a highly efficient, threaded [padding oracle](https://en.wikipedia.org/wiki/Padding_oracle_attack) attack automation script, specifically developed for Python 3.
66

7-
## Install
7+
## Installation
88

9-
PyPI:
9+
You can install the package using either PyPI or directly from GitHub:
1010

11+
**Via PyPI:**
1112
```shell
1213
pip3 install -U padding_oracle
1314
```
1415

15-
GitHub:
16-
16+
**Via GitHub:**
1717
```shell
1818
pip3 install -U git+https://github.com/djosix/padding_oracle.py.git
1919
```
2020

21-
## Performance
21+
## Performance Metrics
2222

23-
Tested on [0x09] Cathub Party from EDU-CTF:
23+
Performance of padding_oracle.py was evaluated using [0x09] Cathub Party from EDU-CTF:
2424

25-
| Request Threads | Execution Time |
25+
| Number of Request Threads | Time Taken |
2626
|-----------------|----------------|
2727
| 1 | 17m 43s |
2828
| 4 | 5m 23s |
2929
| 16 | 1m 20s |
3030
| 64 | 56s |
3131

32-
## Usage
32+
## How to Use
3333

34-
E.g. testing `https://vulnerable.website/api/?token=M9I2K9mZxzRUvyMkFRebeQzrCaMta83eAE72lMxzg94%3D`:
34+
To illustrate the usage, consider an example of testing `https://vulnerable.website/api/?token=M9I2K9mZxzRUvyMkFRebeQzrCaMta83eAE72lMxzg94%3D`:
3535

3636
```python
3737
from padding_oracle import padding_oracle, base64_encode, base64_decode
@@ -64,7 +64,7 @@ plaintext = padding_oracle(
6464
)
6565
```
6666

67-
This package also provides PHP-like encoding/decoding functions:
67+
In addition, the package provides PHP-like encoding/decoding functions:
6868

6969
```python
7070
from padding_oracle.encoding import (
@@ -77,6 +77,6 @@ from padding_oracle.encoding import (
7777

7878
## License
7979

80-
This project is licensed under the terms of the MIT license.
80+
Padding Oracle Python Automation Script is distributed under the terms of the MIT license.
8181

8282
<!-- PiuPiuPiu -->

0 commit comments

Comments
 (0)