Skip to main content

A python library to scan your code for vulnerabilities.

Project description

CTScan Code Scanner

CTScan Code Scanner is a Python-based tool designed to download and execute a CLI from AWS S3, decrypt necessary credentials, and perform code scanning operations. This tool is intended to be used as a command-line utility.

Features

  • Download CLI executable from AWS S3
  • Decrypt AWS credentials using AES encryption
  • Perform code scanning with various configurable options
  • Output results in different formats

Installation

To install the package, use the following command:

pip install ctscan

Usage

To use the ctscan Code Scanner, run the following command:

python -m ctscan --api_key YOUR_API_KEY [options]

Command-Line Arguments

  • --api_key (required): API key for authentication
  • --app_id: Application ID
  • --app_name: Application name
  • --branch_name: Branch name (default: 'default')
  • --enable_color: Enable color in report
  • --format: Output format
  • --is_console_report: Enable console report (default: True)
  • --is_debug: Enable debug logs
  • --output_file: Output file path
  • --scan_types: Types of scans to be triggered
  • --severity: Severity level
  • --skip_build_fail: Skip build fail
  • --source_dir: Source directory (default: current working directory)
  • --version: CLI version to use
  • --hostname: API endpoint hostname (default: custom-endpoint.yourdomain.io)

Example

python -m ctscan --api_key YOUR_API_KEY --app_name MyApp --branch_name main --format json --output_file results.json

License

This project is licensed under the MIT License.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

Contact

For any inquiries, please contact the project maintainers. aspm@securin.io

Project details


Download files

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

Source Distribution

ctscan-0.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ctscan-0.1-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file ctscan-0.1.tar.gz.

File metadata

  • Download URL: ctscan-0.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ctscan-0.1.tar.gz
Algorithm Hash digest
SHA256 d8a62ecbb5f5a917ced4e12e6aa20773166ac328fe24c4361045bd9c752cccab
MD5 957f0294d7275ecf185e163ced8ed3f0
BLAKE2b-256 e7e20fa4e8c62c6db22b73aae89c638bb2e1ac407f72ae8353fc2cad0ea276d1

See more details on using hashes here.

File details

Details for the file ctscan-0.1-py3-none-any.whl.

File metadata

  • Download URL: ctscan-0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ctscan-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8a2079e478811b8bbb49e66d74867ea82ff818e3e3a9e567a591f69942ae6396
MD5 b5788d8c739c2500ba018f87a4c2c413
BLAKE2b-256 7396f7b2945cd24c2f7c64ea02c454c1214286975489485bd7778434feffd012

See more details on using hashes here.

Supported by

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