SecureGroovyCompilationCustomizer.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This 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 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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 software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.groovy.internal;

import java.util.Arrays;
import java.util.Collections;

import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Singleton;

import org.codehaus.groovy.ast.expr.Expression;
import org.codehaus.groovy.ast.stmt.SynchronizedStatement;
import org.codehaus.groovy.classgen.BytecodeExpression;
import org.codehaus.groovy.classgen.BytecodeSequence;
import org.codehaus.groovy.control.customizers.CompilationCustomizer;
import org.codehaus.groovy.control.customizers.SecureASTCustomizer;
import org.xwiki.component.annotation.Component;
import org.xwiki.groovy.GroovyCompilationCustomizer;
import org.xwiki.security.authorization.ContextualAuthorizationManager;
import org.xwiki.security.authorization.Right;

/**
 * Provides a sandbox environment for running Groovy scripts in a safe way.
 *
 * @version $Id: 5a2401dba1c2fbcddaf167a8dda4e363d8ed06f5 $
 * @since 4.1M1
 */
@Component
@Named("secure")
@Singleton
public class SecureGroovyCompilationCustomizer implements GroovyCompilationCustomizer
{
    /**
     * Used to check for Programming Rights; if the document has Programming Rights then don't perform any check.
     */
    @Inject
    private ContextualAuthorizationManager authorizationManager;

    @Override
    public CompilationCustomizer createCustomizer()
    {
        CompilationCustomizer customizer = null;
        if (!this.authorizationManager.hasAccess(Right.PROGRAM)) {
            SecureASTCustomizer secureCustomizer = new SecureASTCustomizer();

            secureCustomizer.setStarImportsWhitelist(Collections.<String>emptyList());
            secureCustomizer.setStaticStarImportsWhitelist(Collections.<String>emptyList());
            secureCustomizer.setImportsWhitelist(Collections.<String>emptyList());
            secureCustomizer.setStaticStarImportsWhitelist(Collections.<String>emptyList());
            secureCustomizer.setMethodDefinitionAllowed(false);
            secureCustomizer.setReceiversClassesWhiteList(Collections.<Class>emptyList());
            secureCustomizer.setReceiversWhiteList(Collections.<String>emptyList());
            secureCustomizer.setTokensWhitelist(Collections.<Integer>emptyList());
            secureCustomizer.setPackageAllowed(false);

            // Note: no whitelist on Constants because that's not dangerous
            // TODO: Check if it's really not dangerous!
            //secureCustomizer.setConstantTypesClassesWhiteList(Collections.<Class>emptyList());
            //secureCustomizer.setConstantTypesWhiteList(Collections.<String>emptyList());

            // Only remove the dangerous Expressions
            secureCustomizer.setExpressionsBlacklist(Arrays.<Class<? extends Expression>>asList(
                BytecodeExpression.class
            ));

            // Only remove the dangerous Statements
            secureCustomizer.setStatementsBlacklist(Arrays.asList(
                BytecodeSequence.class,
                SynchronizedStatement.class
            ));

            customizer = secureCustomizer;
        }
        return customizer;
    }
}