blob: d7709225d636e8a8f6a6a1009855ebb16886894c [file] [log] [blame]
<!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">package org.apache.shiro.spring.web.config;</a>
<span class="sourceLineNo">020</span><a id="line.20"></a>
<span class="sourceLineNo">021</span><a id="line.21">import org.apache.shiro.config.Ini;</a>
<span class="sourceLineNo">022</span><a id="line.22">import org.apache.shiro.mgt.RememberMeManager;</a>
<span class="sourceLineNo">023</span><a id="line.23">import org.apache.shiro.mgt.SessionStorageEvaluator;</a>
<span class="sourceLineNo">024</span><a id="line.24">import org.apache.shiro.mgt.SessionsSecurityManager;</a>
<span class="sourceLineNo">025</span><a id="line.25">import org.apache.shiro.mgt.SubjectFactory;</a>
<span class="sourceLineNo">026</span><a id="line.26">import org.apache.shiro.realm.Realm;</a>
<span class="sourceLineNo">027</span><a id="line.27">import org.apache.shiro.realm.text.IniRealm;</a>
<span class="sourceLineNo">028</span><a id="line.28">import org.apache.shiro.session.mgt.SessionManager;</a>
<span class="sourceLineNo">029</span><a id="line.29">import org.apache.shiro.spring.config.AbstractShiroConfiguration;</a>
<span class="sourceLineNo">030</span><a id="line.30">import org.apache.shiro.web.mgt.CookieRememberMeManager;</a>
<span class="sourceLineNo">031</span><a id="line.31">import org.apache.shiro.web.mgt.DefaultWebSecurityManager;</a>
<span class="sourceLineNo">032</span><a id="line.32">import org.apache.shiro.web.mgt.DefaultWebSessionStorageEvaluator;</a>
<span class="sourceLineNo">033</span><a id="line.33">import org.apache.shiro.web.mgt.DefaultWebSubjectFactory;</a>
<span class="sourceLineNo">034</span><a id="line.34">import org.apache.shiro.web.servlet.Cookie;</a>
<span class="sourceLineNo">035</span><a id="line.35">import org.apache.shiro.web.servlet.SimpleCookie;</a>
<span class="sourceLineNo">036</span><a id="line.36">import org.apache.shiro.web.session.mgt.DefaultWebSessionManager;</a>
<span class="sourceLineNo">037</span><a id="line.37">import org.apache.shiro.web.session.mgt.ServletContainerSessionManager;</a>
<span class="sourceLineNo">038</span><a id="line.38">import org.springframework.beans.factory.annotation.Value;</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"> * @since 1.4.0</a>
<span class="sourceLineNo">042</span><a id="line.42"> */</a>
<span class="sourceLineNo">043</span><a id="line.43">public class AbstractShiroWebConfiguration extends AbstractShiroConfiguration {</a>
<span class="sourceLineNo">044</span><a id="line.44"></a>
<span class="sourceLineNo">045</span><a id="line.45"> @Value("#{ @environment['shiro.sessionManager.sessionIdCookieEnabled'] ?: true }")</a>
<span class="sourceLineNo">046</span><a id="line.46"> protected boolean sessionIdCookieEnabled;</a>
<span class="sourceLineNo">047</span><a id="line.47"></a>
<span class="sourceLineNo">048</span><a id="line.48"> @Value("#{ @environment['shiro.sessionManager.sessionIdUrlRewritingEnabled'] ?: true }")</a>
<span class="sourceLineNo">049</span><a id="line.49"> protected boolean sessionIdUrlRewritingEnabled;</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> @Value("#{ @environment['shiro.userNativeSessionManager'] ?: false }")</a>
<span class="sourceLineNo">052</span><a id="line.52"> protected boolean useNativeSessionManager;</a>
<span class="sourceLineNo">053</span><a id="line.53"></a>
<span class="sourceLineNo">054</span><a id="line.54"></a>
<span class="sourceLineNo">055</span><a id="line.55"> // Session Cookie info</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> @Value("#{ @environment['shiro.sessionManager.cookie.name'] ?: T(org.apache.shiro.web.servlet.ShiroHttpSession).DEFAULT_SESSION_ID_NAME }")</a>
<span class="sourceLineNo">058</span><a id="line.58"> protected String sessionIdCookieName;</a>
<span class="sourceLineNo">059</span><a id="line.59"></a>
<span class="sourceLineNo">060</span><a id="line.60"> @Value("#{ @environment['shiro.sessionManager.cookie.maxAge'] ?: T(org.apache.shiro.web.servlet.SimpleCookie).DEFAULT_MAX_AGE }")</a>
<span class="sourceLineNo">061</span><a id="line.61"> protected int sessionIdCookieMaxAge;</a>
<span class="sourceLineNo">062</span><a id="line.62"></a>
<span class="sourceLineNo">063</span><a id="line.63"> @Value("#{ @environment['shiro.sessionManager.cookie.domain'] ?: null }")</a>
<span class="sourceLineNo">064</span><a id="line.64"> protected String sessionIdCookieDomain;</a>
<span class="sourceLineNo">065</span><a id="line.65"></a>
<span class="sourceLineNo">066</span><a id="line.66"> @Value("#{ @environment['shiro.sessionManager.cookie.path'] ?: null }")</a>
<span class="sourceLineNo">067</span><a id="line.67"> protected String sessionIdCookiePath;</a>
<span class="sourceLineNo">068</span><a id="line.68"></a>
<span class="sourceLineNo">069</span><a id="line.69"> @Value("#{ @environment['shiro.sessionManager.cookie.secure'] ?: false }")</a>
<span class="sourceLineNo">070</span><a id="line.70"> protected boolean sessionIdCookieSecure;</a>
<span class="sourceLineNo">071</span><a id="line.71"></a>
<span class="sourceLineNo">072</span><a id="line.72"></a>
<span class="sourceLineNo">073</span><a id="line.73"> // RememberMe Cookie info</a>
<span class="sourceLineNo">074</span><a id="line.74"></a>
<span class="sourceLineNo">075</span><a id="line.75"> @Value("#{ @environment['shiro.rememberMeManager.cookie.name'] ?: T(org.apache.shiro.web.mgt.CookieRememberMeManager).DEFAULT_REMEMBER_ME_COOKIE_NAME }")</a>
<span class="sourceLineNo">076</span><a id="line.76"> protected String rememberMeCookieName;</a>
<span class="sourceLineNo">077</span><a id="line.77"></a>
<span class="sourceLineNo">078</span><a id="line.78"> @Value("#{ @environment['shiro.rememberMeManager.cookie.maxAge'] ?: T(org.apache.shiro.web.servlet.Cookie).ONE_YEAR }")</a>
<span class="sourceLineNo">079</span><a id="line.79"> protected int rememberMeCookieMaxAge;</a>
<span class="sourceLineNo">080</span><a id="line.80"></a>
<span class="sourceLineNo">081</span><a id="line.81"> @Value("#{ @environment['shiro.rememberMeManager.cookie.domain'] ?: null }")</a>
<span class="sourceLineNo">082</span><a id="line.82"> protected String rememberMeCookieDomain;</a>
<span class="sourceLineNo">083</span><a id="line.83"></a>
<span class="sourceLineNo">084</span><a id="line.84"> @Value("#{ @environment['shiro.rememberMeManager.cookie.path'] ?: null }")</a>
<span class="sourceLineNo">085</span><a id="line.85"> protected String rememberMeCookiePath;</a>
<span class="sourceLineNo">086</span><a id="line.86"></a>
<span class="sourceLineNo">087</span><a id="line.87"> @Value("#{ @environment['shiro.rememberMeManager.cookie.secure'] ?: false }")</a>
<span class="sourceLineNo">088</span><a id="line.88"> protected boolean rememberMeCookieSecure;</a>
<span class="sourceLineNo">089</span><a id="line.89"></a>
<span class="sourceLineNo">090</span><a id="line.90"></a>
<span class="sourceLineNo">091</span><a id="line.91"> protected SessionManager nativeSessionManager() {</a>
<span class="sourceLineNo">092</span><a id="line.92"> DefaultWebSessionManager webSessionManager = new DefaultWebSessionManager();</a>
<span class="sourceLineNo">093</span><a id="line.93"> webSessionManager.setSessionIdCookieEnabled(sessionIdCookieEnabled);</a>
<span class="sourceLineNo">094</span><a id="line.94"> webSessionManager.setSessionIdUrlRewritingEnabled(sessionIdUrlRewritingEnabled);</a>
<span class="sourceLineNo">095</span><a id="line.95"> webSessionManager.setSessionIdCookie(sessionCookieTemplate());</a>
<span class="sourceLineNo">096</span><a id="line.96"></a>
<span class="sourceLineNo">097</span><a id="line.97"> webSessionManager.setSessionFactory(sessionFactory());</a>
<span class="sourceLineNo">098</span><a id="line.98"> webSessionManager.setSessionDAO(sessionDAO());</a>
<span class="sourceLineNo">099</span><a id="line.99"> webSessionManager.setDeleteInvalidSessions(sessionManagerDeleteInvalidSessions);</a>
<span class="sourceLineNo">100</span><a id="line.100"></a>
<span class="sourceLineNo">101</span><a id="line.101"> return webSessionManager;</a>
<span class="sourceLineNo">102</span><a id="line.102"> }</a>
<span class="sourceLineNo">103</span><a id="line.103"></a>
<span class="sourceLineNo">104</span><a id="line.104"> protected Cookie sessionCookieTemplate() {</a>
<span class="sourceLineNo">105</span><a id="line.105"> return buildCookie(</a>
<span class="sourceLineNo">106</span><a id="line.106"> sessionIdCookieName,</a>
<span class="sourceLineNo">107</span><a id="line.107"> sessionIdCookieMaxAge,</a>
<span class="sourceLineNo">108</span><a id="line.108"> sessionIdCookiePath,</a>
<span class="sourceLineNo">109</span><a id="line.109"> sessionIdCookieDomain,</a>
<span class="sourceLineNo">110</span><a id="line.110"> sessionIdCookieSecure);</a>
<span class="sourceLineNo">111</span><a id="line.111"> }</a>
<span class="sourceLineNo">112</span><a id="line.112"></a>
<span class="sourceLineNo">113</span><a id="line.113"> protected Cookie rememberMeCookieTemplate() {</a>
<span class="sourceLineNo">114</span><a id="line.114"> return buildCookie(</a>
<span class="sourceLineNo">115</span><a id="line.115"> rememberMeCookieName,</a>
<span class="sourceLineNo">116</span><a id="line.116"> rememberMeCookieMaxAge,</a>
<span class="sourceLineNo">117</span><a id="line.117"> rememberMeCookiePath,</a>
<span class="sourceLineNo">118</span><a id="line.118"> rememberMeCookieDomain,</a>
<span class="sourceLineNo">119</span><a id="line.119"> rememberMeCookieSecure);</a>
<span class="sourceLineNo">120</span><a id="line.120"> }</a>
<span class="sourceLineNo">121</span><a id="line.121"></a>
<span class="sourceLineNo">122</span><a id="line.122"> protected Cookie buildCookie(String name, int maxAge, String path, String domain, boolean secure) {</a>
<span class="sourceLineNo">123</span><a id="line.123"> Cookie cookie = new SimpleCookie(name);</a>
<span class="sourceLineNo">124</span><a id="line.124"> cookie.setHttpOnly(true);</a>
<span class="sourceLineNo">125</span><a id="line.125"> cookie.setMaxAge(maxAge);</a>
<span class="sourceLineNo">126</span><a id="line.126"> cookie.setPath(path);</a>
<span class="sourceLineNo">127</span><a id="line.127"> cookie.setDomain(domain);</a>
<span class="sourceLineNo">128</span><a id="line.128"> cookie.setSecure(secure);</a>
<span class="sourceLineNo">129</span><a id="line.129"></a>
<span class="sourceLineNo">130</span><a id="line.130"> return cookie;</a>
<span class="sourceLineNo">131</span><a id="line.131"> }</a>
<span class="sourceLineNo">132</span><a id="line.132"></a>
<span class="sourceLineNo">133</span><a id="line.133"> @Override</a>
<span class="sourceLineNo">134</span><a id="line.134"> protected SessionManager sessionManager() {</a>
<span class="sourceLineNo">135</span><a id="line.135"> if (useNativeSessionManager) {</a>
<span class="sourceLineNo">136</span><a id="line.136"> return nativeSessionManager();</a>
<span class="sourceLineNo">137</span><a id="line.137"> }</a>
<span class="sourceLineNo">138</span><a id="line.138"> return new ServletContainerSessionManager();</a>
<span class="sourceLineNo">139</span><a id="line.139"> }</a>
<span class="sourceLineNo">140</span><a id="line.140"></a>
<span class="sourceLineNo">141</span><a id="line.141"> protected RememberMeManager rememberMeManager() {</a>
<span class="sourceLineNo">142</span><a id="line.142"> CookieRememberMeManager cookieRememberMeManager = new CookieRememberMeManager();</a>
<span class="sourceLineNo">143</span><a id="line.143"> cookieRememberMeManager.setCookie(rememberMeCookieTemplate());</a>
<span class="sourceLineNo">144</span><a id="line.144"> return cookieRememberMeManager;</a>
<span class="sourceLineNo">145</span><a id="line.145"> }</a>
<span class="sourceLineNo">146</span><a id="line.146"></a>
<span class="sourceLineNo">147</span><a id="line.147"> @Override</a>
<span class="sourceLineNo">148</span><a id="line.148"> protected SubjectFactory subjectFactory() {</a>
<span class="sourceLineNo">149</span><a id="line.149"> return new DefaultWebSubjectFactory();</a>
<span class="sourceLineNo">150</span><a id="line.150"> }</a>
<span class="sourceLineNo">151</span><a id="line.151"></a>
<span class="sourceLineNo">152</span><a id="line.152"> @Override</a>
<span class="sourceLineNo">153</span><a id="line.153"> protected SessionStorageEvaluator sessionStorageEvaluator() {</a>
<span class="sourceLineNo">154</span><a id="line.154"> return new DefaultWebSessionStorageEvaluator();</a>
<span class="sourceLineNo">155</span><a id="line.155"> }</a>
<span class="sourceLineNo">156</span><a id="line.156"></a>
<span class="sourceLineNo">157</span><a id="line.157"> protected SessionsSecurityManager createSecurityManager() {</a>
<span class="sourceLineNo">158</span><a id="line.158"></a>
<span class="sourceLineNo">159</span><a id="line.159"> DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();</a>
<span class="sourceLineNo">160</span><a id="line.160"> securityManager.setSubjectDAO(subjectDAO());</a>
<span class="sourceLineNo">161</span><a id="line.161"> securityManager.setSubjectFactory(subjectFactory());</a>
<span class="sourceLineNo">162</span><a id="line.162"> securityManager.setRememberMeManager(rememberMeManager());</a>
<span class="sourceLineNo">163</span><a id="line.163"></a>
<span class="sourceLineNo">164</span><a id="line.164"> return securityManager;</a>
<span class="sourceLineNo">165</span><a id="line.165"> }</a>
<span class="sourceLineNo">166</span><a id="line.166"></a>
<span class="sourceLineNo">167</span><a id="line.167"> protected ShiroFilterChainDefinition shiroFilterChainDefinition() {</a>
<span class="sourceLineNo">168</span><a id="line.168"> DefaultShiroFilterChainDefinition chainDefinition = new DefaultShiroFilterChainDefinition();</a>
<span class="sourceLineNo">169</span><a id="line.169"> chainDefinition.addPathDefinition("/**", "authc");</a>
<span class="sourceLineNo">170</span><a id="line.170"> return chainDefinition;</a>
<span class="sourceLineNo">171</span><a id="line.171"> }</a>
<span class="sourceLineNo">172</span><a id="line.172">}</a>
</pre>
</div>
</main>
</body>
</html>