ICU 65.1  65.1
uspoof.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ***************************************************************************
5 * Copyright (C) 2008-2016, International Business Machines Corporation
6 * and others. All Rights Reserved.
7 ***************************************************************************
8 * file name: uspoof.h
9 * encoding: UTF-8
10 * tab size: 8 (not used)
11 * indentation:4
12 *
13 * created on: 2008Feb13
14 * created by: Andy Heninger
15 *
16 * Unicode Spoof Detection
17 */
18 
19 #ifndef USPOOF_H
20 #define USPOOF_H
21 
22 #include "unicode/utypes.h"
23 #include "unicode/uset.h"
24 #include "unicode/parseerr.h"
25 #include "unicode/localpointer.h"
26 
27 #if !UCONFIG_NO_NORMALIZATION
28 
29 
30 #if U_SHOW_CPLUSPLUS_API
31 #include "unicode/unistr.h"
32 #include "unicode/uniset.h"
33 #endif
34 
35 
357 
358 struct USpoofChecker;
362 typedef struct USpoofChecker USpoofChecker;
364 struct USpoofCheckResult;
370 
378 typedef enum USpoofChecks {
388 
398 
408 
419 
420 #ifndef U_HIDE_DEPRECATED_API
421 
427 #endif /* U_HIDE_DEPRECATED_API */
428 
443 
444 #ifndef U_HIDE_DEPRECATED_API
445 
451 #endif /* U_HIDE_DEPRECATED_API */
452 
460 
467 
475 
496 
503 
516  USPOOF_AUX_INFO = 0x40000000
517 
518  } USpoofChecks;
519 
520 
530  typedef enum URestrictionLevel {
537  USPOOF_ASCII = 0x10000000,
578  USPOOF_UNRESTRICTIVE = 0x60000000,
585 #ifndef U_HIDE_INTERNAL_API
586 
591 #endif /* U_HIDE_INTERNAL_API */
593 
604 U_STABLE USpoofChecker * U_EXPORT2
605 uspoof_open(UErrorCode *status);
606 
607 
629 U_STABLE USpoofChecker * U_EXPORT2
630 uspoof_openFromSerialized(const void *data, int32_t length, int32_t *pActualLength,
631  UErrorCode *pErrorCode);
632 
663 U_STABLE USpoofChecker * U_EXPORT2
664 uspoof_openFromSource(const char *confusables, int32_t confusablesLen,
665  const char *confusablesWholeScript, int32_t confusablesWholeScriptLen,
666  int32_t *errType, UParseError *pe, UErrorCode *status);
667 
668 
674 U_STABLE void U_EXPORT2
676 
686 U_STABLE USpoofChecker * U_EXPORT2
687 uspoof_clone(const USpoofChecker *sc, UErrorCode *status);
688 
689 
727 U_STABLE void U_EXPORT2
728 uspoof_setChecks(USpoofChecker *sc, int32_t checks, UErrorCode *status);
729 
741 U_STABLE int32_t U_EXPORT2
742 uspoof_getChecks(const USpoofChecker *sc, UErrorCode *status);
743 
755 U_STABLE void U_EXPORT2
757 
758 
766 U_STABLE URestrictionLevel U_EXPORT2
768 
811 U_STABLE void U_EXPORT2
812 uspoof_setAllowedLocales(USpoofChecker *sc, const char *localesList, UErrorCode *status);
813 
835 U_STABLE const char * U_EXPORT2
837 
838 
857 U_STABLE void U_EXPORT2
858 uspoof_setAllowedChars(USpoofChecker *sc, const USet *chars, UErrorCode *status);
859 
860 
881 U_STABLE const USet * U_EXPORT2
883 
884 
917 U_STABLE int32_t U_EXPORT2
918 uspoof_check(const USpoofChecker *sc,
919  const UChar *id, int32_t length,
920  int32_t *position,
921  UErrorCode *status);
922 
923 
956 U_STABLE int32_t U_EXPORT2
958  const char *id, int32_t length,
959  int32_t *position,
960  UErrorCode *status);
961 
962 
991 U_STABLE int32_t U_EXPORT2
992 uspoof_check2(const USpoofChecker *sc,
993  const UChar* id, int32_t length,
994  USpoofCheckResult* checkResult,
995  UErrorCode *status);
996 
1028 U_STABLE int32_t U_EXPORT2
1030  const char *id, int32_t length,
1031  USpoofCheckResult* checkResult,
1032  UErrorCode *status);
1033 
1052 U_STABLE USpoofCheckResult* U_EXPORT2
1054 
1062 U_STABLE void U_EXPORT2
1064 
1079 U_STABLE int32_t U_EXPORT2
1080 uspoof_getCheckResultChecks(const USpoofCheckResult *checkResult, UErrorCode *status);
1081 
1092 U_STABLE URestrictionLevel U_EXPORT2
1094 
1106 U_STABLE const USet* U_EXPORT2
1107 uspoof_getCheckResultNumerics(const USpoofCheckResult *checkResult, UErrorCode *status);
1108 
1109 
1153 U_STABLE int32_t U_EXPORT2
1155  const UChar *id1, int32_t length1,
1156  const UChar *id2, int32_t length2,
1157  UErrorCode *status);
1158 
1159 
1160 
1186 U_STABLE int32_t U_EXPORT2
1188  const char *id1, int32_t length1,
1189  const char *id2, int32_t length2,
1190  UErrorCode *status);
1191 
1192 
1193 
1194 
1226 U_STABLE int32_t U_EXPORT2
1228  uint32_t type,
1229  const UChar *id, int32_t length,
1230  UChar *dest, int32_t destCapacity,
1231  UErrorCode *status);
1232 
1266 U_STABLE int32_t U_EXPORT2
1268  uint32_t type,
1269  const char *id, int32_t length,
1270  char *dest, int32_t destCapacity,
1271  UErrorCode *status);
1272 
1285 U_STABLE const USet * U_EXPORT2
1287 
1300 U_STABLE const USet * U_EXPORT2
1302 
1325 U_STABLE int32_t U_EXPORT2
1327  void *data, int32_t capacity,
1328  UErrorCode *status);
1329 
1331 
1332 #if U_SHOW_CPLUSPLUS_API
1333 
1334 U_NAMESPACE_BEGIN
1335 
1371 U_NAMESPACE_END
1372 
1391 U_STABLE void U_EXPORT2
1393 
1394 
1415 U_STABLE const icu::UnicodeSet * U_EXPORT2
1417 
1446 U_STABLE int32_t U_EXPORT2
1448  const icu::UnicodeString &id,
1449  int32_t *position,
1450  UErrorCode *status);
1451 
1477 U_STABLE int32_t U_EXPORT2
1479  const icu::UnicodeString &id,
1480  USpoofCheckResult* checkResult,
1481  UErrorCode *status);
1482 
1504 U_STABLE int32_t U_EXPORT2
1506  const icu::UnicodeString &s1,
1507  const icu::UnicodeString &s2,
1508  UErrorCode *status);
1509 
1533 U_I18N_API icu::UnicodeString & U_EXPORT2
1535  uint32_t type,
1536  const icu::UnicodeString &id,
1537  icu::UnicodeString &dest,
1538  UErrorCode *status);
1539 
1552 U_STABLE const icu::UnicodeSet * U_EXPORT2
1554 
1567 U_STABLE const icu::UnicodeSet * U_EXPORT2
1569 
1570 #endif /* U_SHOW_CPLUSPLUS_API */
1571 
1572 #endif /* UCONFIG_NO_NORMALIZATION */
1573 
1574 #endif /* USPOOF_H */
USPOOF_UNDEFINED_RESTRICTIVE
An undefined restriction level.
Definition: uspoof.h:590
USPOOF_ASCII
All characters in the string are in the identifier profile and all characters in the string are in th...
Definition: uspoof.h:537
uspoof_getAllowedUnicodeSet
const U_STABLE icu::UnicodeSet *U_EXPORT2 uspoof_getAllowedUnicodeSet(const USpoofChecker *sc, UErrorCode *status)
Get a UnicodeSet for the characters permitted in an identifier.
uspoof_setChecks
U_STABLE void U_EXPORT2 uspoof_setChecks(USpoofChecker *sc, int32_t checks, UErrorCode *status)
Specify the bitmask of checks that will be performed by uspoof_check.
uspoof_checkUTF8
U_STABLE int32_t U_EXPORT2 uspoof_checkUTF8(const USpoofChecker *sc, const char *id, int32_t length, int32_t *position, UErrorCode *status)
Check the specified string for possible security issues.
USpoofChecks
USpoofChecks
Enum for the kinds of checks that USpoofChecker can perform.
Definition: uspoof.h:378
parseerr.h
C API: Parse Error Information.
uspoof_check2UnicodeString
U_STABLE int32_t U_EXPORT2 uspoof_check2UnicodeString(const USpoofChecker *sc, const icu::UnicodeString &id, USpoofCheckResult *checkResult, UErrorCode *status)
Check the specified string for possible security issues.
USPOOF_RESTRICTION_LEVEL_MASK
Mask for selecting the Restriction Level bits from the return value of uspoof_check.
Definition: uspoof.h:584
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
icu::UnicodeSet
A mutable set of Unicode characters and multicharacter strings.
Definition: uniset.h:281
uspoof_getRestrictionLevel
U_STABLE URestrictionLevel U_EXPORT2 uspoof_getRestrictionLevel(const USpoofChecker *sc)
Get the Restriction Level that will be tested if the checks include USPOOF_RESTRICTION_LEVEL.
uspoof_areConfusable
U_STABLE int32_t U_EXPORT2 uspoof_areConfusable(const USpoofChecker *sc, const UChar *id1, int32_t length1, const UChar *id2, int32_t length2, UErrorCode *status)
Check the whether two specified strings are visually confusable.
uspoof_getSkeleton
U_STABLE int32_t U_EXPORT2 uspoof_getSkeleton(const USpoofChecker *sc, uint32_t type, const UChar *id, int32_t length, UChar *dest, int32_t destCapacity, UErrorCode *status)
Get the "skeleton" for an identifier.
USPOOF_ANY_CASE
This flag is deprecated and no longer affects the behavior of SpoofChecker.
Definition: uspoof.h:426
USPOOF_UNRESTRICTIVE
Any valid identifiers, including characters outside of the Identifier Profile.
Definition: uspoof.h:578
U_I18N_API
#define U_I18N_API
Definition: utypes.h:301
USPOOF_HIGHLY_RESTRICTIVE
The string classifies as Single Script, or all characters in the string are in the identifier profile...
Definition: uspoof.h:558
uspoof_getInclusionSet
const U_STABLE USet *U_EXPORT2 uspoof_getInclusionSet(UErrorCode *status)
Get the set of Candidate Characters for Inclusion in Identifiers, as defined in http://unicode....
USpoofCheckResult
struct USpoofCheckResult USpoofCheckResult
Definition: uspoof.h:369
uspoof_getInclusionUnicodeSet
const U_STABLE icu::UnicodeSet *U_EXPORT2 uspoof_getInclusionUnicodeSet(UErrorCode *status)
Get the set of Candidate Characters for Inclusion in Identifiers, as defined in http://unicode....
UParseError
A UParseError struct is used to returned detailed information about parsing errors.
Definition: parseerr.h:58
uspoof_areConfusableUnicodeString
U_STABLE int32_t U_EXPORT2 uspoof_areConfusableUnicodeString(const USpoofChecker *sc, const icu::UnicodeString &s1, const icu::UnicodeString &s2, UErrorCode *status)
A version of uspoof_areConfusable accepting UnicodeStrings.
USPOOF_CHAR_LIMIT
Check that an identifier contains only characters from a specified set of acceptable characters.
Definition: uspoof.h:466
USPOOF_ALL_CHECKS
Enable all spoof checks.
Definition: uspoof.h:502
uspoof_getRecommendedSet
const U_STABLE USet *U_EXPORT2 uspoof_getRecommendedSet(UErrorCode *status)
Get the set of characters from Recommended Scripts for Inclusion in Identifiers, as defined in http:/...
uspoof_setRestrictionLevel
U_STABLE void U_EXPORT2 uspoof_setRestrictionLevel(USpoofChecker *sc, URestrictionLevel restrictionLevel)
Set the loosest restriction level allowed for strings.
uspoof_getCheckResultNumerics
const U_STABLE USet *U_EXPORT2 uspoof_getCheckResultNumerics(const USpoofCheckResult *checkResult, UErrorCode *status)
Gets the set of numerics found in the string, if the USPOOF_MIXED_NUMBERS check was enabled; otherwis...
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:294
uspoof_getChecks
U_STABLE int32_t U_EXPORT2 uspoof_getChecks(const USpoofChecker *sc, UErrorCode *status)
Get the set of checks that this Spoof Checker has been configured to perform.
uspoof_openCheckResult
U_STABLE USpoofCheckResult *U_EXPORT2 uspoof_openCheckResult(UErrorCode *status)
Create a USpoofCheckResult, used by the uspoof_check2 class of functions to return information about ...
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
USPOOF_SINGLE_SCRIPT_RESTRICTIVE
The string classifies as ASCII-Only, or all characters in the string are in the identifier profile an...
Definition: uspoof.h:544
uspoof_openFromSource
USpoofChecker * uspoof_openFromSource(const char *confusables, int32_t confusablesLen, const char *confusablesWholeScript, int32_t confusablesWholeScriptLen, int32_t *errType, UParseError *pe, UErrorCode *status)
Open a Spoof Checker from the source form of the spoof data.
uspoof_check
U_STABLE int32_t U_EXPORT2 uspoof_check(const USpoofChecker *sc, const UChar *id, int32_t length, int32_t *position, UErrorCode *status)
Check the specified string for possible security issues.
U_CDECL_END
#define U_CDECL_END
Definition: umachine.h:85
U_CDECL_BEGIN
#define U_CDECL_BEGIN
Definition: umachine.h:84
USPOOF_SINGLE_SCRIPT
Check that an identifier contains only characters from a single script (plus chars from the common an...
Definition: uspoof.h:450
uspoof_getCheckResultRestrictionLevel
U_STABLE URestrictionLevel U_EXPORT2 uspoof_getCheckResultRestrictionLevel(const USpoofCheckResult *checkResult, UErrorCode *status)
Gets the restriction level that the text meets, if the USPOOF_RESTRICTION_LEVEL check was enabled; ot...
uspoof_closeCheckResult
U_STABLE void U_EXPORT2 uspoof_closeCheckResult(USpoofCheckResult *checkResult)
Close a USpoofCheckResult, freeing any memory that was being held by its implementation.
uspoof_open
USpoofChecker * uspoof_open(UErrorCode *status)
Create a Unicode Spoof Checker, configured to perform all checks except for USPOOF_LOCALE_LIMIT and U...
uspoof_setAllowedUnicodeSet
U_NAMESPACE_END U_STABLE void U_EXPORT2 uspoof_setAllowedUnicodeSet(USpoofChecker *sc, const icu::UnicodeSet *chars, UErrorCode *status)
Limit the acceptable characters to those specified by a Unicode Set.
uspoof_getAllowedLocales
const U_STABLE char *U_EXPORT2 uspoof_getAllowedLocales(USpoofChecker *sc, UErrorCode *status)
Get a list of locales for the scripts that are acceptable in strings to be checked.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
Definition: localpointer.h:562
USPOOF_SINGLE_SCRIPT_CONFUSABLE
When performing the two-string uspoof_areConfusable test, this flag in the return value indicates tha...
Definition: uspoof.h:387
USPOOF_MIXED_NUMBERS
Check that an identifier does not mix numbers from different numbering systems.
Definition: uspoof.h:474
USPOOF_AUX_INFO
Enable the return of auxillary (non-error) information in the upper bits of the check results value.
Definition: uspoof.h:516
uspoof_serialize
U_STABLE int32_t U_EXPORT2 uspoof_serialize(USpoofChecker *sc, void *data, int32_t capacity, UErrorCode *status)
Serialize the data for a spoof detector into a chunk of memory.
uspoof_clone
USpoofChecker * uspoof_clone(const USpoofChecker *sc, UErrorCode *status)
Clone a Spoof Checker.
uspoof_getSkeletonUTF8
U_STABLE int32_t U_EXPORT2 uspoof_getSkeletonUTF8(const USpoofChecker *sc, uint32_t type, const char *id, int32_t length, char *dest, int32_t destCapacity, UErrorCode *status)
Get the "skeleton" for an identifier.
uset.h
C API: Unicode Set.
uspoof_getSkeletonUnicodeString
U_I18N_API icu::UnicodeString &U_EXPORT2 uspoof_getSkeletonUnicodeString(const USpoofChecker *sc, uint32_t type, const icu::UnicodeString &id, icu::UnicodeString &dest, UErrorCode *status)
Get the "skeleton" for an identifier.
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
uspoof_openFromSerialized
USpoofChecker * uspoof_openFromSerialized(const void *data, int32_t length, int32_t *pActualLength, UErrorCode *pErrorCode)
Open a Spoof checker from its serialized form, stored in 32-bit-aligned memory.
uspoof_getCheckResultChecks
U_STABLE int32_t U_EXPORT2 uspoof_getCheckResultChecks(const USpoofCheckResult *checkResult, UErrorCode *status)
Indicates which of the spoof check(s) have failed.
uspoof_setAllowedLocales
U_STABLE void U_EXPORT2 uspoof_setAllowedLocales(USpoofChecker *sc, const char *localesList, UErrorCode *status)
Limit characters that are acceptable in identifiers being checked to those normally used with the lan...
uspoof_check2UTF8
U_STABLE int32_t U_EXPORT2 uspoof_check2UTF8(const USpoofChecker *sc, const char *id, int32_t length, USpoofCheckResult *checkResult, UErrorCode *status)
Check the specified string for possible security issues.
USPOOF_MINIMALLY_RESTRICTIVE
All characters in the string are in the identifier profile.
Definition: uspoof.h:572
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111
USpoofChecker
struct USpoofChecker USpoofChecker
typedef for C of USpoofChecker
Definition: uspoof.h:362
uspoof_getAllowedChars
const U_STABLE USet *U_EXPORT2 uspoof_getAllowedChars(const USpoofChecker *sc, UErrorCode *status)
Get a USet for the characters permitted in an identifier.
UChar
uint16_t UChar
Definition: umachine.h:378
uspoof_getRecommendedUnicodeSet
const U_STABLE icu::UnicodeSet *U_EXPORT2 uspoof_getRecommendedUnicodeSet(UErrorCode *status)
Get the set of characters from Recommended Scripts for Inclusion in Identifiers, as defined in http:/...
uspoof_areConfusableUTF8
U_STABLE int32_t U_EXPORT2 uspoof_areConfusableUTF8(const USpoofChecker *sc, const char *id1, int32_t length1, const char *id2, int32_t length2, UErrorCode *status)
A version of uspoof_areConfusable accepting strings in UTF-8 format.
USPOOF_MODERATELY_RESTRICTIVE
The string classifies as Highly Restrictive, or all characters in the string are in the identifier pr...
Definition: uspoof.h:566
uspoof_setAllowedChars
U_STABLE void U_EXPORT2 uspoof_setAllowedChars(USpoofChecker *sc, const USet *chars, UErrorCode *status)
Limit the acceptable characters to those specified by a Unicode Set.
uspoof_check2
U_STABLE int32_t U_EXPORT2 uspoof_check2(const USpoofChecker *sc, const UChar *id, int32_t length, USpoofCheckResult *checkResult, UErrorCode *status)
Check the specified string for possible security issues.
uniset.h
C++ API: Unicode Set.
uspoof_close
void uspoof_close(USpoofChecker *sc)
Close a Spoof Checker, freeing any memory that was being held by its implementation.
LocalUSpoofCheckerPointer
USet
struct USet USet
USet is the C API type corresponding to C++ class UnicodeSet.
Definition: uset.h:47
USPOOF_HIDDEN_OVERLAY
Check that an identifier does not have a combining character following a character in which that comb...
Definition: uspoof.h:495
URestrictionLevel
URestrictionLevel
Constants from UAX #39 for use in uspoof_setRestrictionLevel, and for returned identifier restriction...
Definition: uspoof.h:530
unistr.h
C++ API: Unicode String.
USPOOF_RESTRICTION_LEVEL
Check that an identifier is no looser than the specified RestrictionLevel.
Definition: uspoof.h:442
USPOOF_WHOLE_SCRIPT_CONFUSABLE
When performing the two-string uspoof_areConfusable test, this flag in the return value indicates tha...
Definition: uspoof.h:407
USPOOF_INVISIBLE
Check an identifier for the presence of invisible characters, such as zero-width spaces,...
Definition: uspoof.h:459
uspoof_checkUnicodeString
U_STABLE int32_t U_EXPORT2 uspoof_checkUnicodeString(const USpoofChecker *sc, const icu::UnicodeString &id, int32_t *position, UErrorCode *status)
Check the specified string for possible security issues.
LocalUSpoofCheckResultPointer
USPOOF_CONFUSABLE
Enable this flag in uspoof_setChecks to turn on all types of confusables.
Definition: uspoof.h:418
USPOOF_MIXED_SCRIPT_CONFUSABLE
When performing the two-string uspoof_areConfusable test, this flag in the return value indicates tha...
Definition: uspoof.h:397