blob: 849c699de3f288ce8bcf8d6187dd41db6a3d8e11 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the<a name="line.6"></a>
<FONT color="green">007</FONT> * "License"); you may not use this file except in compliance<a name="line.7"></a>
<FONT color="green">008</FONT> * with the License. You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing,<a name="line.12"></a>
<FONT color="green">013</FONT> * software distributed under the License is distributed on an<a name="line.13"></a>
<FONT color="green">014</FONT> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.14"></a>
<FONT color="green">015</FONT> * KIND, either express or implied. See the License for the<a name="line.15"></a>
<FONT color="green">016</FONT> * specific language governing permissions and limitations<a name="line.16"></a>
<FONT color="green">017</FONT> * under the License.<a name="line.17"></a>
<FONT color="green">018</FONT> */<a name="line.18"></a>
<FONT color="green">019</FONT> package org.apache.shiro.authz.aop;<a name="line.19"></a>
<FONT color="green">020</FONT> <a name="line.20"></a>
<FONT color="green">021</FONT> import org.apache.shiro.authz.AuthorizationException;<a name="line.21"></a>
<FONT color="green">022</FONT> import org.apache.shiro.authz.annotation.Logical;<a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.shiro.authz.annotation.RequiresPermissions;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.shiro.authz.annotation.RequiresRoles;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.shiro.subject.Subject;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> import java.lang.annotation.Annotation;<a name="line.27"></a>
<FONT color="green">028</FONT> <a name="line.28"></a>
<FONT color="green">029</FONT> /**<a name="line.29"></a>
<FONT color="green">030</FONT> * Checks to see if a @{@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions} annotation is<a name="line.30"></a>
<FONT color="green">031</FONT> * declared, and if so, performs a permission check to see if the calling &lt;code&gt;Subject&lt;/code&gt; is allowed continued<a name="line.31"></a>
<FONT color="green">032</FONT> * access.<a name="line.32"></a>
<FONT color="green">033</FONT> *<a name="line.33"></a>
<FONT color="green">034</FONT> * @since 0.9.0<a name="line.34"></a>
<FONT color="green">035</FONT> */<a name="line.35"></a>
<FONT color="green">036</FONT> public class PermissionAnnotationHandler extends AuthorizingAnnotationHandler {<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> /**<a name="line.38"></a>
<FONT color="green">039</FONT> * Default no-argument constructor that ensures this handler looks for<a name="line.39"></a>
<FONT color="green">040</FONT> * {@link org.apache.shiro.authz.annotation.RequiresPermissions RequiresPermissions} annotations.<a name="line.40"></a>
<FONT color="green">041</FONT> */<a name="line.41"></a>
<FONT color="green">042</FONT> public PermissionAnnotationHandler() {<a name="line.42"></a>
<FONT color="green">043</FONT> super(RequiresPermissions.class);<a name="line.43"></a>
<FONT color="green">044</FONT> }<a name="line.44"></a>
<FONT color="green">045</FONT> <a name="line.45"></a>
<FONT color="green">046</FONT> /**<a name="line.46"></a>
<FONT color="green">047</FONT> * Returns the annotation {@link RequiresPermissions#value value}, from which the Permission will be constructed.<a name="line.47"></a>
<FONT color="green">048</FONT> *<a name="line.48"></a>
<FONT color="green">049</FONT> * @param a the RequiresPermissions annotation being inspected.<a name="line.49"></a>
<FONT color="green">050</FONT> * @return the annotation's &lt;code&gt;value&lt;/code&gt;, from which the Permission will be constructed.<a name="line.50"></a>
<FONT color="green">051</FONT> */<a name="line.51"></a>
<FONT color="green">052</FONT> protected String[] getAnnotationValue(Annotation a) {<a name="line.52"></a>
<FONT color="green">053</FONT> RequiresPermissions rpAnnotation = (RequiresPermissions) a;<a name="line.53"></a>
<FONT color="green">054</FONT> return rpAnnotation.value();<a name="line.54"></a>
<FONT color="green">055</FONT> }<a name="line.55"></a>
<FONT color="green">056</FONT> <a name="line.56"></a>
<FONT color="green">057</FONT> /**<a name="line.57"></a>
<FONT color="green">058</FONT> * Ensures that the calling &lt;code&gt;Subject&lt;/code&gt; has the Annotation's specified permissions, and if not, throws an<a name="line.58"></a>
<FONT color="green">059</FONT> * &lt;code&gt;AuthorizingException&lt;/code&gt; indicating access is denied.<a name="line.59"></a>
<FONT color="green">060</FONT> *<a name="line.60"></a>
<FONT color="green">061</FONT> * @param a the RequiresPermission annotation being inspected to check for one or more permissions<a name="line.61"></a>
<FONT color="green">062</FONT> * @throws org.apache.shiro.authz.AuthorizationException<a name="line.62"></a>
<FONT color="green">063</FONT> * if the calling &lt;code&gt;Subject&lt;/code&gt; does not have the permission(s) necessary to<a name="line.63"></a>
<FONT color="green">064</FONT> * continue access or execution.<a name="line.64"></a>
<FONT color="green">065</FONT> */<a name="line.65"></a>
<FONT color="green">066</FONT> public void assertAuthorized(Annotation a) throws AuthorizationException {<a name="line.66"></a>
<FONT color="green">067</FONT> if (!(a instanceof RequiresPermissions)) return;<a name="line.67"></a>
<FONT color="green">068</FONT> <a name="line.68"></a>
<FONT color="green">069</FONT> RequiresPermissions rpAnnotation = (RequiresPermissions) a;<a name="line.69"></a>
<FONT color="green">070</FONT> String[] perms = getAnnotationValue(a);<a name="line.70"></a>
<FONT color="green">071</FONT> Subject subject = getSubject();<a name="line.71"></a>
<FONT color="green">072</FONT> <a name="line.72"></a>
<FONT color="green">073</FONT> if (perms.length == 1) {<a name="line.73"></a>
<FONT color="green">074</FONT> subject.checkPermission(perms[0]);<a name="line.74"></a>
<FONT color="green">075</FONT> return;<a name="line.75"></a>
<FONT color="green">076</FONT> }<a name="line.76"></a>
<FONT color="green">077</FONT> if (Logical.AND.equals(rpAnnotation.logical())) {<a name="line.77"></a>
<FONT color="green">078</FONT> getSubject().checkPermissions(perms);<a name="line.78"></a>
<FONT color="green">079</FONT> return;<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> if (Logical.OR.equals(rpAnnotation.logical())) {<a name="line.81"></a>
<FONT color="green">082</FONT> // Avoid processing exceptions unnecessarily - "delay" throwing the exception by calling hasRole first<a name="line.82"></a>
<FONT color="green">083</FONT> boolean hasAtLeastOnePermission = false;<a name="line.83"></a>
<FONT color="green">084</FONT> for (String permission : perms) if (getSubject().isPermitted(permission)) hasAtLeastOnePermission = true;<a name="line.84"></a>
<FONT color="green">085</FONT> // Cause the exception if none of the role match, note that the exception message will be a bit misleading<a name="line.85"></a>
<FONT color="green">086</FONT> if (!hasAtLeastOnePermission) getSubject().checkPermission(perms[0]);<a name="line.86"></a>
<FONT color="green">087</FONT> <a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> }<a name="line.90"></a>
</PRE>
</BODY>
</HTML>