LSParanoid Documentation

The samples directory demonstrates different ways to apply LSParanoid obfuscation across libraries and applications. Understanding these patterns helps you decide how to integrate the tool into your own build pipeline:

Library-level Obfuscation

• Standard Library: A normal project with no LSParanoid integration.
• Selective Obfuscation (library-may-obfuscate): Uses the org.lsposed.lspanoid:core dependency. You can target specific classes for obfuscation by annotating them with @Obfuscate. Classes without this annotation remain unobfuscated.
• Global Library Obfuscation (library-obfuscate): Uses LSParanoid to turn on global obfuscation, meaning the entire .aar is obfuscated.

Application-level Obfuscation

• Dependency-aware Obfuscation (application): An application that uses @Obfuscate on its own classes and enables includeDependencies. In this mode, the build process will obfuscate the application classes and specific annotated classes within its dependencies (like LibraryObfuscate and LibraryMayObfuscate), while leaving unannotated classes (like Library or LibraryMayNotObfuscate) intact.
• Global Application Obfuscation (application-global-obfuscate): An application that enables global obfuscation. This results in all classes within the resulting release APK being obfuscated.

To use LSParanoid in an Android project, apply the plugin and configure the lsparanoid extension in your build.gradle file. The plugin automatically adds the necessary org.lsposed.lsparanoid:core dependency to your implementation configuration based on your project's build version.

Available configuration options in the lsparanoid extension include:

• seed: An optional integer seed for the obfuscation process. If not provided, a SecureRandom integer is used.
• classFilter: A filter used to determine which classes should be processed by LSParanoid.
• includeDependencies: A boolean flag. If true, the plugin processes artifacts in Scope.ALL; otherwise, it defaults to Scope.PROJECT.
• variantFilter: A predicate used to decide whether LSParanoid should be applied to a specific Android variant.

// Example application of the plugin
plugins {
    id("org.lsposed.lsparanoid")
}

// Configuration block
lsparanoid {
    seed = 12345
    classFilter = { ... }
    includeDependencies = true
    // variantFilter is handled internally via the extension
}

Once the plugin is applied, you can obfuscate strings within a class by annotating that class with @Obfuscate. The plugin will transform string constants and string literals into calls to Deobfuscator.getString(index) during compilation.

Example usage in Java:

@Obfuscate
public class MainActivity extends AppCompatActivity {
  private static final String QUESTION = "Q: %s";
  private static final String ANSWER = "A: %s";

  @Override
  protected void onCreate(final Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.main_activity);

    final TextView questionTextView = (TextView) findViewById(R.id.questionTextView);
    questionTextView.setText(String.format(QUESTION, "Does it work?"));

    final TextView answerTextView = (TextView) findViewById(R.id.answerTextView);
    answerTextView.setText(String.format(ANSWER, "Sure it does!"));
  }
}