org.opencastproject.security.util.SecurityUtil.java Source code

Introduction

Here is the source code for org.opencastproject.security.util.SecurityUtil.java

Source

/**
 *  Copyright 2009, 2010 The Regents of the University of California
 *  Licensed under the Educational Community 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.osedu.org/licenses/ECL-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.opencastproject.security.util;

import static org.opencastproject.security.api.SecurityConstants.GLOBAL_ANONYMOUS_USERNAME;
import static org.opencastproject.security.api.SecurityConstants.GLOBAL_ADMIN_ROLE;
import static org.opencastproject.util.data.Option.none;
import static org.opencastproject.util.data.Option.option;
import static org.opencastproject.util.data.Option.some;
import static org.opencastproject.util.data.Tuple.tuple;

import org.apache.commons.lang.StringUtils;
import org.opencastproject.security.api.Organization;
import org.opencastproject.security.api.OrganizationDirectoryService;
import org.opencastproject.security.api.SecurityService;
import org.opencastproject.security.api.User;
import org.opencastproject.security.api.UserDirectoryService;
import org.opencastproject.util.NotFoundException;
import org.opencastproject.util.data.Function;
import org.opencastproject.util.data.Function0;
import org.opencastproject.util.data.Option;
import org.opencastproject.util.data.Tuple;

import java.net.URL;

/** Matterhorn security helpers. */
public final class SecurityUtil {
    private SecurityUtil() {
    }

    /** The name of the key used to store the name of the system user in the global config. */
    public static final String PROPERTY_KEY_SYS_USER = "org.opencastproject.security.digest.user";

    /**
     * Run function <code>f</code> in the context described by the given organization and user.
     * 
     * @return the function's outcome.
     */
    public static <A> A runAs(SecurityService sec, Organization org, User user, Function0<A> f) {
        sec.setOrganization(org);
        sec.setUser(user);
        try {
            return f.apply();
        } finally {
            sec.setOrganization(null);
            sec.setUser(null);
        }
    }

    /**
     * Create a system user with global admin role. Get the <code>systemUserName</code> from the global config where it is
     * stored under {@link #PROPERTY_KEY_SYS_USER}. In an OSGi environment this is typically done calling
     * <code>componentContext.getBundleContext().getProperty(PROPERTY_KEY_SYS_USER)</code>.
     */
    public static User createSystemUser(String systemUserName, Organization org) {
        return new User(systemUserName, org.getId(), new String[] { GLOBAL_ADMIN_ROLE });
    }

    /**
     * Create the global anonymous user with the given organization.
     * 
     * @param org
     *          the organization
     * @return the global anonymous user
     */
    public static User createAnonymousUser(Organization org) {
        return new User(GLOBAL_ANONYMOUS_USERNAME, org.getId(), new String[] { org.getAnonymousRole() });
    }

    /** Get the organization <code>orgId</code>. */
    public static Option<Organization> getOrganization(OrganizationDirectoryService orgDir, String orgId) {
        try {
            return some(orgDir.getOrganization(orgId));
        } catch (NotFoundException e) {
            return none();
        }
    }

    /** Get a user of a certain organization by its ID. */
    public static Option<User> getUserOfOrganization(SecurityService sec, OrganizationDirectoryService orgDir,
            String orgId, UserDirectoryService userDir, String userId) {
        try {
            final Organization org = orgDir.getOrganization(orgId);
            sec.setOrganization(org);
            return option(userDir.loadUser(userId));
        } catch (NotFoundException e) {
            return none();
        } finally {
            sec.setOrganization(null);
        }
    }

    /**
     * Get a user and an organization. Only returns something if both elements can be determined.
     */
    public static Option<Tuple<User, Organization>> getUserAndOrganization(SecurityService sec,
            OrganizationDirectoryService orgDir, String orgId, UserDirectoryService userDir, String userId) {
        try {
            final Organization org = orgDir.getOrganization(orgId);
            sec.setOrganization(org);
            return option(userDir.loadUser(userId)).fmap(new Function<User, Tuple<User, Organization>>() {
                @Override
                public Tuple<User, Organization> apply(User user) {
                    return tuple(user, org);
                }
            });
        } catch (NotFoundException e) {
            return none();
        } finally {
            sec.setOrganization(null);
        }
    }

    /** Extract hostname and port number from a URL. */
    public static Tuple<String, Integer> hostAndPort(URL url) {
        return tuple(StringUtils.strip(url.getHost(), "/"), url.getPort());
    }
}