https://github.com/gianttreelp/proguard-services-mapper

A solution to fix obfuscated Java services after ProGuard has run.
https://github.com/gianttreelp/proguard-services-mapper

cli gradle-plugin java kotlin maven-plugin obfuscation proguard

Last synced: 2 days ago
JSON representation

A solution to fix obfuscated Java services after ProGuard has run.

• Host: GitHub
• URL: https://github.com/gianttreelp/proguard-services-mapper
• Owner: GiantTreeLP
• License: mit
• Created: 2021-12-22T17:56:13.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T17:06:32.000Z (9 days ago)
• Last Synced: 2024-10-29T18:32:38.607Z (9 days ago)
• Topics: cli, gradle-plugin, java, kotlin, maven-plugin, obfuscation, proguard
• Language: Kotlin
• Homepage:
• Size: 314 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ProGuard Service Mapper

[![GitHub license](https://img.shields.io/github/license/GiantTreeLP/proguard-services-mapper)](https://github.com/GiantTreeLP/proguard-services-mapper/blob/main/LICENSE)

[![Maven Package](https://github.com/GiantTreeLP/proguard-services-mapper/actions/workflows/publish.yml/badge.svg)](https://github.com/GiantTreeLP/proguard-services-mapper/actions/workflows/maven-publish.yml)

[![Maven Central](https://img.shields.io/maven-central/v/com.github.gianttreelp.proguardservicesmapper/proguard-services-mapper-common)](https://search.maven.org/artifact/com.github.gianttreelp.proguardservicesmapper/proguard-services-mapper-common)

[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/com.github.gianttreelp.proguardservicesmapper/proguard-services-mapper-common?server=https%3A%2F%2Foss.sonatype.org)](https://oss.sonatype.org/content/repositories/snapshots/com/github/gianttreelp/proguardservicesmapper/)

[![GitHub stars](https://img.shields.io/github/stars/GiantTreeLP/proguard-services-mapper)](https://github.com/GiantTreeLP/proguard-services-mapper/stargazers)

This is a service mapper for the [ProGuard](https://proguard.sourceforge.io/)

Java bytecode obfuscator.

It fixes the issue that files in the `META-INF/services` directory are not renamed or adapted to the new class names.

It replaces the original Jar file with a new one that contains the renamed services.

It consists of the following modules:

* [`proguard-service-mapper`](#proguard-service-mapper):

  The service mapper itself.

* [`proguard-service-mapper-cli`](#proguard-service-mapper-cli):

  The command line interface.

* [`proguard-service-mapper-maven`](#proguard-service-mapper-maven):

  The Maven plugin.

* [`proguard-service-mapper-gradle`](#proguard-service-mapper-gradle):

  The Gradle plugin.

## ProGuard Service Mapper CLI

For convenience, the service mapper can be run from the command line. Withouth any additional arguments, it will print

help information.

### Usage

```shell

$ java -jar proguard-service-mapper-cli-.jar -i  -m 

```

## ProGuard Service Mapper Maven

This plugin is intended to be integrated into your Maven build process and run after

the [ProGuard Maven plugin](https://wvengen.github.io/proguard-maven-plugin/).

### Usage in Maven

```xml

  com.github.gianttreelp.proguardservicesmapper

  proguard-service-mapper-maven-plugin

  1.2-SNAPSHOT 

  

    

      package

      

        map-proguard

      

    

  

  

    

    

  

```

## ProGuard Service Mapper Gradle

This plugin is intended to be integrated into your Gradle build process and run after

the [ProGuard Gradle plugin](https://github.com/Guardsquare/proguard).

### Example usage in Gradle with the ProGuard Gradle plugin and the Shadow plugin

```kotlin

buildscript {

  dependencies {

    classpath("com.github.gianttreelp.proguardservicesmapper:proguard-services-mapper-gradle:1.2-SNAPSHOT")

  }   

}

register("mapServices") {

  this.dependsOn("proguard")

  

  val shadowTask = project.tasks.shadowJar.orNull ?: throw IllegalStateException("No shadow jar task found")

  

  this.mappingFile.set(project.buildDir.resolve("mapping.txt"))

  this.inputFile.set(shadowTask.outputs.files.files.single().let {

    File(it.path.substringBeforeLast('.') + "-obf." + it.path.substringAfterLast('.'))

  })

}

```