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