Updated dependencies

Author: jerzyKleszcz

FileExtractor/README.md

@@ -53,6 +53,7 @@ The output data format is called `Files.json` and presented below:
   ],
   "frameworkSearchPaths": [ <string> ],
   "headerSearchPaths": [ <string> ],
+  "configurationFile": <string>,
   "bridgingHeader": <string>
 }
 ```
@@ -74,6 +75,8 @@ The output data format is called `Files.json` and presented below:
 
 `headerSearchPaths` contain the list of paths to search for Objective-C headers. It's used by compiler to find the headers imported via the bridging header into Swift.
 
+`configurationFile` is a path to the configuration file for the obfuscation process. It should be named `.obfuscation.yml` and placed under the project's root path.
+
 `bridgingHeader` is a path to the bridging header, which contains the parts imported from Objective-C that should be visible and accesible from Swift.
 
 Sample `Files.json` file might look like that:
@@ -115,8 +118,10 @@ Sample `Files.json` file might look like that:
    "headerSearchPaths": [
       "/Users/siejkowski/Polidea/SwiftObfuscator/TestProjects/iOS/Original/XcodeSampleProject/Pods/Headers/Public"
    ],
-   "bridgingHeader": "/Users/siejkowski/Polidea/SwiftObfuscator/TestProjects/iOS/Original/XcodeSampleProject/Bridging-header.h"
+   "configurationFile": "/Users/siejkowski/Polidea/SwiftObfuscator/TestProjects/iOS/Original/XcodeSampleProject/.obfuscation.yml"
    ],
+   "bridgingHeader": "/Users/siejkowski/Polidea/SwiftObfuscator/TestProjects/iOS/Original/XcodeSampleProject/Bridging-header.h"
+   ]
 }
 ```
 

FileExtractor/lib/file-extractor/command.rb

@@ -3,6 +3,7 @@ module FileExtractor
   require 'claide'
 
   require 'file-extractor/arguments_decorator'
+  require 'file-extractor/configuration_determiner'
   require 'file-extractor/data_extractor'
   require 'file-extractor/dependency_builder'
   require 'file-extractor/xcodefiles_determiner'
@@ -68,6 +69,7 @@ def run
       puts @project_root_path
       xcodeprojs, xcworkspaces = FileExtractor::XcodefilesDeterminer.find_xcode_files(@project_root_path)
       projects, schemes = FileExtractor::XcworkspaceExtractor.extract_projects_and_dependency_schemes(xcworkspaces, xcodeprojs)
+      configuration_path = FileExtractor::ConfigurationDeterminer.find_configuration_file(@project_root_path)
       if projects.empty?
         puts "\n\nNo Xcode project document found in the project root directory"
       elsif projects.count == 1
@@ -76,7 +78,7 @@ def run
         puts "Path to files:"
         puts @files_path
 
-        json, output_string, build_dir = FileExtractor::DataExtractor.extract_data(@project_root_path, xcodeprojs.first, @files_path)
+        json, output_string, build_dir = FileExtractor::DataExtractor.extract_data(@project_root_path, xcodeprojs.first, @files_path, configuration_path)
         puts "\nFound data:\n#{json}"
         puts "\n#{output_string}"
 
@@ -87,7 +89,7 @@ def run
         puts "Path to files:"
         puts @files_path
 
-        json, output_string, build_dir = FileExtractor::DataExtractor.extract_data(@project_root_path, xcodeprojs.first, @files_path)
+        json, output_string, build_dir = FileExtractor::DataExtractor.extract_data(@project_root_path, xcodeprojs.first, @files_path, configuration_path)
         puts "\nFound data:\n#{json}"
         puts "\n#{output_string}"
 

FileExtractor/lib/file-extractor/configuration_determiner.rb

