Add support for new PassManager

Author: sr-tream

README.md

@@ -6,10 +6,10 @@ Obfuscator-LLVM is a project initiated in June 2010 by the information security
 
 Here is a list of the different features that are currently available:
 
-* [Instructions Substitution](https://github.com/obfuscator-llvm/obfuscator/wiki/Instructions-Substitution) `-mllvm -sub`
-* [Bogus Control Flow](https://github.com/obfuscator-llvm/obfuscator/wiki/Bogus-Control-Flow) `-mllvm -bcf`
-* [Control Flow Flattening](https://github.com/obfuscator-llvm/obfuscator/wiki/Control-Flow-Flattening) `-mllvm -fla`
-* [Functions annotations](https://github.com/obfuscator-llvm/obfuscator/wiki/Functions-annotations)
+* [Instructions Substitution](https://github.com/obfuscator-llvm/obfuscator/wiki/Instructions-Substitution) `-mllvm -sub` (only old PassManager)
+* [Bogus Control Flow](https://github.com/obfuscator-llvm/obfuscator/wiki/Bogus-Control-Flow) `-mllvm -bcf` (only old PassManager)
+* [Control Flow Flattening](https://github.com/obfuscator-llvm/obfuscator/wiki/Control-Flow-Flattening) `-mllvm -fla` (only old PassManager)
+* [Functions annotations](https://github.com/obfuscator-llvm/obfuscator/wiki/Functions-annotations) (any pass manager)
 
 ## Building
 
@@ -22,6 +22,8 @@ cmake ../
 cmake --build .
 ```
 
+To build for old PassManager add CMake flag `-DLLVM_ENABLE_NEW_PASS_MANAGER=OFF`.
+
 ## Usage
 
 Adding the obfuscator to existing projects which use an LLVM compiler is very easy. For the Make (or rather Makefile) buildsystem simply adjust the small example below to fit your needs:

obfuscator-llvm/BogusControlFlow.cpp

@@ -1,48 +1,47 @@
-//===- BogusControlFlow.h - BogusControlFlow Obfuscation pass------------------------===//
+//===- BogusControlFlow.h - bogus control flow obfuscation pass -----------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
-//===--------------------------------------------------------------------------------===//
+//===----------------------------------------------------------------------===//
 //
-// This file contains includes and defines for the bogusControlFlow pass
+// This file contains includes and defines for the bogus control flow pass
 //
-//===--------------------------------------------------------------------------------===//
+//===----------------------------------------------------------------------===//
+#ifndef _OBFUSCATION_BOGUSCONTROLFLOW_H_
+#define _OBFUSCATION_BOGUSCONTROLFLOW_H_
 
-#ifndef _BOGUSCONTROLFLOW_H_
-#define _BOGUSCONTROLFLOW_H_
-
-
-// LLVM include
-#include "llvm/Pass.h"
-#include "llvm/IR/Module.h"
-#include "llvm/IR/Function.h"
+#include "llvm/ADT/Statistic.h"
+#include "llvm/CodeGen/ISDOpcodes.h"
 #include "llvm/IR/BasicBlock.h"
-#include "llvm/IR/Instructions.h"
-#include "llvm/IR/InstrTypes.h"
 #include "llvm/IR/Constants.h"
-#include "llvm/IR/Type.h"
-#include "llvm/ADT/Statistic.h"
+#include "llvm/IR/Function.h"
 #include "llvm/IR/GlobalValue.h"
+#include "llvm/IR/InstrTypes.h"
+#include "llvm/IR/Instructions.h"
 #include "llvm/IR/LLVMContext.h"
-#include "llvm/Transforms/Utils/Cloning.h"
-#include "llvm/Transforms/Utils/BasicBlockUtils.h"
-#include "llvm/CodeGen/ISDOpcodes.h"
-#include "llvm/Support/raw_ostream.h"
-#include "llvm/Support/Debug.h"
+#include "llvm/IR/Module.h"
+#include "llvm/IR/Type.h"
+#include "llvm/Pass.h"
 #include "llvm/Support/CommandLine.h"
+#include "llvm/Support/Debug.h"
+#include "llvm/Support/raw_ostream.h"
 #include "llvm/Transforms/IPO.h"
 #include "CryptoUtils.h"
-#include <list>
-
-using namespace std;
-using namespace llvm;
+#include "llvm/Transforms/Utils/BasicBlockUtils.h"
+#include "llvm/Transforms/Utils/Cloning.h"
+#include "llvm/IR/PassManager.h" // New PassManager
 
-// Namespace
 namespace llvm {
-	Pass *createBogus (bool flag);
-}
-#endif
+Pass *createBogus();
+class BogusControlFlowPass : public PassInfoMixin<BogusControlFlowPass>{ // New PassManager
+public:
+  PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
+
+  static bool isRequired() { return true; }
+};
+} // namespace llvm
 
+#endif

obfuscator-llvm/BogusControlFlow.h

@@ -1,15 +1,36 @@
-add_llvm_library(ObfuscatorLLVM MODULE
-    # List your source files here.
-    Obfuscation.cpp
-    CryptoUtils.cpp
-    Substitution.cpp
-    BogusControlFlow.cpp
-    SplitBasicBlocks.cpp
-    Flattening.cpp
-    Utils.cpp
-    PLUGIN_TOOL
-    opt
-)
+set(LLVM_ENABLE_NEW_PASS_MANAGER ON CACHE BOOL "Use new PM")
+
+if (LLVM_ENABLE_NEW_PASS_MANAGER)
+    add_llvm_pass_plugin(ObfuscatorLLVM
+        Obfuscation.cpp
+        CryptoUtils.cpp
+        Substitution.cpp
+        BogusControlFlow.cpp
+        SplitBasicBlocks.cpp
+        Flattening.cpp
+        Utils.cpp
+    )
+    target_link_libraries(ObfuscatorLLVM
+        PUBLIC
+        LLVMSupport
+        LLVMCore
+        LLVMipo
+        LLVMPasses
+    )
+else()
+    add_llvm_library(ObfuscatorLLVM MODULE
+        # List your source files here.
+        Obfuscation.cpp
+        CryptoUtils.cpp
+        Substitution.cpp
+        BogusControlFlow.cpp
+        SplitBasicBlocks.cpp
+        Flattening.cpp
+        Utils.cpp
+        PLUGIN_TOOL
+        opt
+    )
+endif()
 
 # Use C++11 to compile your pass (i.e., supply -std=c++11).
 target_compile_features(ObfuscatorLLVM PRIVATE cxx_range_for cxx_auto_type)

obfuscator-llvm/CMakeLists.txt

@@ -20,30 +20,31 @@
 
 using namespace llvm;
 
+static cl::opt<bool> FlatteningArg("fla", cl::init(false),
+                                cl::desc("Enable the flattening pass"));
+
 // Stats
 STATISTIC(Flattened, "Functions flattened");
 
 namespace {
 struct Flattening : public FunctionPass {
-  static char ID;  // Pass identification, replacement for typeid
-  bool flag;
+  static char ID; // Pass identification, replacement for typeid
 
   Flattening() : FunctionPass(ID) {}
-  Flattening(bool flag) : FunctionPass(ID) { this->flag = flag; }
 
   bool runOnFunction(Function &F);
   bool flatten(Function *f);
 };
-}
+} // namespace
 
 char Flattening::ID = 0;
 static RegisterPass<Flattening> X("flattening", "Call graph flattening");
-Pass *llvm::createFlattening(bool flag) { return new Flattening(flag); }
+Pass *llvm::createFlattening() { return new Flattening(); }
 
 bool Flattening::runOnFunction(Function &F) {
   Function *tmp = &F;
   // Do we obfuscate
-  if (toObfuscate(flag, tmp, "fla")) {
+  if (toObfuscate(FlatteningArg, tmp, "fla")) {
     if (flatten(tmp)) {
       ++Flattened;
     }
@@ -52,8 +53,15 @@ bool Flattening::runOnFunction(Function &F) {
   return false;
 }
 
+PreservedAnalyses FlatteningPass::run(Function &F, FunctionAnalysisManager &AM){
+  Flattening fla;
+  fla.runOnFunction(F);
+
+  return PreservedAnalyses::none();
+}
+
 bool Flattening::flatten(Function *f) {
-  vector<BasicBlock *> origBB;
+  std::vector<BasicBlock *> origBB;
   BasicBlock *loopEntry;
   BasicBlock *loopEnd;
   LoadInst *load;
@@ -65,9 +73,14 @@ bool Flattening::flatten(Function *f) {
   llvm::cryptoutils->get_bytes(scrambling_key, 16);
   // END OF SCRAMBLER
 
+#if LLVM_VERSION_MAJOR >= 9
+    // >=9.0, LowerSwitchPass depends on LazyValueInfoWrapperPass, which cause AssertError.
+    // So I move LowerSwitchPass into register function, just before FlatteningPass.
+#else
   // Lower switch
   FunctionPass *lower = createLowerSwitchPass();
   lower->runOnFunction(*f);
+#endif
 
   // Save all original BB
   for (Function::iterator i = f->begin(); i != f->end(); ++i) {
@@ -89,7 +102,7 @@ bool Flattening::flatten(Function *f) {
   origBB.erase(origBB.begin());
 
   // Get a pointer on the first BB
-  Function::iterator tmp = f->begin();  //++tmp;
+  Function::iterator tmp = f->begin(); //++tmp;
   BasicBlock *insert = &*tmp;
 
   // If main begin with an if
@@ -101,7 +114,7 @@ bool Flattening::flatten(Function *f) {
   if ((br != NULL && br->isConditional()) ||
       insert->getTerminator()->getNumSuccessors() > 1) {
     BasicBlock::iterator i = insert->end();
-	--i;
+    --i;
 
     if (insert->size() > 1) {
       --i;
@@ -126,7 +139,7 @@ bool Flattening::flatten(Function *f) {
   loopEntry = BasicBlock::Create(f->getContext(), "loopEntry", f, insert);
   loopEnd = BasicBlock::Create(f->getContext(), "loopEnd", f, insert);
 
-  load = new LoadInst(switchVar->getAllocatedType(), switchVar, "switchVar", loopEntry);
+  load = new LoadInst(switchVar->getType()->getElementType(), switchVar, "switchVar", loopEntry);
 
   // Move first BB on top
   insert->moveBefore(loopEntry);
@@ -149,8 +162,8 @@ bool Flattening::flatten(Function *f) {
   BranchInst::Create(loopEntry, &*f->begin());
 
   // Put all BB in the switch
-  for (vector<BasicBlock *>::iterator b = origBB.begin(); b != origBB.end();
-       ++b) {
+  for (std::vector<BasicBlock *>::iterator b = origBB.begin();
+       b != origBB.end(); ++b) {
     BasicBlock *i = *b;
     ConstantInt *numCase = NULL;
 
@@ -165,8 +178,8 @@ bool Flattening::flatten(Function *f) {
   }
 
   // Recalculate switchVar
-  for (vector<BasicBlock *>::iterator b = origBB.begin(); b != origBB.end();
-       ++b) {
+  for (std::vector<BasicBlock *>::iterator b = origBB.begin();
+       b != origBB.end(); ++b) {
     BasicBlock *i = *b;
     ConstantInt *numCase = NULL;
 

obfuscator-llvm/Flattening.cpp

@@ -1,4 +1,4 @@
-//===- Flattening.h - Flattening Obfuscation pass--------------------------===//
+//===- FlatteningIncludes.h - Flattening Obfuscation pass------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
@@ -11,27 +11,29 @@
 //
 //===----------------------------------------------------------------------===//
 
-#ifndef _FLATTENING_INCLUDES_
-#define _FLATTENING_INCLUDES_
+#ifndef _OBFUSCATION_FLATTENING_H_
+#define _OBFUSCATION_FLATTENING_H_
 
-
-// LLVM include
-#include "llvm/Pass.h"
-#include "llvm/IR/Function.h"
 #include "llvm/ADT/Statistic.h"
-#include "llvm/Transforms/Utils/Local.h" // For DemoteRegToStack and DemotePHIToStack
-#include "llvm/Transforms/IPO.h"
-#include "llvm/Transforms/Scalar.h"
+#include "llvm/IR/Function.h"
 #include "llvm/IR/Module.h"
+#include "llvm/Pass.h"
 #include "llvm/Support/CommandLine.h"
+#include "llvm/Transforms/IPO.h"
 #include "CryptoUtils.h"
 #include "Utils.h"
-
-// Namespace
-using namespace std;
+#include "llvm/Transforms/Scalar.h"
+#include "llvm/Transforms/Utils/Local.h" // For DemoteRegToStack and DemotePHIToStack
+#include "llvm/IR/PassManager.h" // New PassManager
 
 namespace llvm {
-	Pass *createFlattening(bool flag);
-}
+Pass *createFlattening();
+class FlatteningPass : public PassInfoMixin<FlatteningPass>{ // New PassManager
+public:
+  PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
+
+  static bool isRequired() { return true; }
+};
+} // namespace llvm
 
 #endif

obfuscator-llvm/Flattening.h

@@ -1,16 +1,16 @@
 #include "llvm/IR/LegacyPassManager.h"
 #include "llvm/Transforms/IPO/PassManagerBuilder.h"
+#include "llvm/Passes/PassPlugin.h"
+#include "llvm/Passes/PassBuilder.h"
 #include "Substitution.h"
 #include "Flattening.h"
 #include "SplitBasicBlocks.h"
 #include "BogusControlFlow.h"
 
+using namespace llvm;
+
 // Flags for obfuscation
-static cl::opt<bool> Flattening("fla", cl::init(false), cl::desc("Enable the flattening pass"));
-static cl::opt<bool> BogusControlFlow("bcf", cl::init(false), cl::desc("Enable bogus control flow"));
-static cl::opt<bool> Substitution("sub", cl::init(false), cl::desc("Enable instruction substitutions"));
 static cl::opt<std::string> AesSeed("aesSeed", cl::init(""), cl::desc("seed for the AES-CTR PRNG"));
-static cl::opt<bool> Split("spli", cl::init(false), cl::desc("Enable basic block splitting"));
 
 static void loadPass(const PassManagerBuilder &Builder, legacy::PassManagerBase &PM) {
   // Initialization of the global cryptographically
@@ -20,10 +20,10 @@ static void loadPass(const PassManagerBuilder &Builder, legacy::PassManagerBase
       exit(1);
     }
   }
-  PM.add(createSplitBasicBlock(Split));
-  PM.add(createBogus(BogusControlFlow));
-  PM.add(createFlattening(Flattening));
-  PM.add(createSubstitution(Substitution));
+  PM.add(createSplitBasicBlock());
+  PM.add(createBogus());
+  PM.add(createFlattening());
+  PM.add(createSubstitution());
 }
 
 // These constructors add our pass to a list of global extensions.
@@ -37,3 +37,24 @@ static RegisterStandardPasses clangtoolLoader_O0(PassManagerBuilder::EP_EnabledO
 // you're in -O0, and EP_OptimizerLast only runs if you're not). You can check
 // include/llvm/Transforms/IPO/PassManagerBuilder.h header and
 // lib/Transforms/IPO/PassManagerBuilder.cpp file for the exact behavior.
+
+PassPluginLibraryInfo getObfuscatorLLVMPluginInfo(){
+  return {LLVM_PLUGIN_API_VERSION, "ObfuscatorLLVM", LLVM_VERSION_STRING, [](PassBuilder &PB){
+    PB.registerVectorizerStartEPCallback([](FunctionPassManager &PM, PassBuilder::OptimizationLevel level){
+      if(!AesSeed.empty()) {
+        if(!llvm::cryptoutils->prng_seed(AesSeed.c_str())) {
+          exit(1);
+        }
+      }
+      PM.addPass(SplitBasicBlockPass());
+      PM.addPass(BogusControlFlowPass());
+      PM.addPass(FlatteningPass());
+      PM.addPass(SubstitutionPass());
+    });
+  }};
+}
+
+extern "C" LLVM_ATTRIBUTE_WEAK ::llvm::PassPluginLibraryInfo
+llvmGetPassPluginInfo() {
+  return getObfuscatorLLVMPluginInfo();
+}