org.codenarc.rule.grails.GrailsMassAssignmentRule.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of CodeNarc Show documentation

The CodeNarc project provides a static analysis tool for Groovy code.

There is a newer version: 3.5.0-groovy-4.0

/*
 * Copyright 2013 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.codenarc.rule.grails

import org.codehaus.groovy.ast.expr.BinaryExpression
import org.codehaus.groovy.ast.expr.ConstructorCallExpression
import org.codenarc.rule.AbstractAstVisitorRule
import org.codenarc.rule.AbstractAstVisitor
import org.codehaus.groovy.ast.expr.PropertyExpression
import org.codehaus.groovy.ast.expr.AttributeExpression
import org.codehaus.groovy.ast.expr.VariableExpression

/**
 * Untrusted input should not be allowed to set arbitrary object fields without restriction.
 *
 * TODO: Switch from name-based detection to type based detection when Grails domain object interfaces are detectable
 * @author Brian Soby
 */
class GrailsMassAssignmentRule extends AbstractAstVisitorRule {
    String name = 'GrailsMassAssignment'
    int priority = 2
    Class astVisitorClass = GrailsMassAssignmentAstVisitor
}

class GrailsMassAssignmentAstVisitor extends AbstractAstVisitor {

    @Override
    void visitConstructorCallExpression(ConstructorCallExpression call) {
        if (isFirstVisit(call) && call.arguments && call.arguments.expressions) {
            def exp = call.arguments.expressions.first()
            if (exp instanceof VariableExpression) {
                if (exp.variable == 'params') {
                    addViolation(call, 'Restrict mass attribute assignment')
                }
            }
        }
        super.visitConstructorCallExpression(call)
    }

    @Override
    void visitBinaryExpression(BinaryExpression expression) {
        if (isFirstVisit(expression) &&
                expression.leftExpression instanceof PropertyExpression &&
                !(expression.leftExpression instanceof AttributeExpression) &&
                expression.leftExpression.property.hasProperty('value') &&
                expression.leftExpression.property.value == 'properties' &&
                expression.rightExpression instanceof VariableExpression &&
                expression.rightExpression.variable == 'params'
        ) {
            addViolation(expression, 'Restrict mass attribute assignment')
        }
        super.visitBinaryExpression(expression)
    }

}