@@ -0,0 +1,29 @@
+module FileExtractor
+
+  require 'find'
+
+  class ConfigurationDeterminer
+
+    CONFIGURATION_FILES = [".obfuscation.yaml", ".obfuscation.yml", "obfuscation.yaml", "obfuscation.yml"]
+
+    def self.find_configuration_file(path)
+      configuration_path = find_configuration_files(path, CONFIGURATION_FILES).first
+      if configuration_path.nil?
+        return ""
+      end
+      return configuration_path
+    end
+
+    private 
+
+    def self.find_configuration_files(path, types)
+      Find.find(path).select do |path| 
+        types.include?(File.basename(path)) 
+      end.each do |path|
+        File.expand_path(path)
+      end
+    end
+
+  end
+
+end

FileExtractor/lib/file-extractor/data_extractor.rb

@@ -7,8 +7,8 @@ module FileExtractor
 
   class DataExtractor
 
-    def self.extract_data(root_path, project_path, files_path)      
-      data, build_dir = extract_data_from_all_sources(root_path, project_path)
+    def self.extract_data(root_path, project_path, files_path, configuration_path)
+      data, build_dir = extract_data_from_all_sources(root_path, project_path, configuration_path)
       data_is_ok, error_message = FileExtractor::DataIntegrityChecker.verify_data_integrity(data)
       json = JSON.pretty_generate(data)
       if data_is_ok 
@@ -20,10 +20,11 @@ def self.extract_data(root_path, project_path, files_path)
 
     private
 
-    def self.extract_data_from_all_sources(root_path, project_path)
+    def self.extract_data_from_all_sources(root_path, project_path, configuration_path)
       data_extractor = FileExtractor::XcodeprojExtractor.new(root_path, project_path)
       data, build_dir = data_extractor.extract_data_and_build_directory
       data.implicitlyLinkedFrameworks = FileExtractor::ModulesExtractor.system_linked_frameworks(data)
+      data.configurationFile = configuration_path
       return data, build_dir
     end
 

FileExtractor/lib/file-extractor/files_json_struct.rb

@@ -33,6 +33,7 @@ def to_json(options = {})
                          :implicitlyLinkedFrameworks, 
                          :frameworkSearchPaths,
                          :headerSearchPaths,
+                         :configurationFile,
                          :bridgingHeader) do
     include StructSerialization
 

FileExtractor/lib/file-extractor/xcodeproj_extractor.rb

@@ -24,9 +24,10 @@ def extract_data_and_build_directory
         source_files(@main_target),
         layout_files(@main_target),
         update_frameworks_paths(explicitly_linked_frameworks(@main_target), @main_build_settings),
-        nil,
+        nil, # for implicitely linked frameworks
         framework_search_paths(@main_build_settings),
         header_search_paths(@main_build_settings),
+        nil, # for configuration file
         bridging_header(@main_build_settings)
       ), dir
     end

SymbolExtractorAndRenamer/swift/include/swift/Obfuscation/ConfigurationExcluder.h

@@ -0,0 +1,27 @@
+#ifndef ConfigurationExcluder_h
+#define ConfigurationExcluder_h
+
+#include "swift/Obfuscation/DataStructures.h"
+#include "swift/Obfuscation/Excluder.h"
+
+namespace swift {
+namespace obfuscation {
+
+class ConfigurationExcluder: public Excluder {
+
+private:
+
+  ObfuscationConfiguration Configuration;
+
+public:
+
+  ConfigurationExcluder(ObfuscationConfiguration&&);
+
+  void identifyExclusions(Decl *Declaration);
+};
+
+
+} // namespace obfuscation
+} // namespace swift
+
+#endif /* ConfigurationExcluder_h */

SymbolExtractorAndRenamer/swift/include/swift/Obfuscation/DataStructures.h

