Utf8ByteTruncation

warning native off by default

Group: Probable bugs

Detect substr on a literal valid UTF-8 string with statically known offsets selecting an incomplete code-point byte sequence.

Example

<?php
$initial=substr('ñame',0,1);

Reported:

• line 2: Keep UTF-8 code points intact when truncating text.

Detection

• Report substr on a literal valid UTF-8 string with statically known offsets selecting an incomplete code-point byte sequence.
• Resolve builtin calls and named arguments before checking the contract. Project-local callees are considered only when their bodies or immutable summaries establish the required facts. The default is disabled; enable only when the stated intent matches the application.
• For flow-dependent conditions, require a reachable source-to-use path with no intervening invalidation. Unknown calls, ambiguous aliases, recursion or analysis-budget exhaustion cannot establish definite facts.

Exceptions (no report)

• ASCII, boundaries preserving complete code points, binary-data contracts and unknown strings are excluded.
• Unresolved targets, incomplete required facts, suppressed findings and PHP versions lacking the referenced API or language feature produce no report. User declarations shadowing builtin names are not builtin contracts.

Fix

No automatic fix: byte offsets cannot generally be reinterpreted as character offsets.

PHP versions

Apply only on PHP versions supporting the referenced APIs and syntax (within PHP 5.3–8.5). Builtin behavior and argument contracts follow the configured PHP version. Extension-specific calls require resolved extension API symbols; do not treat same-named application functions as extension calls.

Options

None. Enable or disable this rule through normal rule configuration.

Configure

In custos.json:

{
  "rules": {
    "Utf8ByteTruncation": {
      "enabled": true
    }
  }
}

Suppress

Before the statement or declaration (or the first statement of the file):

// @custos-ignore Utf8ByteTruncation