Jackie-Jiang commented on code in PR #14197: URL: https://github.com/apache/pinot/pull/14197#discussion_r1794230668
########## pinot-segment-local/src/main/java/org/apache/pinot/segment/local/function/GroovyMethodSanitizer.java: ########## @@ -0,0 +1,390 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.pinot.segment.local.function; + +import java.util.List; +import org.codehaus.groovy.ast.GroovyCodeVisitor; +import org.codehaus.groovy.ast.Parameter; +import org.codehaus.groovy.ast.expr.ArgumentListExpression; +import org.codehaus.groovy.ast.expr.ArrayExpression; +import org.codehaus.groovy.ast.expr.AttributeExpression; +import org.codehaus.groovy.ast.expr.BinaryExpression; +import org.codehaus.groovy.ast.expr.BitwiseNegationExpression; +import org.codehaus.groovy.ast.expr.BooleanExpression; +import org.codehaus.groovy.ast.expr.CastExpression; +import org.codehaus.groovy.ast.expr.ClassExpression; +import org.codehaus.groovy.ast.expr.ClosureExpression; +import org.codehaus.groovy.ast.expr.ClosureListExpression; +import org.codehaus.groovy.ast.expr.ConstantExpression; +import org.codehaus.groovy.ast.expr.ConstructorCallExpression; +import org.codehaus.groovy.ast.expr.DeclarationExpression; +import org.codehaus.groovy.ast.expr.ElvisOperatorExpression; +import org.codehaus.groovy.ast.expr.Expression; +import org.codehaus.groovy.ast.expr.FieldExpression; +import org.codehaus.groovy.ast.expr.GStringExpression; +import org.codehaus.groovy.ast.expr.ListExpression; +import org.codehaus.groovy.ast.expr.MapEntryExpression; +import org.codehaus.groovy.ast.expr.MapExpression; +import org.codehaus.groovy.ast.expr.MethodCallExpression; +import org.codehaus.groovy.ast.expr.MethodPointerExpression; +import org.codehaus.groovy.ast.expr.NotExpression; +import org.codehaus.groovy.ast.expr.PostfixExpression; +import org.codehaus.groovy.ast.expr.PrefixExpression; +import org.codehaus.groovy.ast.expr.PropertyExpression; +import org.codehaus.groovy.ast.expr.RangeExpression; +import org.codehaus.groovy.ast.expr.SpreadExpression; +import org.codehaus.groovy.ast.expr.SpreadMapExpression; +import org.codehaus.groovy.ast.expr.StaticMethodCallExpression; +import org.codehaus.groovy.ast.expr.TernaryExpression; +import org.codehaus.groovy.ast.expr.TupleExpression; +import org.codehaus.groovy.ast.expr.UnaryMinusExpression; +import org.codehaus.groovy.ast.expr.UnaryPlusExpression; +import org.codehaus.groovy.ast.expr.VariableExpression; +import org.codehaus.groovy.ast.stmt.AssertStatement; +import org.codehaus.groovy.ast.stmt.BlockStatement; +import org.codehaus.groovy.ast.stmt.BreakStatement; +import org.codehaus.groovy.ast.stmt.CaseStatement; +import org.codehaus.groovy.ast.stmt.CatchStatement; +import org.codehaus.groovy.ast.stmt.ContinueStatement; +import org.codehaus.groovy.ast.stmt.DoWhileStatement; +import org.codehaus.groovy.ast.stmt.ExpressionStatement; +import org.codehaus.groovy.ast.stmt.ForStatement; +import org.codehaus.groovy.ast.stmt.IfStatement; +import org.codehaus.groovy.ast.stmt.ReturnStatement; +import org.codehaus.groovy.ast.stmt.SwitchStatement; +import org.codehaus.groovy.ast.stmt.SynchronizedStatement; +import org.codehaus.groovy.ast.stmt.ThrowStatement; +import org.codehaus.groovy.ast.stmt.TryCatchStatement; +import org.codehaus.groovy.ast.stmt.WhileStatement; +import org.codehaus.groovy.classgen.BytecodeExpression; + + +public class GroovyMethodSanitizer implements GroovyCodeVisitor { Review Comment: This class can be significantly simplified if extending `CodeVisitorSupport`. Why do we want to block on method names? Is this mostly for flexibility? ########## pinot-segment-local/src/main/java/org/apache/pinot/segment/local/function/GroovyStaticAnalyzerConfig.java: ########## @@ -0,0 +1,138 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.pinot.segment.local.function; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.google.common.base.Preconditions; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.List; +import org.apache.helix.zookeeper.datamodel.ZNRecord; +import org.apache.pinot.spi.utils.JsonUtils; + + +public class GroovyStaticAnalyzerConfig { + final boolean _enabled; Review Comment: `enabled` is not really useful. Let's remove it and it should be enabled whenever the config exists ########## pinot-segment-local/src/main/java/org/apache/pinot/segment/local/function/GroovyStaticAnalyzerConfig.java: ########## @@ -0,0 +1,138 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.pinot.segment.local.function; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.google.common.base.Preconditions; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.List; +import org.apache.helix.zookeeper.datamodel.ZNRecord; +import org.apache.pinot.spi.utils.JsonUtils; + + +public class GroovyStaticAnalyzerConfig { + final boolean _enabled; + final private List<String> _allowedReceivers; + final private List<String> _allowedImports; + final private List<String> _allowedStaticImports; + final private List<String> _disallowedMethodNames; + + public GroovyStaticAnalyzerConfig( + @JsonProperty("enabled") + boolean enabled, + @JsonProperty("allowedReceivers") + List<String> allowedReceivers, + @JsonProperty("allowedImports") + List<String> allowedImports, + @JsonProperty("allowedStaticImports") + List<String> allowedStaticImports, + @JsonProperty("disallowedMethodNames") + List<String> disallowedMethodNames) { + _enabled = enabled; + _allowedImports = allowedImports; + _allowedReceivers = allowedReceivers; + _allowedStaticImports = allowedStaticImports; + _disallowedMethodNames = disallowedMethodNames; + } + + @JsonProperty("enabled") + public boolean isEnabled() { + return _enabled; + } + + @JsonProperty("allowedReceivers") + public List<String> getAllowedReceivers() { + return _allowedReceivers; + } + + @JsonProperty("allowedImports") + public List<String> getAllowedImports() { + return _allowedImports; + } + + @JsonProperty("allowedStaticImports") + public List<String> getAllowedStaticImports() { + return _allowedStaticImports; + } + + @JsonProperty("disallowedMethodNames") + public List<String> getDisallowedMethodNames() { + return _disallowedMethodNames; + } + + public ZNRecord toZNRecord() throws JsonProcessingException { + ZNRecord record = new ZNRecord("groovySecurityConfiguration"); Review Comment: We probably don't want this config to be a separate ZNode. We can consider putting it as a field in the cluster config ########## pinot-core/src/test/java/org/apache/pinot/core/data/function/GroovyFunctionEvaluatorTest.java: ########## @@ -23,17 +23,55 @@ import java.util.List; import java.util.Map; import org.apache.pinot.segment.local.function.GroovyFunctionEvaluator; +import org.apache.pinot.segment.local.function.GroovyStaticAnalyzerConfig; import org.apache.pinot.spi.data.readers.GenericRow; import org.testng.Assert; import org.testng.annotations.DataProvider; import org.testng.annotations.Test; import org.testng.collections.Lists; +import static org.apache.pinot.segment.local.function.GroovyStaticAnalyzerConfig.getDefaultAllowedImports; +import static org.apache.pinot.segment.local.function.GroovyStaticAnalyzerConfig.getDefaultAllowedReceivers; + /** * Tests Groovy functions for transforming schema columns */ public class GroovyFunctionEvaluatorTest { + @Test + public void testIllegalGroovyScripts() { + // TODO: Add separate tests for these rules: receivers, imports, static imports, and method names. + List<String> scripts = List.of( + "Groovy({\"ls\".execute()})", + "Groovy({[\"ls\"].execute()})", + "Groovy({System.exit(5)})", + "Groovy({System.metaClass.methods.each { method -> if (method.name.md5() == " + + "\"f24f62eeb789199b9b2e467df3b1876b\") {method.invoke(System, 10)} }})", + "Groovy({System.metaClass.methods.each { method -> if (method.name.reverse() == (\"ti\" + \"xe\")) " + + "{method.invoke(System, 10)} }})", + "groovy({def args = [\"QuickStart\", \"-type\", \"REALTIME\"] as String[]; " + + "org.apache.pinot.tools.admin.PinotAdministrator.main(args); 2})", + "Groovy({return [\"bash\", \"-c\", \"env\"].execute().text})" + ); + + final GroovyStaticAnalyzerConfig config = new GroovyStaticAnalyzerConfig( Review Comment: (format) This doesn't follow `Pinot Style`, please reformat the changes ########## pinot-segment-local/src/main/java/org/apache/pinot/segment/local/function/GroovySecurityConfigManager.java: ########## @@ -0,0 +1,76 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.pinot.segment.local.function; + +import com.google.common.cache.CacheBuilder; +import com.google.common.cache.CacheLoader; +import com.google.common.cache.LoadingCache; +import java.util.concurrent.TimeUnit; +import javax.annotation.Nonnull; +import org.apache.helix.AccessOption; +import org.apache.helix.HelixManager; +import org.apache.helix.zookeeper.datamodel.ZNRecord; +import org.apache.zookeeper.data.Stat; + + +public class GroovySecurityConfigManager { + public static final String PROPERTYSTORE_PATH = "/CONFIGS/GROOVY_EXECUTION/StaticAnalyzer"; + private static LoadingCache<Integer, GroovyStaticAnalyzerConfig> _configCache; + private static HelixManager _helixManager; + + public GroovySecurityConfigManager(HelixManager helixManager) { + _helixManager = helixManager; + _configCache = CacheBuilder.newBuilder() + .maximumSize(1) + .expireAfterWrite(5, TimeUnit.MINUTES) + .build(new CacheLoader<>() { + @Override + @Nonnull Review Comment: (convention) We don't usually annotate `@Nonnull`, but only annotate `@Nullable` ########## pinot-core/src/test/java/org/apache/pinot/core/data/function/GroovyFunctionEvaluatorTest.java: ########## @@ -23,17 +23,55 @@ import java.util.List; import java.util.Map; import org.apache.pinot.segment.local.function.GroovyFunctionEvaluator; +import org.apache.pinot.segment.local.function.GroovyStaticAnalyzerConfig; import org.apache.pinot.spi.data.readers.GenericRow; import org.testng.Assert; import org.testng.annotations.DataProvider; import org.testng.annotations.Test; import org.testng.collections.Lists; +import static org.apache.pinot.segment.local.function.GroovyStaticAnalyzerConfig.getDefaultAllowedImports; +import static org.apache.pinot.segment.local.function.GroovyStaticAnalyzerConfig.getDefaultAllowedReceivers; + /** * Tests Groovy functions for transforming schema columns */ public class GroovyFunctionEvaluatorTest { + @Test + public void testIllegalGroovyScripts() { + // TODO: Add separate tests for these rules: receivers, imports, static imports, and method names. + List<String> scripts = List.of( + "Groovy({\"ls\".execute()})", + "Groovy({[\"ls\"].execute()})", + "Groovy({System.exit(5)})", + "Groovy({System.metaClass.methods.each { method -> if (method.name.md5() == " + + "\"f24f62eeb789199b9b2e467df3b1876b\") {method.invoke(System, 10)} }})", + "Groovy({System.metaClass.methods.each { method -> if (method.name.reverse() == (\"ti\" + \"xe\")) " + + "{method.invoke(System, 10)} }})", + "groovy({def args = [\"QuickStart\", \"-type\", \"REALTIME\"] as String[]; " + + "org.apache.pinot.tools.admin.PinotAdministrator.main(args); 2})", + "Groovy({return [\"bash\", \"-c\", \"env\"].execute().text})" + ); + + final GroovyStaticAnalyzerConfig config = new GroovyStaticAnalyzerConfig( Review Comment: (minor, convention) We don't usually use `final` in local variable, same for other places ########## pinot-segment-local/src/main/java/org/apache/pinot/segment/local/function/GroovyStaticAnalyzerConfig.java: ########## @@ -0,0 +1,138 @@ +/** + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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.apache.pinot.segment.local.function; + +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.core.JsonProcessingException; +import com.google.common.base.Preconditions; +import java.math.BigDecimal; +import java.math.BigInteger; +import java.util.List; +import org.apache.helix.zookeeper.datamodel.ZNRecord; +import org.apache.pinot.spi.utils.JsonUtils; + + +public class GroovyStaticAnalyzerConfig { + final boolean _enabled; + final private List<String> _allowedReceivers; Review Comment: (convention) Put `private` before `final` ########## pinot-server/src/main/java/org/apache/pinot/server/starter/helix/BaseServerStarter.java: ########## @@ -945,4 +951,22 @@ private void initSegmentFetcher(PinotConfiguration config) protected AdminApiApplication createServerAdminApp() { return new AdminApiApplication(_serverInstance, _accessControlFactory, _serverConf); } + + private void configureGroovySecurity() { + GroovyStaticAnalyzerConfig config = null; + try { + GroovySecurityConfigManager manager = new GroovySecurityConfigManager(_helixManager); + config = manager.getConfig(); + + if (config == null) { + config = GroovyStaticAnalyzerConfig.createDefault(true); + manager.setConfig(config); + } + } catch (Exception _ex) { + LOGGER.error("Failed to read config from ZK. Loading Default configuration."); Review Comment: Directly throw exception instead of logging error. We want to fail the server start if security is not guaranteed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
