PermissionsValidator.java

/*
 * Copyright (c) 2015-2016 LabKey Corporation
 *
 * 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 org.labkey.core.security.validators;

import org.labkey.api.admin.sitevalidation.SiteValidationProvider;
import org.labkey.api.admin.sitevalidation.SiteValidationResultList;
import org.labkey.api.data.Container;
import org.labkey.api.security.User;
import org.labkey.api.security.permissions.Permission;
import org.labkey.api.security.roles.EditorRole;
import org.labkey.api.security.roles.ReaderRole;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

/**
 * Validates appropriate container level permissions for the guest user.
 */
public class PermissionsValidator implements SiteValidationProvider
{
    @Override
    public String getName()
    {
        return "Permissions Validator";
    }

    @Override
    public String getDescription()
    {
        return "Check that guest user permissions are set appropriately";
    }

    @Override
    public boolean isSiteScope()
    {
        return false;
    }

    @Override
    public SiteValidationResultList runValidation(Container c, User u)
    {
        SiteValidationResultList results = new SiteValidationResultList();

        Set<Class<? extends Permission>> readerPermissions = new ReaderRole().getPermissions();
        if (c.hasOneOf(User.guest, readerPermissions))
        {
            results.addInfo("Guest user has read permission for folder.");
        }
        Set<Class<? extends Permission>> editorPermissions = new HashSet<>(new EditorRole().getPermissions());
        editorPermissions.removeAll(readerPermissions);
        if (c.hasOneOf(User.guest, Collections.unmodifiableSet(editorPermissions)))
        {
            results.addWarn("Guest user has edit permission for folder.");
        }
        return results.nullIfEmpty();
    }
}