redacted-compiler-plugin

by ZacSweers

A Kotlin compiler plugin that generates redacted toString() implementations.

140 Stars 8 Forks Last release: Not found Apache License 2.0 25 Commits 4 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

redacted-compiler-plugin

A Kotlin compiler plugin that generates redacted

toString()
implementations.

Inspired by the

auto-value-redacted
extension for AutoValue.

Usage

Include the gradle plugin in your project, define a

@Redacted
annotation, and apply it to any properties that you wish to redact.
@Retention(SOURCE)
@Target(PROPERTY)
annotation class Redacted

data class User(val name: String, @Redacted val phoneNumber: String)

When you call

toString()
any
@Redacted
properties are hidden:
User(name=Bob, phoneNumber=██)

If your annotation is applied to the class, then

toString()
will emit a single replacement string:
@Retention(SOURCE)
@Target(CLASS)
annotation class Redacted

@Redacted data class SensitiveData(val ssn: String, val birthday: String)

SensitiveData(██)

Installation

Apply the gradle plugin.

buildscript {
  dependencies {
    classpath "dev.zacsweers.redacted:redacted-compiler-plugin-gradle:x.y.z"
  }  
}

apply plugin: 'dev.zacsweers.redacted.redacted-gradle-plugin'

And that's it! The default configuration will add the

-annotations
artifact (which has a
@Redacted
annotation you can use) and wire it all automatically. Just annotate what you want to redact.

You can configure custom behavior with properties on the

redacted
extension.
redacted {
  // Define a custom annotation. The -annotations artifact won't be automatically added to
  // dependencies if you define your own!
  redactedAnnotation = "dev.zacsweers.redacted.annotations.Redacted" // Default

// Define whether or not this is enabled. Useful if you want to gate this behind a dynamic // build configuration. enabled = true // Default

// Define a custom replacement string for redactions. replacementString = "██" // Default }

Android Per-Variant Configuration

If using Android, you can optionally configure the plugin to be applied on a per-variant basis via

androidVariantFilter
. This is similar to the Android Gradle Plugin's native
variantFilter
API, except with an
overrideEnabled
function to override the enabled status and there is no
defaultConfig
property. If not overridden, the default is to match the
redacted
extension's value. Other
VariantFilter
APIs should behave as expected (buildType, flavors, name, etc).

Note: Variants with different

enabled
values will have to be compiled separately. This is common in most multi-variant projects anyway, but something to be aware of.
redacted {
  enabled = true // Default
  androidVariantFilter {
    // Don't enable on debug
    if (buildType.name == "debug") {
      overrideEnabled(false)
    }
  }
}

Snapshots of the development version are available in Sonatype's

snapshots
repository.

Caveats

  • Kotlin compiler plugins are not a stable API! Compiled outputs from this plugin should be stable, but usage in newer versions of kotlinc are not guaranteed to be stable.
  • IDE support is not currently possible. See #8.

License

Copyright (C) 2018 Zac Sweers

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.