1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30 package org.apache.commons.httpclient.cookie;
31
32 import java.util.Collection;
33 import java.util.Date;
34 import java.util.LinkedList;
35 import java.util.List;
36
37 import org.apache.commons.httpclient.Cookie;
38 import org.apache.commons.httpclient.Header;
39 import org.apache.commons.httpclient.HeaderElement;
40 import org.apache.commons.httpclient.NameValuePair;
41 import org.apache.commons.httpclient.util.DateParseException;
42 import org.apache.commons.httpclient.util.DateUtil;
43 import org.apache.commons.logging.Log;
44 import org.apache.commons.logging.LogFactory;
45
46 /***
47 *
48 * Cookie management functions shared by all specification.
49 *
50 * @author B.C. Holmes
51 * @author <a href="mailto:jericho@thinkfree.com">Park, Sung-Gu</a>
52 * @author <a href="mailto:dsale@us.britannica.com">Doug Sale</a>
53 * @author Rod Waldhoff
54 * @author dIon Gillard
55 * @author Sean C. Sullivan
56 * @author <a href="mailto:JEvans@Cyveillance.com">John Evans</a>
57 * @author Marc A. Saegesser
58 * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
59 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
60 *
61 * @since 2.0
62 */
63 public class CookieSpecBase implements CookieSpec {
64
65 /*** Log object */
66 protected static final Log LOG = LogFactory.getLog(CookieSpec.class);
67
68 /*** Valid date patterns */
69 private Collection datepatterns = null;
70
71 /*** Default constructor */
72 public CookieSpecBase() {
73 super();
74 }
75
76
77 /***
78 * Parses the Set-Cookie value into an array of <tt>Cookie</tt>s.
79 *
80 * <P>The syntax for the Set-Cookie response header is:
81 *
82 * <PRE>
83 * set-cookie = "Set-Cookie:" cookies
84 * cookies = 1#cookie
85 * cookie = NAME "=" VALUE * (";" cookie-av)
86 * NAME = attr
87 * VALUE = value
88 * cookie-av = "Comment" "=" value
89 * | "Domain" "=" value
90 * | "Max-Age" "=" value
91 * | "Path" "=" value
92 * | "Secure"
93 * | "Version" "=" 1*DIGIT
94 * </PRE>
95 *
96 * @param host the host from which the <tt>Set-Cookie</tt> value was
97 * received
98 * @param port the port from which the <tt>Set-Cookie</tt> value was
99 * received
100 * @param path the path from which the <tt>Set-Cookie</tt> value was
101 * received
102 * @param secure <tt>true</tt> when the <tt>Set-Cookie</tt> value was
103 * received over secure conection
104 * @param header the <tt>Set-Cookie</tt> received from the server
105 * @return an array of <tt>Cookie</tt>s parsed from the Set-Cookie value
106 * @throws MalformedCookieException if an exception occurs during parsing
107 */
108 public Cookie[] parse(String host, int port, String path,
109 boolean secure, final String header)
110 throws MalformedCookieException {
111
112 LOG.trace("enter CookieSpecBase.parse("
113 + "String, port, path, boolean, Header)");
114
115 if (host == null) {
116 throw new IllegalArgumentException(
117 "Host of origin may not be null");
118 }
119 if (host.trim().equals("")) {
120 throw new IllegalArgumentException(
121 "Host of origin may not be blank");
122 }
123 if (port < 0) {
124 throw new IllegalArgumentException("Invalid port: " + port);
125 }
126 if (path == null) {
127 throw new IllegalArgumentException(
128 "Path of origin may not be null.");
129 }
130 if (header == null) {
131 throw new IllegalArgumentException("Header may not be null.");
132 }
133
134 if (path.trim().equals("")) {
135 path = PATH_DELIM;
136 }
137 host = host.toLowerCase();
138
139 String defaultPath = path;
140 int lastSlashIndex = defaultPath.lastIndexOf(PATH_DELIM);
141 if (lastSlashIndex >= 0) {
142 if (lastSlashIndex == 0) {
143
144 lastSlashIndex = 1;
145 }
146 defaultPath = defaultPath.substring(0, lastSlashIndex);
147 }
148
149 HeaderElement[] headerElements = null;
150
151 boolean isNetscapeCookie = false;
152 int i1 = header.toLowerCase().indexOf("expires=");
153 if (i1 != -1) {
154 i1 += "expires=".length();
155 int i2 = header.indexOf(";", i1);
156 if (i2 == -1) {
157 i2 = header.length();
158 }
159 try {
160 DateUtil.parseDate(header.substring(i1, i2), this.datepatterns);
161 isNetscapeCookie = true;
162 } catch (DateParseException e) {
163
164 }
165 }
166 if (isNetscapeCookie) {
167 headerElements = new HeaderElement[] {
168 new HeaderElement(header.toCharArray())
169 };
170 } else {
171 headerElements = HeaderElement.parseElements(header.toCharArray());
172 }
173
174 Cookie[] cookies = new Cookie[headerElements.length];
175
176 for (int i = 0; i < headerElements.length; i++) {
177
178 HeaderElement headerelement = headerElements[i];
179 Cookie cookie = null;
180 try {
181 cookie = new Cookie(host,
182 headerelement.getName(),
183 headerelement.getValue(),
184 defaultPath,
185 null,
186 false);
187 } catch (IllegalArgumentException e) {
188 throw new MalformedCookieException(e.getMessage());
189 }
190
191 NameValuePair[] parameters = headerelement.getParameters();
192
193 if (parameters != null) {
194
195 for (int j = 0; j < parameters.length; j++) {
196 parseAttribute(parameters[j], cookie);
197 }
198 }
199 cookies[i] = cookie;
200 }
201 return cookies;
202 }
203
204
205 /***
206 * Parse the <tt>"Set-Cookie"</tt> {@link Header} into an array of {@link
207 * Cookie}s.
208 *
209 * <P>The syntax for the Set-Cookie response header is:
210 *
211 * <PRE>
212 * set-cookie = "Set-Cookie:" cookies
213 * cookies = 1#cookie
214 * cookie = NAME "=" VALUE * (";" cookie-av)
215 * NAME = attr
216 * VALUE = value
217 * cookie-av = "Comment" "=" value
218 * | "Domain" "=" value
219 * | "Max-Age" "=" value
220 * | "Path" "=" value
221 * | "Secure"
222 * | "Version" "=" 1*DIGIT
223 * </PRE>
224 *
225 * @param host the host from which the <tt>Set-Cookie</tt> header was
226 * received
227 * @param port the port from which the <tt>Set-Cookie</tt> header was
228 * received
229 * @param path the path from which the <tt>Set-Cookie</tt> header was
230 * received
231 * @param secure <tt>true</tt> when the <tt>Set-Cookie</tt> header was
232 * received over secure conection
233 * @param header the <tt>Set-Cookie</tt> received from the server
234 * @return an array of <tt>Cookie</tt>s parsed from the <tt>"Set-Cookie"
235 * </tt> header
236 * @throws MalformedCookieException if an exception occurs during parsing
237 */
238 public Cookie[] parse(
239 String host, int port, String path, boolean secure, final Header header)
240 throws MalformedCookieException {
241
242 LOG.trace("enter CookieSpecBase.parse("
243 + "String, port, path, boolean, String)");
244 if (header == null) {
245 throw new IllegalArgumentException("Header may not be null.");
246 }
247 return parse(host, port, path, secure, header.getValue());
248 }
249
250
251 /***
252 * Parse the cookie attribute and update the corresponsing {@link Cookie}
253 * properties.
254 *
255 * @param attribute {@link HeaderElement} cookie attribute from the
256 * <tt>Set- Cookie</tt>
257 * @param cookie {@link Cookie} to be updated
258 * @throws MalformedCookieException if an exception occurs during parsing
259 */
260
261 public void parseAttribute(
262 final NameValuePair attribute, final Cookie cookie)
263 throws MalformedCookieException {
264
265 if (attribute == null) {
266 throw new IllegalArgumentException("Attribute may not be null.");
267 }
268 if (cookie == null) {
269 throw new IllegalArgumentException("Cookie may not be null.");
270 }
271 final String paramName = attribute.getName().toLowerCase();
272 String paramValue = attribute.getValue();
273
274 if (paramName.equals("path")) {
275
276 if ((paramValue == null) || (paramValue.trim().equals(""))) {
277 paramValue = "/";
278 }
279 cookie.setPath(paramValue);
280 cookie.setPathAttributeSpecified(true);
281
282 } else if (paramName.equals("domain")) {
283
284 if (paramValue == null) {
285 throw new MalformedCookieException(
286 "Missing value for domain attribute");
287 }
288 if (paramValue.trim().equals("")) {
289 throw new MalformedCookieException(
290 "Blank value for domain attribute");
291 }
292 cookie.setDomain(paramValue);
293 cookie.setDomainAttributeSpecified(true);
294
295 } else if (paramName.equals("max-age")) {
296
297 if (paramValue == null) {
298 throw new MalformedCookieException(
299 "Missing value for max-age attribute");
300 }
301 int age;
302 try {
303 age = Integer.parseInt(paramValue);
304 } catch (NumberFormatException e) {
305 throw new MalformedCookieException ("Invalid max-age "
306 + "attribute: " + e.getMessage());
307 }
308 cookie.setExpiryDate(
309 new Date(System.currentTimeMillis() + age * 1000L));
310
311 } else if (paramName.equals("secure")) {
312
313 cookie.setSecure(true);
314
315 } else if (paramName.equals("comment")) {
316
317 cookie.setComment(paramValue);
318
319 } else if (paramName.equals("expires")) {
320
321 if (paramValue == null) {
322 throw new MalformedCookieException(
323 "Missing value for expires attribute");
324 }
325
326 try {
327 cookie.setExpiryDate(DateUtil.parseDate(paramValue, this.datepatterns));
328 } catch (DateParseException dpe) {
329 LOG.debug("Error parsing cookie date", dpe);
330 throw new MalformedCookieException(
331 "Unable to parse expiration date parameter: "
332 + paramValue);
333 }
334 } else {
335 if (LOG.isDebugEnabled()) {
336 LOG.debug("Unrecognized cookie attribute: "
337 + attribute.toString());
338 }
339 }
340 }
341
342
343 public Collection getValidDateFormats() {
344 return this.datepatterns;
345 }
346
347 public void setValidDateFormats(final Collection datepatterns) {
348 this.datepatterns = datepatterns;
349 }
350
351 /***
352 * Performs most common {@link Cookie} validation
353 *
354 * @param host the host from which the {@link Cookie} was received
355 * @param port the port from which the {@link Cookie} was received
356 * @param path the path from which the {@link Cookie} was received
357 * @param secure <tt>true</tt> when the {@link Cookie} was received using a
358 * secure connection
359 * @param cookie The cookie to validate.
360 * @throws MalformedCookieException if an exception occurs during
361 * validation
362 */
363
364 public void validate(String host, int port, String path,
365 boolean secure, final Cookie cookie)
366 throws MalformedCookieException {
367
368 LOG.trace("enter CookieSpecBase.validate("
369 + "String, port, path, boolean, Cookie)");
370 if (host == null) {
371 throw new IllegalArgumentException(
372 "Host of origin may not be null");
373 }
374 if (host.trim().equals("")) {
375 throw new IllegalArgumentException(
376 "Host of origin may not be blank");
377 }
378 if (port < 0) {
379 throw new IllegalArgumentException("Invalid port: " + port);
380 }
381 if (path == null) {
382 throw new IllegalArgumentException(
383 "Path of origin may not be null.");
384 }
385 if (path.trim().equals("")) {
386 path = PATH_DELIM;
387 }
388 host = host.toLowerCase();
389
390 if (cookie.getVersion() < 0) {
391 throw new MalformedCookieException ("Illegal version number "
392 + cookie.getValue());
393 }
394
395
396
397
398
399
400
401
402
403 if (host.indexOf(".") >= 0) {
404
405
406
407
408 if (!host.endsWith(cookie.getDomain())) {
409 String s = cookie.getDomain();
410 if (s.startsWith(".")) {
411 s = s.substring(1, s.length());
412 }
413 if (!host.equals(s)) {
414 throw new MalformedCookieException(
415 "Illegal domain attribute \"" + cookie.getDomain()
416 + "\". Domain of origin: \"" + host + "\"");
417 }
418 }
419 } else {
420 if (!host.equals(cookie.getDomain())) {
421 throw new MalformedCookieException(
422 "Illegal domain attribute \"" + cookie.getDomain()
423 + "\". Domain of origin: \"" + host + "\"");
424 }
425 }
426
427
428
429
430 if (!path.startsWith(cookie.getPath())) {
431 throw new MalformedCookieException(
432 "Illegal path attribute \"" + cookie.getPath()
433 + "\". Path of origin: \"" + path + "\"");
434 }
435 }
436
437
438 /***
439 * Return <tt>true</tt> if the cookie should be submitted with a request
440 * with given attributes, <tt>false</tt> otherwise.
441 * @param host the host to which the request is being submitted
442 * @param port the port to which the request is being submitted (ignored)
443 * @param path the path to which the request is being submitted
444 * @param secure <tt>true</tt> if the request is using a secure connection
445 * @param cookie {@link Cookie} to be matched
446 * @return true if the cookie matches the criterium
447 */
448
449 public boolean match(String host, int port, String path,
450 boolean secure, final Cookie cookie) {
451
452 LOG.trace("enter CookieSpecBase.match("
453 + "String, int, String, boolean, Cookie");
454
455 if (host == null) {
456 throw new IllegalArgumentException(
457 "Host of origin may not be null");
458 }
459 if (host.trim().equals("")) {
460 throw new IllegalArgumentException(
461 "Host of origin may not be blank");
462 }
463 if (port < 0) {
464 throw new IllegalArgumentException("Invalid port: " + port);
465 }
466 if (path == null) {
467 throw new IllegalArgumentException(
468 "Path of origin may not be null.");
469 }
470 if (cookie == null) {
471 throw new IllegalArgumentException("Cookie may not be null");
472 }
473 if (path.trim().equals("")) {
474 path = PATH_DELIM;
475 }
476 host = host.toLowerCase();
477 if (cookie.getDomain() == null) {
478 LOG.warn("Invalid cookie state: domain not specified");
479 return false;
480 }
481 if (cookie.getPath() == null) {
482 LOG.warn("Invalid cookie state: path not specified");
483 return false;
484 }
485
486 return
487
488 (cookie.getExpiryDate() == null
489 || cookie.getExpiryDate().after(new Date()))
490
491 && (domainMatch(host, cookie.getDomain()))
492
493 && (pathMatch(path, cookie.getPath()))
494
495
496 && (cookie.getSecure() ? secure : true);
497 }
498
499 /***
500 * Performs domain-match as implemented in common browsers.
501 * @param host The target host.
502 * @param domain The cookie domain attribute.
503 * @return true if the specified host matches the given domain.
504 */
505 public boolean domainMatch(final String host, final String domain) {
506 return host.endsWith(domain)
507 || (domain.startsWith(".") && host.endsWith(domain.substring(1)));
508 }
509
510 /***
511 * Performs path-match as implemented in common browsers.
512 * @param path The target path.
513 * @param topmostPath The cookie path attribute.
514 * @return true if the paths match
515 */
516 public boolean pathMatch(final String path, final String topmostPath) {
517 boolean match = path.startsWith (topmostPath);
518
519
520 if (match && path.length() != topmostPath.length()) {
521 if (!topmostPath.endsWith(PATH_DELIM)) {
522 match = (path.charAt(topmostPath.length()) == PATH_DELIM_CHAR);
523 }
524 }
525 return match;
526 }
527
528 /***
529 * Return an array of {@link Cookie}s that should be submitted with a
530 * request with given attributes, <tt>false</tt> otherwise.
531 * @param host the host to which the request is being submitted
532 * @param port the port to which the request is being submitted (currently
533 * ignored)
534 * @param path the path to which the request is being submitted
535 * @param secure <tt>true</tt> if the request is using a secure protocol
536 * @param cookies an array of <tt>Cookie</tt>s to be matched
537 * @return an array of <tt>Cookie</tt>s matching the criterium
538 */
539
540 public Cookie[] match(String host, int port, String path,
541 boolean secure, final Cookie cookies[]) {
542
543 LOG.trace("enter CookieSpecBase.match("
544 + "String, int, String, boolean, Cookie[])");
545
546 if (cookies == null) {
547 return null;
548 }
549 List matching = new LinkedList();
550 for (int i = 0; i < cookies.length; i++) {
551 if (match(host, port, path, secure, cookies[i])) {
552 addInPathOrder(matching, cookies[i]);
553 }
554 }
555 return (Cookie[]) matching.toArray(new Cookie[matching.size()]);
556 }
557
558
559 /***
560 * Adds the given cookie into the given list in descending path order. That
561 * is, more specific path to least specific paths. This may not be the
562 * fastest algorythm, but it'll work OK for the small number of cookies
563 * we're generally dealing with.
564 *
565 * @param list - the list to add the cookie to
566 * @param addCookie - the Cookie to add to list
567 */
568 private static void addInPathOrder(List list, Cookie addCookie) {
569 int i = 0;
570
571 for (i = 0; i < list.size(); i++) {
572 Cookie c = (Cookie) list.get(i);
573 if (addCookie.compare(addCookie, c) > 0) {
574 break;
575 }
576 }
577 list.add(i, addCookie);
578 }
579
580 /***
581 * Return a string suitable for sending in a <tt>"Cookie"</tt> header
582 * @param cookie a {@link Cookie} to be formatted as string
583 * @return a string suitable for sending in a <tt>"Cookie"</tt> header.
584 */
585 public String formatCookie(Cookie cookie) {
586 LOG.trace("enter CookieSpecBase.formatCookie(Cookie)");
587 if (cookie == null) {
588 throw new IllegalArgumentException("Cookie may not be null");
589 }
590 StringBuffer buf = new StringBuffer();
591 buf.append(cookie.getName());
592 buf.append("=");
593 String s = cookie.getValue();
594 if (s != null) {
595 buf.append(s);
596 }
597 return buf.toString();
598 }
599
600 /***
601 * Create a <tt>"Cookie"</tt> header value containing all {@link Cookie}s in
602 * <i>cookies</i> suitable for sending in a <tt>"Cookie"</tt> header
603 * @param cookies an array of {@link Cookie}s to be formatted
604 * @return a string suitable for sending in a Cookie header.
605 * @throws IllegalArgumentException if an input parameter is illegal
606 */
607
608 public String formatCookies(Cookie[] cookies)
609 throws IllegalArgumentException {
610 LOG.trace("enter CookieSpecBase.formatCookies(Cookie[])");
611 if (cookies == null) {
612 throw new IllegalArgumentException("Cookie array may not be null");
613 }
614 if (cookies.length == 0) {
615 throw new IllegalArgumentException("Cookie array may not be empty");
616 }
617
618 StringBuffer buffer = new StringBuffer();
619 for (int i = 0; i < cookies.length; i++) {
620 if (i > 0) {
621 buffer.append("; ");
622 }
623 buffer.append(formatCookie(cookies[i]));
624 }
625 return buffer.toString();
626 }
627
628
629 /***
630 * Create a <tt>"Cookie"</tt> {@link Header} containing all {@link Cookie}s
631 * in <i>cookies</i>.
632 * @param cookies an array of {@link Cookie}s to be formatted as a <tt>"
633 * Cookie"</tt> header
634 * @return a <tt>"Cookie"</tt> {@link Header}.
635 */
636 public Header formatCookieHeader(Cookie[] cookies) {
637 LOG.trace("enter CookieSpecBase.formatCookieHeader(Cookie[])");
638 return new Header("Cookie", formatCookies(cookies));
639 }
640
641
642 /***
643 * Create a <tt>"Cookie"</tt> {@link Header} containing the {@link Cookie}.
644 * @param cookie <tt>Cookie</tt>s to be formatted as a <tt>Cookie</tt>
645 * header
646 * @return a Cookie header.
647 */
648 public Header formatCookieHeader(Cookie cookie) {
649 LOG.trace("enter CookieSpecBase.formatCookieHeader(Cookie)");
650 return new Header("Cookie", formatCookie(cookie));
651 }
652
653 }