org.wicketstuff.shiro.annotation.AnnotationsShiroAuthorizationStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wicketstuff-shiro Show documentation
Shiro Security for Apache Wicket. (Shiro was formerly known as Apache Ki and JSecurity)
There is a newer version: 10.2.0
/*
 * 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.wicketstuff.shiro.annotation;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.subject.Subject;
import org.apache.wicket.Component;
import org.apache.wicket.authorization.Action;
import org.apache.wicket.authorization.IAuthorizationStrategy;
import org.apache.wicket.request.component.IRequestableComponent;
import org.apache.wicket.request.mapper.parameter.PageParameters;
import org.apache.wicket.request.resource.IResource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.wicketstuff.shiro.ShiroAction;

import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

public class AnnotationsShiroAuthorizationStrategy implements IAuthorizationStrategy
{
	private static final Logger LOG = LoggerFactory.getLogger(AnnotationsShiroAuthorizationStrategy.class);

	/**
	 * @return null if ok, or the Annotation that failed
	 */
	protected ShiroSecurityConstraint checkInvalidInstantiation(final Annotation[] annotations,
		final ShiroAction action)
	{
		if (annotations == null)
		{
			return null;
		}

		for (final Annotation annotation : annotations)
		{
			// Check Permissions
			if (annotation instanceof ShiroSecurityConstraint)
			{
				final ShiroSecurityConstraint constraint = (ShiroSecurityConstraint)annotation;
				if (action == constraint.action())
				{
					final Subject subject = SecurityUtils.getSubject();
					switch (constraint.constraint())
					{
						case HasRole : {
							if (!subject.hasRole(constraint.value()))
							{
								return constraint;
							}
							break;
						}

						case HasPermission : {
							if (!subject.isPermitted(constraint.value()))
							{
								return constraint;
							}
							break;
						}

						case IsAuthenticated : {
							if (!subject.isAuthenticated())
							{
								return constraint;
							}
							break;
						}

						case LoggedIn : {
							if (subject.getPrincipal() == null)
							{
								return constraint;
							}
							break;
						}
					}
				}
			} // end if KiSecurityConstraint
		}
		return null;
	}

	public  ShiroSecurityConstraint checkInvalidInstantiation(
		final Class componentClass)
	{
		Annotation[] componentClassAnnotations = componentClass.getAnnotations();
		ShiroSecurityConstraint fail = checkInvalidInstantiation(
				findShiroSecurityConstraintAnnotations(componentClassAnnotations), ShiroAction.INSTANTIATE);

		if (fail == null)
		{
			//TODO: Allow ShiroSecurityConstraint annotations on packages OR remove this check as the annotation is
			// currently only allowed on types
			Annotation[] packageAnnotations = componentClass.getPackage().getAnnotations();
			fail = checkInvalidInstantiation(findShiroSecurityConstraintAnnotations(packageAnnotations),
				ShiroAction.INSTANTIATE);
		}
		return fail;
	}

	/**
	 * {@inheritDoc}
	 */
	public boolean isActionAuthorized(final Component component, final Action action)
	{

		final ShiroAction _action = action.getName().equals(Action.RENDER) ? ShiroAction.RENDER
			: ShiroAction.ENABLE;

		final Class clazz = component.getClass();
		Annotation[] componentClassAnnotations = clazz.getAnnotations();
		ShiroSecurityConstraint fail = checkInvalidInstantiation(
				findShiroSecurityConstraintAnnotations(componentClassAnnotations), _action );
		if (fail == null)
		{
			//TODO: Allow ShiroSecurityConstraint annotations on packages OR remove this check as the annotation is
			// currently only allowed on types
			Annotation[] packageAnnotations = clazz.getPackage().getAnnotations();
			fail = checkInvalidInstantiation(findShiroSecurityConstraintAnnotations(packageAnnotations), _action);
		}
		return fail == null;
	}

    @Override
    public boolean isResourceAuthorized(IResource resource, PageParameters parameters) {
        return true;
    }

    /**
	 * {@inheritDoc}
	 */
	public  boolean isInstantiationAuthorized(
		final Class componentClass)
	{
		final Annotation fail = checkInvalidInstantiation(componentClass);
		if (fail != null)
		{
			LOG.info("Unauthorized Instantiation :: component={} reason={} subject={}",
				new Object[] { componentClass, fail, SecurityUtils.getSubject() });
			return false;
		}
		return true;
	}

	private ShiroSecurityConstraint[] findShiroSecurityConstraintAnnotations(Annotation[] componentClassAnnotations) {
		List annotations = new ArrayList();
		for (Annotation annotation : componentClassAnnotations)
		{
			if (annotation instanceof ShiroSecurityConstraint)
			{
				annotations.add(annotation);
			} else if (annotation instanceof ShiroSecurityConstraints)
			{
				annotations.addAll(Arrays.asList(((ShiroSecurityConstraints) annotation).value()));
			}
		}
		return annotations.toArray(new ShiroSecurityConstraint[annotations.size()]);
	}
}