ICU 63.1  63.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 
356 struct USpoofChecker;
360 typedef struct USpoofChecker USpoofChecker;
362 struct USpoofCheckResult;
368 
376 typedef enum USpoofChecks {
386 
396 
406 
417 
418 #ifndef U_HIDE_DEPRECATED_API
419 
425 #endif /* U_HIDE_DEPRECATED_API */
426 
441 
442 #ifndef U_HIDE_DEPRECATED_API
443 
449 #endif /* U_HIDE_DEPRECATED_API */
450 
458 
465 
473 
474 #ifndef U_HIDE_DRAFT_API
475 
495 #endif /* U_HIDE_DRAFT_API */
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 
677 #if U_SHOW_CPLUSPLUS_API
678 
680 
691 
693 
694 #endif
695 
705 U_STABLE USpoofChecker * U_EXPORT2
706 uspoof_clone(const USpoofChecker *sc, UErrorCode *status);
707 
708 
746 U_STABLE void U_EXPORT2
747 uspoof_setChecks(USpoofChecker *sc, int32_t checks, UErrorCode *status);
748 
760 U_STABLE int32_t U_EXPORT2
761 uspoof_getChecks(const USpoofChecker *sc, UErrorCode *status);
762 
774 U_STABLE void U_EXPORT2
776 
777 
785 U_STABLE URestrictionLevel U_EXPORT2
787 
830 U_STABLE void U_EXPORT2
831 uspoof_setAllowedLocales(USpoofChecker *sc, const char *localesList, UErrorCode *status);
832 
854 U_STABLE const char * U_EXPORT2
856 
857 
876 U_STABLE void U_EXPORT2
877 uspoof_setAllowedChars(USpoofChecker *sc, const USet *chars, UErrorCode *status);
878 
879 
900 U_STABLE const USet * U_EXPORT2
902 
903 
904 #if U_SHOW_CPLUSPLUS_API
905 
923 U_STABLE void U_EXPORT2
925 
926 
947 U_STABLE const icu::UnicodeSet * U_EXPORT2
949 #endif
950 
951 
984 U_STABLE int32_t U_EXPORT2
985 uspoof_check(const USpoofChecker *sc,
986  const UChar *id, int32_t length,
987  int32_t *position,
988  UErrorCode *status);
989 
990 
1023 U_STABLE int32_t U_EXPORT2
1025  const char *id, int32_t length,
1026  int32_t *position,
1027  UErrorCode *status);
1028 
1029 
1030 #if U_SHOW_CPLUSPLUS_API
1031 
1059 U_STABLE int32_t U_EXPORT2
1061  const icu::UnicodeString &id,
1062  int32_t *position,
1063  UErrorCode *status);
1064 #endif
1065 
1066 
1095 U_STABLE int32_t U_EXPORT2
1096 uspoof_check2(const USpoofChecker *sc,
1097  const UChar* id, int32_t length,
1098  USpoofCheckResult* checkResult,
1099  UErrorCode *status);
1100 
1132 U_STABLE int32_t U_EXPORT2
1134  const char *id, int32_t length,
1135  USpoofCheckResult* checkResult,
1136  UErrorCode *status);
1137 
1138 #if U_SHOW_CPLUSPLUS_API
1139 
1164 U_STABLE int32_t U_EXPORT2
1166  const icu::UnicodeString &id,
1167  USpoofCheckResult* checkResult,
1168  UErrorCode *status);
1169 #endif
1170 
1189 U_STABLE USpoofCheckResult* U_EXPORT2
1191 
1199 U_STABLE void U_EXPORT2
1201 
1202 #if U_SHOW_CPLUSPLUS_API
1203 
1205 
1225 
1226 #endif
1227 
1242 U_STABLE int32_t U_EXPORT2
1243 uspoof_getCheckResultChecks(const USpoofCheckResult *checkResult, UErrorCode *status);
1244 
1255 U_STABLE URestrictionLevel U_EXPORT2
1257 
1269 U_STABLE const USet* U_EXPORT2
1270 uspoof_getCheckResultNumerics(const USpoofCheckResult *checkResult, UErrorCode *status);
1271 
1272 
1316 U_STABLE int32_t U_EXPORT2
1318  const UChar *id1, int32_t length1,
1319  const UChar *id2, int32_t length2,
1320  UErrorCode *status);
1321 
1322 
1323 
1349 U_STABLE int32_t U_EXPORT2
1351  const char *id1, int32_t length1,
1352  const char *id2, int32_t length2,
1353  UErrorCode *status);
1354 
1355 
1356 
1357 
1358 #if U_SHOW_CPLUSPLUS_API
1359 
1380 U_STABLE int32_t U_EXPORT2
1382  const icu::UnicodeString &s1,
1383  const icu::UnicodeString &s2,
1384  UErrorCode *status);
1385 #endif
1386 
1387 
1419 U_STABLE int32_t U_EXPORT2
1421  uint32_t type,
1422  const UChar *id, int32_t length,
1423  UChar *dest, int32_t destCapacity,
1424  UErrorCode *status);
1425 
1459 U_STABLE int32_t U_EXPORT2
1461  uint32_t type,
1462  const char *id, int32_t length,
1463  char *dest, int32_t destCapacity,
1464  UErrorCode *status);
1465 
1466 #if U_SHOW_CPLUSPLUS_API
1467 
1490 U_I18N_API icu::UnicodeString & U_EXPORT2
1492  uint32_t type,
1493  const icu::UnicodeString &id,
1494  icu::UnicodeString &dest,
1495  UErrorCode *status);
1496 #endif /* U_SHOW_CPLUSPLUS_API */
1497 
1510 U_STABLE const USet * U_EXPORT2
1512 
1525 U_STABLE const USet * U_EXPORT2
1527 
1528 #if U_SHOW_CPLUSPLUS_API
1529 
1542 U_STABLE const icu::UnicodeSet * U_EXPORT2
1544 
1557 U_STABLE const icu::UnicodeSet * U_EXPORT2
1559 
1560 #endif /* U_SHOW_CPLUSPLUS_API */
1561 
1584 U_STABLE int32_t U_EXPORT2
1586  void *data, int32_t capacity,
1587  UErrorCode *status);
1588 
1589 
1590 #endif
1591 
1592 #endif /* USPOOF_H */
void uspoof_close(USpoofChecker *sc)
Close a Spoof Checker, freeing any memory that was being held by its implementation.
U_STABLE const icu::UnicodeSet *U_EXPORT2 uspoof_getInclusionUnicodeSet(UErrorCode *status)
Get the set of Candidate Characters for Inclusion in Identifiers, as defined in http://unicode.org/Public/security/latest/xidmodifications.txt and documented in http://www.unicode.org/reports/tr39/, Unicode Security Mechanisms.
URestrictionLevel
Constants from UAX #39 for use in uspoof_setRestrictionLevel, and for returned identifier restriction...
Definition: uspoof.h:530
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.
Definition: uspoof.h:457
Check that an identifier contains only characters from a single script (plus chars from the common an...
Definition: uspoof.h:448
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.
struct USpoofCheckResult USpoofCheckResult
Definition: uspoof.h:367
U_NAMESPACE_END U_STABLE int32_t U_EXPORT2 uspoof_getCheckResultChecks(const USpoofCheckResult *checkResult, UErrorCode *status)
Indicates which of the spoof check(s) have failed.
USpoofChecker * uspoof_clone(const USpoofChecker *sc, UErrorCode *status)
Clone a Spoof Checker.
All characters in the string are in the identifier profile and all characters in the string are in th...
Definition: uspoof.h:537
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.
Check that an identifier contains only characters from a specified set of acceptable characters...
Definition: uspoof.h:464
All characters in the string are in the identifier profile.
Definition: uspoof.h:572
USpoofChecks
Enum for the kinds of checks that USpoofChecker can perform.
Definition: uspoof.h:376
C++ API: Unicode String.
USpoofChecker * uspoof_open(UErrorCode *status)
Create a Unicode Spoof Checker, configured to perform all checks except for USPOOF_LOCALE_LIMIT and U...
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.
U_STABLE void U_EXPORT2 uspoof_closeCheckResult(USpoofCheckResult *checkResult)
Close a USpoofCheckResult, freeing any memory that was being held by its implementation.
Enable this flag in uspoof_setChecks to turn on all types of confusables.
Definition: uspoof.h:416
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.
U_STABLE const USet *U_EXPORT2 uspoof_getRecommendedSet(UErrorCode *status)
Get the set of characters from Recommended Scripts for Inclusion in Identifiers, as defined in http:/...
C API: Unicode Set.
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.
Enable all spoof checks.
Definition: uspoof.h:502
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside...
Definition: utypes.h:301
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...
Check that an identifier does not have a combining character following a character in which that comb...
Definition: uspoof.h:494
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
U_STABLE const 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.
This flag is deprecated and no longer affects the behavior of SpoofChecker.
Definition: uspoof.h:424
When performing the two-string uspoof_areConfusable test, this flag in the return value indicates tha...
Definition: uspoof.h:405
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:487
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
U_STABLE const icu::UnicodeSet *U_EXPORT2 uspoof_getRecommendedUnicodeSet(UErrorCode *status)
Get the set of characters from Recommended Scripts for Inclusion in Identifiers, as defined in http:/...
U_STABLE void U_EXPORT2 uspoof_setRestrictionLevel(USpoofChecker *sc, URestrictionLevel restrictionLevel)
Set the loosest restriction level allowed for strings.
The string classifies as Highly Restrictive, or all characters in the string are in the identifier pr...
Definition: uspoof.h:566
Check that an identifier does not mix numbers from different numbering systems.
Definition: uspoof.h:472
The string classifies as ASCII-Only, or all characters in the string are in the identifier profile an...
Definition: uspoof.h:544
The string classifies as Single Script, or all characters in the string are in the identifier profile...
Definition: uspoof.h:558
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.
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.
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.
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.
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.
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...
A mutable set of Unicode characters and multicharacter strings.
Definition: uniset.h:278
struct USpoofChecker USpoofChecker
typedef for C of USpoofChecker
Definition: uspoof.h:360
U_STABLE USpoofCheckResult *U_EXPORT2 uspoof_openCheckResult(UErrorCode *status)
Create a USpoofCheckResult, used by the uspoof_check2 class of functions to return information about ...
"Smart pointer" class, closes a USpoofChecker via uspoof_close().
U_STABLE const 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...
When performing the two-string uspoof_areConfusable test, this flag in the return value indicates tha...
Definition: uspoof.h:385
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:342
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
C API: Parse Error Information.
U_STABLE const icu::UnicodeSet *U_EXPORT2 uspoof_getAllowedUnicodeSet(const USpoofChecker *sc, UErrorCode *status)
Get a UnicodeSet for the characters permitted in an identifier.
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.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:401
When performing the two-string uspoof_areConfusable test, this flag in the return value indicates tha...
Definition: uspoof.h:395
struct USet USet
USet is the C API type corresponding to C++ class UnicodeSet.
Definition: uset.h:47
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.
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.
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.
Enable the return of auxillary (non-error) information in the upper bits of the check results value...
Definition: uspoof.h:516
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.
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.
Check that an identifier is no looser than the specified RestrictionLevel.
Definition: uspoof.h:440
A UParseError struct is used to returned detailed information about parsing errors.
Definition: parseerr.h:58
Basic definitions for ICU, for both C and C++ APIs.
U_STABLE const USet *U_EXPORT2 uspoof_getInclusionSet(UErrorCode *status)
Get the set of Candidate Characters for Inclusion in Identifiers, as defined in http://unicode.org/Public/security/latest/xidmodifications.txt and documented in http://www.unicode.org/reports/tr39/, Unicode Security Mechanisms.
Mask for selecting the Restriction Level bits from the return value of uspoof_check.
Definition: uspoof.h:584
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.
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.
Any valid identifiers, including characters outside of the Identifier Profile.
Definition: uspoof.h:578
U_STABLE const USet *U_EXPORT2 uspoof_getAllowedChars(const USpoofChecker *sc, UErrorCode *status)
Get a USet for the characters permitted in an identifier.
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:289
"Smart pointer" class, closes a USpoofCheckResult via uspoof_closeCheckResult().
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.
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.
An undefined restriction level.
Definition: uspoof.h:590
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111
C++ API: Unicode Set.