| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <main role="main"> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span><a id="line.1">/*</a> |
| <span class="sourceLineNo">002</span><a id="line.2"> * Licensed to the Apache Software Foundation (ASF) under one</a> |
| <span class="sourceLineNo">003</span><a id="line.3"> * or more contributor license agreements. See the NOTICE file</a> |
| <span class="sourceLineNo">004</span><a id="line.4"> * distributed with this work for additional information</a> |
| <span class="sourceLineNo">005</span><a id="line.5"> * regarding copyright ownership. The ASF licenses this file</a> |
| <span class="sourceLineNo">006</span><a id="line.6"> * to you under the Apache License, Version 2.0 (the</a> |
| <span class="sourceLineNo">007</span><a id="line.7"> * "License"); you may not use this file except in compliance</a> |
| <span class="sourceLineNo">008</span><a id="line.8"> * with the License. You may obtain a copy of the License at</a> |
| <span class="sourceLineNo">009</span><a id="line.9"> *</a> |
| <span class="sourceLineNo">010</span><a id="line.10"> * http://www.apache.org/licenses/LICENSE-2.0</a> |
| <span class="sourceLineNo">011</span><a id="line.11"> *</a> |
| <span class="sourceLineNo">012</span><a id="line.12"> * Unless required by applicable law or agreed to in writing,</a> |
| <span class="sourceLineNo">013</span><a id="line.13"> * software distributed under the License is distributed on an</a> |
| <span class="sourceLineNo">014</span><a id="line.14"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</a> |
| <span class="sourceLineNo">015</span><a id="line.15"> * KIND, either express or implied. See the License for the</a> |
| <span class="sourceLineNo">016</span><a id="line.16"> * specific language governing permissions and limitations</a> |
| <span class="sourceLineNo">017</span><a id="line.17"> * under the License.</a> |
| <span class="sourceLineNo">018</span><a id="line.18"> */</a> |
| <span class="sourceLineNo">019</span><a id="line.19"></a> |
| <span class="sourceLineNo">020</span><a id="line.20">import org.apache.shiro.SecurityUtils;</a> |
| <span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.authc.*;</a> |
| <span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.config.IniSecurityManagerFactory;</a> |
| <span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.mgt.SecurityManager;</a> |
| <span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.session.Session;</a> |
| <span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.subject.Subject;</a> |
| <span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.util.Factory;</a> |
| <span class="sourceLineNo">027</span><a id="line.27">import org.slf4j.Logger;</a> |
| <span class="sourceLineNo">028</span><a id="line.28">import org.slf4j.LoggerFactory;</a> |
| <span class="sourceLineNo">029</span><a id="line.29"></a> |
| <span class="sourceLineNo">030</span><a id="line.30"></a> |
| <span class="sourceLineNo">031</span><a id="line.31">/**</a> |
| <span class="sourceLineNo">032</span><a id="line.32"> * Simple Quickstart application showing how to use Shiro's API.</a> |
| <span class="sourceLineNo">033</span><a id="line.33"> *</a> |
| <span class="sourceLineNo">034</span><a id="line.34"> * @since 0.9 RC2</a> |
| <span class="sourceLineNo">035</span><a id="line.35"> */</a> |
| <span class="sourceLineNo">036</span><a id="line.36">public class Quickstart {</a> |
| <span class="sourceLineNo">037</span><a id="line.37"></a> |
| <span class="sourceLineNo">038</span><a id="line.38"> private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);</a> |
| <span class="sourceLineNo">039</span><a id="line.39"></a> |
| <span class="sourceLineNo">040</span><a id="line.40"></a> |
| <span class="sourceLineNo">041</span><a id="line.41"> public static void main(String[] args) {</a> |
| <span class="sourceLineNo">042</span><a id="line.42"></a> |
| <span class="sourceLineNo">043</span><a id="line.43"> // The easiest way to create a Shiro SecurityManager with configured</a> |
| <span class="sourceLineNo">044</span><a id="line.44"> // realms, users, roles and permissions is to use the simple INI config.</a> |
| <span class="sourceLineNo">045</span><a id="line.45"> // We'll do that by using a factory that can ingest a .ini file and</a> |
| <span class="sourceLineNo">046</span><a id="line.46"> // return a SecurityManager instance:</a> |
| <span class="sourceLineNo">047</span><a id="line.47"></a> |
| <span class="sourceLineNo">048</span><a id="line.48"> // Use the shiro.ini file at the root of the classpath</a> |
| <span class="sourceLineNo">049</span><a id="line.49"> // (file: and url: prefixes load from files and urls respectively):</a> |
| <span class="sourceLineNo">050</span><a id="line.50"> Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");</a> |
| <span class="sourceLineNo">051</span><a id="line.51"> SecurityManager securityManager = factory.getInstance();</a> |
| <span class="sourceLineNo">052</span><a id="line.52"></a> |
| <span class="sourceLineNo">053</span><a id="line.53"> // for this simple example quickstart, make the SecurityManager</a> |
| <span class="sourceLineNo">054</span><a id="line.54"> // accessible as a JVM singleton. Most applications wouldn't do this</a> |
| <span class="sourceLineNo">055</span><a id="line.55"> // and instead rely on their container configuration or web.xml for</a> |
| <span class="sourceLineNo">056</span><a id="line.56"> // webapps. That is outside the scope of this simple quickstart, so</a> |
| <span class="sourceLineNo">057</span><a id="line.57"> // we'll just do the bare minimum so you can continue to get a feel</a> |
| <span class="sourceLineNo">058</span><a id="line.58"> // for things.</a> |
| <span class="sourceLineNo">059</span><a id="line.59"> SecurityUtils.setSecurityManager(securityManager);</a> |
| <span class="sourceLineNo">060</span><a id="line.60"></a> |
| <span class="sourceLineNo">061</span><a id="line.61"> // Now that a simple Shiro environment is set up, let's see what you can do:</a> |
| <span class="sourceLineNo">062</span><a id="line.62"></a> |
| <span class="sourceLineNo">063</span><a id="line.63"> // get the currently executing user:</a> |
| <span class="sourceLineNo">064</span><a id="line.64"> Subject currentUser = SecurityUtils.getSubject();</a> |
| <span class="sourceLineNo">065</span><a id="line.65"></a> |
| <span class="sourceLineNo">066</span><a id="line.66"> // Do some stuff with a Session (no need for a web or EJB container!!!)</a> |
| <span class="sourceLineNo">067</span><a id="line.67"> Session session = currentUser.getSession();</a> |
| <span class="sourceLineNo">068</span><a id="line.68"> session.setAttribute("someKey", "aValue");</a> |
| <span class="sourceLineNo">069</span><a id="line.69"> String value = (String) session.getAttribute("someKey");</a> |
| <span class="sourceLineNo">070</span><a id="line.70"> if (value.equals("aValue")) {</a> |
| <span class="sourceLineNo">071</span><a id="line.71"> log.info("Retrieved the correct value! [" + value + "]");</a> |
| <span class="sourceLineNo">072</span><a id="line.72"> }</a> |
| <span class="sourceLineNo">073</span><a id="line.73"></a> |
| <span class="sourceLineNo">074</span><a id="line.74"> // let's login the current user so we can check against roles and permissions:</a> |
| <span class="sourceLineNo">075</span><a id="line.75"> if (!currentUser.isAuthenticated()) {</a> |
| <span class="sourceLineNo">076</span><a id="line.76"> UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");</a> |
| <span class="sourceLineNo">077</span><a id="line.77"> token.setRememberMe(true);</a> |
| <span class="sourceLineNo">078</span><a id="line.78"> try {</a> |
| <span class="sourceLineNo">079</span><a id="line.79"> currentUser.login(token);</a> |
| <span class="sourceLineNo">080</span><a id="line.80"> } catch (UnknownAccountException uae) {</a> |
| <span class="sourceLineNo">081</span><a id="line.81"> log.info("There is no user with username of " + token.getPrincipal());</a> |
| <span class="sourceLineNo">082</span><a id="line.82"> } catch (IncorrectCredentialsException ice) {</a> |
| <span class="sourceLineNo">083</span><a id="line.83"> log.info("Password for account " + token.getPrincipal() + " was incorrect!");</a> |
| <span class="sourceLineNo">084</span><a id="line.84"> } catch (LockedAccountException lae) {</a> |
| <span class="sourceLineNo">085</span><a id="line.85"> log.info("The account for username " + token.getPrincipal() + " is locked. " +</a> |
| <span class="sourceLineNo">086</span><a id="line.86"> "Please contact your administrator to unlock it.");</a> |
| <span class="sourceLineNo">087</span><a id="line.87"> }</a> |
| <span class="sourceLineNo">088</span><a id="line.88"> // ... catch more exceptions here (maybe custom ones specific to your application?</a> |
| <span class="sourceLineNo">089</span><a id="line.89"> catch (AuthenticationException ae) {</a> |
| <span class="sourceLineNo">090</span><a id="line.90"> //unexpected condition? error?</a> |
| <span class="sourceLineNo">091</span><a id="line.91"> }</a> |
| <span class="sourceLineNo">092</span><a id="line.92"> }</a> |
| <span class="sourceLineNo">093</span><a id="line.93"></a> |
| <span class="sourceLineNo">094</span><a id="line.94"> //say who they are:</a> |
| <span class="sourceLineNo">095</span><a id="line.95"> //print their identifying principal (in this case, a username):</a> |
| <span class="sourceLineNo">096</span><a id="line.96"> log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");</a> |
| <span class="sourceLineNo">097</span><a id="line.97"></a> |
| <span class="sourceLineNo">098</span><a id="line.98"> //test a role:</a> |
| <span class="sourceLineNo">099</span><a id="line.99"> if (currentUser.hasRole("schwartz")) {</a> |
| <span class="sourceLineNo">100</span><a id="line.100"> log.info("May the Schwartz be with you!");</a> |
| <span class="sourceLineNo">101</span><a id="line.101"> } else {</a> |
| <span class="sourceLineNo">102</span><a id="line.102"> log.info("Hello, mere mortal.");</a> |
| <span class="sourceLineNo">103</span><a id="line.103"> }</a> |
| <span class="sourceLineNo">104</span><a id="line.104"></a> |
| <span class="sourceLineNo">105</span><a id="line.105"> //test a typed permission (not instance-level)</a> |
| <span class="sourceLineNo">106</span><a id="line.106"> if (currentUser.isPermitted("lightsaber:wield")) {</a> |
| <span class="sourceLineNo">107</span><a id="line.107"> log.info("You may use a lightsaber ring. Use it wisely.");</a> |
| <span class="sourceLineNo">108</span><a id="line.108"> } else {</a> |
| <span class="sourceLineNo">109</span><a id="line.109"> log.info("Sorry, lightsaber rings are for schwartz masters only.");</a> |
| <span class="sourceLineNo">110</span><a id="line.110"> }</a> |
| <span class="sourceLineNo">111</span><a id="line.111"></a> |
| <span class="sourceLineNo">112</span><a id="line.112"> //a (very powerful) Instance Level permission:</a> |
| <span class="sourceLineNo">113</span><a id="line.113"> if (currentUser.isPermitted("winnebago:drive:eagle5")) {</a> |
| <span class="sourceLineNo">114</span><a id="line.114"> log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'. " +</a> |
| <span class="sourceLineNo">115</span><a id="line.115"> "Here are the keys - have fun!");</a> |
| <span class="sourceLineNo">116</span><a id="line.116"> } else {</a> |
| <span class="sourceLineNo">117</span><a id="line.117"> log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");</a> |
| <span class="sourceLineNo">118</span><a id="line.118"> }</a> |
| <span class="sourceLineNo">119</span><a id="line.119"></a> |
| <span class="sourceLineNo">120</span><a id="line.120"> //all done - log out!</a> |
| <span class="sourceLineNo">121</span><a id="line.121"> currentUser.logout();</a> |
| <span class="sourceLineNo">122</span><a id="line.122"></a> |
| <span class="sourceLineNo">123</span><a id="line.123"> System.exit(0);</a> |
| <span class="sourceLineNo">124</span><a id="line.124"> }</a> |
| <span class="sourceLineNo">125</span><a id="line.125">}</a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </main> |
| </body> |
| </html> |
