org.sonar.java.checks.Struts1EndpointCheck 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.9.0.37768
/*
 * 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;

import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import org.sonar.check.Rule;
import org.sonar.java.matcher.MethodMatcher;
import org.sonar.java.matcher.MethodMatcherCollection;
import org.sonar.java.matcher.TypeCriteria;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.JavaFileScannerContext;
import org.sonar.plugins.java.api.tree.IdentifierTree;
import org.sonar.plugins.java.api.tree.MethodTree;
import org.sonar.plugins.java.api.tree.Tree;

@Rule(key = "S4530")
public class Struts1EndpointCheck extends IssuableSubscriptionVisitor {

  private static final String[] args1 = {"org.apache.struts.action.ActionMapping", "org.apache.struts.action.ActionForm",
    "javax.servlet.http.HttpServletRequest", "javax.servlet.http.HttpServletResponse"};
  private static final String[] args2 = {"org.apache.struts.action.ActionMapping", "org.apache.struts.action.ActionForm",
    "javax.servlet.ServletRequest", "javax.servlet.ServletResponse"};
  private static final MethodMatcherCollection STRUTS_METHOD = MethodMatcherCollection.create(
    MethodMatcher.create().typeDefinition(TypeCriteria.anyType()).name("perform").parameters(args1),
    MethodMatcher.create().typeDefinition(TypeCriteria.anyType()).name("perform").parameters(args2),
    MethodMatcher.create().typeDefinition(TypeCriteria.anyType()).name("execute").parameters(args1),
    MethodMatcher.create().typeDefinition(TypeCriteria.anyType()).name("execute").parameters(args2)
  );

  @Override
  public List nodesToVisit() {
    return Collections.singletonList(Tree.Kind.METHOD);
  }

  @Override
  public void visitNode(Tree tree) {
    if(!hasSemantic()) {
      return;
    }
    MethodTree methodTree = (MethodTree) tree;
    if (methodTree.symbol().owner().type().isSubtypeOf("org.apache.struts.action.Action") && STRUTS_METHOD.anyMatch(methodTree)) {
      List actionMappingUsages = methodTree.parameters().get(1).symbol().usages();
      if (!actionMappingUsages.isEmpty()) {
        reportIssue(methodTree.simpleName(), "Make sure that the ActionForm is used safely here.",
          actionMappingUsages.stream().map(idTree -> new JavaFileScannerContext.Location("", idTree)).collect(Collectors.toList()), null);
      }
    }
  }
}