com.redhat.insights.reports.Utils Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of runtimes-java-api Show documentation
There is a newer version: 2.0.4
/* Copyright (C) Red Hat 2023-2024 */
package com.redhat.insights.reports;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public final class Utils {
  private Utils() {}

  @SuppressWarnings("unchecked")
  public static Map defaultMasking(final Map inArgs) {
    List jvmArgs = new ArrayList<>();
    for (String arg : (List) (inArgs.get("jvm.args"))) {
      jvmArgs.add(sanitizeJavaParameters(arg));
    }
    inArgs.put("jvm.args", jvmArgs);
    inArgs.put("java.command", sanitizeJavaParameters((String) inArgs.get("java.command")));
    return inArgs;
  }

  private static String REDACTED_VALUE = "=ZZZZZZZZZ";

  /**
   * Sanitizes a string that contains java style parameters of the type -Dxxxxx=yyyyy by
   * substituting the yyyyy value for an obfuscated string
   *
   * @param parameters
   * @return a sanitized parameter string suitable for persisting
   */
  static String sanitizeJavaParameters(final String parameters) {
    final StringBuilder out = new StringBuilder();

    for (final String token : tokenizeComplexJavaParameters(parameters)) {
      // We only care about -Dxxxxx=yyyyy params
      if (token.startsWith("-D") && token.contains("=")) {
        String[] parts = token.split("=", 2);
        out.append(parts[0]);
        out.append(REDACTED_VALUE);
        // We might be parsing json
        // if so, preserve the list comma or list closing bracket
        if (token.endsWith(",")) {
          out.append(',');
        }
        if (token.endsWith("]")) {
          out.append(']');
        }
      } else {
        out.append(token);
      }
      out.append(" ");
    }
    // Remove the last added space
    out.deleteCharAt(out.length() - 1);
    return out.toString();
  }

  // This tokenizes a string, but with some special rules
  // It tokenizes based on spaces, but it will interpret quotes
  // that start in the middle of a string, after an '='
  // This is important because some of the data we want to preserve might
  // look like -Dxxxxx="this is all one token"
  // This is also aware of escape sequences
  static String[] tokenizeComplexJavaParameters(final String parameters) {
    final ArrayList tokens = new ArrayList();
    StringBuilder currentWord = new StringBuilder();
    Character currentQuote = null;
    boolean escaping = false;
    boolean afterEquals = false;
    // Order is important here. Rearrange at your own risk.
    for (final char c : parameters.toCharArray()) {
      // If we're not escaping, start escaping and continue
      if (c == '\\' && !escaping) {
        escaping = true;
        currentWord.append(c);
        continue;
      }

      // If we're escaping, always just add to the word and continue
      if (escaping) {
        escaping = false;
        currentWord.append(c);
        continue;
      }

      // If we see an '=', remember that and continue
      if (c == '=') {
        afterEquals = true;
        currentWord.append(c);
        continue;
      }

      // If we're not in a quote and we hit a space, save the word and continue
      if (currentQuote == null && c == ' ') {
        tokens.add(currentWord.toString());
        currentWord = new StringBuilder();
        continue;
      }

      // If we see a quote...
      if (c == '\'' || c == '"') {
        // If we are quoting...
        if (currentQuote != null) {
          // stop quoting if we're at the matching quote
          if (c == currentQuote) {
            currentQuote = null;
          }
        } else {
          // So we're not quoting...
          // If we're at a new word or after an equals, start quoting
          if (afterEquals || currentWord.length() == 0) {
            currentQuote = c;
          }
        }
      }

      // Otherwise, just add the char
      afterEquals = false;
      currentWord.append(c);
    }
    // Add the last word for the end of string
    tokens.add(currentWord.toString());
    return tokens.toArray(new String[0]);
  }
}