The Spoofchecker class

(PHP 5 >= 5.4.0, PHP 7, PHP 8, PECL intl >= 2.0.0)

Introduction

This class is provided because Unicode contains large number of characters and incorporates the varied writing systems of the world and their incorrect usage can expose programs or systems to possible security attacks using characters similarity.

Provided methods allow to check whether an individual string is likely an attempt at confusing the reader (spoof detection), such as "pаypаl" spelled with Cyrillic 'а' characters.

Class synopsis

class Spoofchecker {

/* Constants */

public const int SINGLE_SCRIPT_CONFUSABLE;

public const int MIXED_SCRIPT_CONFUSABLE;

public const int WHOLE_SCRIPT_CONFUSABLE;

public const int ANY_CASE;

public const int SINGLE_SCRIPT;

public const int INVISIBLE;

public const int CHAR_LIMIT;

public const int ASCII;

public const int HIGHLY_RESTRICTIVE;

public const int MODERATELY_RESTRICTIVE;

public const int MINIMALLY_RESTRICTIVE;

public const int UNRESTRICTIVE;

public const int SINGLE_SCRIPT_RESTRICTIVE;

public const int MIXED_NUMBERS;

public const int HIDDEN_OVERLAY;

/* Methods */

public __construct()

public areConfusable(string $string1, string $string2, int &$errorCode = null): bool

public isSuspicious(string $string, int &$errorCode = null): bool

public setAllowedLocales(string $locales): void

public setChecks(int $checks): void

public setRestrictionLevel(int $level): void

}

Predefined Constants

Spoofchecker::SINGLE_SCRIPT_CONFUSABLE int
Spoofchecker::MIXED_SCRIPT_CONFUSABLE int
Spoofchecker::WHOLE_SCRIPT_CONFUSABLE int
Spoofchecker::ANY_CASE int
Spoofchecker::SINGLE_SCRIPT int
Spoofchecker::INVISIBLE int
Spoofchecker::CHAR_LIMIT int
Spoofchecker::ASCII int
Spoofchecker::HIGHLY_RESTRICTIVE int
Spoofchecker::MODERATELY_RESTRICTIVE int
Spoofchecker::MINIMALLY_RESTRICTIVE int
Spoofchecker::UNRESTRICTIVE int
Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE int
Spoofchecker::MIXED_NUMBERS int
Spoofchecker::HIDDEN_OVERLAY int

Changelog

Version	Description
8.4.0	The class constants are now typed.
7.3.0	Class constants used by Spoofchecker::setRestrictionLevel() such as `Spoofchecker::ASCII`, `Spoofchecker::HIGHLY_RESTRICTIVE`, `Spoofchecker::MODERATELY_RESTRICTIVE`, `Spoofchecker::MINIMALLY_RESTRICTIVE`, `Spoofchecker::UNRESTRICTIVE`, `Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE` has been added.

Spoofchecker::areConfusable — Checks if given strings can be confused
Spoofchecker::__construct — Constructor
Spoofchecker::isSuspicious — Checks if a given text contains any suspicious characters
Spoofchecker::setAllowedLocales — Locales to use when running checks
Spoofchecker::setChecks — Set the checks to run
Spoofchecker::setRestrictionLevel — Set the restriction level

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 2 notes

down

Anonymous ¶

8 years ago

From http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SpoofChecker.html :SINGLE_SCRIPT_CONFUSABLE: indicates that the two strings are visually confusable and that they are from the same scriptMIXED_SCRIPT_CONFUSABLE: indicates that the two strings are visually confusable and that they are NOT from the same scriptWHOLE_SCRIPT_CONFUSABLE: indicates that the two strings are visually confusable and that they are NOT from the same script BUT both of them are single-script stringsANY_CASE: Deprecated.SINGLE_SCRIPT: Deprecated.INVISIBLE: Check an identifier for the presence of invisible characters, such as zero-width spaces, or character sequences that are likely not to display, such as multiple occurrences of the same non-spacing mark.CHAR_LIMIT: Check that an identifier contains only characters from a specified set of acceptable characters.Explanation of whole script, mixed script and single script confusables in UTS 39 section 4 : http://unicode.org/reports/tr39/#Confusable_DetectionDetails from Java SpoofChecker class at http://icu-project.org/apiref/icu4j/com/ibm/icu/text/SpoofChecker.html