org.picketbox.http.PicketBoxHTTPManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of picketbox-http
PicketBox is a security framework for Java Applications
The newest version!
/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.picketbox.http;

import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;

import org.picketbox.core.AbstractPicketBoxManager;
import org.picketbox.core.PicketBoxManager;
import org.picketbox.core.UserContext;
import org.picketbox.core.authorization.Resource;
import org.picketbox.http.authorization.resource.WebResource;
import org.picketbox.http.config.PicketBoxHTTPConfiguration;
import org.picketbox.http.resource.ProtectedResource;
import org.picketbox.http.resource.ProtectedResourceManager;

/**
 * 
 * {@link PicketBoxManager} implementation to be used by web applications.
 * 
 *
 * @author Pedro Silva
 */
public final class PicketBoxHTTPManager extends AbstractPicketBoxManager {

    @SuppressWarnings("rawtypes")
    private ProtectedResourceManager protectedResourceManager;
    private PicketBoxHTTPConfiguration configuration;

    public PicketBoxHTTPManager(PicketBoxHTTPConfiguration configuration) {
        super(configuration);
        this.configuration = configuration;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.picketbox.core.AbstractPicketBoxManager#doPreAuthentication(org.picketbox.core.PicketBoxSecurityContext,
     * org.picketbox.core.authentication.AuthenticationCallbackHandler)
     */
    @SuppressWarnings("unchecked")
    @Override
    protected boolean doPreAuthentication(UserContext subject) {
        if (this.protectedResourceManager == null) {
            return true;
        }

        HTTPUserContext httpUserContext = (HTTPUserContext) subject;

        ProtectedResource protectedResource = this.protectedResourceManager.getProtectedResource(createWebResource(
                httpUserContext.getRequest(), httpUserContext.getResponse()));

        return protectedResource.requiresAuthentication();
    }

    @SuppressWarnings("unchecked")
    @Override
    public boolean authorize(UserContext subject, Resource resource) {
        if (this.protectedResourceManager != null && subject != null) {
            ProtectedResource protectedResource = this.protectedResourceManager.getProtectedResource(resource);

            if (protectedResource.requiresAuthorization() && subject.isAuthenticated()) {
                if (!protectedResource.isAllowed(subject)) {
                    return false;
                }

                return super.authorize(subject, resource);
            }
        }

        return true;
    }

    private WebResource createWebResource(HttpServletRequest request, HttpServletResponse response) {
        WebResource resource = new WebResource();

        resource.setContext(request.getServletContext());
        resource.setRequest(request);
        resource.setResponse(response);

        return resource;
    }

    /*
     * (non-Javadoc)
     *
     * @see org.picketbox.core.AbstractPicketBoxManager#doConfigure()
     */
    @Override
    protected void doConfigure() {
        this.protectedResourceManager = this.configuration.getProtectedResource().getManager();
        List resources = this.configuration.getProtectedResource().getResources();

        for (ProtectedResource protectedResource : resources) {
            this.protectedResourceManager.addProtectedResource(protectedResource);
        }

        this.protectedResourceManager.start();

        HTTPSessionManager sessionManager = new HTTPSessionManager(this);

        sessionManager.start();

        setSessionManager(sessionManager);
    }

    public UserContext getUserContext(HttpServletRequest request) {
        HttpSession session = request.getSession(false);

        if (session == null) {
            return null;
        }

        return (UserContext) session.getAttribute(getUserAttributeName());
    }

    /**
     * Returns the attribute name that should be used to store the {@link UserContext}.
     *
     * @return
     */
    private String getUserAttributeName() {
        String name = this.configuration.getSessionManager().getSessionAttributeName();

        if (name == null) {
            name = PicketBoxConstants.SUBJECT;
        }

        return name;
    }

    @SuppressWarnings("unchecked")
    public boolean requiresAuthentication(HttpServletRequest request, HttpServletResponse response) {
        return this.protectedResourceManager != null
                && this.protectedResourceManager.getProtectedResource(createWebResource(request, response))
                        .requiresAuthentication();
    }
}