cloudstack-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From bhaisaab <...@git.apache.org>
Subject [GitHub] cloudstack pull request: CLOUDSTACK-8562: Dynamic Role-Based API C...
Date Wed, 20 Apr 2016 16:16:21 GMT
Github user bhaisaab commented on a diff in the pull request:

    https://github.com/apache/cloudstack/pull/1489#discussion_r60439905
  
    --- Diff: plugins/acl/dynamic-role-based/src/org/apache/cloudstack/acl/DynamicRoleBasedAPIAccessChecker.java
---
    @@ -0,0 +1,170 @@
    +// 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.cloudstack.acl;
    +
    +import com.cloud.exception.InvalidParameterValueException;
    +import com.cloud.exception.PermissionDeniedException;
    +import com.cloud.user.Account;
    +import com.cloud.user.AccountService;
    +import com.cloud.user.User;
    +import com.cloud.utils.component.AdapterBase;
    +import com.cloud.utils.component.PluggableService;
    +import com.google.common.base.Strings;
    +import org.apache.cloudstack.api.APICommand;
    +
    +import org.apache.log4j.Logger;
    +
    +import javax.ejb.Local;
    +import javax.inject.Inject;
    +import javax.naming.ConfigurationException;
    +import java.util.HashMap;
    +import java.util.HashSet;
    +import java.util.List;
    +import java.util.Map;
    +import java.util.Set;
    +
    +@Local(value = APIChecker.class)
    +public class DynamicRoleBasedAPIAccessChecker extends AdapterBase implements APIChecker
{
    +
    +    protected static final Logger LOGGER = Logger.getLogger(DynamicRoleBasedAPIAccessChecker.class);
    +
    +    @Inject
    +    private AccountService accountService;
    +    @Inject
    +    private RoleService roleService;
    +
    +    private List<PluggableService> services;
    +    private Map<RoleType, Set<String>> annotationRoleBasedApisMap = new HashMap<>();
    +
    +    protected DynamicRoleBasedAPIAccessChecker() {
    +        super();
    +        for (RoleType roleType : RoleType.values()) {
    +            annotationRoleBasedApisMap.put(roleType, new HashSet<String>());
    +        }
    +    }
    +
    +    private void denyApiAccess(final String commandName) throws PermissionDeniedException
{
    +        throw new PermissionDeniedException("The API does not exist or is blacklisted
for the account's role. " +
    +                "The account with is not allowed to request the api: " + commandName);
    +    }
    +
    +    private boolean checkPermission(final List <? extends RolePermission> permissions,
final RolePermission.Permission permissionToCheck, final String commandName) {
    +        if (permissions == null || permissions.isEmpty() || Strings.isNullOrEmpty(commandName))
{
    +            return false;
    +        }
    +        for (final RolePermission permission : permissions) {
    +            if (permission.getPermission() != permissionToCheck) {
    +                continue;
    +            }
    +            try {
    +                final Rule rule = new Rule(permission.getRule());
    +                if (rule.matches(commandName)) {
    +                    return true;
    +                }
    +            } catch (InvalidParameterValueException e) {
    +                LOGGER.warn("Invalid rule permission, please fix id=" + permission.getId()
+ " rule=" + permission.getRule());
    +                continue;
    +            }
    +        }
    +        return false;
    +    }
    +
    +    public boolean isDisabled() {
    +        return !roleService.isEnabled();
    +    }
    +
    +    @Override
    +    public boolean checkAccess(User user, String commandName) throws PermissionDeniedException
{
    +        if (isDisabled()) {
    +            return true;
    +        }
    +        Account account = accountService.getAccount(user.getAccountId());
    +        if (account == null) {
    +            throw new PermissionDeniedException("The account id=" + user.getAccountId()
+ "for user id=" + user.getId() + "is null");
    +        }
    +
    +        final Role accountRole = roleService.findRole(account.getRoleId());
    +        if (accountRole == null || accountRole.getId() < 1L) {
    +            denyApiAccess(commandName);
    +        }
    +
    +        // Allow all APIs for root admins
    +        if (accountRole.getRoleType() == RoleType.Admin && accountRole.getId()
== RoleType.Admin.getId()) {
    +            return true;
    +        }
    +
    +        final List<RolePermission> rolePermissions = roleService.findAllPermissionsBy(accountRole.getId());
    +
    +        // Check for allow rules
    +        if (checkPermission(rolePermissions, RolePermission.Permission.ALLOW, commandName))
{
    +            return true;
    +        }
    +
    +        // Check for deny rules
    +        if (checkPermission(rolePermissions, RolePermission.Permission.DENY, commandName))
{
    +            denyApiAccess(commandName);
    +        }
    +
    +        // Check annotations
    +        if (annotationRoleBasedApisMap.get(accountRole.getRoleType()) != null
    +                && annotationRoleBasedApisMap.get(accountRole.getRoleType()).contains(commandName))
{
    +            return true;
    +        }
    +
    +        denyApiAccess(commandName);
    +        return false;
    +    }
    +
    +    public void addApiToRoleBasedAnnotationsMap(final RoleType roleType, final String
commandName) {
    +        if (roleType == null || Strings.isNullOrEmpty(commandName)) {
    +            return;
    +        }
    +        final Set<String> commands = annotationRoleBasedApisMap.get(roleType);
    +        if (commands != null && !commands.contains(commandName)) {
    +            commands.add(commandName);
    +        }
    +    }
    +
    +    @Override
    +    public boolean configure(String name, Map<String, Object> params) throws ConfigurationException
{
    +        super.configure(name, params);
    +        return true;
    +    }
    +
    +    @Override
    +    public boolean start() {
    +        for (PluggableService service : services) {
    +            for (Class<?> clz : service.getCommands()) {
    +                APICommand command = clz.getAnnotation(APICommand.class);
    +                for (RoleType role : command.authorized()) {
    +                    addApiToRoleBasedAnnotationsMap(role, command.name());
    --- End diff --
    
    @koushik-das (2) when the class is configured and start() called, it goes through each
service, loops through the exposed apis and gets the authorized list of roletypes from its
APICommand annotation. It is here that it know what default role types are allowed for a given
api. For most apis, authorized is empty (as developers don't use it much).


---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---

Mime
View raw message