| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 1 | //== GenericTaintChecker.cpp ----------------------------------- -*- C++ -*--=// |
| 2 | // |
| Chandler Carruth | 2946cd7 | 2019-01-19 08:50:56 +0000 | [diff] [blame] | 3 | // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| 4 | // See https://llvm.org/LICENSE.txt for license information. |
| 5 | // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 6 | // |
| 7 | //===----------------------------------------------------------------------===// |
| 8 | // |
| 9 | // This checker defines the attack surface for generic taint propagation. |
| 10 | // |
| 11 | // The taint information produced by it might be useful to other checkers. For |
| 12 | // example, checkers should report errors which involve tainted data more |
| 13 | // aggressively, even if the involved symbols are under constrained. |
| 14 | // |
| 15 | //===----------------------------------------------------------------------===// |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 16 | |
| 17 | #include "Taint.h" |
| Kristof Umann | 76a2150 | 2018-12-15 16:23:51 +0000 | [diff] [blame] | 18 | #include "clang/StaticAnalyzer/Checkers/BuiltinCheckerRegistration.h" |
| Chandler Carruth | 3a02247 | 2012-12-04 09:13:33 +0000 | [diff] [blame] | 19 | #include "clang/AST/Attr.h" |
| 20 | #include "clang/Basic/Builtins.h" |
| 21 | #include "clang/StaticAnalyzer/Core/BugReporter/BugType.h" |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 22 | #include "clang/StaticAnalyzer/Core/Checker.h" |
| 23 | #include "clang/StaticAnalyzer/Core/CheckerManager.h" |
| 24 | #include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h" |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 25 | #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h" |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 26 | #include <climits> |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 27 | #include <initializer_list> |
| 28 | #include <utility> |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 29 | |
| 30 | using namespace clang; |
| 31 | using namespace ento; |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 32 | using namespace taint; |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 33 | |
| 34 | namespace { |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 35 | class GenericTaintChecker |
| 36 | : public Checker<check::PostStmt<CallExpr>, check::PreStmt<CallExpr>> { |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 37 | public: |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 38 | static void *getTag() { |
| 39 | static int Tag; |
| 40 | return &Tag; |
| 41 | } |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 42 | |
| 43 | void checkPostStmt(const CallExpr *CE, CheckerContext &C) const; |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 44 | |
| 45 | void checkPreStmt(const CallExpr *CE, CheckerContext &C) const; |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 46 | |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 47 | void printState(raw_ostream &Out, ProgramStateRef State, |
| 48 | const char *NL, const char *Sep) const override; |
| 49 | |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 50 | private: |
| Anna Zaks | bf74051 | 2012-01-24 19:32:25 +0000 | [diff] [blame] | 51 | static const unsigned InvalidArgIndex = UINT_MAX; |
| 52 | /// Denotes the return vale. |
| 53 | static const unsigned ReturnValueIndex = UINT_MAX - 1; |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 54 | |
| Ahmed Charles | b898432 | 2014-03-07 20:03:18 +0000 | [diff] [blame] | 55 | mutable std::unique_ptr<BugType> BT; |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 56 | void initBugType() const { |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 57 | if (!BT) |
| Alexander Kornienko | 4aca9b1 | 2014-02-11 21:49:21 +0000 | [diff] [blame] | 58 | BT.reset(new BugType(this, "Use of Untrusted Data", "Untrusted Data")); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 59 | } |
| Anna Zaks | 457c687 | 2011-11-18 02:26:36 +0000 | [diff] [blame] | 60 | |
| Adrian Prantl | 9fc8faf | 2018-05-09 01:00:01 +0000 | [diff] [blame] | 61 | /// Catch taint related bugs. Check if tainted data is passed to a |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 62 | /// system call etc. |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 63 | bool checkPre(const CallExpr *CE, CheckerContext &C) const; |
| 64 | |
| Adrian Prantl | 9fc8faf | 2018-05-09 01:00:01 +0000 | [diff] [blame] | 65 | /// Add taint sources on a pre-visit. |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 66 | void addSourcesPre(const CallExpr *CE, CheckerContext &C) const; |
| 67 | |
| Adrian Prantl | 9fc8faf | 2018-05-09 01:00:01 +0000 | [diff] [blame] | 68 | /// Propagate taint generated at pre-visit. |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 69 | bool propagateFromPre(const CallExpr *CE, CheckerContext &C) const; |
| 70 | |
| Anna Zaks | bf74051 | 2012-01-24 19:32:25 +0000 | [diff] [blame] | 71 | /// Check if the region the expression evaluates to is the standard input, |
| 72 | /// and thus, is tainted. |
| 73 | static bool isStdin(const Expr *E, CheckerContext &C); |
| 74 | |
| Adrian Prantl | 9fc8faf | 2018-05-09 01:00:01 +0000 | [diff] [blame] | 75 | /// Given a pointer argument, return the value it points to. |
| Artem Dergachev | eed7a31 | 2017-05-29 15:42:56 +0000 | [diff] [blame] | 76 | static Optional<SVal> getPointedToSVal(CheckerContext &C, const Expr *Arg); |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 77 | |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 78 | /// Check for CWE-134: Uncontrolled Format String. |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 79 | static const char MsgUncontrolledFormatString[]; |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 80 | bool checkUncontrolledFormatString(const CallExpr *CE, |
| 81 | CheckerContext &C) const; |
| 82 | |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 83 | /// Check for: |
| 84 | /// CERT/STR02-C. "Sanitize data passed to complex subsystems" |
| 85 | /// CWE-78, "Failure to Sanitize Data into an OS Command" |
| 86 | static const char MsgSanitizeSystemArgs[]; |
| 87 | bool checkSystemCall(const CallExpr *CE, StringRef Name, |
| 88 | CheckerContext &C) const; |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 89 | |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 90 | /// Check if tainted data is used as a buffer size ins strn.. functions, |
| 91 | /// and allocators. |
| 92 | static const char MsgTaintedBufferSize[]; |
| 93 | bool checkTaintedBufferSize(const CallExpr *CE, const FunctionDecl *FDecl, |
| 94 | CheckerContext &C) const; |
| 95 | |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 96 | /// Generate a report if the expression is tainted or points to tainted data. |
| 97 | bool generateReportIfTainted(const Expr *E, const char Msg[], |
| 98 | CheckerContext &C) const; |
| Ted Kremenek | 3a0678e | 2015-09-08 03:50:52 +0000 | [diff] [blame] | 99 | |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 100 | using ArgVector = SmallVector<unsigned, 2>; |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 101 | |
| Adrian Prantl | 9fc8faf | 2018-05-09 01:00:01 +0000 | [diff] [blame] | 102 | /// A struct used to specify taint propagation rules for a function. |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 103 | /// |
| 104 | /// If any of the possible taint source arguments is tainted, all of the |
| 105 | /// destination arguments should also be tainted. Use InvalidArgIndex in the |
| 106 | /// src list to specify that all of the arguments can introduce taint. Use |
| 107 | /// InvalidArgIndex in the dst arguments to signify that all the non-const |
| 108 | /// pointer and reference arguments might be tainted on return. If |
| 109 | /// ReturnValueIndex is added to the dst list, the return value will be |
| 110 | /// tainted. |
| 111 | struct TaintPropagationRule { |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 112 | enum class VariadicType { None, Src, Dst }; |
| 113 | |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 114 | using PropagationFuncType = bool (*)(bool IsTainted, const CallExpr *, |
| 115 | CheckerContext &C); |
| 116 | |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 117 | /// List of arguments which can be taint sources and should be checked. |
| 118 | ArgVector SrcArgs; |
| 119 | /// List of arguments which should be tainted on function return. |
| 120 | ArgVector DstArgs; |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 121 | /// Index for the first variadic parameter if exist. |
| 122 | unsigned VariadicIndex; |
| 123 | /// Show when a function has variadic parameters. If it has, it marks all |
| 124 | /// of them as source or destination. |
| 125 | VariadicType VarType; |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 126 | /// Special function for tainted source determination. If defined, it can |
| 127 | /// override the default behavior. |
| 128 | PropagationFuncType PropagationFunc; |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 129 | |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 130 | TaintPropagationRule() |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 131 | : VariadicIndex(InvalidArgIndex), VarType(VariadicType::None), |
| 132 | PropagationFunc(nullptr) {} |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 133 | |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 134 | TaintPropagationRule(std::initializer_list<unsigned> &&Src, |
| 135 | std::initializer_list<unsigned> &&Dst, |
| 136 | VariadicType Var = VariadicType::None, |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 137 | unsigned VarIndex = InvalidArgIndex, |
| 138 | PropagationFuncType Func = nullptr) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 139 | : SrcArgs(std::move(Src)), DstArgs(std::move(Dst)), |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 140 | VariadicIndex(VarIndex), VarType(Var), PropagationFunc(Func) {} |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 141 | |
| 142 | /// Get the propagation rule for a given function. |
| 143 | static TaintPropagationRule |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 144 | getTaintPropagationRule(const FunctionDecl *FDecl, StringRef Name, |
| 145 | CheckerContext &C); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 146 | |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 147 | void addSrcArg(unsigned A) { SrcArgs.push_back(A); } |
| 148 | void addDstArg(unsigned A) { DstArgs.push_back(A); } |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 149 | |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 150 | bool isNull() const { |
| 151 | return SrcArgs.empty() && DstArgs.empty() && |
| 152 | VariadicType::None == VarType; |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 153 | } |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 154 | |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 155 | bool isDestinationArgument(unsigned ArgNum) const { |
| 156 | return (llvm::find(DstArgs, ArgNum) != DstArgs.end()); |
| 157 | } |
| 158 | |
| 159 | static bool isTaintedOrPointsToTainted(const Expr *E, ProgramStateRef State, |
| 160 | CheckerContext &C) { |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 161 | if (isTainted(State, E, C.getLocationContext()) || isStdin(E, C)) |
| Artem Dergachev | eed7a31 | 2017-05-29 15:42:56 +0000 | [diff] [blame] | 162 | return true; |
| 163 | |
| 164 | if (!E->getType().getTypePtr()->isPointerType()) |
| 165 | return false; |
| 166 | |
| 167 | Optional<SVal> V = getPointedToSVal(C, E); |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 168 | return (V && isTainted(State, *V)); |
| Anna Zaks | bf74051 | 2012-01-24 19:32:25 +0000 | [diff] [blame] | 169 | } |
| 170 | |
| Adrian Prantl | 9fc8faf | 2018-05-09 01:00:01 +0000 | [diff] [blame] | 171 | /// Pre-process a function which propagates taint according to the |
| Anna Zaks | 7f6a6b7 | 2012-01-18 02:45:13 +0000 | [diff] [blame] | 172 | /// taint rule. |
| Ted Kremenek | 49b1e38 | 2012-01-26 21:29:00 +0000 | [diff] [blame] | 173 | ProgramStateRef process(const CallExpr *CE, CheckerContext &C) const; |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 174 | |
| 175 | // Functions for custom taintedness propagation. |
| 176 | static bool postSocket(bool IsTainted, const CallExpr *CE, |
| 177 | CheckerContext &C); |
| Anna Zaks | 7f6a6b7 | 2012-01-18 02:45:13 +0000 | [diff] [blame] | 178 | }; |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 179 | }; |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 180 | |
| 181 | const unsigned GenericTaintChecker::ReturnValueIndex; |
| 182 | const unsigned GenericTaintChecker::InvalidArgIndex; |
| 183 | |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 184 | const char GenericTaintChecker::MsgUncontrolledFormatString[] = |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 185 | "Untrusted data is used as a format string " |
| 186 | "(CWE-134: Uncontrolled Format String)"; |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 187 | |
| 188 | const char GenericTaintChecker::MsgSanitizeSystemArgs[] = |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 189 | "Untrusted data is passed to a system call " |
| 190 | "(CERT/STR02-C. Sanitize data passed to complex subsystems)"; |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 191 | |
| 192 | const char GenericTaintChecker::MsgTaintedBufferSize[] = |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 193 | "Untrusted data is used to specify the buffer size " |
| 194 | "(CERT/STR31-C. Guarantee that storage for strings has sufficient space " |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 195 | "for character data and the null terminator)"; |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 196 | |
| 197 | } // end of anonymous namespace |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 198 | |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 199 | /// A set which is used to pass information from call pre-visit instruction |
| 200 | /// to the call post-visit. The values are unsigned integers, which are either |
| 201 | /// ReturnValueIndex, or indexes of the pointer/reference argument, which |
| 202 | /// points to data, which should be tainted on return. |
| Jordan Rose | 0c153cb | 2012-11-02 01:54:06 +0000 | [diff] [blame] | 203 | REGISTER_SET_WITH_PROGRAMSTATE(TaintArgsOnPostVisit, unsigned) |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 204 | |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 205 | GenericTaintChecker::TaintPropagationRule |
| 206 | GenericTaintChecker::TaintPropagationRule::getTaintPropagationRule( |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 207 | const FunctionDecl *FDecl, StringRef Name, CheckerContext &C) { |
| Enrico Pertoso | 4432d87 | 2015-06-03 09:10:58 +0000 | [diff] [blame] | 208 | // TODO: Currently, we might lose precision here: we always mark a return |
| Anna Zaks | bf74051 | 2012-01-24 19:32:25 +0000 | [diff] [blame] | 209 | // value as tainted even if it's just a pointer, pointing to tainted data. |
| 210 | |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 211 | // Check for exact name match for functions without builtin substitutes. |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 212 | TaintPropagationRule Rule = |
| 213 | llvm::StringSwitch<TaintPropagationRule>(Name) |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 214 | // Source functions |
| 215 | // TODO: Add support for vfscanf & family. |
| 216 | .Case("fdopen", TaintPropagationRule({}, {ReturnValueIndex})) |
| 217 | .Case("fopen", TaintPropagationRule({}, {ReturnValueIndex})) |
| 218 | .Case("freopen", TaintPropagationRule({}, {ReturnValueIndex})) |
| 219 | .Case("getch", TaintPropagationRule({}, {ReturnValueIndex})) |
| 220 | .Case("getchar", TaintPropagationRule({}, {ReturnValueIndex})) |
| 221 | .Case("getchar_unlocked", TaintPropagationRule({}, {ReturnValueIndex})) |
| 222 | .Case("getenv", TaintPropagationRule({}, {ReturnValueIndex})) |
| 223 | .Case("gets", TaintPropagationRule({}, {0, ReturnValueIndex})) |
| 224 | .Case("scanf", TaintPropagationRule({}, {}, VariadicType::Dst, 1)) |
| 225 | .Case("socket", |
| 226 | TaintPropagationRule({}, {ReturnValueIndex}, VariadicType::None, |
| 227 | InvalidArgIndex, |
| 228 | &TaintPropagationRule::postSocket)) |
| 229 | .Case("wgetch", TaintPropagationRule({}, {ReturnValueIndex})) |
| 230 | // Propagating functions |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 231 | .Case("atoi", TaintPropagationRule({0}, {ReturnValueIndex})) |
| 232 | .Case("atol", TaintPropagationRule({0}, {ReturnValueIndex})) |
| 233 | .Case("atoll", TaintPropagationRule({0}, {ReturnValueIndex})) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 234 | .Case("fgetc", TaintPropagationRule({0}, {ReturnValueIndex})) |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 235 | .Case("fgetln", TaintPropagationRule({0}, {ReturnValueIndex})) |
| 236 | .Case("fgets", TaintPropagationRule({2}, {0, ReturnValueIndex})) |
| 237 | .Case("fscanf", TaintPropagationRule({0}, {}, VariadicType::Dst, 2)) |
| 238 | .Case("getc", TaintPropagationRule({0}, {ReturnValueIndex})) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 239 | .Case("getc_unlocked", TaintPropagationRule({0}, {ReturnValueIndex})) |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 240 | .Case("getdelim", TaintPropagationRule({3}, {0})) |
| 241 | .Case("getline", TaintPropagationRule({2}, {0})) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 242 | .Case("getw", TaintPropagationRule({0}, {ReturnValueIndex})) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 243 | .Case("pread", |
| 244 | TaintPropagationRule({0, 1, 2, 3}, {1, ReturnValueIndex})) |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 245 | .Case("read", TaintPropagationRule({0, 2}, {1, ReturnValueIndex})) |
| 246 | .Case("strchr", TaintPropagationRule({0}, {ReturnValueIndex})) |
| 247 | .Case("strrchr", TaintPropagationRule({0}, {ReturnValueIndex})) |
| 248 | .Case("tolower", TaintPropagationRule({0}, {ReturnValueIndex})) |
| 249 | .Case("toupper", TaintPropagationRule({0}, {ReturnValueIndex})) |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 250 | .Default(TaintPropagationRule()); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 251 | |
| 252 | if (!Rule.isNull()) |
| 253 | return Rule; |
| 254 | |
| 255 | // Check if it's one of the memory setting/copying functions. |
| 256 | // This check is specialized but faster then calling isCLibraryFunction. |
| 257 | unsigned BId = 0; |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 258 | if ((BId = FDecl->getMemoryFunctionKind())) |
| 259 | switch (BId) { |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 260 | case Builtin::BImemcpy: |
| 261 | case Builtin::BImemmove: |
| 262 | case Builtin::BIstrncpy: |
| 263 | case Builtin::BIstrncat: |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 264 | return TaintPropagationRule({1, 2}, {0, ReturnValueIndex}); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 265 | case Builtin::BIstrlcpy: |
| 266 | case Builtin::BIstrlcat: |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 267 | return TaintPropagationRule({1, 2}, {0}); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 268 | case Builtin::BIstrndup: |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 269 | return TaintPropagationRule({0, 1}, {ReturnValueIndex}); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 270 | |
| 271 | default: |
| 272 | break; |
| 273 | }; |
| 274 | |
| 275 | // Process all other functions which could be defined as builtins. |
| 276 | if (Rule.isNull()) { |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 277 | if (C.isCLibraryFunction(FDecl, "snprintf")) |
| 278 | return TaintPropagationRule({1}, {0, ReturnValueIndex}, VariadicType::Src, |
| 279 | 3); |
| 280 | else if (C.isCLibraryFunction(FDecl, "sprintf")) |
| 281 | return TaintPropagationRule({}, {0, ReturnValueIndex}, VariadicType::Src, |
| 282 | 2); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 283 | else if (C.isCLibraryFunction(FDecl, "strcpy") || |
| 284 | C.isCLibraryFunction(FDecl, "stpcpy") || |
| 285 | C.isCLibraryFunction(FDecl, "strcat")) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 286 | return TaintPropagationRule({1}, {0, ReturnValueIndex}); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 287 | else if (C.isCLibraryFunction(FDecl, "bcopy")) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 288 | return TaintPropagationRule({0, 2}, {1}); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 289 | else if (C.isCLibraryFunction(FDecl, "strdup") || |
| 290 | C.isCLibraryFunction(FDecl, "strdupa")) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 291 | return TaintPropagationRule({0}, {ReturnValueIndex}); |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 292 | else if (C.isCLibraryFunction(FDecl, "wcsdup")) |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 293 | return TaintPropagationRule({0}, {ReturnValueIndex}); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 294 | } |
| 295 | |
| 296 | // Skipping the following functions, since they might be used for cleansing |
| 297 | // or smart memory copy: |
| Benjamin Kramer | 474261a | 2012-06-02 10:20:41 +0000 | [diff] [blame] | 298 | // - memccpy - copying until hitting a special character. |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 299 | |
| 300 | return TaintPropagationRule(); |
| Anna Zaks | 457c687 | 2011-11-18 02:26:36 +0000 | [diff] [blame] | 301 | } |
| 302 | |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 303 | void GenericTaintChecker::checkPreStmt(const CallExpr *CE, |
| 304 | CheckerContext &C) const { |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 305 | // Check for taintedness related errors first: system call, uncontrolled |
| 306 | // format string, tainted buffer size. |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 307 | if (checkPre(CE, C)) |
| 308 | return; |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 309 | |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 310 | // Marks the function's arguments and/or return value tainted if it present in |
| 311 | // the list. |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 312 | addSourcesPre(CE, C); |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 313 | } |
| 314 | |
| 315 | void GenericTaintChecker::checkPostStmt(const CallExpr *CE, |
| 316 | CheckerContext &C) const { |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 317 | // Set the marked values as tainted. The return value only accessible from |
| 318 | // checkPostStmt. |
| 319 | propagateFromPre(CE, C); |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 320 | } |
| 321 | |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 322 | void GenericTaintChecker::printState(raw_ostream &Out, ProgramStateRef State, |
| 323 | const char *NL, const char *Sep) const { |
| 324 | printTaint(State, Out, NL, Sep); |
| 325 | } |
| 326 | |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 327 | void GenericTaintChecker::addSourcesPre(const CallExpr *CE, |
| 328 | CheckerContext &C) const { |
| Craig Topper | 0dbb783 | 2014-05-27 02:45:47 +0000 | [diff] [blame] | 329 | ProgramStateRef State = nullptr; |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 330 | const FunctionDecl *FDecl = C.getCalleeDecl(CE); |
| Jordan Rose | 6cd16c5 | 2012-07-10 23:13:01 +0000 | [diff] [blame] | 331 | if (!FDecl || FDecl->getKind() != Decl::Function) |
| 332 | return; |
| 333 | |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 334 | StringRef Name = C.getCalleeName(FDecl); |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 335 | if (Name.empty()) |
| 336 | return; |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 337 | |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 338 | // First, try generating a propagation rule for this function. |
| 339 | TaintPropagationRule Rule = |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 340 | TaintPropagationRule::getTaintPropagationRule(FDecl, Name, C); |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 341 | if (!Rule.isNull()) { |
| Anna Zaks | 7f6a6b7 | 2012-01-18 02:45:13 +0000 | [diff] [blame] | 342 | State = Rule.process(CE, C); |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 343 | if (!State) |
| 344 | return; |
| 345 | C.addTransition(State); |
| Anna Zaks | 5d324e5 | 2012-01-18 02:45:07 +0000 | [diff] [blame] | 346 | return; |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 347 | } |
| 348 | |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 349 | if (!State) |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 350 | return; |
| Anna Zaks | 3b0ab20 | 2011-12-17 00:26:34 +0000 | [diff] [blame] | 351 | C.addTransition(State); |
| 352 | } |
| 353 | |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 354 | bool GenericTaintChecker::propagateFromPre(const CallExpr *CE, |
| 355 | CheckerContext &C) const { |
| Ted Kremenek | 49b1e38 | 2012-01-26 21:29:00 +0000 | [diff] [blame] | 356 | ProgramStateRef State = C.getState(); |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 357 | |
| 358 | // Depending on what was tainted at pre-visit, we determined a set of |
| 359 | // arguments which should be tainted after the function returns. These are |
| 360 | // stored in the state as TaintArgsOnPostVisit set. |
| Jordan Rose | 0c153cb | 2012-11-02 01:54:06 +0000 | [diff] [blame] | 361 | TaintArgsOnPostVisitTy TaintArgs = State->get<TaintArgsOnPostVisit>(); |
| Anna Zaks | bf74051 | 2012-01-24 19:32:25 +0000 | [diff] [blame] | 362 | if (TaintArgs.isEmpty()) |
| 363 | return false; |
| 364 | |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 365 | for (unsigned ArgNum : TaintArgs) { |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 366 | // Special handling for the tainted return value. |
| 367 | if (ArgNum == ReturnValueIndex) { |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 368 | State = addTaint(State, CE, C.getLocationContext()); |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 369 | continue; |
| 370 | } |
| 371 | |
| 372 | // The arguments are pointer arguments. The data they are pointing at is |
| 373 | // tainted after the call. |
| Anna Zaks | b508d29 | 2012-04-10 23:41:11 +0000 | [diff] [blame] | 374 | if (CE->getNumArgs() < (ArgNum + 1)) |
| 375 | return false; |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 376 | const Expr *Arg = CE->getArg(ArgNum); |
| Artem Dergachev | eed7a31 | 2017-05-29 15:42:56 +0000 | [diff] [blame] | 377 | Optional<SVal> V = getPointedToSVal(C, Arg); |
| 378 | if (V) |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 379 | State = addTaint(State, *V); |
| Anna Zaks | b3fa8d7 | 2012-01-12 02:22:34 +0000 | [diff] [blame] | 380 | } |
| 381 | |
| 382 | // Clear up the taint info from the state. |
| 383 | State = State->remove<TaintArgsOnPostVisit>(); |
| 384 | |
| 385 | if (State != C.getState()) { |
| 386 | C.addTransition(State); |
| 387 | return true; |
| 388 | } |
| 389 | return false; |
| 390 | } |
| 391 | |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 392 | bool GenericTaintChecker::checkPre(const CallExpr *CE, |
| 393 | CheckerContext &C) const { |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 394 | |
| 395 | if (checkUncontrolledFormatString(CE, C)) |
| 396 | return true; |
| 397 | |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 398 | const FunctionDecl *FDecl = C.getCalleeDecl(CE); |
| Jordan Rose | 6cd16c5 | 2012-07-10 23:13:01 +0000 | [diff] [blame] | 399 | if (!FDecl || FDecl->getKind() != Decl::Function) |
| 400 | return false; |
| 401 | |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 402 | StringRef Name = C.getCalleeName(FDecl); |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 403 | if (Name.empty()) |
| 404 | return false; |
| 405 | |
| 406 | if (checkSystemCall(CE, Name, C)) |
| 407 | return true; |
| 408 | |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 409 | if (checkTaintedBufferSize(CE, FDecl, C)) |
| 410 | return true; |
| 411 | |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 412 | return false; |
| 413 | } |
| 414 | |
| Artem Dergachev | eed7a31 | 2017-05-29 15:42:56 +0000 | [diff] [blame] | 415 | Optional<SVal> GenericTaintChecker::getPointedToSVal(CheckerContext &C, |
| Artem Dergachev | 3ef5deb | 2017-12-12 02:27:55 +0000 | [diff] [blame] | 416 | const Expr *Arg) { |
| Ted Kremenek | 49b1e38 | 2012-01-26 21:29:00 +0000 | [diff] [blame] | 417 | ProgramStateRef State = C.getState(); |
| George Karpenkov | d703ec9 | 2018-01-17 20:27:29 +0000 | [diff] [blame] | 418 | SVal AddrVal = C.getSVal(Arg->IgnoreParens()); |
| Anna Zaks | e48ee50 | 2011-12-16 18:28:50 +0000 | [diff] [blame] | 419 | if (AddrVal.isUnknownOrUndef()) |
| Artem Dergachev | eed7a31 | 2017-05-29 15:42:56 +0000 | [diff] [blame] | 420 | return None; |
| Anna Zaks | 7c96b7d | 2011-12-11 18:43:40 +0000 | [diff] [blame] | 421 | |
| David Blaikie | 05785d1 | 2013-02-20 22:23:23 +0000 | [diff] [blame] | 422 | Optional<Loc> AddrLoc = AddrVal.getAs<Loc>(); |
| Anna Zaks | 7f6a6b7 | 2012-01-18 02:45:13 +0000 | [diff] [blame] | 423 | if (!AddrLoc) |
| Artem Dergachev | eed7a31 | 2017-05-29 15:42:56 +0000 | [diff] [blame] | 424 | return None; |
| Anna Zaks | 457c687 | 2011-11-18 02:26:36 +0000 | [diff] [blame] | 425 | |
| Artem Dergachev | 3ef5deb | 2017-12-12 02:27:55 +0000 | [diff] [blame] | 426 | QualType ArgTy = Arg->getType().getCanonicalType(); |
| 427 | if (!ArgTy->isPointerType()) |
| 428 | return None; |
| 429 | |
| 430 | QualType ValTy = ArgTy->getPointeeType(); |
| 431 | |
| 432 | // Do not dereference void pointers. Treat them as byte pointers instead. |
| 433 | // FIXME: we might want to consider more than just the first byte. |
| 434 | if (ValTy->isVoidType()) |
| 435 | ValTy = C.getASTContext().CharTy; |
| 436 | |
| 437 | return State->getSVal(*AddrLoc, ValTy); |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 438 | } |
| 439 | |
| Ted Kremenek | 3a0678e | 2015-09-08 03:50:52 +0000 | [diff] [blame] | 440 | ProgramStateRef |
| Anna Zaks | 7f6a6b7 | 2012-01-18 02:45:13 +0000 | [diff] [blame] | 441 | GenericTaintChecker::TaintPropagationRule::process(const CallExpr *CE, |
| 442 | CheckerContext &C) const { |
| Ted Kremenek | 49b1e38 | 2012-01-26 21:29:00 +0000 | [diff] [blame] | 443 | ProgramStateRef State = C.getState(); |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 444 | |
| 445 | // Check for taint in arguments. |
| Kristof Umann | 8554783 | 2019-03-05 12:42:59 +0000 | [diff] [blame] | 446 | bool IsTainted = true; |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 447 | for (unsigned ArgNum : SrcArgs) { |
| 448 | if (ArgNum >= CE->getNumArgs()) |
| Anna Zaks | b508d29 | 2012-04-10 23:41:11 +0000 | [diff] [blame] | 449 | return State; |
| Anna Zaks | bf74051 | 2012-01-24 19:32:25 +0000 | [diff] [blame] | 450 | if ((IsTainted = isTaintedOrPointsToTainted(CE->getArg(ArgNum), State, C))) |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 451 | break; |
| 452 | } |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 453 | |
| 454 | // Check for taint in variadic arguments. |
| 455 | if (!IsTainted && VariadicType::Src == VarType) { |
| 456 | // Check if any of the arguments is tainted |
| 457 | for (unsigned int i = VariadicIndex; i < CE->getNumArgs(); ++i) { |
| 458 | if ((IsTainted = isTaintedOrPointsToTainted(CE->getArg(i), State, C))) |
| 459 | break; |
| 460 | } |
| 461 | } |
| 462 | |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 463 | if (PropagationFunc) |
| 464 | IsTainted = PropagationFunc(IsTainted, CE, C); |
| 465 | |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 466 | if (!IsTainted) |
| 467 | return State; |
| 468 | |
| 469 | // Mark the arguments which should be tainted after the function returns. |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 470 | for (unsigned ArgNum : DstArgs) { |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 471 | // Should mark the return value? |
| 472 | if (ArgNum == ReturnValueIndex) { |
| 473 | State = State->add<TaintArgsOnPostVisit>(ReturnValueIndex); |
| 474 | continue; |
| 475 | } |
| 476 | |
| 477 | // Mark the given argument. |
| 478 | assert(ArgNum < CE->getNumArgs()); |
| 479 | State = State->add<TaintArgsOnPostVisit>(ArgNum); |
| 480 | } |
| 481 | |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 482 | // Mark all variadic arguments tainted if present. |
| 483 | if (VariadicType::Dst == VarType) { |
| 484 | // For all pointer and references that were passed in: |
| 485 | // If they are not pointing to const data, mark data as tainted. |
| 486 | // TODO: So far we are just going one level down; ideally we'd need to |
| 487 | // recurse here. |
| 488 | for (unsigned int i = VariadicIndex; i < CE->getNumArgs(); ++i) { |
| 489 | const Expr *Arg = CE->getArg(i); |
| 490 | // Process pointer argument. |
| 491 | const Type *ArgTy = Arg->getType().getTypePtr(); |
| 492 | QualType PType = ArgTy->getPointeeType(); |
| 493 | if ((!PType.isNull() && !PType.isConstQualified()) || |
| 494 | (ArgTy->isReferenceType() && !Arg->getType().isConstQualified())) |
| 495 | State = State->add<TaintArgsOnPostVisit>(i); |
| 496 | } |
| 497 | } |
| 498 | |
| Anna Zaks | 3666d2c | 2012-01-17 00:37:02 +0000 | [diff] [blame] | 499 | return State; |
| 500 | } |
| 501 | |
| Anna Zaks | 3b754b2 | 2012-01-20 00:11:19 +0000 | [diff] [blame] | 502 | // If argument 0(protocol domain) is network, the return value should get taint. |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 503 | bool GenericTaintChecker::TaintPropagationRule::postSocket(bool /*IsTainted*/, |
| 504 | const CallExpr *CE, |
| 505 | CheckerContext &C) { |
| Anna Zaks | 3b754b2 | 2012-01-20 00:11:19 +0000 | [diff] [blame] | 506 | SourceLocation DomLoc = CE->getArg(0)->getExprLoc(); |
| 507 | StringRef DomName = C.getMacroNameOrSpelling(DomLoc); |
| 508 | // White list the internal communication protocols. |
| 509 | if (DomName.equals("AF_SYSTEM") || DomName.equals("AF_LOCAL") || |
| 510 | DomName.equals("AF_UNIX") || DomName.equals("AF_RESERVED_36")) |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 511 | return false; |
| Anna Zaks | 3b754b2 | 2012-01-20 00:11:19 +0000 | [diff] [blame] | 512 | |
| Kristof Umann | 2827349 | 2019-03-08 15:47:56 +0000 | [diff] [blame] | 513 | return true; |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 514 | } |
| 515 | |
| Anna Zaks | bf74051 | 2012-01-24 19:32:25 +0000 | [diff] [blame] | 516 | bool GenericTaintChecker::isStdin(const Expr *E, CheckerContext &C) { |
| Ted Kremenek | 49b1e38 | 2012-01-26 21:29:00 +0000 | [diff] [blame] | 517 | ProgramStateRef State = C.getState(); |
| George Karpenkov | d703ec9 | 2018-01-17 20:27:29 +0000 | [diff] [blame] | 518 | SVal Val = C.getSVal(E); |
| Anna Zaks | 099fe3f | 2011-12-14 00:56:18 +0000 | [diff] [blame] | 519 | |
| Anna Zaks | e48ee50 | 2011-12-16 18:28:50 +0000 | [diff] [blame] | 520 | // stdin is a pointer, so it would be a region. |
| 521 | const MemRegion *MemReg = Val.getAsRegion(); |
| 522 | |
| 523 | // The region should be symbolic, we do not know it's value. |
| 524 | const SymbolicRegion *SymReg = dyn_cast_or_null<SymbolicRegion>(MemReg); |
| 525 | if (!SymReg) |
| Anna Zaks | 099fe3f | 2011-12-14 00:56:18 +0000 | [diff] [blame] | 526 | return false; |
| 527 | |
| Anna Zaks | e48ee50 | 2011-12-16 18:28:50 +0000 | [diff] [blame] | 528 | // Get it's symbol and find the declaration region it's pointing to. |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 529 | const SymbolRegionValue *Sm = |
| 530 | dyn_cast<SymbolRegionValue>(SymReg->getSymbol()); |
| Anna Zaks | e48ee50 | 2011-12-16 18:28:50 +0000 | [diff] [blame] | 531 | if (!Sm) |
| 532 | return false; |
| 533 | const DeclRegion *DeclReg = dyn_cast_or_null<DeclRegion>(Sm->getRegion()); |
| 534 | if (!DeclReg) |
| 535 | return false; |
| Anna Zaks | 099fe3f | 2011-12-14 00:56:18 +0000 | [diff] [blame] | 536 | |
| Anna Zaks | e48ee50 | 2011-12-16 18:28:50 +0000 | [diff] [blame] | 537 | // This region corresponds to a declaration, find out if it's a global/extern |
| 538 | // variable named stdin with the proper type. |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 539 | if (const auto *D = dyn_cast_or_null<VarDecl>(DeclReg->getDecl())) { |
| Anna Zaks | e48ee50 | 2011-12-16 18:28:50 +0000 | [diff] [blame] | 540 | D = D->getCanonicalDecl(); |
| Artem Dergachev | 2a5fb12 | 2019-01-30 00:06:43 +0000 | [diff] [blame] | 541 | if ((D->getName().find("stdin") != StringRef::npos) && D->isExternC()) { |
| 542 | const auto *PtrTy = dyn_cast<PointerType>(D->getType().getTypePtr()); |
| 543 | if (PtrTy && PtrTy->getPointeeType().getCanonicalType() == |
| 544 | C.getASTContext().getFILEType().getCanonicalType()) |
| 545 | return true; |
| 546 | } |
| Anna Zaks | e48ee50 | 2011-12-16 18:28:50 +0000 | [diff] [blame] | 547 | } |
| Anna Zaks | 099fe3f | 2011-12-14 00:56:18 +0000 | [diff] [blame] | 548 | return false; |
| 549 | } |
| 550 | |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 551 | static bool getPrintfFormatArgumentNum(const CallExpr *CE, |
| 552 | const CheckerContext &C, |
| 553 | unsigned int &ArgNum) { |
| 554 | // Find if the function contains a format string argument. |
| 555 | // Handles: fprintf, printf, sprintf, snprintf, vfprintf, vprintf, vsprintf, |
| 556 | // vsnprintf, syslog, custom annotated functions. |
| 557 | const FunctionDecl *FDecl = C.getCalleeDecl(CE); |
| 558 | if (!FDecl) |
| 559 | return false; |
| Aaron Ballman | be22bcb | 2014-03-10 17:08:28 +0000 | [diff] [blame] | 560 | for (const auto *Format : FDecl->specific_attrs<FormatAttr>()) { |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 561 | ArgNum = Format->getFormatIdx() - 1; |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 562 | if ((Format->getType()->getName() == "printf") && CE->getNumArgs() > ArgNum) |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 563 | return true; |
| 564 | } |
| 565 | |
| 566 | // Or if a function is named setproctitle (this is a heuristic). |
| 567 | if (C.getCalleeName(CE).find("setproctitle") != StringRef::npos) { |
| 568 | ArgNum = 0; |
| 569 | return true; |
| 570 | } |
| 571 | |
| 572 | return false; |
| 573 | } |
| 574 | |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 575 | bool GenericTaintChecker::generateReportIfTainted(const Expr *E, |
| 576 | const char Msg[], |
| 577 | CheckerContext &C) const { |
| 578 | assert(E); |
| 579 | |
| 580 | // Check for taint. |
| Ted Kremenek | 49b1e38 | 2012-01-26 21:29:00 +0000 | [diff] [blame] | 581 | ProgramStateRef State = C.getState(); |
| Artem Dergachev | eed7a31 | 2017-05-29 15:42:56 +0000 | [diff] [blame] | 582 | Optional<SVal> PointedToSVal = getPointedToSVal(C, E); |
| Anna Zaks | d4e43ae | 2017-03-09 00:01:07 +0000 | [diff] [blame] | 583 | SVal TaintedSVal; |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 584 | if (PointedToSVal && isTainted(State, *PointedToSVal)) |
| Artem Dergachev | eed7a31 | 2017-05-29 15:42:56 +0000 | [diff] [blame] | 585 | TaintedSVal = *PointedToSVal; |
| Artem Dergachev | 44551cf | 2019-03-29 22:49:30 +0000 | [diff] [blame] | 586 | else if (isTainted(State, E, C.getLocationContext())) |
| Anna Zaks | d4e43ae | 2017-03-09 00:01:07 +0000 | [diff] [blame] | 587 | TaintedSVal = C.getSVal(E); |
| 588 | else |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 589 | return false; |
| 590 | |
| 591 | // Generate diagnostic. |
| Devin Coughlin | e39bd40 | 2015-09-16 22:03:05 +0000 | [diff] [blame] | 592 | if (ExplodedNode *N = C.generateNonFatalErrorNode()) { |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 593 | initBugType(); |
| Aaron Ballman | 8d3a7a5 | 2015-06-23 13:15:32 +0000 | [diff] [blame] | 594 | auto report = llvm::make_unique<BugReport>(*BT, Msg, N); |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 595 | report->addRange(E->getSourceRange()); |
| Anna Zaks | d4e43ae | 2017-03-09 00:01:07 +0000 | [diff] [blame] | 596 | report->addVisitor(llvm::make_unique<TaintBugVisitor>(TaintedSVal)); |
| Aaron Ballman | 8d3a7a5 | 2015-06-23 13:15:32 +0000 | [diff] [blame] | 597 | C.emitReport(std::move(report)); |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 598 | return true; |
| 599 | } |
| 600 | return false; |
| 601 | } |
| 602 | |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 603 | bool GenericTaintChecker::checkUncontrolledFormatString( |
| 604 | const CallExpr *CE, CheckerContext &C) const { |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 605 | // Check if the function contains a format string argument. |
| 606 | unsigned int ArgNum = 0; |
| 607 | if (!getPrintfFormatArgumentNum(CE, C, ArgNum)) |
| 608 | return false; |
| 609 | |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 610 | // If either the format string content or the pointer itself are tainted, |
| 611 | // warn. |
| Alexander Kornienko | 9c10490 | 2015-12-28 13:06:58 +0000 | [diff] [blame] | 612 | return generateReportIfTainted(CE->getArg(ArgNum), |
| 613 | MsgUncontrolledFormatString, C); |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 614 | } |
| 615 | |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 616 | bool GenericTaintChecker::checkSystemCall(const CallExpr *CE, StringRef Name, |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 617 | CheckerContext &C) const { |
| Ted Kremenek | 3a0678e | 2015-09-08 03:50:52 +0000 | [diff] [blame] | 618 | // TODO: It might make sense to run this check on demand. In some cases, |
| 619 | // we should check if the environment has been cleansed here. We also might |
| Anna Zaks | bf74051 | 2012-01-24 19:32:25 +0000 | [diff] [blame] | 620 | // need to know if the user was reset before these calls(seteuid). |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 621 | unsigned ArgNum = llvm::StringSwitch<unsigned>(Name) |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 622 | .Case("system", 0) |
| 623 | .Case("popen", 0) |
| 624 | .Case("execl", 0) |
| 625 | .Case("execle", 0) |
| 626 | .Case("execlp", 0) |
| 627 | .Case("execv", 0) |
| 628 | .Case("execvp", 0) |
| 629 | .Case("execvP", 0) |
| 630 | .Case("execve", 0) |
| 631 | .Case("dlopen", 0) |
| 632 | .Default(UINT_MAX); |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 633 | |
| Anna Zaks | b508d29 | 2012-04-10 23:41:11 +0000 | [diff] [blame] | 634 | if (ArgNum == UINT_MAX || CE->getNumArgs() < (ArgNum + 1)) |
| Anna Zaks | 0244cd7 | 2012-01-14 02:48:40 +0000 | [diff] [blame] | 635 | return false; |
| 636 | |
| Alexander Kornienko | 9c10490 | 2015-12-28 13:06:58 +0000 | [diff] [blame] | 637 | return generateReportIfTainted(CE->getArg(ArgNum), MsgSanitizeSystemArgs, C); |
| Anna Zaks | 126a2ef | 2012-01-07 02:33:10 +0000 | [diff] [blame] | 638 | } |
| 639 | |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 640 | // TODO: Should this check be a part of the CString checker? |
| 641 | // If yes, should taint be a global setting? |
| 642 | bool GenericTaintChecker::checkTaintedBufferSize(const CallExpr *CE, |
| 643 | const FunctionDecl *FDecl, |
| 644 | CheckerContext &C) const { |
| 645 | // If the function has a buffer size argument, set ArgNum. |
| 646 | unsigned ArgNum = InvalidArgIndex; |
| 647 | unsigned BId = 0; |
| Artem Dergachev | b68cb54 | 2018-12-19 23:35:08 +0000 | [diff] [blame] | 648 | if ((BId = FDecl->getMemoryFunctionKind())) |
| 649 | switch (BId) { |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 650 | case Builtin::BImemcpy: |
| 651 | case Builtin::BImemmove: |
| 652 | case Builtin::BIstrncpy: |
| 653 | ArgNum = 2; |
| 654 | break; |
| 655 | case Builtin::BIstrndup: |
| 656 | ArgNum = 1; |
| 657 | break; |
| 658 | default: |
| 659 | break; |
| 660 | }; |
| 661 | |
| 662 | if (ArgNum == InvalidArgIndex) { |
| 663 | if (C.isCLibraryFunction(FDecl, "malloc") || |
| 664 | C.isCLibraryFunction(FDecl, "calloc") || |
| 665 | C.isCLibraryFunction(FDecl, "alloca")) |
| 666 | ArgNum = 0; |
| 667 | else if (C.isCLibraryFunction(FDecl, "memccpy")) |
| 668 | ArgNum = 3; |
| 669 | else if (C.isCLibraryFunction(FDecl, "realloc")) |
| 670 | ArgNum = 1; |
| 671 | else if (C.isCLibraryFunction(FDecl, "bcopy")) |
| 672 | ArgNum = 2; |
| 673 | } |
| 674 | |
| Alexander Kornienko | 9c10490 | 2015-12-28 13:06:58 +0000 | [diff] [blame] | 675 | return ArgNum != InvalidArgIndex && CE->getNumArgs() > ArgNum && |
| 676 | generateReportIfTainted(CE->getArg(ArgNum), MsgTaintedBufferSize, C); |
| Anna Zaks | 560dbe9 | 2012-01-18 02:45:11 +0000 | [diff] [blame] | 677 | } |
| 678 | |
| Anna Zaks | 5c5bf9b | 2011-11-16 19:58:13 +0000 | [diff] [blame] | 679 | void ento::registerGenericTaintChecker(CheckerManager &mgr) { |
| 680 | mgr.registerChecker<GenericTaintChecker>(); |
| 681 | } |
| Kristof Umann | 058a7a4 | 2019-01-26 14:23:08 +0000 | [diff] [blame] | 682 | |
| 683 | bool ento::shouldRegisterGenericTaintChecker(const LangOptions &LO) { |
| 684 | return true; |
| 685 | } |