目录

Package-specific Source Code Obfuscation Recommendations

Different package types serve distinct purposes and have unique build processes, which means you need to consider different factors when applying obfuscation. This topic offers tailored recommendations for three package types: HAP, HAR, and HSP, aiming to help you implement obfuscation effectively.

To better understand how obfuscation works with different package types, you are advised to first gain a thorough understanding of obfuscation principles and the obfuscation enabling process before configuring settings for specific package types. You are also advised to read Application Package Structure in Stage Model to familiarize yourself with the differences between package types.

HAP Package Obfuscation Recommendations

  1. Enable the obfuscation rules. Start with the recommended four options and add other options as needed.

  2. Familiarize yourself with the obfuscation rule merging strategies to understand how these rules affect the current module during compilation.

  3. Understand which code from dependent packages will be compiled and obfuscated together with the current module. This will affect the newly generated obfuscated names and some globally effective trustlists (such as property names), and consequently affect the final obfuscation effect of the current module. Specifically:

    • When your HAP depends on a local HAR package, its code is obfuscated together with your HAP. The original and obfuscated names in this code will appear in the obfuscation/nameCache.json file of the HAP.
    • When your HAP depends on a released source code HAR package, its code in the project-level oh_modules directory is obfuscated together with your HAP. The original and obfuscated names in this code will appear in the obfuscation/nameCache.json file of the HAP.
    • When your HAP depends on a released bytecode HAR package or HSP package, only the binary bytecode and declaration files are used for compilation. Since ArkGuard supports only source code obfuscation, these files are not obfuscated. (This also maintains the consistency between the interfaces in the declaration file and those in the binary file.) However, if third-party libraries lack proper interface declarations or trustlist configurations in consumer-rules, their interfaces may be accidentally obfuscated. You should manually configure trustlists to ensure runtime correctness.

  4. To ensure correct interaction with third-party libraries in the release state, ArkGuard automatically adds the export names and related properties of remote HARs in the project-level oh_modules directory to a trustlist. Since you can reference files from any path within the dependent modules, this collection includes exported names from both entry files (such as Index.ets) and all files in oh_modules.

  5. For local source code HAR packages and local HSP packages, ArkGuard does not automatically collect exported names in all files and add them to a trustlist.

    The table below summarizes the compilation and obfuscation scenarios for common dependent packages.

    Dependent Module Files Involved in Compilation Obfuscated with the Current Module Passes Retention Configuration to the Current Module Collects Exported Names into a Trustlist
    Local source code HAR package Source code directory of the module in the local environment Yes Yes No
    Released source code HAR package Module directory under project-level oh_modules Yes Yes Yes
    Released bytecode HAR package Binary bytecode and declaration files No Yes Yes
    Local source code HSP package NA No Yes No
    Integrated HSP package Binary bytecode and declaration files No Yes Yes

  6. Identify the scenarios that require trustlist configurations, and configure a trustlist in obfuscation-rules.txt.

  7. Build and verify the HAP. If issues arise, check whether the trustlist is complete.

  8. Once the HAP functions correctly, you can release the package.

HAR Package Obfuscation Recommendations

[h2]General Recommendations

  1. Familiarize yourself with the three types of obfuscation configuration files and the obfuscation rule merging strategies. Understand the precautions provided in HAP Package Obfuscation Recommendations to ensure that your HAR functions correctly when it is used by HAP packages.

  2. HAR packages can affect the obfuscation process of the main module that uses them. No matter whether obfuscation is enabled for your HAR, configure consumer-rules.txt to ensure that your HAR package functions correctly when the main module enables obfuscation.

  3. Due to the transitivity of consumer configurations, avoid enabling obfuscation directly in your HAR. Instead, use -keep-global-name and -keep-property-name to add specific names to a trustlist and minimize impact on dependent modules.

[h2]Local Source Code HAR Package

As unreleased static packages, local source code HAR packages are compiled and obfuscated together with the main module (such as HAP), rather than independently. Therefore, follow the HAP Package Obfuscation Recommendations.

Since local source code HAR packages are obfuscated together with the main module, when multiple HAPs or HSPs depend on the same local source HAR, the obfuscation results of that local source HAR may differ across modules. When useNormalizedOHMUrl is enabled (specifically, by setting the useNormalizedOHMUrl field under the strictMode property to true in the project-level build-profile.json5 file), only one instance of the HAR is loaded at runtime. This prevents HAPs and HSPs from locating their corresponding HAR, leading to errors where the HAR's methods cannot be found when called.

