Skip to content

CHANGELOG.md

Latest commit

 

History

History
115 lines (93 loc) · 4.35 KB

CHANGELOG.md

File metadata and controls

115 lines (93 loc) · 4.35 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

  • Cleaner API (unicleaner::clean) — sanitize strings against malicious Unicode patterns. Returns CleanResult { output: Cow<str>, violations, modified }; the no-op fast path is zero-allocation.
    • CleanPolicy with three presets (strict, lossy, report_only), per-category overrides via with_action, and opt-in NFC normalization via with_nfc.
    • CleanAction variants: Strip, Replace(char), KeepWithMark.
    • Re-exported from the crate root: unicleaner::{clean, CleanPolicy, CleanResult, CleanAction}.
  • unicleaner clean CLI subcommand — sanitize a file or stdin to stdout (default) or atomically rewrite the file with --in-place. Honors --policy {strict|lossy|report-only}, --nfc, and the global --config flag (optional [cleaner] block). The subcommand currently takes a single path; multi-path mode is not yet supported.
  • Optional [cleaner] block in unicleaner.toml; documented in examples/unicleaner.toml.
  • Throughput benchmark (benches/clean_throughput.rs) and fuzz target (fuzz/fuzz_targets/fuzz_clean.rs).

Changed

  • New runtime dependency: unicode-normalization = "0.1" (only transitive is tinyvec, already in tree).
  • MaliciousCategory now derives Hash, PartialOrd, Ord so it can key the cleaner's per-category override map. UnicodeRange now derives serde::{Serialize, Deserialize}. Both are additive.

1.0.0 - 2025-10-23

Added

  • Initial release of Unicleaner - malicious Unicode character detector

  • Core Scanner (US1: P1)

    • Detection of zero-width characters (U+200B, U+200C, U+200D, U+FEFF)
    • Detection of bidirectional override characters (U+202A-U+202E) - Trojan Source attacks
    • Detection of homoglyphs from various scripts (Cyrillic, Greek, etc.)
    • Detection of non-printable control characters
    • Parallel file scanning with configurable thread count
    • Support for UTF-8, UTF-16 (LE/BE), and UTF-32 (LE/BE) encodings
    • Binary file detection and skipping
    • Precise violation reporting with file path, line number, column number

  • Configuration System (US2: P2)

    • TOML-based configuration file support
    • Deny-by-default security model
    • 50+ language-specific presets (Rust, Python, JavaScript, etc.)
    • File-pattern-based rules using glob patterns
    • Custom Unicode range allowlists and denylists
    • Configuration validation and merging

  • Git/CI Integration (US3: P3)

    • Git diff mode to scan only changed files
    • GitHub Actions output format (::error annotations)
    • GitLab CI output format (JSON)
    • Exit codes for CI/CD: 0 (clean), 1 (violations), 2 (error)
    • Example workflow files for GitHub Actions and GitLab CI

  • Reporting & Output (US4: P4)

    • Human-readable colored terminal output
    • JSON output for machine parsing
    • Compact JSON mode for piping
    • TTY auto-detection for color output
    • NO_COLOR environment variable support
    • --color flag (auto/always/never)
    • --severity filtering (error/warning/info)
    • --quiet mode for summary only
    • --verbose mode for progress messages

  • CLI Commands

    • scan - Scan files for malicious Unicode
    • init - Generate default configuration file
    • list-presets - Show available language presets

  • Quality & Testing

    • 150 tests total (115 unit + 34 integration + 1 doc test)
    • Property-based testing with proptest
    • Fuzzing infrastructure for Unicode detection, config parsing, and file scanning
    • Performance benchmarks with criterion
    • Full clippy and rustfmt compliance

Documentation

  • Comprehensive README with usage examples
  • Quickstart guide with common scenarios
  • CLI reference documentation
  • API documentation with rustdoc
  • CI/CD integration examples
  • Configuration examples

Performance

  • Parallel scanning using rayon
  • Fast UTF-8 detection path
  • BOM-based encoding detection
  • Efficient Unicode range lookups

Security

  • Deny-by-default security model
  • Comprehensive malicious Unicode detection
  • Protection against Trojan Source attacks
  • Safe encoding handling for all Unicode formats