@@ -43,6 +43,7 @@ struct FilesJson {
   std::vector<std::string> FrameworkSearchPaths;
   std::vector<std::string> HeaderSearchPaths;
   std::string BridgingHeader;
+  std::string ConfigurationFile;
 };
 
 enum class SymbolType: int {
@@ -107,6 +108,65 @@ struct SymbolRenaming {
 struct RenamesJson {
   std::vector<SymbolRenaming> Symbols;
 };
+
+enum class ExclusionKind: int {
+  UnknownKind,
+
+  Type,
+
+  Inheritance,
+
+  Conformance
+};
+
+struct TypeExclusion;
+struct InheritanceExclusion;
+struct ConformanceExclusion;
+
+struct Exclusion {
+
+  std::string Module;
+
+  ExclusionKind Kind;
+
+  const TypeExclusion* getAsTypeExclusion() const;
+  const InheritanceExclusion* getAsInheritanceExclusion() const;
+  const ConformanceExclusion* getAsConformanceExclusion() const;
+};
+
+struct TypeExclusion: public Exclusion {
+  std::string Name;
+
+  TypeExclusion() = default;
+  TypeExclusion(const TypeExclusion&) = default;
+  TypeExclusion(TypeExclusion&&) = default;
+};
+
+struct InheritanceExclusion: public Exclusion {
+  std::string Base;
+
+  InheritanceExclusion() = default;
+  InheritanceExclusion(const InheritanceExclusion&) = default;
+  InheritanceExclusion(InheritanceExclusion&&) = default;
+};
+
+struct ConformanceExclusion: public Exclusion {
+  std::string Protocol;
+
+  ConformanceExclusion() = default;
+  ConformanceExclusion(const ConformanceExclusion&) = default;
+  ConformanceExclusion(ConformanceExclusion&&) = default;
+};
+
+struct ObfuscationConfiguration {
+  std::vector<std::unique_ptr<Exclusion>> Exclude;
+
+  ObfuscationConfiguration() = default;
+  ObfuscationConfiguration(const ObfuscationConfiguration&) = delete;
+  ObfuscationConfiguration(ObfuscationConfiguration&&) = default;
+  ObfuscationConfiguration& operator=(const ObfuscationConfiguration &) = delete;
+  ObfuscationConfiguration& operator=(ObfuscationConfiguration &&) = default;
+};
 
 /// SymbolWithRange - struct for linking the symbol identified in the Swift
 /// source code with the range in which it was encountered.
@@ -214,6 +274,36 @@ struct MappingTraits<SymbolRenaming> {
   static void mapping(IO &Io, SymbolRenaming &Object);
 };
 
+template <>
+struct MappingTraits<ObfuscationConfiguration> {
+  static void mapping(IO &Io, ObfuscationConfiguration &Object);
+};
+
+template <>
+struct ScalarEnumerationTraits<ExclusionKind> {
+  static void enumeration(IO &Io, ExclusionKind &Enum);
+};
+
+template <>
+struct MappingTraits<std::unique_ptr<Exclusion>> {
+  static void mapping(IO &Io, std::unique_ptr<Exclusion> &Object);
+};
+
+template <>
+struct MappingTraits<TypeExclusion> {
+  static void mapping(IO &Io, TypeExclusion &Object);
+};
+
+template <>
+struct MappingTraits<InheritanceExclusion> {
+  static void mapping(IO &Io, InheritanceExclusion &Object);
+};
+
+template <>
+struct MappingTraits<ConformanceExclusion> {
+  static void mapping(IO &Io, ConformanceExclusion &Object);
+};
+
 template <typename U>
 struct SequenceTraits<std::vector<U>> {
   static size_t size(IO &Io, std::vector<U> &Vec);

SymbolExtractorAndRenamer/swift/include/swift/Obfuscation/NameMapping.h

@@ -14,10 +14,11 @@ namespace swift {
 namespace obfuscation {
 
 /// Name mapping strategies:
-/// - random generates unique random identifiers
-/// - deterministic generates predictible identifiers, we use it in tests
+/// - Random generates unique random identifiers
+/// - Deterministic generates predictible identifiers, we use it in tests
+/// - Minifying generates shortes possible names
 enum NameMappingStrategy {
-  random, deterministic
+  Random, Deterministic, Minifying
 };
 
 /// Base class for names generators.
@@ -47,6 +48,21 @@ class BaseIdentifierGenerator {
     { SymbolType::Variable, {} },
     { SymbolType::Operator, {} }
   };
+  
+  // taken from https://developer.apple.com/library/content/documentation/Swift/Conceptual/Swift_Programming_Language/LexicalStructure.html
+  std::set<std::string> SwiftKeywords = {
+    "associatedtype", "class", "deinit", "enum", "extension", "fileprivate",
+    "func", "import", "init", "inout", "internal", "let", "open", "operator",
+    "private", "protocol", "public", "static", "struct", "subscript",
+    "typealias", "var", "break", "case", "continue", "default", "defer", "do",
+    "else", "fallthrough", "for", "guard", "if", "in", "repeat", "return",
+    "switch", "where", "while", "as", "Any", "catch", "false", "is", "nil",
+    "rethrows", "super", "self", "Self", "throw", "throws", "true", "try",
+    "associativity", "convenience", "dynamic", "didSet", "final", "get", "infix",
+    "indirect", "lazy", "left", "mutating", "none", "nonmutating", "optional",
+    "override", "postfix", "precedence", "prefix", "Protocol", "required",
+    "right", "set", "Type", "unowned", "weak", "willSet"
+  };
 
   static std::vector<std::string>
   concatenateSymbols(const std::vector<std::string> &Head,

SymbolExtractorAndRenamer/swift/include/swift/Obfuscation/Renaming.h

@@ -52,11 +52,13 @@ using FilesList = std::vector<std::pair<std::string, std::string>>;
 /// \param DiagnosticStream Stream for writing the diagnostic information into.
 ///
 /// \returns List of project files that were affected by the renaming.
-llvm::Expected<FilesList> performRenaming(std::string MainExecutablePath,
-                                          const FilesJson &FilesJson,
-                                          const RenamesJson &RenamesJson,
-                                          std::string ObfuscatedProjectPath,
-                                          llvm::raw_ostream &DiagnosticStream);
+llvm::Expected<FilesList>
+performRenaming(std::string MainExecutablePath,
+                const FilesJson &FilesJson,
+                ObfuscationConfiguration &&ObfuscationConfiguration,
+                const RenamesJson &RenamesJson,
+                std::string ObfuscatedProjectPath,
+                llvm::raw_ostream &DiagnosticStream);
 
 } //namespace obfuscation
 } //namespace swift

SymbolExtractorAndRenamer/swift/lib/Obfuscation/CMakeLists.txt

@@ -4,6 +4,7 @@ include_directories(SYSTEM ${LIBXML2_INCLUDE_DIR})
 
 add_swift_library(swiftObfuscation STATIC
   CompilerInfrastructure.cpp
+  ConfigurationExcluder.cpp
   DataStructures.cpp
   DeclarationParser.cpp
   OperatorParser.cpp

SymbolExtractorAndRenamer/swift/lib/Obfuscation/ConfigurationExcluder.cpp

@@ -0,0 +1,38 @@
+#include "swift/Obfuscation/ConfigurationExcluder.h"
+
+namespace swift {
+namespace obfuscation {
+
+ConfigurationExcluder::
+  ConfigurationExcluder(ObfuscationConfiguration&& Configuration)
+: Configuration(std::move(Configuration)) {
+
+  // TODO: remove when there's logic added to identifyExclusions method
+  for (auto &Exclusion : this->Configuration.Exclude) {
+    switch (Exclusion->Kind) {
+      case ExclusionKind::Type: {
+        auto Type = Exclusion->getAsTypeExclusion();
+        llvm::outs() << Type->Name << '\n';
+        break;
+      }
+      case ExclusionKind::Inheritance: {
+        auto Type = Exclusion->getAsInheritanceExclusion();
+        llvm::outs() << Type->Base << '\n';
+        break;
+      }
+      case ExclusionKind::Conformance: {
+        auto Type = Exclusion->getAsConformanceExclusion();
+        llvm::outs() << Type->Protocol << '\n';
+        break;
+      }
+    }
+  }
+
+}
+
+void ConfigurationExcluder::identifyExclusions(Decl *Declaration) {
+
+}
+
+} // namespace obfuscation
+} // namespace swift