@01a/git-sentinel

Git Sentinel

Git Sentinel is a powerful security scanner designed to analyze Git repositories for malicious code patterns, BiDi (bidirectional) attacks, and obfuscated malware. It helps developers and security researchers safely inspect untrusted repositories before running scripts or including them in their projects.

Features

• Repository Scanning: Scan local directories or remote Git repositories by URL.
• BiDi Attack Detection: Identifies Unicode control characters (BiDi) that can visually reorder code logic to hide malicious intent.
• Pattern Matching: Uses a robust set of predefined rules to detect reverse shells, persistence mechanisms, dropper behaviors, and obfuscation.
• Custom Rules: Extend the scanner with your own JSON-based rule sets.
• Isolated Sandbox: Safely execute repository scripts (like ./configure or install scripts) in an isolated, non-networked Docker container.
• Suspicious Filename Detection: Flags files with names like ... or . commonly used by malware.
• Obfuscation Detection: Identifies excessively long lines and common obfuscation techniques (Base64 eval, character concatenation).

Installation

Prerequisites

• Node.js (v16 or higher)
• Docker (required for sandbox execution)
• Git

Setup

1. Clone this repository:

   git clone https://github.com/youruser/git-sentinel.git
   cd git-sentinel
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

Usage

The easiest way to run Git Sentinel is with npx:

npx @01a/git-sentinel scan <url-or-path> [options]

Or you can run it directly using npm start after cloning the repository.

Self-Scanning Example

You can try scanning this repository itself to see Git Sentinel in action:

npx @01a/git-sentinel scan git@github.com:eknowlton/git-sentinel.git

Options

Example with Sandbox

To scan a repository and safely test its install.sh script:

npm start -- scan https://github.com/example/repo.git -s ./install.sh

Custom Rules

Custom rules are JSON files containing an array of rule objects.

Example custom-rules/my-rules.json:

[
  {
    "pattern": "rm -rf /",
    "description": "Attempted destruction of the root directory",
    "severity": "critical"
  }
]

Run with custom rules:

npm start -- scan ./target-repo -r ./custom-rules

How the Sandbox Works

The sandbox uses Docker to create an isolated environment with the following constraints:

• No Network: The container has no internet access (--network none).
• Read-Only Mount: The repository is mounted as read-only at /repo.
• Resource Limits: Limited to 512MB RAM and 0.5 CPU core.
• Non-Privileged User: Scripts run as a restricted sentinel user.
• Base Image: Uses a lightweight Alpine Linux image with bash, python3, and coreutils pre-installed.

Disclaimer and Limitation of Liability

Git Sentinel is provided "as is", without warranty of any kind, express or implied.

The authors and contributors of this project:

• Do not guarantee the detection of all malicious patterns or security threats.
• Are not responsible for any damage to your system, data loss, or security breaches that may occur while using this tool or as a result of relying on its findings.
• Do not endorse or guarantee the safety of any repository scanned by this tool, even if no issues are found.

Security scanning is an inherently complex task. This tool should be used as part of a broader security strategy and not as a sole source of truth. Use at your own risk.

License

ISC License. See package.json for details.