delightful-anonymization
is a library for anonymizing case classes on-the-fly.
This library is built for Scala 2.12.12 and 2.13.3
SBT
libraryDependencies += "org.sweet-delights" %% "delightful-anonymization" % "0.0.1"
Maven
<dependency>
<groupId>org.sweet-delights</groupId>
<artifactId>delightful-anonymization_2.12</artifactId>
<version>0.0.1</version>
</dependency>
License
All files in delightful-anonymization
are under the GNU Lesser General Public License version 3. Please read files COPYING
and COPYING.LESSER
for details.
How to anonymize a case class ?
Step 1: decorate a case class with @PII
annotations. Example:
import sweet.delights.anonymization.PII
import sweet.delights.anonymization.Hash
case class Foo(
opt: Option[String] @PII(Hash.MD5),
str: String @PII(Hash.SHA512),
integer: Int
)
Step 2: apply the anonymize
function on an instance of Foo
:
import sweet.delights.anonymization.Anonymizer._
val foo = Foo(
Some("opt"),
"str",
1
)
val anonymized == Foo(
opt = Some("A9WeZjwa+awzqZSdEZNQWg=="),
str = "Ms3snktf//qQkCS0pxCFDuLhtNPxn/2PJImMPoQBmZes+h+d3Q39yiEojcksp2agyxDgzXstaSbe/+zMWSOVAg==",
integer = 1
)
//> true
Supported types
By default, Anonymizer
hashes arrays of bytes. But any type T
- other than products and co-products - that can be transformed into an array of bytes can be hashed.
The support for additional types is done via Injections
, a mechanism borrowed from the frameless
library.
For example, support for strings is added with the following:
import sweet.delights.anonymization.Injection
import org.apache.commons.codec.binary.Base64
implicit lazy val stringInjection: Injection[String, Array[Byte]] = new Injection[String, Array[Byte]] {
override def apply(t: String): Array[Byte] = t.getBytes("UTF-8")
override def invert(u: Array[Byte]): String = Base64.encodeBase64String(u)
}
Supported hashing algorithms
The hashing algorithms are those supported by Java 8:
- MD5
- SHA-1
- SHA-256
- SHA-384
- SHA-512
Other algorithms, not necessarly hashing algorithms, could be implemented. For instance, the anonymization method FirstLetter
-of-a-string could be added. Contributions welcome!
Acknowledgments
- the
shapeless
library - the
frameless
library for theInjection
mechanism - the
Apache Commons Codec
library - the The Type Astronaut's Guide to Shapeless book