View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  package org.apache.http.impl.cookie;
28  
29  import java.util.Locale;
30  import java.util.StringTokenizer;
31  
32  import org.apache.http.annotation.Immutable;
33  import org.apache.http.cookie.Cookie;
34  import org.apache.http.cookie.CookieOrigin;
35  import org.apache.http.cookie.CookieRestrictionViolationException;
36  import org.apache.http.cookie.MalformedCookieException;
37  import org.apache.http.util.Args;
38  
39  /**
40   *
41   * @since 4.0
42   */
43  @Immutable
44  public class NetscapeDomainHandler extends BasicDomainHandler {
45  
46      public NetscapeDomainHandler() {
47          super();
48      }
49  
50      @Override
51      public void validate(final Cookie cookie, final CookieOrigin origin)
52              throws MalformedCookieException {
53          super.validate(cookie, origin);
54          // Perform Netscape Cookie draft specific validation
55          final String host = origin.getHost();
56          final String domain = cookie.getDomain();
57          if (host.contains(".")) {
58              final int domainParts = new StringTokenizer(domain, ".").countTokens();
59  
60              if (isSpecialDomain(domain)) {
61                  if (domainParts < 2) {
62                      throw new CookieRestrictionViolationException("Domain attribute \""
63                          + domain
64                          + "\" violates the Netscape cookie specification for "
65                          + "special domains");
66                  }
67              } else {
68                  if (domainParts < 3) {
69                      throw new CookieRestrictionViolationException("Domain attribute \""
70                          + domain
71                          + "\" violates the Netscape cookie specification");
72                  }
73              }
74          }
75      }
76  
77     /**
78      * Checks if the given domain is in one of the seven special
79      * top level domains defined by the Netscape cookie specification.
80      * @param domain The domain.
81      * @return True if the specified domain is "special"
82      */
83     private static boolean isSpecialDomain(final String domain) {
84         final String ucDomain = domain.toUpperCase(Locale.ENGLISH);
85         return ucDomain.endsWith(".COM")
86                 || ucDomain.endsWith(".EDU")
87                 || ucDomain.endsWith(".NET")
88                 || ucDomain.endsWith(".GOV")
89                 || ucDomain.endsWith(".MIL")
90                 || ucDomain.endsWith(".ORG")
91                 || ucDomain.endsWith(".INT");
92     }
93  
94     @Override
95     public boolean match(final Cookie cookie, final CookieOrigin origin) {
96         Args.notNull(cookie, "Cookie");
97         Args.notNull(origin, "Cookie origin");
98         final String host = origin.getHost();
99         final String domain = cookie.getDomain();
100        if (domain == null) {
101            return false;
102        }
103        return host.endsWith(domain);
104    }
105 
106 }