Skip to content

Commit 5e93d75

Browse files
darmadodarmado
committed
fixed wiki back links
1 parent 4280b2c commit 5e93d75

File tree

11 files changed

+601
-455
lines changed

11 files changed

+601
-455
lines changed

‎README.md

Lines changed: 71 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -14,101 +14,107 @@
1414
1515
Postman2Burp bridges the gap between API development and security testing by automatically sending Postman collection requests through Burp Suite proxy.
1616

17-
## 🔮 Assumptions
18-
19-
The user operates under the following assumptions:
20-
21-
| Assumption | Description |
22-
|------------|-------------|
23-
| 📁 Collection Location | User has exported a Postman collection to the `/collections` directory of this repository |
24-
| 🧩 Collection Format | The exported collection follows Postman Collection v2.1 format |
25-
| 🔄 Variable Usage | Collection may contain environment variables that need resolution |
26-
| 🌐 Proxy Availability | A proxy (like Burp Suite) is running and accessible |
27-
| 🔒 Authentication | Any required authentication tokens can be provided via environment variables |
28-
2917
## 📋 Table of Contents
3018

3119
- [Postman2Burp](#postman2burp)
32-
- [🔮 Assumptions](#-assumptions)
3320
- [📋 Table of Contents](#-table-of-contents)
3421
- [🎯 Purpose](#-purpose)
22+
- [🔮 Assumptions](#-assumptions)
3523
- [📦 Requirements](#-requirements)
3624
- [🚀 Quick Start](#-quick-start)
3725
- [✨ Features](#-features)
26+
- [🎯 Use Cases](#-use-cases)
3827
- [⚠️ Limitations](#️-limitations)
3928
- [📚 Documentation](#-documentation)
4029
- [📜 License](#-license)
4130
- [👥 Contributing](#-contributing)
42-
- [Code Style](#code-style)
43-
- [Bug Reports](#bug-reports)
44-
- [Feature Requests](#feature-requests)
4531

4632
## 🎯 Purpose
4733

48-
To automate API security testing by:
34+
| Problem | Solution |
35+
|---------|----------|
36+
| Manual recreation of API requests in security tools is time-consuming and error-prone | Postman2Burp automates sending Postman collection requests through Burp Suite proxy |
37+
| Complex API flows are difficult to test manually | Maintains request sequence and handles variable extraction/substitution automatically |
38+
| Environment variables need manual substitution | Automatically resolves all environment variables from profile files |
39+
| Authentication flows require careful token management | Extracts and reuses tokens across requests in the correct sequence |
4940

50-
| Step | Description |
51-
|------|-------------|
52-
| 1️⃣ | Reading Postman collection JSON files |
53-
| 2️⃣ | Parsing all requests (including nested folders) |
54-
| 3️⃣ | Resolving environment variables |
55-
| 4️⃣ | Sending requests through Burp Suite proxy |
56-
| 5️⃣ | Logging results |
41+
## 🔮 Assumptions
5742

58-
## 📦 Requirements
43+
The tool operates under the following assumptions:
5944

60-
- Python 3.6+
61-
- Required packages (auto-installed):
62-
- requests
63-
- urllib3
64-
- python-dotenv
45+
| Assumption | Description |
46+
|------------|-------------|
47+
| 📁 Collection Location | User has exported a Postman collection to the `/collections` directory of this repository |
48+
| 🧩 Collection Format | The exported collection follows Postman Collection v2.1 format |
49+
| 🔄 Variable Usage | Collection may contain environment variables that need resolution |
50+
| 🌐 Proxy Availability | A proxy (like Burp Suite) is running and accessible |
51+
| 🔒 Authentication | Any required authentication tokens can be provided via environment variables |
6552

66-
## 🚀 Quick Start
53+
## 📦 Requirements
6754

68-
```bash
69-
# Clone the repository
70-
git clone https://github.com/darmado/postman2burp.git
71-
cd postman2burp
55+
| Requirement | Details |
56+
|-------------|---------|
57+
| **Python** | 3.6 or higher |
58+
| **Packages** | Auto-installed via setup script:<br>• requests<br>• urllib3<br>• python-dotenv |
59+
| **Operating System** | Windows, macOS, or Linux |
7260

73-
# Set up the environment
74-
chmod +x setup_venv.sh
75-
./setup_venv.sh
61+
## 🚀 Quick Start
7662

77-
# Run the tool
78-
python postman2burp.py --collection "your_collection.json"
79-
```
63+
| Step | Command |
64+
|------|---------|
65+
| 1. Clone the repository | `git clone https://github.com/darmado/postman2burp.git`<br>`cd postman2burp` |
66+
| 2. Set up the environment | `chmod +x setup_venv.sh`<br>`./setup_venv.sh` |
67+
| 3. Run the tool | `python postman2burp.py --collection "your_collection.json"` |
8068

8169
For detailed usage instructions, see the [Wiki](https://github.com/darmado/postman2burp/wiki).
8270

8371
## ✨ Features
8472

85-
| Feature | Description |
86-
|---------|-------------|
87-
| 🔍 Proxy Auto-detection | Automatically detects running proxies on common ports |
88-
| 📁 Nested Folders | Handles nested folders in collections |
89-
| 🔄 Environment Variables | Supports environment variables |
90-
| 📝 Multiple Body Types | Processes multiple request body types |
91-
| 🔐 Authentication | Handles authentication headers |
92-
| 📊 Logging | Logs request results |
93-
| 🔍 Proxy Verification | Verifies proxy before sending requests |
94-
| ⚙️ Configuration File | Stores settings in config.json |
95-
| 🔑 Variable Extraction | Extracts variables from collections to create environment templates |
73+
| Feature | Description | Benefit |
74+
|---------|-------------|---------|
75+
| 🔍 Proxy Auto-detection | Automatically detects running proxies on common ports | No manual proxy configuration needed |
76+
| 📁 Nested Folders | Handles nested folders in collections | Works with complex collection structures |
77+
| 🔄 Environment Variables | Supports environment variables | Reuse collections across different environments |
78+
| 📝 Multiple Body Types | Processes multiple request body types | Works with JSON, form data, raw text, etc. |
79+
| 🔐 Authentication | Handles authentication headers | Maintains security context across requests |
80+
| 📊 Logging | Logs request results | Easy troubleshooting and verification |
81+
| 🔍 Proxy Verification | Verifies proxy before sending requests | Prevents failed test runs |
82+
| ⚙️ Configuration File | Stores settings in config.json | Reuse configurations across runs |
83+
| 🔑 Variable Extraction | Extracts variables from collections | Easily create environment templates |
84+
85+
## 🎯 Use Cases
86+
87+
| Problem | Solution | Example Command | Details |
88+
|---------|----------|-----------------|---------|
89+
| **OAuth2 Flows**: Multiple sequential requests with token extraction and reuse | Maintains request sequence and handles token extraction automatically | `python postman2burp.py --collection "oauth_flow.json" --target-profile "oauth_creds.json" --verbose` | [View Details](https://github.com/darmado/postman2burp/wiki/Use-Cases#oauth2-flow-analysis) |
90+
| **GraphQL Queries**: Complex nested queries difficult to recreate manually | Preserves exact query structure and variables | `python postman2burp.py --collection "graphql_api.json" --target-profile "graphql_vars.json"` | [View Details](https://github.com/darmado/postman2burp/wiki/Use-Cases#graphql-api-security-testing) |
91+
| **Anti-CSRF Protection**: Tokens from responses must be included in subsequent requests | Extracts tokens from responses and applies them to follow-up requests | `python postman2burp.py --collection "secured_workflow.json" --target-profile "test_env.json" --verbose` | [View Details](https://github.com/darmado/postman2burp/wiki/Use-Cases#anti-csrf-protection-testing) |
92+
| **BOLA/IDOR Testing**: Requires different user contexts for the same endpoints | Allows running the same collection with different profile files | `python postman2burp.py --collection "user_management.json" --target-profile "admin_profile.json" --output "admin_results.json"` | [View Details](https://github.com/darmado/postman2burp/wiki/Use-Cases#broken-object-level-authorization-testing) |
93+
| **API Gateway Configurations**: Specific headers, API keys, and request signing | Maintains all headers and authentication mechanisms | `python postman2burp.py --collection "aws_api.json" --target-profile "aws_creds.json"` | [View Details](https://github.com/darmado/postman2burp/wiki/Use-Cases#api-gateway-configuration-testing) |
94+
95+
For complete examples with code samples and technical details, see our [Use Cases Documentation](https://github.com/darmado/postman2burp/wiki/Use-Cases).
9696

9797
## ⚠️ Limitations
9898

99-
- Limited support for file uploads in multipart/form-data
100-
- No support for WebSocket requests
101-
- No execution of Postman pre-request and test scripts
99+
| Limitation | Description | Workaround |
100+
|------------|-------------|------------|
101+
| File Uploads | Limited support for multipart/form-data file uploads | Use simple file uploads with base64-encoded content |
102+
| WebSocket Requests | No support for WebSocket requests | Use separate WebSocket testing tools |
103+
| Pre-request Scripts | No execution of Postman pre-request scripts | Manually implement required functionality in your environment |
102104

103105
## 📚 Documentation
104106

105107
Comprehensive documentation is available in the [Wiki](https://github.com/darmado/postman2burp/wiki):
106108

107-
- [Installation Guide](https://github.com/darmado/postman2burp/wiki/Installation)
108-
- [Usage Guide](https://github.com/darmado/postman2burp/wiki/Usage)
109-
- [Advanced Usage](https://github.com/darmado/postman2burp/wiki/Advanced)
110-
- [Configuration Options](https://github.com/darmado/postman2burp/wiki/Configuration)
111-
- [Troubleshooting](https://github.com/darmado/postman2burp/wiki/Troubleshooting)
109+
| Documentation | Description |
110+
|---------------|-------------|
111+
| [Overview](https://github.com/darmado/postman2burp/wiki/Overview) | High-level understanding of Postman2Burp |
112+
| [Installation](https://github.com/darmado/postman2burp/wiki/Installation) | How to install and set up the tool |
113+
| [Usage](https://github.com/darmado/postman2burp/wiki/Usage) | Basic operations and commands |
114+
| [Use Cases](https://github.com/darmado/postman2burp/wiki/Use-Cases) | Detailed examples for specific scenarios |
115+
| [Additional Features](https://github.com/darmado/postman2burp/wiki/Features) | Extended features and techniques |
116+
| [Configuration](https://github.com/darmado/postman2burp/wiki/Configuration) | Configuration options and settings |
117+
| [Troubleshooting](https://github.com/darmado/postman2burp/wiki/Troubleshooting) | Solutions for common issues |
112118

113119
## 📜 License
114120

@@ -124,25 +130,8 @@ Contributions are welcome! Here's how you can contribute:
124130
4. Push to the branch (`git push origin feature/amazing-feature`)
125131
5. Open a Pull Request
126132

127-
### Code Style
128-
129-
- Follow PEP 8 guidelines for Python code
130-
- Use descriptive variable names
131-
- Add comments for complex logic
132-
- Write tests for new features
133-
134-
### Bug Reports
135-
136-
If you find a bug, please open an issue with:
137-
- Clear description of the bug
138-
- Steps to reproduce
139-
- Expected behavior
140-
- Screenshots (if applicable)
141-
- Environment details
142-
143-
### Feature Requests
144-
145-
Have an idea for a new feature? Open an issue describing:
146-
- The problem your feature would solve
147-
- How your solution would work
148-
- Any alternatives you've considered
133+
| Contribution Area | Guidelines |
134+
|-------------------|------------|
135+
| **Code Style** | • Follow PEP 8 guidelines for Python code<br>• Use descriptive variable names<br>• Add comments for complex logic<br>• Write tests for new features |
136+
| **Bug Reports** | • Clear description of the bug<br>• Steps to reproduce<br>• Expected behavior<br>• Screenshots (if applicable)<br>• Environment details |
137+
| **Feature Requests** | • The problem your feature would solve<br>• How your solution would work<br>• Any alternatives you've considered |

‎Wiki/Advanced/README.md

Lines changed: 0 additions & 126 deletions
This file was deleted.

0 commit comments

Comments
 (0)