PatternObfuscator.java

/*
 * Copyright 2014-2015 Groupon, Inc
 * Copyright 2014-2015 The Billing Project, LLC
 *
 * The Billing Project licenses this file to you 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.
 */

package org.killbill.billing.server.log.obfuscators;

import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedList;
import java.util.regex.Pattern;

import ch.qos.logback.classic.spi.ILoggingEvent;
import com.google.common.collect.ImmutableList;

public class PatternObfuscator extends Obfuscator {

    // Hide by default sensitive bank, PCI and PII data. For PANs, see LuhnMaskingObfuscator
    private static final Collection<String> DEFAULT_SENSITIVE_KEYS = ImmutableList.of(
            "accountnumber",
            "authenticationdata",
            "bankaccountnumber",
            "banknumber",
            "bic",
            "cardvalidationnum",
            "cavv",
            "ccFirstName",
            "ccLastName",
            "ccNumber",
            "ccTrackData",
            "ccVerificationValue",
            "ccvv",
            "cvNumber",
            "cvc",
            "cvv",
            "email",
            "iban",
            "name",
            "number",
            "password",
            "xid");

    private final Collection<Pattern> patterns = new LinkedList<Pattern>();

    public PatternObfuscator() {
        this(ImmutableList.<Pattern>of(), ImmutableList.<String>of());
    }

    public PatternObfuscator(final Collection<String> extraKeywords) {
        this(ImmutableList.<Pattern>of(), extraKeywords);
    }

    public PatternObfuscator(final Collection<Pattern> extraPatterns, final Collection<String> extraKeywords) {
        super();
        Collection<String> keywords = new ArrayList<String>();
        keywords.addAll(DEFAULT_SENSITIVE_KEYS);
        if (extraKeywords != null) {
            keywords.addAll(extraKeywords);
        }

        for (final String sensitiveKey : keywords) {
            this.patterns.add(buildJSONPattern(sensitiveKey));
            this.patterns.add(buildXMLPattern(sensitiveKey));
            this.patterns.add(buildMultiValuesXMLPattern(sensitiveKey));
            this.patterns.add(buildKeyValuePattern1(sensitiveKey));
            this.patterns.add(buildKeyValuePattern2(sensitiveKey));
        }
        this.patterns.addAll(extraPatterns);
    }

    @Override
    public String obfuscate(final String originalString, final ILoggingEvent event) {
        return obfuscate(originalString, patterns, event);
    }

    private Pattern buildJSONPattern(final String key) {
        return Pattern.compile(key + "\"\\s*:\\s*([^,{}]+)", DEFAULT_PATTERN_FLAGS);
    }

    private Pattern buildXMLPattern(final String key) {
        return Pattern.compile(key + "(?:\\s+.*?)?>([^<\\n]+)</[^<>]*" + key + ">", DEFAULT_PATTERN_FLAGS);
    }

    private Pattern buildMultiValuesXMLPattern(final String key) {
        return Pattern.compile(key + "</key>\\s*<value[^>]*>([^<\\n]+)</value>", DEFAULT_PATTERN_FLAGS);
    }

    // Splunk-type logging
    private Pattern buildKeyValuePattern1(final String key) {
        return Pattern.compile(key + "\\s*=\\s*'([^\']+)'", DEFAULT_PATTERN_FLAGS);
    }

    // Splunk-type logging
    private Pattern buildKeyValuePattern2(final String key) {
        return Pattern.compile(key + "\\s*=\\s*\"([^\"]+)\"", DEFAULT_PATTERN_FLAGS);
    }
}