From dbfbbab65139552549604931dfa2759c9aa392de Mon Sep 17 00:00:00 2001 From: serge-sans-paille Date: Fri, 15 Oct 2021 15:18:52 +0200 Subject: [PATCH 3/3] Misleading unicode identifier detection pass MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Detect when an identifier contains some Right-To-Left characters. This pass relates to https://trojansource.codes/ Example of misleading source: short int א = (short int)0; short int ג = (short int)12345; int main() { int א = ג; // a local variable, set to zero? printf("ג is %d\n", ג); printf("א is %d\n", א); } This is a recommit of 299aa4dfa1d8c120648b1404b481d858b76c8173 with missing option registration fixed. Differential Revision: https://reviews.llvm.org/D112914 --- clang-tools-extra/clang-tidy/misc/CMakeLists.txt | 1 + .../clang-tidy/misc/MiscTidyModule.cpp | 3 + .../clang-tidy/misc/MisleadingIdentifier.cpp | 166 +++++++++++++++++++++ .../clang-tidy/misc/MisleadingIdentifier.h | 31 ++++ clang-tools-extra/docs/ReleaseNotes.rst | 4 + clang-tools-extra/docs/clang-tidy/checks/list.rst | 1 + .../checks/misc-misleading-identifier.rst | 23 +++ .../checkers/misc-misleading-identifier.cpp | 15 ++ 8 files changed, 244 insertions(+) create mode 100644 clang-tools-extra/clang-tidy/misc/MisleadingIdentifier.cpp create mode 100644 clang-tools-extra/clang-tidy/misc/MisleadingIdentifier.h create mode 100644 clang-tools-extra/docs/clang-tidy/checks/misc-misleading-identifier.rst create mode 100644 clang-tools-extra/test/clang-tidy/checkers/misc-misleading-identifier.cpp diff --git a/clang-tools-extra/clang-tidy/misc/CMakeLists.txt b/clang-tools-extra/clang-tidy/misc/CMakeLists.txt index e6abac8..22d1659 100644 --- a/clang-tools-extra/clang-tidy/misc/CMakeLists.txt +++ b/clang-tools-extra/clang-tidy/misc/CMakeLists.txt @@ -17,6 +17,7 @@ add_clang_library(clangTidyMiscModule Homoglyph.cpp MiscTidyModule.cpp MisleadingBidirectional.cpp + MisleadingIdentifier.cpp MisplacedConstCheck.cpp NewDeleteOverloadsCheck.cpp NoRecursionCheck.cpp diff --git a/clang-tools-extra/clang-tidy/misc/MiscTidyModule.cpp b/clang-tools-extra/clang-tidy/misc/MiscTidyModule.cpp index bb5fde2..b484db8 100644 --- a/clang-tools-extra/clang-tidy/misc/MiscTidyModule.cpp +++ b/clang-tools-extra/clang-tidy/misc/MiscTidyModule.cpp @@ -12,6 +12,7 @@ #include "DefinitionsInHeadersCheck.h" #include "Homoglyph.h" #include "MisleadingBidirectional.h" +#include "MisleadingIdentifier.h" #include "MisplacedConstCheck.h" #include "NewDeleteOverloadsCheck.h" #include "NoRecursionCheck.h" @@ -38,6 +39,8 @@ public: CheckFactories.registerCheck("misc-homoglyph"); CheckFactories.registerCheck( "misc-misleading-bidirectional"); + CheckFactories.registerCheck( + "misc-misleading-identifier"); CheckFactories.registerCheck("misc-misplaced-const"); CheckFactories.registerCheck( "misc-new-delete-overloads"); diff --git a/clang-tools-extra/clang-tidy/misc/MisleadingIdentifier.cpp b/clang-tools-extra/clang-tidy/misc/MisleadingIdentifier.cpp new file mode 100644 index 0000000..4ddb8ba --- /dev/null +++ b/clang-tools-extra/clang-tidy/misc/MisleadingIdentifier.cpp @@ -0,0 +1,166 @@ +//===--- MisleadingIdentifier.cpp - clang-tidy-----------------------------===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#include "MisleadingIdentifier.h" + +#include "clang/Frontend/CompilerInstance.h" +#include "llvm/Support/ConvertUTF.h" + +namespace clang { +namespace tidy { +namespace misc { + +// See https://www.unicode.org/Public/14.0.0/ucd/extracted/DerivedBidiClass.txt +static bool isUnassignedAL(llvm::UTF32 CP) { + return (0x0600 <= CP && CP <= 0x07BF) || (0x0860 <= CP && CP <= 0x08FF) || + (0xFB50 <= CP && CP <= 0xFDCF) || (0xFDF0 <= CP && CP <= 0xFDFF) || + (0xFE70 <= CP && CP <= 0xFEFF) || + (0x00010D00 <= CP && CP <= 0x00010D3F) || + (0x00010F30 <= CP && CP <= 0x00010F6F) || + (0x0001EC70 <= CP && CP <= 0x0001ECBF) || + (0x0001ED00 <= CP && CP <= 0x0001ED4F) || + (0x0001EE00 <= CP && CP <= 0x0001EEFF); +} + +// See https://www.unicode.org/Public/14.0.0/ucd/extracted/DerivedBidiClass.txt +static bool isUnassignedR(llvm::UTF32 CP) { + return (0x0590 <= CP && CP <= 0x05FF) || (0x07C0 <= CP && CP <= 0x085F) || + (0xFB1D <= CP && CP <= 0xFB4F) || + (0x00010800 <= CP && CP <= 0x00010CFF) || + (0x00010D40 <= CP && CP <= 0x00010F2F) || + (0x00010F70 <= CP && CP <= 0x00010FFF) || + (0x0001E800 <= CP && CP <= 0x0001EC6F) || + (0x0001ECC0 <= CP && CP <= 0x0001ECFF) || + (0x0001ED50 <= CP && CP <= 0x0001EDFF) || + (0x0001EF00 <= CP && CP <= 0x0001EFFF); +} + +// See https://www.unicode.org/Public/14.0.0/ucd/extracted/DerivedBidiClass.txt +static bool isR(llvm::UTF32 CP) { + return (CP == 0x0590) || (CP == 0x05BE) || (CP == 0x05C0) || (CP == 0x05C3) || + (CP == 0x05C6) || (0x05C8 <= CP && CP <= 0x05CF) || + (0x05D0 <= CP && CP <= 0x05EA) || (0x05EB <= CP && CP <= 0x05EE) || + (0x05EF <= CP && CP <= 0x05F2) || (0x05F3 <= CP && CP <= 0x05F4) || + (0x05F5 <= CP && CP <= 0x05FF) || (0x07C0 <= CP && CP <= 0x07C9) || + (0x07CA <= CP && CP <= 0x07EA) || (0x07F4 <= CP && CP <= 0x07F5) || + (CP == 0x07FA) || (0x07FB <= CP && CP <= 0x07FC) || + (0x07FE <= CP && CP <= 0x07FF) || (0x0800 <= CP && CP <= 0x0815) || + (CP == 0x081A) || (CP == 0x0824) || (CP == 0x0828) || + (0x082E <= CP && CP <= 0x082F) || (0x0830 <= CP && CP <= 0x083E) || + (CP == 0x083F) || (0x0840 <= CP && CP <= 0x0858) || + (0x085C <= CP && CP <= 0x085D) || (CP == 0x085E) || (CP == 0x085F) || + (CP == 0x200F) || (CP == 0xFB1D) || (0xFB1F <= CP && CP <= 0xFB28) || + (0xFB2A <= CP && CP <= 0xFB36) || (CP == 0xFB37) || + (0xFB38 <= CP && CP <= 0xFB3C) || (CP == 0xFB3D) || (CP == 0xFB3E) || + (CP == 0xFB3F) || (0xFB40 <= CP && CP <= 0xFB41) || (CP == 0xFB42) || + (0xFB43 <= CP && CP <= 0xFB44) || (CP == 0xFB45) || + (0xFB46 <= CP && CP <= 0xFB4F) || (0x10800 <= CP && CP <= 0x10805) || + (0x10806 <= CP && CP <= 0x10807) || (CP == 0x10808) || + (CP == 0x10809) || (0x1080A <= CP && CP <= 0x10835) || + (CP == 0x10836) || (0x10837 <= CP && CP <= 0x10838) || + (0x10839 <= CP && CP <= 0x1083B) || (CP == 0x1083C) || + (0x1083D <= CP && CP <= 0x1083E) || (0x1083F <= CP && CP <= 0x10855) || + (CP == 0x10856) || (CP == 0x10857) || + (0x10858 <= CP && CP <= 0x1085F) || (0x10860 <= CP && CP <= 0x10876) || + (0x10877 <= CP && CP <= 0x10878) || (0x10879 <= CP && CP <= 0x1087F) || + (0x10880 <= CP && CP <= 0x1089E) || (0x1089F <= CP && CP <= 0x108A6) || + (0x108A7 <= CP && CP <= 0x108AF) || (0x108B0 <= CP && CP <= 0x108DF) || + (0x108E0 <= CP && CP <= 0x108F2) || (CP == 0x108F3) || + (0x108F4 <= CP && CP <= 0x108F5) || (0x108F6 <= CP && CP <= 0x108FA) || + (0x108FB <= CP && CP <= 0x108FF) || (0x10900 <= CP && CP <= 0x10915) || + (0x10916 <= CP && CP <= 0x1091B) || (0x1091C <= CP && CP <= 0x1091E) || + (0x10920 <= CP && CP <= 0x10939) || (0x1093A <= CP && CP <= 0x1093E) || + (CP == 0x1093F) || (0x10940 <= CP && CP <= 0x1097F) || + (0x10980 <= CP && CP <= 0x109B7) || (0x109B8 <= CP && CP <= 0x109BB) || + (0x109BC <= CP && CP <= 0x109BD) || (0x109BE <= CP && CP <= 0x109BF) || + (0x109C0 <= CP && CP <= 0x109CF) || (0x109D0 <= CP && CP <= 0x109D1) || + (0x109D2 <= CP && CP <= 0x109FF) || (CP == 0x10A00) || + (CP == 0x10A04) || (0x10A07 <= CP && CP <= 0x10A0B) || + (0x10A10 <= CP && CP <= 0x10A13) || (CP == 0x10A14) || + (0x10A15 <= CP && CP <= 0x10A17) || (CP == 0x10A18) || + (0x10A19 <= CP && CP <= 0x10A35) || (0x10A36 <= CP && CP <= 0x10A37) || + (0x10A3B <= CP && CP <= 0x10A3E) || (0x10A40 <= CP && CP <= 0x10A48) || + (0x10A49 <= CP && CP <= 0x10A4F) || (0x10A50 <= CP && CP <= 0x10A58) || + (0x10A59 <= CP && CP <= 0x10A5F) || (0x10A60 <= CP && CP <= 0x10A7C) || + (0x10A7D <= CP && CP <= 0x10A7E) || (CP == 0x10A7F) || + (0x10A80 <= CP && CP <= 0x10A9C) || (0x10A9D <= CP && CP <= 0x10A9F) || + (0x10AA0 <= CP && CP <= 0x10ABF) || (0x10AC0 <= CP && CP <= 0x10AC7) || + (CP == 0x10AC8) || (0x10AC9 <= CP && CP <= 0x10AE4) || + (0x10AE7 <= CP && CP <= 0x10AEA) || (0x10AEB <= CP && CP <= 0x10AEF) || + (0x10AF0 <= CP && CP <= 0x10AF6) || (0x10AF7 <= CP && CP <= 0x10AFF) || + (0x10B00 <= CP && CP <= 0x10B35) || (0x10B36 <= CP && CP <= 0x10B38) || + (0x10B40 <= CP && CP <= 0x10B55) || (0x10B56 <= CP && CP <= 0x10B57) || + (0x10B58 <= CP && CP <= 0x10B5F) || (0x10B60 <= CP && CP <= 0x10B72) || + (0x10B73 <= CP && CP <= 0x10B77) || (0x10B78 <= CP && CP <= 0x10B7F) || + (0x10B80 <= CP && CP <= 0x10B91) || (0x10B92 <= CP && CP <= 0x10B98) || + (0x10B99 <= CP && CP <= 0x10B9C) || (0x10B9D <= CP && CP <= 0x10BA8) || + (0x10BA9 <= CP && CP <= 0x10BAF) || (0x10BB0 <= CP && CP <= 0x10BFF) || + (0x10C00 <= CP && CP <= 0x10C48) || (0x10C49 <= CP && CP <= 0x10C7F) || + (0x10C80 <= CP && CP <= 0x10CB2) || (0x10CB3 <= CP && CP <= 0x10CBF) || + (0x10CC0 <= CP && CP <= 0x10CF2) || (0x10CF3 <= CP && CP <= 0x10CF9) || + (0x10CFA <= CP && CP <= 0x10CFF) || (0x10D40 <= CP && CP <= 0x10E5F) || + (CP == 0x10E7F) || (0x10E80 <= CP && CP <= 0x10EA9) || + (CP == 0x10EAA) || (CP == 0x10EAD) || + (0x10EAE <= CP && CP <= 0x10EAF) || (0x10EB0 <= CP && CP <= 0x10EB1) || + (0x10EB2 <= CP && CP <= 0x10EFF) || (0x10F00 <= CP && CP <= 0x10F1C) || + (0x10F1D <= CP && CP <= 0x10F26) || (CP == 0x10F27) || + (0x10F28 <= CP && CP <= 0x10F2F) || (0x10F70 <= CP && CP <= 0x10F81) || + (0x10F86 <= CP && CP <= 0x10F89) || (0x10F8A <= CP && CP <= 0x10FAF) || + (0x10FB0 <= CP && CP <= 0x10FC4) || (0x10FC5 <= CP && CP <= 0x10FCB) || + (0x10FCC <= CP && CP <= 0x10FDF) || (0x10FE0 <= CP && CP <= 0x10FF6) || + (0x10FF7 <= CP && CP <= 0x10FFF) || (0x1E800 <= CP && CP <= 0x1E8C4) || + (0x1E8C5 <= CP && CP <= 0x1E8C6) || (0x1E8C7 <= CP && CP <= 0x1E8CF) || + (0x1E8D7 <= CP && CP <= 0x1E8FF) || (0x1E900 <= CP && CP <= 0x1E943) || + (CP == 0x1E94B) || (0x1E94C <= CP && CP <= 0x1E94F) || + (0x1E950 <= CP && CP <= 0x1E959) || (0x1E95A <= CP && CP <= 0x1E95D) || + (0x1E95E <= CP && CP <= 0x1E95F) || (0x1E960 <= CP && CP <= 0x1EC6F) || + (0x1ECC0 <= CP && CP <= 0x1ECFF) || (0x1ED50 <= CP && CP <= 0x1EDFF); +} + +static bool hasRTLCharacters(StringRef Buffer) { + const char *CurPtr = Buffer.begin(); + const char *EndPtr = Buffer.end(); + while (CurPtr < EndPtr) { + llvm::UTF32 CodePoint; + llvm::ConversionResult Result = llvm::convertUTF8Sequence( + (const llvm::UTF8 **)&CurPtr, (const llvm::UTF8 *)EndPtr, &CodePoint, + llvm::strictConversion); + if (Result != llvm::conversionOK) + break; + if (isUnassignedAL(CodePoint) || isUnassignedR(CodePoint) || isR(CodePoint)) + return true; + } + return false; +} + +MisleadingIdentifierCheck::MisleadingIdentifierCheck(StringRef Name, + ClangTidyContext *Context) + : ClangTidyCheck(Name, Context) {} + +MisleadingIdentifierCheck::~MisleadingIdentifierCheck() = default; + +void MisleadingIdentifierCheck::check( + const ast_matchers::MatchFinder::MatchResult &Result) { + if (const auto *ND = Result.Nodes.getNodeAs("nameddecl")) { + IdentifierInfo *II = ND->getIdentifier(); + if (II) { + StringRef NDName = II->getName(); + if (hasRTLCharacters(NDName)) + diag(ND->getBeginLoc(), "identifier has right-to-left codepoints"); + } + } +} + +void MisleadingIdentifierCheck::registerMatchers( + ast_matchers::MatchFinder *Finder) { + Finder->addMatcher(ast_matchers::namedDecl().bind("nameddecl"), this); +} + +} // namespace misc +} // namespace tidy +} // namespace clang diff --git a/clang-tools-extra/clang-tidy/misc/MisleadingIdentifier.h b/clang-tools-extra/clang-tidy/misc/MisleadingIdentifier.h new file mode 100644 index 0000000..9580ae6 --- /dev/null +++ b/clang-tools-extra/clang-tidy/misc/MisleadingIdentifier.h @@ -0,0 +1,31 @@ +//===--- MisleadingIdentifierCheck.h - clang-tidy ---------------*- C++ -*-===// +// +// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. +// See https://llvm.org/LICENSE.txt for license information. +// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_MISLEADINGIDENTIFIERCHECK_H +#define LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_MISLEADINGIDENTIFIERCHECK_H + +#include "../ClangTidyCheck.h" + +namespace clang { +namespace tidy { +namespace misc { + +class MisleadingIdentifierCheck : public ClangTidyCheck { +public: + MisleadingIdentifierCheck(StringRef Name, ClangTidyContext *Context); + ~MisleadingIdentifierCheck(); + + void registerMatchers(ast_matchers::MatchFinder *Finder) override; + void check(const ast_matchers::MatchFinder::MatchResult &Result) override; +}; + +} // namespace misc +} // namespace tidy +} // namespace clang + +#endif // LLVM_CLANG_TOOLS_EXTRA_CLANG_TIDY_MISC_MISLEADINGIDENTIFIERCHECK_H diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index 1eec7db..07977d0 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -223,6 +223,10 @@ New checks Inspect string literal and comments for unterminated bidirectional Unicode characters. +- New :doc:`misc-misleading-identifier ` check. + + Reports identifier with unicode right-to-left characters. + New check aliases ^^^^^^^^^^^^^^^^^ diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst index b118639..592d69b 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/list.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst @@ -209,6 +209,7 @@ Clang-Tidy Checks `misc-definitions-in-headers `_, "Yes" `misc-homoglyph `_, `misc-misleading-bidirectional `_, + `misc-misleading-identifier `_, `misc-misplaced-const `_, `misc-new-delete-overloads `_, `misc-no-recursion `_, diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc-misleading-identifier.rst b/clang-tools-extra/docs/clang-tidy/checks/misc-misleading-identifier.rst new file mode 100644 index 0000000..8bd9999 --- /dev/null +++ b/clang-tools-extra/docs/clang-tidy/checks/misc-misleading-identifier.rst @@ -0,0 +1,23 @@ +.. title:: clang-tidy - misc-misleading-identifier + +misc-misleading-identifier +========================== + +Finds identifiers that contain Unicode characters with right-to-left direction, +which can be confusing as they may change the understanding of a whole statement +line, as described in `Trojan Source `_. + +An example of such misleading code follows: + +.. code-block:: c + + #include + + short int א = (short int)0; + short int ג = (short int)12345; + + int main() { + int א = ג; // a local variable, set to zero? + printf("ג is %d\n", ג); + printf("א is %d\n", א); + } diff --git a/clang-tools-extra/test/clang-tidy/checkers/misc-misleading-identifier.cpp b/clang-tools-extra/test/clang-tidy/checkers/misc-misleading-identifier.cpp new file mode 100644 index 0000000..cb036f9 --- /dev/null +++ b/clang-tools-extra/test/clang-tidy/checkers/misc-misleading-identifier.cpp @@ -0,0 +1,15 @@ +// RUN: %check_clang_tidy %s misc-misleading-identifier %t + +#include + +// CHECK-MESSAGES: :[[#@LINE+1]]:1: warning: identifier has right-to-left codepoints [misc-misleading-identifier] +short int א = (short int)0; +// CHECK-MESSAGES: :[[#@LINE+1]]:1: warning: identifier has right-to-left codepoints [misc-misleading-identifier] +short int ג = (short int)12345; + +int main() { + // CHECK-MESSAGES: :[[#@LINE+1]]:3: warning: identifier has right-to-left codepoints [misc-misleading-identifier] + int א = ג; // a local variable, set to zero? + printf("ג is %d\n", ג); + printf("א is %d\n", א); +} -- 1.8.3.1