Yaraflux

🚀 Yara Project Documentation

Yara is a powerful tool for threat detection. It provides flexible installation methods, rich configuration options, and a complete development and deployment workflow to help users quickly detect and handle threats.

🚀 Quick Start

Installation Steps

1. Clone the repository:

   git clone https://github.com/ThreatFlux/Yara.git
   cd Yara
   

2. Install dependencies:

   • Use the Makefile automation script for installation:

     make install
     

   • Or install manually:

     pip install -r requirements.txt
     

3. Run the application:

   python run.py
   

Basic Usage

from yara import YaraScanner

scanner = YaraScanner()
result = scanner.scan_file("target.exe")
print(result)

✨ Features

• Flexible Configuration: Support different log levels and storage backends.
• Complete Workflow: Include build, test, and deployment stages.
• Contribution Friendly: Provide clear contribution guidelines.

📦 Installation

The installation steps are as described in the "Quick Start" section.

💻 Usage Examples

Basic Usage

from yara import YaraScanner

scanner = YaraScanner()
result = scanner.scan_file("target.exe")
print(result)

Advanced Usage

from yara import YaraScanner

scanner = YaraScanner()
scan_result = scanner.scan_memory(b"some bytes")
print(f"Detected threats: {scan_result.detected_threats}")

📚 Documentation

Configuration Options

• Log Level:

  • Debug mode: DEBUG
  • Development mode: INFO
  • Production environment: WARNING, ERROR, or CRITICAL

• Storage Backend:

  • Local file system: Default configuration
  • MinIO/S3 storage: Additional access information is required.

Workflow

• Build Phase:

  make build
  

  Generate executable files and Docker images.

• Test Phase:

  make test
  

  Execute unit tests and integration tests.

• Deployment Phase:

  • Use Docker for deployment:

    docker-compose up --build
    

Development Information

Local Development

make dev-setup

Run the development server:

make run-dev

CI/CD Pipeline

• Test Pipeline:

  • Automatically executed on the main and develop branches.
  • Include code format checking, static analysis, and unit tests.

• Version Release:

  make release
  

  Automatically increment the version number and generate release notes.

Status Check

• Format Check: Ensure the code complies with Black and isort format specifications.
• Code Quality: Perform lint checks to ensure code standards.
• Test Coverage: Meet the preset test coverage requirements.

API Documentation

• Swagger UI: Visit http://localhost:8000/docs
• ReDoc: Visit http://localhost:8000/redoc
• For detailed documentation, please refer to API Reference

Contribution Guidelines

Welcome to contribute! Please follow the steps below to submit your code:

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes and generate a commit message.
4. Push the branch to the remote repository.
5. Submit a Pull Request.

🔧 Technical Details

• The project uses Makefile for automation scripts to simplify the build, test, and deployment processes.
• Docker and Docker Compose are used for containerization and deployment.
• The CI/CD pipeline ensures code quality and automates the release process.

📄 License

This project is licensed under the MIT License. For details, please see the LICENSE file.

Support and Donation

• Patreon: To support the author, please visit Patreon Link
• PayPal: Donate to email@example.com