Skip to content

flask-secret

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

flask-secret

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
.gitignore
.gitignore
 
 
README.md
README.md
 
 
keploy.yml
keploy.yml
 
 
main.py
main.py
 
 
requirements.txt
requirements.txt
 
 
temp_main.py
temp_main.py
 
 

README.md

Flask Secret Generator API

This application is a Flask-based API that generates synthetic secrets and API keys for testing purposes. It provides deterministic secret generation across multiple endpoints, making it perfect for testing secret scanning tools like GitLeaks and other security scanners.

Table of Contents

Introduction

🔐 Dive into the world of synthetic secret generation and see how seamlessly Keploy integrates with Flask for API testing. This application generates realistic-looking secrets for various cloud providers and services in a deterministic way, making it perfect for security testing workflows! 🎢

Pre-Requisites 🛠️

  • Python 3.7+ installed on your system
  • pip (Python package installer)
  • Install WSL (wsl --install) for Windows Windows.

Optional 🛠️

  • Install Colima( brew install colima && colima start ) for MacOS MacOS.

Installation 📥

Install Dependencies

First, navigate to the project directory and setup python virtual environment

python3 -m venv venv
source venv/bin/activate

Install the required Python packages:

pip install -r requirements.txt

Install Keploy

 curl --silent -O -L https://keploy.io/install.sh && source install.sh

Running the Application 🚀

Start the Flask application:

python main.py

The server will start on http://localhost:8000

API Endpoints 📡

The application provides the following endpoints:

Health Check

curl -s http://localhost:8000/health

Secret Generation Endpoints

Get secrets from /secret1:

curl -s http://localhost:8000/secret1

Get secrets from /secret2:

curl -s http://localhost:8000/secret2

Get secrets from /secret3:

curl -s http://localhost:8000/secret3

Each endpoint returns a deeply nested JSON payload containing various types of synthetic secrets including:

  • AWS Access Keys and Secret Keys
  • GitHub Personal Access Tokens
  • Slack Webhook URLs
  • Stripe Live Keys
  • Google API Keys
  • MongoDB URIs
  • PostgreSQL URLs
  • And many more...

Testing with Keploy 🧪

Lights, Camera, Record! 🎥

Capture test cases by recording API interactions:

keploy record -c "python main.py"

Generate Test Cases

Make some API calls to generate test cases. You can use curl, Postman, or any HTTP client:

Make GET requests to all secret endpoints:

curl -s http://localhost:8000/secret1
curl -s http://localhost:8000/secret2  
curl -s http://localhost:8000/secret3

You will now see a folder named keploy with your recorded tests.

Run Tests

Execute the recorded tests:

keploy test -c "python main.py"

Features ✨

  • Deterministic Generation: All secrets are generated deterministically using fixed seeds
  • Realistic Format: Secrets follow the actual format patterns of real services
  • Multiple Providers: Supports AWS, GitHub, Slack, Stripe, Google, MongoDB, PostgreSQL, and more
  • Nested Payloads: Returns complex, deeply nested JSON structures
  • Testing Ready: Perfect for security scanner testing and API testing workflows

Wrapping it up 🎉

Congrats on exploring the Flask Secret Generator API! You've seen how Keploy can seamlessly integrate with Flask applications for comprehensive API testing. This tool is perfect for testing secret scanning tools and security workflows without exposing real credentials.

Happy coding! ✨👩‍💻👨‍💻✨