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;

public const int IGNORE_SPACE;

public const int CASE_INSENSITIVE;

public const int ADD_CASE_MAPPINGS;

public const int SIMPLE_CASE_INSENSITIVE;

/* Methods */

public function __construct()

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

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

public function setAllowedChars(string $pattern, int $patternOptions = 0): void

public function setAllowedLocales(string $locales): void

public function setChecks(int $checks): void

public function 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
Spoofchecker::IGNORE_SPACE int
Spoofchecker::CASE_INSENSITIVE int: Enables case-insensitive matching
Spoofchecker::ADD_CASE_MAPPINGS int: Adds all case mappings for each element in the set
Spoofchecker::SIMPLE_CASE_INSENSITIVE int: Enables case-insensitive matching

Changelog

Version	Description
8.4.0	Added `Spoofchecker::IGNORE_SPACE`, `Spoofchecker::CASE_INSENSITIVE`, `Spoofchecker::ADD_CASE_MAPPINGS`, `Spoofchecker::SIMPLE_CASE_INSENSITIVE`.
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::setAllowedChars — Set the set of characters allowed when running checks
Spoofchecker::setAllowedLocales — Locales to use when running checks
Spoofchecker::setChecks — Set the checks to run
Spoofchecker::setRestrictionLevel — Set the restriction level

The Spoofchecker class

Introduction

Class synopsis

Predefined Constants

Changelog

Table of Contents