Skip to main content

API Security Testing Tool

Project description

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.

Project details


Release history Release notifications | RSS feed

This version

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

apisec-1.0.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

apisec-1.0-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file apisec-1.0.tar.gz.

File metadata

  • Download URL: apisec-1.0.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for apisec-1.0.tar.gz
Algorithm Hash digest
SHA256 29cf7b5ca6fb26ddb52a55d5008cb4416e3459e65601973feea5023076859668
MD5 e3bf6685d030b8da222857410bdcdef5
BLAKE2b-256 81006da90d7659c32a2d5ccb5eabbac9bcfdfd854eed9c19f0f37f602a7501c3

See more details on using hashes here.

File details

Details for the file apisec-1.0-py3-none-any.whl.

File metadata

  • Download URL: apisec-1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for apisec-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7dd03ed31bb96c5c5f4cb372880347f391d08085152674fb12ec33c372efec9d
MD5 1e433d09ff06c149e2f663900655729f
BLAKE2b-256 59bc0a968fd89ddbc32f893eea944e8e2416d0b95a34cfc3d15dfcf34eb4bc5d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page