| <!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.web.servlet;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span><a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import org.apache.shiro.util.StringUtils;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import org.slf4j.Logger;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import org.slf4j.LoggerFactory;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span><a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import javax.servlet.http.HttpServletRequest;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import javax.servlet.http.HttpServletResponse;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.text.DateFormat;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.text.SimpleDateFormat;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.Calendar;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.Date;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.Locale;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import java.util.TimeZone;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span><a name="line.33"></a> |
| <span class="sourceLineNo">034</span>/**<a name="line.34"></a> |
| <span class="sourceLineNo">035</span> * Default {@link Cookie Cookie} implementation. 'HttpOnly' is supported out of the box, even on<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Servlet {@code 2.4} and {@code 2.5} container implementations, using raw header writing logic and not<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * {@link javax.servlet.http.Cookie javax.servlet.http.Cookie} objects (which only has 'HttpOnly' support in Servlet<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * {@code 2.6} specifications and above).<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> *<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * @since 1.0<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> */<a name="line.41"></a> |
| <span class="sourceLineNo">042</span>public class SimpleCookie implements Cookie {<a name="line.42"></a> |
| <span class="sourceLineNo">043</span><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> /**<a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * {@code -1}, indicating the cookie should expire when the browser closes.<a name="line.45"></a> |
| <span class="sourceLineNo">046</span> */<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> public static final int DEFAULT_MAX_AGE = -1;<a name="line.47"></a> |
| <span class="sourceLineNo">048</span><a name="line.48"></a> |
| <span class="sourceLineNo">049</span> /**<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * {@code -1} indicating that no version property should be set on the cookie.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> */<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> public static final int DEFAULT_VERSION = -1;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> //These constants are protected on purpose so that the test case can use them<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> protected static final String NAME_VALUE_DELIMITER = "=";<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> protected static final String ATTRIBUTE_DELIMITER = "; ";<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> protected static final long DAY_MILLIS = 86400000; //1 day = 86,400,000 milliseconds<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> protected static final String GMT_TIME_ZONE_ID = "GMT";<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> protected static final String COOKIE_DATE_FORMAT_STRING = "EEE, dd-MMM-yyyy HH:mm:ss z";<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> protected static final String COOKIE_HEADER_NAME = "Set-Cookie";<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> protected static final String PATH_ATTRIBUTE_NAME = "Path";<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> protected static final String EXPIRES_ATTRIBUTE_NAME = "Expires";<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> protected static final String MAXAGE_ATTRIBUTE_NAME = "Max-Age";<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> protected static final String DOMAIN_ATTRIBUTE_NAME = "Domain";<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> protected static final String VERSION_ATTRIBUTE_NAME = "Version";<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> protected static final String COMMENT_ATTRIBUTE_NAME = "Comment";<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> protected static final String SECURE_ATTRIBUTE_NAME = "Secure";<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> protected static final String HTTP_ONLY_ATTRIBUTE_NAME = "HttpOnly";<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> private static final transient Logger log = LoggerFactory.getLogger(SimpleCookie.class);<a name="line.71"></a> |
| <span class="sourceLineNo">072</span><a name="line.72"></a> |
| <span class="sourceLineNo">073</span> private String name;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> private String value;<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> private String comment;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> private String domain;<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> private String path;<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> private int maxAge;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> private int version;<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> private boolean secure;<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> private boolean httpOnly;<a name="line.81"></a> |
| <span class="sourceLineNo">082</span><a name="line.82"></a> |
| <span class="sourceLineNo">083</span> public SimpleCookie() {<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> this.maxAge = DEFAULT_MAX_AGE;<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> this.version = DEFAULT_VERSION;<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> this.httpOnly = true; //most of the cookies ever used by Shiro should be as secure as possible.<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> public SimpleCookie(String name) {<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> this();<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> this.name = name;<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> public SimpleCookie(Cookie cookie) {<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> this.name = cookie.getName();<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> this.value = cookie.getValue();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> this.comment = cookie.getComment();<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> this.domain = cookie.getDomain();<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> this.path = cookie.getPath();<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> this.maxAge = Math.max(DEFAULT_MAX_AGE, cookie.getMaxAge());<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> this.version = Math.max(DEFAULT_VERSION, cookie.getVersion());<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> this.secure = cookie.isSecure();<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> this.httpOnly = cookie.isHttpOnly();<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> }<a name="line.104"></a> |
| <span class="sourceLineNo">105</span><a name="line.105"></a> |
| <span class="sourceLineNo">106</span> public String getName() {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> return name;<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> }<a name="line.108"></a> |
| <span class="sourceLineNo">109</span><a name="line.109"></a> |
| <span class="sourceLineNo">110</span> public void setName(String name) {<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> if (!StringUtils.hasText(name)) {<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> throw new IllegalArgumentException("Name cannot be null/empty.");<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> }<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> this.name = name;<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> }<a name="line.115"></a> |
| <span class="sourceLineNo">116</span><a name="line.116"></a> |
| <span class="sourceLineNo">117</span> public String getValue() {<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> return value;<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> }<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> public void setValue(String value) {<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> this.value = value;<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> public String getComment() {<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> return comment;<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> }<a name="line.127"></a> |
| <span class="sourceLineNo">128</span><a name="line.128"></a> |
| <span class="sourceLineNo">129</span> public void setComment(String comment) {<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> this.comment = comment;<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> }<a name="line.131"></a> |
| <span class="sourceLineNo">132</span><a name="line.132"></a> |
| <span class="sourceLineNo">133</span> public String getDomain() {<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> return domain;<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> }<a name="line.135"></a> |
| <span class="sourceLineNo">136</span><a name="line.136"></a> |
| <span class="sourceLineNo">137</span> public void setDomain(String domain) {<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> this.domain = domain;<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> }<a name="line.139"></a> |
| <span class="sourceLineNo">140</span><a name="line.140"></a> |
| <span class="sourceLineNo">141</span> public String getPath() {<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return path;<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> }<a name="line.143"></a> |
| <span class="sourceLineNo">144</span><a name="line.144"></a> |
| <span class="sourceLineNo">145</span> public void setPath(String path) {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> this.path = path;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> public int getMaxAge() {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> return maxAge;<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span><a name="line.152"></a> |
| <span class="sourceLineNo">153</span> public void setMaxAge(int maxAge) {<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> this.maxAge = Math.max(DEFAULT_MAX_AGE, maxAge);<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> }<a name="line.155"></a> |
| <span class="sourceLineNo">156</span><a name="line.156"></a> |
| <span class="sourceLineNo">157</span> public int getVersion() {<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> return version;<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> }<a name="line.159"></a> |
| <span class="sourceLineNo">160</span><a name="line.160"></a> |
| <span class="sourceLineNo">161</span> public void setVersion(int version) {<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> this.version = Math.max(DEFAULT_VERSION, version);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> }<a name="line.163"></a> |
| <span class="sourceLineNo">164</span><a name="line.164"></a> |
| <span class="sourceLineNo">165</span> public boolean isSecure() {<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> return secure;<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> }<a name="line.167"></a> |
| <span class="sourceLineNo">168</span><a name="line.168"></a> |
| <span class="sourceLineNo">169</span> public void setSecure(boolean secure) {<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> this.secure = secure;<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> }<a name="line.171"></a> |
| <span class="sourceLineNo">172</span><a name="line.172"></a> |
| <span class="sourceLineNo">173</span> public boolean isHttpOnly() {<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> return httpOnly;<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> }<a name="line.175"></a> |
| <span class="sourceLineNo">176</span><a name="line.176"></a> |
| <span class="sourceLineNo">177</span> public void setHttpOnly(boolean httpOnly) {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> this.httpOnly = httpOnly;<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> /**<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Returns the Cookie's calculated path setting. If the {@link javax.servlet.http.Cookie#getPath() path} is {@code null}, then the<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * {@code request}'s {@link javax.servlet.http.HttpServletRequest#getContextPath() context path}<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * will be returned. If getContextPath() is the empty string or null then the ROOT_PATH constant is returned.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> *<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @param request the incoming HttpServletRequest<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * @return the path to be used as the path when the cookie is created or removed<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> */<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> private String calculatePath(HttpServletRequest request) {<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> String path = StringUtils.clean(getPath());<a name="line.190"></a> |
| <span class="sourceLineNo">191</span> if (!StringUtils.hasText(path)) {<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> path = StringUtils.clean(request.getContextPath());<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> }<a name="line.193"></a> |
| <span class="sourceLineNo">194</span><a name="line.194"></a> |
| <span class="sourceLineNo">195</span> //fix for http://issues.apache.org/jira/browse/SHIRO-9:<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> if (path == null) {<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> path = ROOT_PATH;<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> }<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> log.trace("calculated path: {}", path);<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> return path;<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> }<a name="line.201"></a> |
| <span class="sourceLineNo">202</span><a name="line.202"></a> |
| <span class="sourceLineNo">203</span> public void saveTo(HttpServletRequest request, HttpServletResponse response) {<a name="line.203"></a> |
| <span class="sourceLineNo">204</span><a name="line.204"></a> |
| <span class="sourceLineNo">205</span> String name = getName();<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> String value = getValue();<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> String comment = getComment();<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> String domain = getDomain();<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> String path = calculatePath(request);<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> int maxAge = getMaxAge();<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> int version = getVersion();<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> boolean secure = isSecure();<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> boolean httpOnly = isHttpOnly();<a name="line.213"></a> |
| <span class="sourceLineNo">214</span><a name="line.214"></a> |
| <span class="sourceLineNo">215</span> addCookieHeader(response, name, value, comment, domain, path, maxAge, version, secure, httpOnly);<a name="line.215"></a> |
| <span class="sourceLineNo">216</span> }<a name="line.216"></a> |
| <span class="sourceLineNo">217</span><a name="line.217"></a> |
| <span class="sourceLineNo">218</span> private void addCookieHeader(HttpServletResponse response, String name, String value, String comment,<a name="line.218"></a> |
| <span class="sourceLineNo">219</span> String domain, String path, int maxAge, int version,<a name="line.219"></a> |
| <span class="sourceLineNo">220</span> boolean secure, boolean httpOnly) {<a name="line.220"></a> |
| <span class="sourceLineNo">221</span><a name="line.221"></a> |
| <span class="sourceLineNo">222</span> String headerValue = buildHeaderValue(name, value, comment, domain, path, maxAge, version, secure, httpOnly);<a name="line.222"></a> |
| <span class="sourceLineNo">223</span> response.addHeader(COOKIE_HEADER_NAME, headerValue);<a name="line.223"></a> |
| <span class="sourceLineNo">224</span><a name="line.224"></a> |
| <span class="sourceLineNo">225</span> if (log.isDebugEnabled()) {<a name="line.225"></a> |
| <span class="sourceLineNo">226</span> log.debug("Added HttpServletResponse Cookie [{}]", headerValue);<a name="line.226"></a> |
| <span class="sourceLineNo">227</span> }<a name="line.227"></a> |
| <span class="sourceLineNo">228</span> }<a name="line.228"></a> |
| <span class="sourceLineNo">229</span><a name="line.229"></a> |
| <span class="sourceLineNo">230</span> /*<a name="line.230"></a> |
| <span class="sourceLineNo">231</span> * This implementation followed the grammar defined here for convenience:<a name="line.231"></a> |
| <span class="sourceLineNo">232</span> * <a href="http://github.com/abarth/http-state/blob/master/notes/2009-11-07-Yui-Naruse.txt">Cookie grammar</a>.<a name="line.232"></a> |
| <span class="sourceLineNo">233</span> *<a name="line.233"></a> |
| <span class="sourceLineNo">234</span> * @return the 'Set-Cookie' header value for this cookie instance.<a name="line.234"></a> |
| <span class="sourceLineNo">235</span> */<a name="line.235"></a> |
| <span class="sourceLineNo">236</span><a name="line.236"></a> |
| <span class="sourceLineNo">237</span> protected String buildHeaderValue(String name, String value, String comment,<a name="line.237"></a> |
| <span class="sourceLineNo">238</span> String domain, String path, int maxAge, int version,<a name="line.238"></a> |
| <span class="sourceLineNo">239</span> boolean secure, boolean httpOnly) {<a name="line.239"></a> |
| <span class="sourceLineNo">240</span><a name="line.240"></a> |
| <span class="sourceLineNo">241</span> if (!StringUtils.hasText(name)) {<a name="line.241"></a> |
| <span class="sourceLineNo">242</span> throw new IllegalStateException("Cookie name cannot be null/empty.");<a name="line.242"></a> |
| <span class="sourceLineNo">243</span> }<a name="line.243"></a> |
| <span class="sourceLineNo">244</span><a name="line.244"></a> |
| <span class="sourceLineNo">245</span> StringBuilder sb = new StringBuilder(name).append(NAME_VALUE_DELIMITER);<a name="line.245"></a> |
| <span class="sourceLineNo">246</span><a name="line.246"></a> |
| <span class="sourceLineNo">247</span> if (StringUtils.hasText(value)) {<a name="line.247"></a> |
| <span class="sourceLineNo">248</span> sb.append(value);<a name="line.248"></a> |
| <span class="sourceLineNo">249</span> }<a name="line.249"></a> |
| <span class="sourceLineNo">250</span><a name="line.250"></a> |
| <span class="sourceLineNo">251</span> appendComment(sb, comment);<a name="line.251"></a> |
| <span class="sourceLineNo">252</span> appendDomain(sb, domain);<a name="line.252"></a> |
| <span class="sourceLineNo">253</span> appendPath(sb, path);<a name="line.253"></a> |
| <span class="sourceLineNo">254</span> appendExpires(sb, maxAge);<a name="line.254"></a> |
| <span class="sourceLineNo">255</span> appendVersion(sb, version);<a name="line.255"></a> |
| <span class="sourceLineNo">256</span> appendSecure(sb, secure);<a name="line.256"></a> |
| <span class="sourceLineNo">257</span> appendHttpOnly(sb, httpOnly);<a name="line.257"></a> |
| <span class="sourceLineNo">258</span><a name="line.258"></a> |
| <span class="sourceLineNo">259</span> return sb.toString();<a name="line.259"></a> |
| <span class="sourceLineNo">260</span><a name="line.260"></a> |
| <span class="sourceLineNo">261</span> }<a name="line.261"></a> |
| <span class="sourceLineNo">262</span><a name="line.262"></a> |
| <span class="sourceLineNo">263</span> private void appendComment(StringBuilder sb, String comment) {<a name="line.263"></a> |
| <span class="sourceLineNo">264</span> if (StringUtils.hasText(comment)) {<a name="line.264"></a> |
| <span class="sourceLineNo">265</span> sb.append(ATTRIBUTE_DELIMITER);<a name="line.265"></a> |
| <span class="sourceLineNo">266</span> sb.append(COMMENT_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(comment);<a name="line.266"></a> |
| <span class="sourceLineNo">267</span> }<a name="line.267"></a> |
| <span class="sourceLineNo">268</span> }<a name="line.268"></a> |
| <span class="sourceLineNo">269</span><a name="line.269"></a> |
| <span class="sourceLineNo">270</span> private void appendDomain(StringBuilder sb, String domain) {<a name="line.270"></a> |
| <span class="sourceLineNo">271</span> if (StringUtils.hasText(domain)) {<a name="line.271"></a> |
| <span class="sourceLineNo">272</span> sb.append(ATTRIBUTE_DELIMITER);<a name="line.272"></a> |
| <span class="sourceLineNo">273</span> sb.append(DOMAIN_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(domain);<a name="line.273"></a> |
| <span class="sourceLineNo">274</span> }<a name="line.274"></a> |
| <span class="sourceLineNo">275</span> }<a name="line.275"></a> |
| <span class="sourceLineNo">276</span><a name="line.276"></a> |
| <span class="sourceLineNo">277</span> private void appendPath(StringBuilder sb, String path) {<a name="line.277"></a> |
| <span class="sourceLineNo">278</span> if (StringUtils.hasText(path)) {<a name="line.278"></a> |
| <span class="sourceLineNo">279</span> sb.append(ATTRIBUTE_DELIMITER);<a name="line.279"></a> |
| <span class="sourceLineNo">280</span> sb.append(PATH_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(path);<a name="line.280"></a> |
| <span class="sourceLineNo">281</span> }<a name="line.281"></a> |
| <span class="sourceLineNo">282</span> }<a name="line.282"></a> |
| <span class="sourceLineNo">283</span><a name="line.283"></a> |
| <span class="sourceLineNo">284</span> private void appendExpires(StringBuilder sb, int maxAge) {<a name="line.284"></a> |
| <span class="sourceLineNo">285</span> // if maxAge is negative, cookie should should expire when browser closes<a name="line.285"></a> |
| <span class="sourceLineNo">286</span> // Don't write the maxAge cookie value if it's negative - at least on Firefox it'll cause the <a name="line.286"></a> |
| <span class="sourceLineNo">287</span> // cookie to be deleted immediately<a name="line.287"></a> |
| <span class="sourceLineNo">288</span> // Write the expires header used by older browsers, but may be unnecessary<a name="line.288"></a> |
| <span class="sourceLineNo">289</span> // and it is not by the spec, see http://www.faqs.org/rfcs/rfc2965.html<a name="line.289"></a> |
| <span class="sourceLineNo">290</span> // TODO consider completely removing the following <a name="line.290"></a> |
| <span class="sourceLineNo">291</span> if (maxAge >= 0) {<a name="line.291"></a> |
| <span class="sourceLineNo">292</span> sb.append(ATTRIBUTE_DELIMITER);<a name="line.292"></a> |
| <span class="sourceLineNo">293</span> sb.append(MAXAGE_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(maxAge);<a name="line.293"></a> |
| <span class="sourceLineNo">294</span> sb.append(ATTRIBUTE_DELIMITER);<a name="line.294"></a> |
| <span class="sourceLineNo">295</span> Date expires;<a name="line.295"></a> |
| <span class="sourceLineNo">296</span> if (maxAge == 0) {<a name="line.296"></a> |
| <span class="sourceLineNo">297</span> //delete the cookie by specifying a time in the past (1 day ago):<a name="line.297"></a> |
| <span class="sourceLineNo">298</span> expires = new Date(System.currentTimeMillis() - DAY_MILLIS);<a name="line.298"></a> |
| <span class="sourceLineNo">299</span> } else {<a name="line.299"></a> |
| <span class="sourceLineNo">300</span> //Value is in seconds. So take 'now' and add that many seconds, and that's our expiration date:<a name="line.300"></a> |
| <span class="sourceLineNo">301</span> Calendar cal = Calendar.getInstance();<a name="line.301"></a> |
| <span class="sourceLineNo">302</span> cal.add(Calendar.SECOND, maxAge);<a name="line.302"></a> |
| <span class="sourceLineNo">303</span> expires = cal.getTime();<a name="line.303"></a> |
| <span class="sourceLineNo">304</span> }<a name="line.304"></a> |
| <span class="sourceLineNo">305</span> String formatted = toCookieDate(expires);<a name="line.305"></a> |
| <span class="sourceLineNo">306</span> sb.append(EXPIRES_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(formatted);<a name="line.306"></a> |
| <span class="sourceLineNo">307</span> }<a name="line.307"></a> |
| <span class="sourceLineNo">308</span> }<a name="line.308"></a> |
| <span class="sourceLineNo">309</span><a name="line.309"></a> |
| <span class="sourceLineNo">310</span> private void appendVersion(StringBuilder sb, int version) {<a name="line.310"></a> |
| <span class="sourceLineNo">311</span> if (version > DEFAULT_VERSION) {<a name="line.311"></a> |
| <span class="sourceLineNo">312</span> sb.append(ATTRIBUTE_DELIMITER);<a name="line.312"></a> |
| <span class="sourceLineNo">313</span> sb.append(VERSION_ATTRIBUTE_NAME).append(NAME_VALUE_DELIMITER).append(version);<a name="line.313"></a> |
| <span class="sourceLineNo">314</span> }<a name="line.314"></a> |
| <span class="sourceLineNo">315</span> }<a name="line.315"></a> |
| <span class="sourceLineNo">316</span><a name="line.316"></a> |
| <span class="sourceLineNo">317</span> private void appendSecure(StringBuilder sb, boolean secure) {<a name="line.317"></a> |
| <span class="sourceLineNo">318</span> if (secure) {<a name="line.318"></a> |
| <span class="sourceLineNo">319</span> sb.append(ATTRIBUTE_DELIMITER);<a name="line.319"></a> |
| <span class="sourceLineNo">320</span> sb.append(SECURE_ATTRIBUTE_NAME); //No value for this attribute<a name="line.320"></a> |
| <span class="sourceLineNo">321</span> }<a name="line.321"></a> |
| <span class="sourceLineNo">322</span> }<a name="line.322"></a> |
| <span class="sourceLineNo">323</span><a name="line.323"></a> |
| <span class="sourceLineNo">324</span> private void appendHttpOnly(StringBuilder sb, boolean httpOnly) {<a name="line.324"></a> |
| <span class="sourceLineNo">325</span> if (httpOnly) {<a name="line.325"></a> |
| <span class="sourceLineNo">326</span> sb.append(ATTRIBUTE_DELIMITER);<a name="line.326"></a> |
| <span class="sourceLineNo">327</span> sb.append(HTTP_ONLY_ATTRIBUTE_NAME); //No value for this attribute<a name="line.327"></a> |
| <span class="sourceLineNo">328</span> }<a name="line.328"></a> |
| <span class="sourceLineNo">329</span> }<a name="line.329"></a> |
| <span class="sourceLineNo">330</span><a name="line.330"></a> |
| <span class="sourceLineNo">331</span> /**<a name="line.331"></a> |
| <span class="sourceLineNo">332</span> * Check whether the given {@code cookiePath} matches the {@code requestPath}<a name="line.332"></a> |
| <span class="sourceLineNo">333</span> *<a name="line.333"></a> |
| <span class="sourceLineNo">334</span> * @param cookiePath<a name="line.334"></a> |
| <span class="sourceLineNo">335</span> * @param requestPath<a name="line.335"></a> |
| <span class="sourceLineNo">336</span> * @return<a name="line.336"></a> |
| <span class="sourceLineNo">337</span> * @see <a href="https://tools.ietf.org/html/rfc6265#section-5.1.4">RFC 6265, Section 5.1.4 "Paths and Path-Match"</a><a name="line.337"></a> |
| <span class="sourceLineNo">338</span> */<a name="line.338"></a> |
| <span class="sourceLineNo">339</span> private boolean pathMatches(String cookiePath, String requestPath) {<a name="line.339"></a> |
| <span class="sourceLineNo">340</span> if (!requestPath.startsWith(cookiePath)) {<a name="line.340"></a> |
| <span class="sourceLineNo">341</span> return false;<a name="line.341"></a> |
| <span class="sourceLineNo">342</span> }<a name="line.342"></a> |
| <span class="sourceLineNo">343</span><a name="line.343"></a> |
| <span class="sourceLineNo">344</span> return requestPath.length() == cookiePath.length()<a name="line.344"></a> |
| <span class="sourceLineNo">345</span> || cookiePath.charAt(cookiePath.length() - 1) == '/'<a name="line.345"></a> |
| <span class="sourceLineNo">346</span> || requestPath.charAt(cookiePath.length()) == '/';<a name="line.346"></a> |
| <span class="sourceLineNo">347</span> }<a name="line.347"></a> |
| <span class="sourceLineNo">348</span><a name="line.348"></a> |
| <span class="sourceLineNo">349</span> /**<a name="line.349"></a> |
| <span class="sourceLineNo">350</span> * Formats a date into a cookie date compatible string (Netscape's specification).<a name="line.350"></a> |
| <span class="sourceLineNo">351</span> *<a name="line.351"></a> |
| <span class="sourceLineNo">352</span> * @param date the date to format<a name="line.352"></a> |
| <span class="sourceLineNo">353</span> * @return an HTTP 1.0/1.1 Cookie compatible date string (GMT-based).<a name="line.353"></a> |
| <span class="sourceLineNo">354</span> */<a name="line.354"></a> |
| <span class="sourceLineNo">355</span> private static String toCookieDate(Date date) {<a name="line.355"></a> |
| <span class="sourceLineNo">356</span> TimeZone tz = TimeZone.getTimeZone(GMT_TIME_ZONE_ID);<a name="line.356"></a> |
| <span class="sourceLineNo">357</span> DateFormat fmt = new SimpleDateFormat(COOKIE_DATE_FORMAT_STRING, Locale.US);<a name="line.357"></a> |
| <span class="sourceLineNo">358</span> fmt.setTimeZone(tz);<a name="line.358"></a> |
| <span class="sourceLineNo">359</span> return fmt.format(date);<a name="line.359"></a> |
| <span class="sourceLineNo">360</span> }<a name="line.360"></a> |
| <span class="sourceLineNo">361</span><a name="line.361"></a> |
| <span class="sourceLineNo">362</span> public void removeFrom(HttpServletRequest request, HttpServletResponse response) {<a name="line.362"></a> |
| <span class="sourceLineNo">363</span> String name = getName();<a name="line.363"></a> |
| <span class="sourceLineNo">364</span> String value = DELETED_COOKIE_VALUE;<a name="line.364"></a> |
| <span class="sourceLineNo">365</span> String comment = null; //don't need to add extra size to the response - comments are irrelevant for deletions<a name="line.365"></a> |
| <span class="sourceLineNo">366</span> String domain = getDomain();<a name="line.366"></a> |
| <span class="sourceLineNo">367</span> String path = calculatePath(request);<a name="line.367"></a> |
| <span class="sourceLineNo">368</span> int maxAge = 0; //always zero for deletion<a name="line.368"></a> |
| <span class="sourceLineNo">369</span> int version = getVersion();<a name="line.369"></a> |
| <span class="sourceLineNo">370</span> boolean secure = isSecure();<a name="line.370"></a> |
| <span class="sourceLineNo">371</span> boolean httpOnly = false; //no need to add the extra text, plus the value 'deleteMe' is not sensitive at all<a name="line.371"></a> |
| <span class="sourceLineNo">372</span><a name="line.372"></a> |
| <span class="sourceLineNo">373</span> addCookieHeader(response, name, value, comment, domain, path, maxAge, version, secure, httpOnly);<a name="line.373"></a> |
| <span class="sourceLineNo">374</span><a name="line.374"></a> |
| <span class="sourceLineNo">375</span> log.trace("Removed '{}' cookie by setting maxAge=0", name);<a name="line.375"></a> |
| <span class="sourceLineNo">376</span> }<a name="line.376"></a> |
| <span class="sourceLineNo">377</span><a name="line.377"></a> |
| <span class="sourceLineNo">378</span> public String readValue(HttpServletRequest request, HttpServletResponse ignored) {<a name="line.378"></a> |
| <span class="sourceLineNo">379</span> String name = getName();<a name="line.379"></a> |
| <span class="sourceLineNo">380</span> String value = null;<a name="line.380"></a> |
| <span class="sourceLineNo">381</span> javax.servlet.http.Cookie cookie = getCookie(request, name);<a name="line.381"></a> |
| <span class="sourceLineNo">382</span> if (cookie != null) {<a name="line.382"></a> |
| <span class="sourceLineNo">383</span> // Validate that the cookie is used at the correct place.<a name="line.383"></a> |
| <span class="sourceLineNo">384</span> String path = StringUtils.clean(getPath());<a name="line.384"></a> |
| <span class="sourceLineNo">385</span> if (path != null && !pathMatches(path, request.getRequestURI())) {<a name="line.385"></a> |
| <span class="sourceLineNo">386</span> log.warn("Found '{}' cookie at path '{}', but should be only used for '{}'", new Object[] { name, request.getRequestURI(), path});<a name="line.386"></a> |
| <span class="sourceLineNo">387</span> } else {<a name="line.387"></a> |
| <span class="sourceLineNo">388</span> value = cookie.getValue();<a name="line.388"></a> |
| <span class="sourceLineNo">389</span> log.debug("Found '{}' cookie value [{}]", name, value);<a name="line.389"></a> |
| <span class="sourceLineNo">390</span> }<a name="line.390"></a> |
| <span class="sourceLineNo">391</span> } else {<a name="line.391"></a> |
| <span class="sourceLineNo">392</span> log.trace("No '{}' cookie value", name);<a name="line.392"></a> |
| <span class="sourceLineNo">393</span> }<a name="line.393"></a> |
| <span class="sourceLineNo">394</span><a name="line.394"></a> |
| <span class="sourceLineNo">395</span> return value;<a name="line.395"></a> |
| <span class="sourceLineNo">396</span> }<a name="line.396"></a> |
| <span class="sourceLineNo">397</span><a name="line.397"></a> |
| <span class="sourceLineNo">398</span> /**<a name="line.398"></a> |
| <span class="sourceLineNo">399</span> * Returns the cookie with the given name from the request or {@code null} if no cookie<a name="line.399"></a> |
| <span class="sourceLineNo">400</span> * with that name could be found.<a name="line.400"></a> |
| <span class="sourceLineNo">401</span> *<a name="line.401"></a> |
| <span class="sourceLineNo">402</span> * @param request the current executing http request.<a name="line.402"></a> |
| <span class="sourceLineNo">403</span> * @param cookieName the name of the cookie to find and return.<a name="line.403"></a> |
| <span class="sourceLineNo">404</span> * @return the cookie with the given name from the request or {@code null} if no cookie<a name="line.404"></a> |
| <span class="sourceLineNo">405</span> * with that name could be found.<a name="line.405"></a> |
| <span class="sourceLineNo">406</span> */<a name="line.406"></a> |
| <span class="sourceLineNo">407</span> private static javax.servlet.http.Cookie getCookie(HttpServletRequest request, String cookieName) {<a name="line.407"></a> |
| <span class="sourceLineNo">408</span> javax.servlet.http.Cookie cookies[] = request.getCookies();<a name="line.408"></a> |
| <span class="sourceLineNo">409</span> if (cookies != null) {<a name="line.409"></a> |
| <span class="sourceLineNo">410</span> for (javax.servlet.http.Cookie cookie : cookies) {<a name="line.410"></a> |
| <span class="sourceLineNo">411</span> if (cookie.getName().equals(cookieName)) {<a name="line.411"></a> |
| <span class="sourceLineNo">412</span> return cookie;<a name="line.412"></a> |
| <span class="sourceLineNo">413</span> }<a name="line.413"></a> |
| <span class="sourceLineNo">414</span> }<a name="line.414"></a> |
| <span class="sourceLineNo">415</span> }<a name="line.415"></a> |
| <span class="sourceLineNo">416</span> return null;<a name="line.416"></a> |
| <span class="sourceLineNo">417</span> }<a name="line.417"></a> |
| <span class="sourceLineNo">418</span>}<a name="line.418"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
