src/edu/internet2/middleware/shibboleth/aa/arp/provider/ResourceTreeMatchFunction.java

   1 /*
   2  * The Shibboleth License, Version 1.
   3  * Copyright (c) 2002
   4  * University Corporation for Advanced Internet Development, Inc.
   5  * All rights reserved
   6  *
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *
  11  * Redistributions of source code must retain the above copyright notice, this
  12  * list of conditions and the following disclaimer.
  13  *
  14  * Redistributions in binary form must reproduce the above copyright notice,
  15  * this list of conditions and the following disclaimer in the documentation
  16  * and/or other materials provided with the distribution, if any, must include
  17  * the following acknowledgment: "This product includes software developed by
  18  * the University Corporation for Advanced Internet Development
  19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement
  20  * may appear in the software itself, if and wherever such third-party
  21  * acknowledgments normally appear.
  22  *
  23  * Neither the name of Shibboleth nor the names of its contributors, nor
  24  * Internet2, nor the University Corporation for Advanced Internet Development,
  25  * Inc., nor UCAID may be used to endorse or promote products derived from this
  26  * software without specific prior written permission. For written permission,
  27  * please contact shibboleth@shibboleth.org
  28  *
  29  * Products derived from this software may not be called Shibboleth, Internet2,
  30  * UCAID, or the University Corporation for Advanced Internet Development, nor
  31  * may Shibboleth appear in their name, without prior written permission of the
  32  * University Corporation for Advanced Internet Development.
  33  *
  34  *
  35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
  38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK
  39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE.
  40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY
  41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT,
  42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  48  */
  49
  50 package edu.internet2.middleware.shibboleth.aa.arp.provider;
  51
  52 import edu.internet2.middleware.shibboleth.aa.arp.MatchFunction;
  53 import edu.internet2.middleware.shibboleth.aa.arp.MatchingException;
  54
  55 import org.apache.log4j.Logger;
  56
  57 import java.net.MalformedURLException;
  58 import java.net.URL;
  59
  60 /**
  61  * MatchFuction implementation that does "tail" matching on resources.
  62  *
  63  * @author Walter Hoehn (wassa&#064;columbia.edu)
  64  */
  65 public class ResourceTreeMatchFunction implements MatchFunction {
  66         private static Logger log = Logger.getLogger(ResourceTreeMatchFunction.class.getName());
  67
  68         /**
  69          * @see edu.internet2.middleware.shibboleth.aa.arp.MatchFunction#match(Object,
  70          *              Object)
  71          */
  72         public boolean match(Object arpComponent, Object requestComponent)
  73                 throws MatchingException
  74         {
  75                 if (!(arpComponent instanceof String) && !(requestComponent instanceof URL)) {
  76                         log.error("Invalid use of ARP matching function (ExacthSharMatchFunction).");
  77                         throw new MatchingException(
  78                                 "Invalid use of ARP matching function (ExacthSharMatchFunction).");
  79                 }
  80
  81                 URL arpURL = null;
  82
  83                 try {
  84                         arpURL = new URL((String) arpComponent);
  85                 } catch (MalformedURLException e) {
  86                         log.error(
  87                                 "Invalid use of ARP matching function (ResourceTreeMatchFunction): ARP Component is not a URL.");
  88                         throw new MatchingException(
  89                                 "Invalid use of ARP matching function (ResourceTreeMatchFunction).");
  90                 }
  91
  92                 if (!matchProtocol(arpURL, (URL) requestComponent)) {
  93                         return false;
  94                 }
  95
  96                 if (!matchHost(arpURL, (URL) requestComponent)) {
  97                         return false;
  98                 }
  99
 100                 if (!matchPort(arpURL, (URL) requestComponent)) {
 101                         return false;
 102                 }
 103
 104                 if (!matchPath(arpURL, (URL) requestComponent)) {
 105                         return false;
 106                 }
 107
 108                 if (!matchQuery(arpURL, (URL) requestComponent)) {
 109                         return false;
 110                 }
 111
 112                 return true;
 113         }
 114
 115         protected boolean matchHost(URL arpURL, URL requestURL) {
 116                 return arpURL.getHost().equals(requestURL.getHost());
 117         }
 118
 119         protected boolean matchPath(URL arpURL, URL requestURL) {
 120                 String arpPath = arpURL.getPath();
 121
 122                 if (arpPath.equals("")) {
 123                         arpPath = "/";
 124                 }
 125
 126                 String requestPath = requestURL.getPath();
 127
 128                 if (requestPath.equals("")) {
 129                         requestPath = "/";
 130                 }
 131
 132                 return requestPath.startsWith(arpPath);
 133         }
 134
 135         protected boolean matchPort(URL arpURL, URL requestURL) {
 136                 int arpPort = arpURL.getPort();
 137
 138                 if (arpPort < 1) {
 139                         arpPort = arpURL.getDefaultPort();
 140                 }
 141
 142                 int requestPort = requestURL.getPort();
 143
 144                 if (requestPort < 1) {
 145                         requestPort = requestURL.getDefaultPort();
 146                 }
 147
 148                 if (arpPort == requestPort) {
 149                         return true;
 150                 }
 151
 152                 return false;
 153         }
 154
 155         protected boolean matchProtocol(URL arpURL, URL requestURL) {
 156                 return arpURL.getProtocol().equals(requestURL.getProtocol());
 157         }
 158
 159         protected boolean matchQuery(URL arpURL, URL requestURL) {
 160                 if (arpURL.getQuery() == null) {
 161                         return true;
 162                 }
 163
 164                 return arpURL.getQuery().equals(requestURL.getQuery());
 165         }
 166 }