org.elasticsearch.script.ClassPermission Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of elasticsearch Show documentation
Elasticsearch subproject :server
There is a newer version: 8.13.4
/*
 * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
 * or more contributor license agreements. Licensed under the Elastic License
 * 2.0 and the Server Side Public License, v 1; you may not use this file except
 * in compliance with, at your election, the Elastic License 2.0 or the Server
 * Side Public License, v 1.
 */

package org.elasticsearch.script;

import java.security.BasicPermission;
import java.security.Permission;
import java.security.PermissionCollection;
import java.util.Arrays;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.Set;

/**
 * Checked by scripting engines to allow loading a java class.
 * 
 * Examples:
 * 

 * Allow permission to {@code java.util.List}
 * 
permission org.elasticsearch.script.ClassPermission "java.util.List";
 * Allow permission to classes underneath {@code java.util} (and its subpackages such as {@code java.util.zip})
 * permission org.elasticsearch.script.ClassPermission "java.util.*";
 * Allow permission to standard predefined list of basic classes (see list below)
 * permission org.elasticsearch.script.ClassPermission "<<STANDARD>>";
 * Allow permission to all classes
 * permission org.elasticsearch.script.ClassPermission "*";
 * 
 * Set of classes (allowed by special value <<STANDARD>>):
 * 

 *   {@link java.lang.Boolean}
 *   {@link java.lang.Byte}
 *   {@link java.lang.Character}
 *   {@link java.lang.Double}
 *   {@link java.lang.Integer}
 *   {@link java.lang.Long}
 *   {@link java.lang.Math}
 *   {@link java.lang.Object}
 *   {@link java.lang.Short}
 *   {@link java.lang.String}
 *   {@link java.math.BigDecimal}
 *   {@link java.util.ArrayList}
 *   {@link java.util.Arrays}
 *   {@link java.util.Date}
 *   {@link java.util.HashMap}
 *   {@link java.util.HashSet}
 *   {@link java.util.Iterator}
 *   {@link java.util.List}
 *   {@link java.util.Map}
 *   {@link java.util.Set}
 *   {@link java.util.UUID}
 * 
 */
public final class ClassPermission extends BasicPermission {
    public static final String STANDARD = "<>";
    // jdk classes
    /** Typical set of classes for scripting: basic data types, math, dates, and simple collections */
    // this is the list from the old grovy sandbox impl (+ some things like String, Iterator, etc that were missing)
    private static final Set STANDARD_CLASSES = Set.of(
        Boolean.class.getName(),
        Byte.class.getName(),
        Character.class.getName(),
        Double.class.getName(),
        Integer.class.getName(),
        Long.class.getName(),
        Math.class.getName(),
        Object.class.getName(),
        Short.class.getName(),
        String.class.getName(),
        java.math.BigDecimal.class.getName(),
        java.util.ArrayList.class.getName(),
        Arrays.class.getName(),
        java.util.Date.class.getName(),
        java.util.HashMap.class.getName(),
        HashSet.class.getName(),
        java.util.Iterator.class.getName(),
        java.util.List.class.getName(),
        java.util.Map.class.getName(),
        Set.class.getName(),
        java.util.UUID.class.getName()
    );

    /**
     * Creates a new ClassPermission object.
     *
     * @param name class to grant permission to
     */
    public ClassPermission(String name) {
        super(name);
    }

    /**
     * Creates a new ClassPermission object.
     * This constructor exists for use by the {@code Policy} object to instantiate new Permission objects.
     *
     * @param name class to grant permission to
     * @param actions ignored
     */
    public ClassPermission(String name, String actions) {
        this(name);
    }

    @Override
    public boolean implies(Permission p) {
        // check for a special value of STANDARD to imply the basic set
        if (p != null && p.getClass() == getClass()) {
            ClassPermission other = (ClassPermission) p;
            if (STANDARD.equals(getName()) && STANDARD_CLASSES.contains(other.getName())) {
                return true;
            }
        }
        return super.implies(p);
    }

    @Override
    public PermissionCollection newPermissionCollection() {
        // BasicPermissionCollection only handles wildcards, we expand <> here
        PermissionCollection impl = super.newPermissionCollection();
        return new PermissionCollection() {
            @Override
            public void add(Permission permission) {
                if (permission instanceof ClassPermission && STANDARD.equals(permission.getName())) {
                    for (String clazz : STANDARD_CLASSES) {
                        impl.add(new ClassPermission(clazz));
                    }
                } else {
                    impl.add(permission);
                }
            }

            @Override
            public boolean implies(Permission permission) {
                return impl.implies(permission);
            }

            @Override
            public Enumeration elements() {
                return impl.elements();
            }
        };
    }
}