hudson.plugins.sonar.utils.MaskPasswordsOutputStream.java Source code

Introduction

Here is the source code for hudson.plugins.sonar.utils.MaskPasswordsOutputStream.java

Source

/*
 * Jenkins Plugin for SonarQube, open source software quality management tool.
 * mailto:contact AT sonarsource DOT com
 *
 * Jenkins Plugin for SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * Jenkins Plugin for SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
/*
 * Sonar is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * Sonar is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with Sonar; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02
 */
package hudson.plugins.sonar.utils;

import hudson.console.LineTransformationOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.regex.Pattern;
import org.apache.commons.lang.StringUtils;

/**
 * Class adapted from the mask-passwords plugin
 */
public class MaskPasswordsOutputStream extends LineTransformationOutputStream {
    private static final String REPLACEMENT = "******";
    private static final String URL_IN_LOGS = "ANALYSIS SUCCESSFUL, you can browse ";
    private final OutputStream logger;
    private final Pattern passwordsAsPattern;
    private final Charset charset;

    public MaskPasswordsOutputStream(OutputStream logger, Charset charset, Collection<String> passwords) {

        this.logger = logger;
        this.charset = charset;

        if (passwords != null && !passwords.isEmpty()) {

            // passwords are aggregated into a regex which is compiled as a pattern
            // for efficiency
            StringBuilder regex = new StringBuilder().append('(');

            int nbMaskedPasswords = 0;
            for (String password : passwords) {
                // we must not handle empty passwords
                if (StringUtils.isNotEmpty(password)) {
                    regex.append(Pattern.quote(password));
                    regex.append('|');
                    nbMaskedPasswords++;
                }
            }
            // is there at least one password to mask?
            if (nbMaskedPasswords >= 1) {
                // removes the last unuseful pipe
                regex.deleteCharAt(regex.length() - 1);
                regex.append(')');
                passwordsAsPattern = Pattern.compile(regex.toString());
            } else {
                // no passwords to hide
                passwordsAsPattern = null;
            }
        } else {
            // no passwords to hide
            passwordsAsPattern = null;
        }
    }

    @Override
    protected void eol(byte[] bytes, int len) throws IOException {
        String line = charset.decode(ByteBuffer.wrap(bytes, 0, len)).toString();
        if (passwordsAsPattern != null && !line.contains(URL_IN_LOGS)) {
            line = passwordsAsPattern.matcher(line).replaceAll(REPLACEMENT);
        }
        logger.write(line.getBytes(charset));
    }

    @Override
    public void close() throws IOException {
        super.close();
        logger.close();
    }
}