Solution:

  1. Use obfuscation for code hardening to select the scenario where the HAR exposes external APIs and add the generated trustlist to the consumer-rules.txt file of the HAR.
  2. Change the shared local source code HAR to a bytecode HAR, separately compile the HAR, and then depend on the HAR.

[h2]Released Source Code HAR Package

  1. Enable the obfuscation rules. Start with the recommended four obfuscation options and add other options as needed.
  2. Understand the scenarios that require trustlist configurations, and configure a trustlist in the HAR.
    • In obfuscation-rules.txt, configure the exported interface names and related property names of your HAR, as well as any names that should not be obfuscated during the build.
    • In consumer-rules.txt, configure the names of interfaces and properties that should not be re-obfuscated.
  3. Verify the functionality of the HAR package. Note that during the compilation of the current module, one round of obfuscation is triggered for your HAR. When the published HAR package is used by a dependent module, if the dependent module enables obfuscation, the code of the released HAR package will be re-obfuscated. Therefore, you should fully verify whether the HAR functions correctly when it is used by a dependent module with obfuscation enabled.
  4. Release the HAR package.

When your HAR is used by other modules, pay attention to the following points:

  • During obfuscation of dependent modules (such as HAP), ArkGuard collects exported names and properties from your released HAR package into a trustlist.
  • During obfuscation of dependent modules (such as HAP), ArkGuard collects the trustlist from the obfuscation.txt file of your released HAR package but does not recursively collect from its dependencies (four-party libraries). This is because the trustlist of the four-party libraries has been collected during the construction of the third-party libraries. Therefore, if a released HAR package depends on other HAR packages, the versions of these other HAR packages should be fixed and should not be configured to automatically match the latest version. Otherwise, when the fourth-party libraries are upgraded and the trustlist is changed, it will not take effect in the HAP, leading to stability issues.

[h2]Released Bytecode HAR Package

After obfuscation is enabled for the bytecode HAR package, you do not need to configure the trustlist in consumer-rules.txt, and the rest of the adaptation process remains consistent with that of the released source code HAR packages. This is because ArkGuard is a source code obfuscation tool that obfuscates the module only once when the bytecode HAR package is released. When other relying parties introduce the HAR and enable obfuscation, ArkGuard does not perform secondary obfuscation on the HAR.

HSP Package Obfuscation Recommendations

[h2]General Recommendations

  1. Familiarize yourself with the three types of obfuscation configuration files and the obfuscation rule merging strategies. Understand the precautions provided in HAP Package Obfuscation Recommendations to ensure that your HSP functions correctly when it is used by HAP packages.
  2. HSP packages are built independently and are built only once. Therefore, focus on the obfuscation effects within the module and ensure proper interface calls from other modules.
  3. Due to the transitivity of consumer configurations, avoid enabling obfuscation directly in your HSP. Instead, use -keep-global-name and -keep-property-name to add specific names to a trustlist and minimize impact on dependent modules.

[h2]Local Source Code HSP Package

  1. Clearly define external APIs and properties that your source code HSP provides, and configure these names in obfuscation-rules.txt and consumer-rules.txt.
  2. Follow the HAP Package Obfuscation Recommendations to ensure the obfuscation effects within the module.
  3. Build and verify the HSP together with the main module to ensure all APIs provided by the HSP work correctly.

[h2]Integrated HSP Package

  1. Clearly define external interfaces and properties that your integrated HSP package provides, and configure these names in obfuscation-rules.txt. There is no need to configure consumer-rules.txt because the .tgz file contains both HAR and HSP, and the exported APIs and properties defined in the declaration files of the HAR are automatically collected into the trustlist.
  2. Follow the HAP Package Obfuscation Recommendations to ensure the obfuscation effects within the module.
  3. Ensure that the interfaces that your integrated HSP package provides can be called correctly by dependent modules, especially when obfuscation is enabled.

The obfuscation.txt file for integrated HSPs is generated based on the current module's consumer-rules.txt, and does not include the consumer-rules.txt or obfuscation.txt files from dependent modules.

To ensure proper internal obfuscation of integrated HSPs, you can follow the HAP obfuscation recommendations. After an integrated HSP is released, it is necessary to verify that the APIs can be called properly when obfuscation is enabled.