https://github.com/robtimus/obfuscation-commons-lang

Provides functionality for obfuscating objects using Apache Commons Lang
https://github.com/robtimus/obfuscation-commons-lang

commons commons-lang java obfuscation

Last synced: 22 days ago
JSON representation

Provides functionality for obfuscating objects using Apache Commons Lang

• Host: GitHub
• URL: https://github.com/robtimus/obfuscation-commons-lang
• Owner: robtimus
• License: apache-2.0
• Created: 2020-05-03T12:05:11.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-01-20T12:52:34.000Z (over 2 years ago)
• Last Synced: 2025-01-18T01:45:19.619Z (over 1 year ago)
• Topics: commons, commons-lang, java, obfuscation
• Language: Java
• Homepage: https://robtimus.github.io/obfuscation-commons-lang
• Size: 581 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# obfuscation-commons-lang

[![Maven Central](https://img.shields.io/maven-central/v/com.github.robtimus/obfuscation-commons-lang)](https://search.maven.org/artifact/com.github.robtimus/obfuscation-commons-lang)

[![Build Status](https://github.com/robtimus/obfuscation-commons-lang/actions/workflows/build.yml/badge.svg)](https://github.com/robtimus/obfuscation-commons-lang/actions/workflows/build.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com.github.robtimus%3Aobfuscation-commons-lang&metric=alert_status)](https://sonarcloud.io/summary/overall?id=com.github.robtimus%3Aobfuscation-commons-lang)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=com.github.robtimus%3Aobfuscation-commons-lang&metric=coverage)](https://sonarcloud.io/summary/overall?id=com.github.robtimus%3Aobfuscation-commons-lang)

[![Known Vulnerabilities](https://snyk.io/test/github/robtimus/obfuscation-commons-lang/badge.svg)](https://snyk.io/test/github/robtimus/obfuscation-commons-lang)

Provides extensions to [Apache Commons Lang](https://commons.apache.org/proper/commons-lang/) for obfuscating objects.

Currently it has one extension: an obfuscating [ToStringStyle](https://commons.apache.org/proper/commons-lang/javadocs/api-release/org/apache/commons/lang3/builder/ToStringStyle.html). This can obfuscate fields when used with [ToStringBuilder](https://commons.apache.org/proper/commons-lang/javadocs/api-release/org/apache/commons/lang3/builder/ToStringBuilder.html) or similar classes.

To create an obfuscating `ToStringStyle`, use one of the factory methods of class 

[ObfuscatingToStringStyle](https://robtimus.github.io/obfuscation-commons-lang/apidocs/com/github/robtimus/obfuscation/commons/lang3/ObfuscatingToStringStyle.html) to create a builder, add fields, and build the result. For instance, using the default style:

    ToStringStyle style = ObfuscatingToStringStyle.defaultStyle()

            .withField("password", Obfuscator.fixedLength(3))

            .build();

## Available styles

Most of the styles available in Apache Commons Lang 3 are available, including the recursive and multi-line recursive style. The only style that has been omitted is the [JSON toString style](https://commons.apache.org/proper/commons-lang/javadocs/api-release/org/apache/commons/lang3/builder/ToStringStyle.html#JSON_STYLE).

## Immutability

Most of the styles available in Apache Commons Lang 3 are all immutable. The same cannot be said for the obfuscating styles, they are not immutable and not thread-safe. Reusing the same instance should not be done concurrently (reusing it in the same thread should be possible).

However, it is possible to create immutable _suppliers_ instead:

    Supplier extends ToStringStyle> styleSupplier = ObfuscatingToStringStyle.defaultStyle()

            .withField("password", Obfuscator.fixedLength(3))

            .supplier();

The difference between using `build()` and using `supplier()` is that `supplier()` is more light-weight if you need to create multiple styles with the same settings. Such a supplier can be used directly or using `ThreadLocal`. For instance, in a class:

    private static final Supplier extends ToStringStyle> TO_STRING_STYLE = ObfuscatingToStringStyle.defaultStyle()

            ...

            .supplier();

    

    ...

    

    @Override

    public String toString() {

        return ToStringBuilder.reflectionToString(this, TO_STRING_STYLE.get());

    }

## Serializability

Obfuscating `ToStringStyle` instances are serializable if the obfuscators they use are. This most often means that they are not serializable, even though most `ToStringStyle` implementations are.

## Extending ObfuscatingToStringStyle

See [examples](https://github.com/robtimus/obfuscation-commons-lang/tree/master/src/examples/java/com/github/robtimus/obfuscation/commons/lang3/extending) for some examples. These include both an example that simply reuses [ObfuscatingToStringStyle.Builder](https://robtimus.github.io/obfuscation-commons-lang/apidocs/com/github/robtimus/obfuscation/commons/lang3/ObfuscatingToStringStyle.Builder.html), and one that provides a builder with more properties.