SentraSec Scanner

⚠️ Alpha Release: This package is currently in early testing phase. Features and APIs may change. Use with caution in production environments.

Official CLI tool for the SentraSec Platform - Performs Software Composition Analysis (SCA) scans to identify security vulnerabilities in your project dependencies.

Note: This package requires an active SentraSec platform account. Sign up at https://sentrasec.ai to get started.

📋 Table of Contents

• Features
• Installation
• Quick Start
• Usage
• Supported Languages
• Commands
• Requirements
• Troubleshooting
• License
• Support

✨ Features

• SentraSec Platform Integration: Official CLI tool for the SentraSec security platform
• Software Composition Analysis (SCA): Comprehensive dependency vulnerability scanning
• Automated Dependency Detection: Automatically detects and scans project dependencies
• Multi-Language Support: Currently supports Node.js and Python projects
• Centralized Dashboard: View detailed scan results on the SentraSec platform dashboard
• CI/CD Ready: Simple command-line interface for easy integration into your pipelines
• Zero Configuration: Automatic project type detection

📦 Installation

Prerequisites

• SentraSec Platform Account: Sign up at https://sentrasec.ai
• Node.js: Version 14.x or higher
• Package Manager: npm or yarn

Install via npm

npm install -g @sentrasec/scanner

Install via yarn

yarn global add @sentrasec/scanner

Verify Installation

sentrasec-scan --version
# or
ss-scan --version

You should see version 1.0.0 displayed.

🚀 Quick Start

1. Create a SentraSec Platform Account

   • Sign up at https://sentrasec.ai
   • Access your dashboard

2. Get Your Credentials

   • Create a new application in the SentraSec platform
   • Copy your Application ID and API Key from the dashboard

3. Install the Scanner

   npm install -g @sentrasec/scanner

4. Run Your First SCA Scan

   Navigate to your project directory and run:

   sentrasec-scan sca <YOUR_APP_ID> <YOUR_API_KEY>

5. View Results on SentraSec Platform

   • Scan results are automatically uploaded to the SentraSec platform
   • Login to your dashboard to view detailed vulnerability reports and remediation guidance

📖 Usage

Basic Syntax

sentrasec-scan <command> [arguments]

Both sentrasec-scan and ss-scan commands are available as aliases.

Example: Scan a Node.js Project

cd /path/to/your/nodejs-project
sentrasec-scan sca app_12345 sk_1234567890abcdef

Example: Scan a Python Project

cd /path/to/your/python-project
sentrasec-scan sca app_12345 sk_1234567890abcdef

🌍 Supported Languages

Currently Supported ✅

Node.js / JavaScript

• Files Detected: package.json
• Dependency Types:
  • Production dependencies (dependencies)
  • Development dependencies (devDependencies)
  • Peer dependencies (peerDependencies)

Python

• Files Detected: requirements.txt
• Supported Formats:
  • package==1.0.0 (exact version)
  • package>=1.0.0 (minimum version)
  • package~=1.0.0 (compatible version)
  • package (any version)

Planned Support 📋

The following languages are planned for future releases:

• Java (Maven, Gradle)
• .NET / C#
• Go
• Ruby
• PHP
• Rust
• Swift

See SUPPORTED_LANGUAGES.md for detailed language support roadmap.

💻 Commands

sca (Recommended)

Performs a Software Composition Analysis (SCA) scan and uploads results to the SentraSec platform.

sentrasec-scan sca <app_id> <api_key>

Arguments:

• app_id (required): Your application ID from the SentraSec platform dashboard
• api_key (required): Your API key for authentication

What it does:

1. Automatically detects your project type (Node.js or Python)
2. Scans all dependencies for known vulnerabilities
3. Uploads scan results to the SentraSec platform
4. Provides detailed vulnerability reports accessible via your dashboard

Example:

sentrasec-scan sca app_12345 sk_1234567890abcdef

scan (Legacy)

Legacy command for scanning dependencies locally.

sentrasec-scan scan <project_name> <key>

Arguments:

• project_name (required): Name of the project to scan
• key (required): Scan key for authentication

Example:

sentrasec-scan scan my-project legacy_key_123

Note: This command is deprecated. Please use the sca command for new integrations.

⚙️ Requirements

System Requirements

• Operating System: Linux, macOS, or Windows
• Node.js: Version 14.x or higher
• Network: Internet connection required for vulnerability database access

Project Requirements

Your project must contain one of the following dependency files:

• package.json (Node.js)
• requirements.txt (Python)

🔧 Troubleshooting

Command Not Found

If you receive a "command not found" error after installation:

# Check if the package is installed
npm list -g @sentrasec/scanner

# Reinstall the package
npm install -g @sentrasec/scanner

Authentication Errors

If you receive authentication errors:

• Verify your App ID and API Key are correct
• Ensure you're using the correct credentials from your dashboard
• Check that your API key hasn't expired

No Dependencies Detected

If the scanner doesn't detect your dependencies:

• Ensure package.json or requirements.txt exists in your project root
• Run the scan from your project's root directory
• Check that the dependency file is properly formatted

Network Errors

If you encounter network-related errors:

• Check your internet connection
• Verify that your firewall isn't blocking the connection
• Try running the scan again

📄 License

Copyright © 2025 SentraSec. All rights reserved.

This software is licensed under the ISC License.

📞 Support

Documentation

• SentraSec Platform
• Platform Documentation
• Language Support

Get Help

• Email: [email protected]
• Website: https://sentrasec.ai
• Platform Dashboard: Login to your account for support resources

🎯 Roadmap

Current Version (1.0.0-alpha)

• ✅ SentraSec platform integration
• ✅ SCA scanning for Node.js (package.json)
• ✅ SCA scanning for Python (requirements.txt)
• ✅ Automated vulnerability detection
• ✅ Dashboard-based reporting

Upcoming Features

• 🔄 Additional language support (Java, .NET, Go, Ruby, PHP)
• 🔄 Enhanced SCA capabilities
• 🔄 CI/CD integration templates
• 🔄 Custom security policy configuration
• 🔄 SBOM (Software Bill of Materials) generation
• 🔄 Advanced vulnerability remediation guidance

⚠️ Alpha Notice

This package is currently in alpha status and is undergoing early testing. Please be aware:

• Features and commands may change in future releases
• Some features may be incomplete or experimental
• Bug reports and feedback are highly appreciated
• Not recommended for production-critical workflows until stable release

We appreciate your patience and feedback as we work toward a stable release!

Built with ❤️ by the SentraSec Team