Skip to content

Security: hmlendea/nucisearch

SECURITY.md

Security Policy

This document describes the security policy for NuciSearch, including supported versions, vulnerability reporting procedures, and disclosure expectations.

πŸ“‘ Table of Contents

πŸ›‘οΈ Supported Versions

Use this table to indicate which project versions currently receive security maintenance.

Version Distribution Channel Supported
Latest version GitHub Releases βœ…
Preceding versions Any distribution channel ❌

🚨 Reporting a Vulnerability

Please do not disclose suspected vulnerabilities publicly before maintainers have had an opportunity to validate and remediate them.

To report a vulnerability:

πŸ“Œ Scope

The subsequent report categories are in scope for this repository:

  • Search query routing and redirection logic
  • Geolocation IP lookup and country code resolution
  • OpenSearch descriptor generation and query handling
  • Query deobfuscation and pattern matching
  • Localisation and culture provider behaviour
  • Configuration and logging settings
  • Dependency injection and service lifetime management

The subsequent categories are out of scope unless explicitly stated to the contrary:

  • Third-party search engine behaviour or vulnerabilities
  • Browser integration issues outside OpenSearch specification
  • Infrastructure, hosting, or network-layer concerns
  • Operating system or .NET runtime vulnerabilities
  • Social engineering or phishing via search results

πŸ“’ Disclosure Policy

This project follows coordinated disclosure:

  1. Vulnerabilities are investigated privately.
  2. A remediation plan is prepared and validated.
  3. Public disclosure is published after a fix, mitigation, or agreed risk decision is available.
  4. Credit is attributed in accordance with reporter preference and project policy.

πŸ” Security Scan Workflow

The repository includes an automated security scan workflow (.github/workflows/security.yml) that runs on:

  • Push to master branch
  • Pull requests targeting master branch
  • Weekly schedule (Sundays at 00:00 UTC)

The workflow performs:

  1. Vulnerable package detection β€” dotnet list package --vulnerable --include-transitive scans all direct and transitive NuGet dependencies for known vulnerabilities.
  2. CodeQL static analysis β€” GitHub's CodeQL engine analyses the C# codebase for security issues, uploading results to GitHub Code Scanning (requires security-events: write permission).

Results are visible in the Security tab of the repository under Code scanning alerts.

There aren't any published security advisories