1 //===- Chrootchecker.cpp -------- Basic security checks ----------*- C++ -*-==//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines chroot checker, which checks improper use of chroot.
12 //===----------------------------------------------------------------------===//
14 #include "ClangSACheckers.h"
15 #include "clang/StaticAnalyzer/Core/BugReporter/BugType.h"
16 #include "clang/StaticAnalyzer/Core/Checker.h"
17 #include "clang/StaticAnalyzer/Core/CheckerManager.h"
18 #include "clang/StaticAnalyzer/Core/PathSensitive/CheckerContext.h"
19 #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramState.h"
20 #include "clang/StaticAnalyzer/Core/PathSensitive/ProgramStateTrait.h"
21 #include "clang/StaticAnalyzer/Core/PathSensitive/SymbolManager.h"
22 #include "llvm/ADT/ImmutableMap.h"
23 using namespace clang;
28 // enum value that represent the jail state
29 enum Kind { NO_CHROOT, ROOT_CHANGED, JAIL_ENTERED };
31 bool isRootChanged(intptr_t k) { return k == ROOT_CHANGED; }
32 //bool isJailEntered(intptr_t k) { return k == JAIL_ENTERED; }
34 // This checker checks improper use of chroot.
35 // The state transition:
36 // NO_CHROOT ---chroot(path)--> ROOT_CHANGED ---chdir(/) --> JAIL_ENTERED
38 // ROOT_CHANGED<--chdir(..)-- JAIL_ENTERED<--chdir(..)--
40 // bug<--foo()-- JAIL_ENTERED<--foo()--
41 class ChrootChecker : public Checker<eval::Call, check::PreStmt<CallExpr> > {
42 mutable IdentifierInfo *II_chroot, *II_chdir;
43 // This bug refers to possibly break out of a chroot() jail.
44 mutable std::unique_ptr<BuiltinBug> BT_BreakJail;
47 ChrootChecker() : II_chroot(nullptr), II_chdir(nullptr) {}
49 static void *getTag() {
54 bool evalCall(const CallExpr *CE, CheckerContext &C) const;
55 void checkPreStmt(const CallExpr *CE, CheckerContext &C) const;
58 void Chroot(CheckerContext &C, const CallExpr *CE) const;
59 void Chdir(CheckerContext &C, const CallExpr *CE) const;
62 } // end anonymous namespace
64 bool ChrootChecker::evalCall(const CallExpr *CE, CheckerContext &C) const {
65 const FunctionDecl *FD = C.getCalleeDecl(CE);
69 ASTContext &Ctx = C.getASTContext();
71 II_chroot = &Ctx.Idents.get("chroot");
73 II_chdir = &Ctx.Idents.get("chdir");
75 if (FD->getIdentifier() == II_chroot) {
79 if (FD->getIdentifier() == II_chdir) {
87 void ChrootChecker::Chroot(CheckerContext &C, const CallExpr *CE) const {
88 ProgramStateRef state = C.getState();
89 ProgramStateManager &Mgr = state->getStateManager();
91 // Once encouter a chroot(), set the enum value ROOT_CHANGED directly in
93 state = Mgr.addGDM(state, ChrootChecker::getTag(), (void*) ROOT_CHANGED);
94 C.addTransition(state);
97 void ChrootChecker::Chdir(CheckerContext &C, const CallExpr *CE) const {
98 ProgramStateRef state = C.getState();
99 ProgramStateManager &Mgr = state->getStateManager();
101 // If there are no jail state in the GDM, just return.
102 const void *k = state->FindGDM(ChrootChecker::getTag());
106 // After chdir("/"), enter the jail, set the enum value JAIL_ENTERED.
107 const Expr *ArgExpr = CE->getArg(0);
108 SVal ArgVal = state->getSVal(ArgExpr, C.getLocationContext());
110 if (const MemRegion *R = ArgVal.getAsRegion()) {
112 if (const StringRegion* StrRegion= dyn_cast<StringRegion>(R)) {
113 const StringLiteral* Str = StrRegion->getStringLiteral();
114 if (Str->getString() == "/")
115 state = Mgr.addGDM(state, ChrootChecker::getTag(),
116 (void*) JAIL_ENTERED);
120 C.addTransition(state);
123 // Check the jail state before any function call except chroot and chdir().
124 void ChrootChecker::checkPreStmt(const CallExpr *CE, CheckerContext &C) const {
125 const FunctionDecl *FD = C.getCalleeDecl(CE);
129 ASTContext &Ctx = C.getASTContext();
131 II_chroot = &Ctx.Idents.get("chroot");
133 II_chdir = &Ctx.Idents.get("chdir");
135 // Ingnore chroot and chdir.
136 if (FD->getIdentifier() == II_chroot || FD->getIdentifier() == II_chdir)
139 // If jail state is ROOT_CHANGED, generate BugReport.
140 void *const* k = C.getState()->FindGDM(ChrootChecker::getTag());
142 if (isRootChanged((intptr_t) *k))
143 if (ExplodedNode *N = C.addTransition()) {
145 BT_BreakJail.reset(new BuiltinBug(
146 this, "Break out of jail", "No call of chdir(\"/\") immediately "
148 BugReport *R = new BugReport(*BT_BreakJail,
149 BT_BreakJail->getDescription(), N);
156 void ento::registerChrootChecker(CheckerManager &mgr) {
157 mgr.registerChecker<ChrootChecker>();