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