Metadata-Version: 2.2
Name: ctscan
Version: 0.3
Summary: A python library to scan your code for vulnerabilities.
Author: Aswin Venkat
Author-email: aspm@securin.io
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.md
Requires-Dist: requests>=2.32.3
Requires-Dist: boto3>=1.34.25
Requires-Dist: botocore>=1.34.25
Requires-Dist: pycryptodome>=3.10.1
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# 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:

```bash
pip install ctscan
```

## Usage

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

```bash
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

```bash
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
