io.inversion.action.security.AclRule Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of inversion-core-api Show documentation
Inversion Cloud API Engine
The newest version!
/*
 * Copyright (c) 2015-2018 Rocket Partners, LLC
 * https://github.com/inversion-api
 *
 * 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 io.inversion.action.security;

import io.inversion.Chain;
import io.inversion.Request;
import io.inversion.Rule;
import io.inversion.utils.Utils;

import java.util.ArrayList;

public class AclRule extends Rule {
    protected final ArrayList permissions             = new ArrayList<>();
    protected final ArrayList roles                   = new ArrayList<>();
    protected final ArrayList scopes                  = new ArrayList<>();
    protected       boolean           allow                   = true;
    protected       boolean           info                    = false;
    protected       boolean           allRolesMustMatch       = false;
    protected       boolean           allPermissionsMustMatch = false;
    protected       boolean           allScopesMustMatch = false;


    public AclRule() {
        super();
    }

//    public AclRule(String name, String permissions, StringString ruleMatcherSpec, String permission1, String... permissionsN) {
//        withName(name);
//        withIncludeOn(ruleMatcherSpec);
//
//        if (permission1 != null)
//            withPermissions(permission1);
//
//        if (permissionsN != null)
//            withPermissions(permissionsN);
//    }

    public static AclRule allowAll(String includedOn) {
        AclRule rule = new AclRule();
        rule.withIncludeOn(includedOn);
        return rule;
    }

    public static AclRule requireAllPerms(String permissions, String... includedOn) {
        AclRule rule = new AclRule();
        rule.withAllPermissionsMustMatch(true);
        rule.withPermissions(permissions);
        rule.withIncludeOn(includedOn);
        return rule;
    }

    public static AclRule requireOnePerm(String permissions, String... includedOn) {
        AclRule rule = new AclRule();
        rule.withAllPermissionsMustMatch(false);
        rule.withPermissions(permissions);
        rule.withIncludeOn(includedOn);
        return rule;
    }

    public static AclRule requireAllRoles(String roles, String... includedOn) {
        AclRule rule = new AclRule();
        rule.withAllRolesMustMatch(true);
        rule.withRoles(roles);
        rule.withIncludeOn(includedOn);
        return rule;
    }

    public static AclRule requireOneRole(String roles, String... includedOn) {
        AclRule rule = new AclRule();
        rule.withAllRolesMustMatch(false);
        rule.withRoles(roles);
        rule.withIncludeOn(includedOn);
        return rule;
    }

    public static AclRule requireAllScopes(String scopes, String... includedOn) {
        AclRule rule = new AclRule();
        rule.withAllScopesMustMatch(true);
        rule.withScopes(scopes);
        rule.withIncludeOn(includedOn);
        return rule;
    }

    public static AclRule requireOneScope(String scopes, String... includedOn) {
        AclRule rule = new AclRule();
        rule.withAllScopesMustMatch(false);
        rule.withScopes(scopes);
        rule.withIncludeOn(includedOn);
        return rule;
    }




    public boolean ruleMatches(Request req) {

        if (match(req.getMethod(), req.getPath()) == null)
            return false;

        if (Chain.getUser() == null && (roles.size() > 0 || permissions.size() > 0 || scopes.size() > 0))
            return false;

        int matches = 0;
        for (String requiredRole : roles) {
            boolean matched = Chain.getUser().hasRoles(requiredRole);

            if (matched) {
                matches += 1;
                if (!allRolesMustMatch) {
                    break;
                }
            } else {
                if (allRolesMustMatch) {
                    break;
                }
            }
        }

        for (String requiredPerm : permissions) {
            boolean matched = Chain.getUser().hasPermissions(requiredPerm);

            if (matched) {
                matches += 1;
                if (!allPermissionsMustMatch) {
                    break;
                }
            } else {
                if (allPermissionsMustMatch) {
                    break;
                }
            }
        }

        for (String requiredScope : scopes) {
            boolean matched = Chain.getUser().hasScope(requiredScope);

            if (matched) {
                matches += 1;
                if (!allScopesMustMatch) {
                    break;
                }
            } else {
                if (allScopesMustMatch) {
                    break;
                }
            }
        }

        boolean hasRoles = roles.size() == 0 //
                || (allRolesMustMatch && matches == roles.size())//
                || (!allRolesMustMatch && matches > 0);

        boolean hasPermissions = permissions.size() == 0 //
                || (allPermissionsMustMatch && matches == permissions.size())//
                || (!allPermissionsMustMatch && matches > 0);

        boolean hasScopes = scopes.size() == 0 //
                || (allScopesMustMatch && matches == scopes.size())//
                || (!allScopesMustMatch && matches > 0);

        return hasRoles || hasPermissions || hasScopes;
    }

    public ArrayList getRoles() {
        return new ArrayList(roles);
    }

    public AclRule withRoles(String... roles) {
        if (roles != null) {
            for (String role : Utils.explode(",", roles)) {
                if (!this.roles.contains(role))
                    this.roles.add(role);
            }
        }
        return this;
    }

    public ArrayList getPermissions() {
        return new ArrayList(permissions);
    }

    public AclRule withPermissions(String... permissions) {
        if (permissions != null) {
            for (String permission : Utils.explode(",", permissions)) {
                if (!this.permissions.contains(permission))
                    this.permissions.add(permission);
            }
        }
        return this;
    }

    public ArrayList getScopes() {
        return new ArrayList(scopes);
    }

    public AclRule withScopes(String... scopes) {
        if (scopes != null) {
            for (String scope : Utils.explode(",", scopes)) {
                if (!this.scopes.contains(scope))
                    this.scopes.add(scope);
            }
        }
        return this;
    }



    public boolean isAllow() {
        return allow;
    }

    public AclRule withAllow(boolean allow) {
        this.allow = allow;
        return this;
    }

    public boolean isInfo() {
        return info;
    }

    public AclRule withInfo(boolean info) {
        this.info = info;
        return this;
    }

    public boolean isAllRolesMustMatch() {
        return allRolesMustMatch;
    }

    public AclRule withAllRolesMustMatch(boolean allRolesMustMatch) {
        this.allRolesMustMatch = allRolesMustMatch;
        return this;
    }

    public boolean isAllPermissionsMustMatch() {
        return allPermissionsMustMatch;
    }

    public AclRule withAllPermissionsMustMatch(boolean allPermissionsMustMatch) {
        this.allPermissionsMustMatch = allPermissionsMustMatch;
        return this;
    }

    public boolean isAllScopesMustMatch() {
        return allScopesMustMatch;
    }

    public AclRule withAllScopesMustMatch(boolean allScopesMustMatch) {
        this.allScopesMustMatch = allScopesMustMatch;
        return this;
    }
}