@0xlayout/sentinel-security

███████╗ ███████╗ ███╗   ██╗ ████████╗ ██╗ ███╗   ██╗ ███████╗ ██╗     
██╔════╝ ██╔════╝ ████╗  ██║ ╚══██╔══╝ ██║ ████╗  ██║ ██╔════╝ ██║     
███████╗ █████╗   ██╔██╗ ██║    ██║    ██║ ██╔██╗ ██║ █████╗   ██║     
╚════██║ ██╔══╝   ██║╚██╗██║    ██║    ██║ ██║╚██╗██║ ██╔══╝   ██║     
███████║ ███████╗ ██║ ╚████║    ██║    ██║ ██║ ╚████║ ███████╗ ███████╗
╚══════╝ ╚══════╝ ╚═╝  ╚═══╝    ██║    ╚═╝ ╚═╝  ╚═══╝ ╚══════╝ ╚══════╝

Prevent Code Leaks in Your Projects

Sentinel is an advanced secret scanning tool designed for developers, security engineers, and CI/CD pipelines. It helps prevent sensitive information, credentials, and API keys from leaking into public repositories or production environments by scanning codebases before deployment.

This documentation covers installation, usage, configuration, advanced features, reporting, examples, integration into pipelines, best practices, troubleshooting, and contributing guidelines.

---

Table of Contents

1. Features
2. Installation
3. Usage
4. Options
5. Architecture
6. Scanners
7. Advanced Examples
8. Configuration & Customization
9. Reporting
10. CI/CD Integration
11. Best Practices
12. Troubleshooting & FAQ
13. Contributing
14. License

---

Features

---

Installation

Install the package from npm:

npm install -g @0xlayout/sentinel-security

[!NOTE] The -g flag makes the sentinel CLI available globally.

Locally:

Clone the repository and install dependencies:

git clone https://github.com/0xlayout/sentinel.git
cd sentinel
npm install
npm link

Run the CLI:

npm link
sentinel <command>

Or:

node bin/sentinel.js <command>

Important: Before scanning, remove or ignore folders that do not contain source code or sensitive information to improve scan speed and reduce false positives:

• .git
• assets
• node_modules (unless scanning dependencies is desired)
• dist / build / other auto-generated folders

---

Usage

Basic Scan (Fast)

sentinel /path/to/project --fast

• Performs a fast scan using only regex rules.
• Outputs results to Terminal.

Deep Scan (Full)

sentinel /path/to/project --deep --json --html

• Runs Regex, Entropy, and Heuristic scans.
• Generates structured JSON and human-readable HTML reports.
• Suitable for CI/CD and security audits.

Ignore Specific Directories

sentinel /path/to/project --deep --ignore node_modules dist test

• Excludes specific directories from scanning.
• Useful for large projects or third-party dependencies.

---

Options

---

Architecture

Sentinel is modular and consists of the following components:

1. File Loader

   • Recursively loads files from the target directory.
   • Filters out ignored paths.
   • Supports large codebases efficiently.

2. Scanners

   • RegexScanner: Matches secrets with predefined and custom rules.
   • EntropyScanner: Detects high-entropy strings.
   • HeuristicScanner: Detects suspicious keywords and insecure patterns.

3. Deduplication

   • Ensures each secret is reported only once.
   • Uses a combination of file path, line number, and matched content.

4. Reporting

   • Terminal output for quick review.
   • JSON for CI/CD consumption.
   • HTML for visual, human-readable reports.

---

Scanners Details

Regex Scanner

• Detects patterns of known secrets like API keys, tokens, and credentials.
• Supports custom JSON-based rules.
• High performance, suitable for large codebases.

Entropy Scanner

• Measures Shannon entropy of strings.
• Flags strings with unusually high entropy as potential secrets.
• Ideal for passwords, encryption keys, and API secrets.

Heuristic Scanner

• Scans for keywords such as password, secret, token, apikey.
• Detects suspicious patterns and commented-out secrets.

---

Advanced Examples

---

Configuration & Customization

1. Adding Custom Rules

   • Create a .json file in src/scanners/providerRules/.
   • Each rule must have a name and pattern (regex).

2. Excluding Files/Folders

   • Use --ignore option to skip irrelevant directories.
   • Recommended: .git, assets, node_modules, dist.

3. Adjusting Scan Depth

   • --fast: Only regex, minimal processing.
   • --deep: Full scan, including entropy and heuristics.

---

Reporting

• Terminal: Quick overview for development.
• JSON: Structured, ideal for pipelines. Includes file, line, type, and matched value.
• HTML: Human-readable report with color-coded severity and summary statistics.

Example JSON Entry:

{
  "file": "src/config.js",
  "line": 12,
  "type": "AWS_SECRET_KEY",
  "match": "AKIA************"
}

---

CI/CD Integration

• GitHub Actions: Automatically scan on push or pull request. Upload artifacts.
• GitLab CI: Use script section to run Sentinel and store reports as artifacts.
• Jenkins: Include node build step with npm install and run sentinel.js.

Best Practice: Integrate into pre-deploy or pre-merge pipelines to prevent secrets from entering production.

---

Best Practices

• Exclude .git, node_modules, and generated folders to reduce false positives.
• Regularly update provider rules.
• Run deep scans before production deployment.
• Use custom rules for internal APIs or unique token patterns.
• Combine JSON reports with automated alerting in pipelines.

---

Troubleshooting & FAQ

Q: Some files are not scanned. A: Ensure they are not ignored via --ignore and check file permissions.

Q: False positives detected. A: Review the rules in src/scanners/providerRules/ and refine regex patterns.

Q: Scan takes too long. A: Use --fast or exclude large directories like node_modules.

---

Contributing

Sentinel is open-source. Contributions welcome:

• Add or improve provider rules (src/scanners/providerRules/*.json).
• Enhance scanner performance or add new strategies.
• Fix bugs, improve tests, or enhance documentation.

---

License

This project is licensed under the MIT License.

You are free to use, modify, distribute, and integrate this software in both
open-source and commercial projects — as long as you include the copyright notice below.

---