org.sonar.java.checks.security.IntegerToHexStringCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-checks Show documentation
There is a newer version: 8.6.0.37351
/*
 * SonarQube Java
 * Copyright (C) 2012-2018 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program 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.
 *
 * This program 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.
 */
package org.sonar.java.checks.security;

import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.sonar.check.Rule;
import org.sonar.java.checks.methods.AbstractMethodDetection;
import org.sonar.java.matcher.MethodMatcher;
import org.sonar.java.matcher.TypeCriteria;
import org.sonar.java.model.ExpressionUtils;
import org.sonar.plugins.java.api.tree.ExpressionTree;
import org.sonar.plugins.java.api.tree.MethodInvocationTree;
import org.sonar.plugins.java.api.tree.Tree;

@Rule(key = "S4425")
public class IntegerToHexStringCheck extends AbstractMethodDetection {

  private static final MethodMatcher APPEND_MATCHER = MethodMatcher.create()
    .typeDefinition(TypeCriteria.subtypeOf("java.lang.AbstractStringBuilder"))
    .name("append")
    .addParameter(TypeCriteria.is("java.lang.String"));

  private static final MethodMatcher PRINT_MATCHER = MethodMatcher.create()
    .typeDefinition(TypeCriteria.subtypeOf("java.io.PrintStream"))
    .name("print")
    .addParameter(TypeCriteria.is("java.lang.String"));

  private static final MethodMatcher JOINER_MATCHER = MethodMatcher.create()
    .typeDefinition(TypeCriteria.subtypeOf("java.util.StringJoiner"))
    .name("add")
    .addParameter(TypeCriteria.is("java.lang.CharSequence"));

  @Override
  protected List getMethodInvocationMatchers() {
    return Collections.singletonList(
      MethodMatcher.create()
        .typeDefinition(TypeCriteria.is("java.lang.Integer"))
        .name("toHexString")
        .addParameter(TypeCriteria.is("int")));
  }

  @Override
  protected void onMethodInvocationFound(MethodInvocationTree method) {
    if (isArgumentAppended(method) && typeIsByte(method.arguments().get(0))) {
      reportIssue(method.methodSelect(), "Use String.format( \"%02X\", ...) instead.");
    }
  }

  private static boolean isArgumentAppended(MethodInvocationTree method) {
    return Optional.of(method)
      .map(Tree::parent)
      .filter(tree -> tree.is(Tree.Kind.ARGUMENTS))
      .map(Tree::parent)
      .filter(tree -> tree.is(Tree.Kind.METHOD_INVOCATION))
      .map(MethodInvocationTree.class::cast)
      .filter(parentMethod -> APPEND_MATCHER.matches(parentMethod) ||
        PRINT_MATCHER.matches(parentMethod) ||
        JOINER_MATCHER.matches(parentMethod))
      .isPresent();
  }

  private static boolean typeIsByte(ExpressionTree expression) {
    return expression.symbolType().isSubtypeOf("byte") ||
      ExpressionUtils.isSecuringByte(expression);
  }
}