org.sonar.javascript.checks.WebSQLDatabaseCheck Maven / Gradle / Ivy

Go to download
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011 SonarSource and Eriks Nukis
 * [email protected]
 *
 * 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  02
 */
package org.sonar.javascript.checks;

import com.google.common.collect.ImmutableList;
import org.sonar.api.server.rule.RulesDefinition;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.javascript.checks.utils.CheckUtils;
import org.sonar.plugins.javascript.api.tree.expression.CallExpressionTree;
import org.sonar.plugins.javascript.api.visitors.BaseTreeVisitor;
import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
import org.sonar.squidbridge.annotations.SqaleSubCharacteristic;

import java.util.List;

@Rule(
  key = "S2817",
  name = "Web SQL databases should not be used",
  priority = Priority.CRITICAL,
  tags = {Tags.HTML5, Tags.SECURITY, Tags.OWASP_A6, Tags.OWASP_A9})
@SqaleSubCharacteristic(RulesDefinition.SubCharacteristics.SECURITY_FEATURES)
@SqaleConstantRemediation("2h")
public class WebSQLDatabaseCheck extends BaseTreeVisitor {

  private static final String MESSAGE = "Convert this use of a Web SQL database to another technology";
  private static final List OPEN_DATABASE_METHOD_CALLS = ImmutableList.of(
      "openDatabase",
      "window.openDatabase",
      "this.openDatabase"
  );

  @Override
  public void visitCallExpression(CallExpressionTree tree) {
    String callee = CheckUtils.asString(tree.callee());
    if (OPEN_DATABASE_METHOD_CALLS.contains(callee)){
      getContext().addIssue(this, tree, MESSAGE);
    }

    super.visitCallExpression(tree);
  }

}