presents

Compliance Logging

A library that allows developers to mask sensitive information when logging.

Description

This library has been built to help developers mask PII, PCI and PHI when logging using their favorite framework.
For instance, to log a JSON String that contains some sensitive information, the result would be something like:

12:44:09 [main] INFO  MyClass - {"login":"john","password":"***********"}

At the moment, the library supports two types of objects that can be scanned to mask sensitive information: JSON and Lombok.
In order to achieve that, the developer needs to provide the framework with a custom marker.
For example:

log.info("{}", "{\"login\":\"john\",\"password":\"mypassword\"});

Would not mask anything; however, if a mask is used like below:

log.info(MaskType.JSON, "{}", "{\"login\":\"john\",\"password":\"mypassword\"});

It would mask the password (or any other fields that have been configured as sensitive).

Checkout our examples in our repository.

Usage with Log4j2

Import the latest version of the library in your project:
Maven:

<dependency>
    <groupId>com.slalom</groupId>
    <artifactId>compliance-logging-log4j2</artifactId>
    <version>{LATEST_VERSION}</version>
</dependency>

Gradle (Kotlin DSL):

dependencies {
    implementation(group = "com.slalom", name = "compliance-logging-log4j2", version = "{LATEST_VERSION}")
}

Then three things need to be setup in your Log4j2 configuration:

1. Package scanning (to scan our plugin).

<Configuration tatus="WARN" packages="com.slalom.logging">
  ...
</Configuration>

2. Add a property that represents the fields that need to be masked, the fields should be given as a comma separated list.

<Properties>
    <Property name="COMPLIANCE_FIELDS">password,ssn</Property>
</Properties>

3. Add our plugin pattern (%mm or %maskMessage) in the pattern layout.

<PatternLayout pattern="%d{HH:mm:ss} [%t] %-5level %logger{36} - %mm{${COMPLIANCE_FIELDS}}%n"/>

Full example:

<?xml version="1.0" encoding="UTF-8"?>
<Configuration tatus="WARN" packages="com.slalom.logging">
    <Properties>
        <Property name="COMPLIANCE_FIELDS">password,ssn</Property>
        <Property name="CONSOLE_LOG_PATTERN">%d{HH:mm:ss} [%t] %-5level %logger{36} - %mm{${COMPLIANCE_FIELDS}}%n
        </Property>
    </Properties>
    <appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="${sys:CONSOLE_LOG_PATTERN}"/>
        </Console>
    </appenders>
    <loggers>
        <root level="info">
            <appender-ref ref="Console"/>
        </root>
    </loggers>
</Configuration>

Simple example - Spring Boot example

Usage with Logback

Import the latest version of the library in your project:
Maven:

<dependency>
    <groupId>com.slalom</groupId>
    <artifactId>compliance-logging-logback</artifactId>
    <version>{LATEST_VERSION}</version>
</dependency>

Gradle (Kotlin DSL):

dependencies {
    implementation(group = "com.slalom", name = "compliance-logging-logback", version = "{LATEST_VERSION}")
}

Then two things need to be setup in your Logback configuration:

1. Add our Layout (com.slalom.logging.compliance.logback.PatternMaskingLayout).
2. Provide the fields that need to be masked, the fields should be given as a comma separated list.

Here is a full example:

<?xml version="1.0" encoding="UTF-8" ?>
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
            <layout class="com.slalom.logging.compliance.logback.PatternMaskingLayout">
                <fields>password,ssn</fields>
                <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            </layout>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

Simple example - Spring Boot example

Questions?

Create an issue

Development

Developer notes

License

MIT License

Copyright (c) 2020 Slalom LLC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.