Skip to main content

API Security Testing Tool

This tool allows you to perform security scans on various types of APIs, including REST, SOAP, and GraphQL. It provides basic and advanced scans and integrates with Swagger for automated testing.

Features

  • Basic API Scan: Quickly scan a domain for common security vulnerabilities.
  • Advanced Endpoint Scan: Perform a more in-depth scan on specific API endpoints with custom headers.
  • Swagger Integration: Scan APIs using Swagger documentation (URL or file).
  • SOAP Endpoint Testing: Test SOAP APIs for security issues.
  • GraphQL Endpoint Testing: Scan GraphQL APIs to detect vulnerabilities.
  • Output: Save scan results in a JSON file for later analysis.

Installation

Method 1:

Install directly using pip from PyPi:

pip install apisec

Method 2:

Clone the repository and install the package using pip:

git clone https://github.com/yourusername/apisec-tool.git
cd apisec-tool
pip install .

Post Install

After installing apisec, run below command to install all dependecies and sync path variables.

apisec -i

Usage

REST API

  • Basic Scan: Perform a basic security scan on a domain:

    apisec -bs "<domain name>"
    
  • Advanced Scan: Perform an advanced scan on a specific API endpoint:

    apisec -ae "<API endpoint>" -ah "<headers in JSON format>"
    
  • Using Swagger JSON File: Scan APIs based on Swagger documentation:

    apisec -su "<API server url>" -sf "<url or path to swagger.json file>" 
    

SOAP API

  • SOAP Scan: Test a SOAP API by specifying its endpoint:

    apisec -s "<SOAP API endpoint>
    

GraphQL API

  • GraphQL Scan: Test a GraphQL API for security vulnerabilities:

    apisec -g "<GraphQL API endpoint>"
    

Saving Output

To save the scan results to a JSON file for later analysis, use the -o option:

apisec -bs "<domain name>" -o "scan_results.json"

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Metadata

Release files for apisec 1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apisec 1.0
File Size Uploaded
apisec-1.0.tar.gz 9.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for apisec 1.0
File Interpreter ABI Platform
apisec-1.0-py3-none-any.whl Python 3 none any Details

Total release size: 17.6 kB

Release files / apisec-1.0.tar.gz

Download URL apisec-1.0.tar.gz
Size 9.0 kB
Tags Source
SHA-256 checksum
How to use checksums
29cf7b5ca6fb26ddb52a55d5008cb4416e3459e65601973feea5023076859668
BLAKE2b-256 checksum
How to use checksums
81006da90d7659c32a2d5ccb5eabbac9bcfdfd854eed9c19f0f37f602a7501c3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.6

Release files / apisec-1.0-py3-none-any.whl

Download URL apisec-1.0-py3-none-any.whl
Size 8.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7dd03ed31bb96c5c5f4cb372880347f391d08085152674fb12ec33c372efec9d
BLAKE2b-256 checksum
How to use checksums
59bc0a968fd89ddbc32f893eea944e8e2416d0b95a34cfc3d15dfcf34eb4bc5d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.6

Release history Release notifications | RSS feed

This release

1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page