Welcome to Kapow!

If you can script it, you can HTTP it

What’s Kapow!

Think of that software that you need but only runs in the command line. Kapow! lets you wrap it into an HTTP API real easy.

Want to know more? Check the Quick Start Guide section for a longer explanation of what Kapow! does.

Authors

Kapow! is being developed by the BBVA-Labs Security team.

License

Kapow! is Open Source Software and available under the Apache 2 license.

Contributions

Contributions are of course welcome. See CONTRIBUTING or skim existing tickets to see where you could help out.

Contents

The Project

• Quick Start Guide
  • Scenario
  • Limitations and Constraints
  • The Desired Solution
  • Using Kapow!
• Security Concerns
  • Parameter Injection Attacks
  • Parameter Mangling Attacks
• Installing Kapow!
  • Download and Install a Binary
  • Install the package with go get
  • Include Kapow! in your Container Image

Tutorial

• Kapow! Tutorial
• Your First Day at Work
• Let’s Backup that Database!
• What have we done?
• We need to filter
• I Need my Report!
• Sharing the Stats

Usage Examples

• Working with pow Files
  • Starting Kapow! using a pow file
  • Load More Than One pow File
  • Writing Multiline pow Files
  • Keeping Things Tidy
• Managing Routes
  • Adding New Routes
  • Listing Routes
  • Deleting Routes
• Handling HTTP Requests
  • Add or Modify an HTTP Header
  • Upload Files
  • Sending HTTP error codes
  • How to redirect using HTTP
  • Manage Cookies
• Using JSON
  • Modify JSON by Using Shell Commands
• Shell Tricks
  • How to Execute Two Processes in Parallel
• Kapow! Behind a Reverse Proxy
  • Serving over HTTPS

Concepts

• Kapow! HTTP Interfaces
  • HTTP User Interface
  • HTTP Control Interface
  • HTTP Data Interface
• Philosophy
  • Single Static Binary
  • Shell Agnostic
  • Not a Silver Bullet
  • Interoperability over Performance
• Request Life Cycle
  • 1. request
  • 2. spawn
  • 3. kapow set /response/body banana
  • 4. exit
  • 5. response
• The Kapow! Resource Tree
  • Overview
  • Resources
• Route Matching
• Routes
  • Elements
  • Matching Algorithm

Indices and Tables

• Index
• Module Index
• Search Page