Sort out Pluggable interface and delete the middlemen
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / metadata / provider / XMLMetadataProvider.java
index 068c90f..e9b50dc 100644 (file)
@@ -1,27 +1,17 @@
 /*
- * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
- * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
- * provided that the following conditions are met: Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the
- * above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other
- * materials provided with the distribution, if any, must include the following acknowledgment: "This product includes
- * software developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu>Internet2
- * Project. Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
- * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2,
- * nor the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
- * products derived from this software without specific prior written permission. For written permission, please
- * contact shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2,
- * UCAID, or the University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name,
- * without prior written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS
- * PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
- * NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS
- * WITH LICENSEE. IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED
- * INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
- * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
- * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
- * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
- * POSSIBILITY OF SUCH DAMAGE.
+ * Copyright [2005] [University Corporation for Advanced Internet Development, Inc.]
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
  */
 
 package edu.internet2.middleware.shibboleth.metadata.provider;
@@ -39,11 +29,13 @@ import java.util.Iterator;
 import java.util.Map;
 import java.util.TimeZone;
 
-import org.apache.commons.codec.binary.Hex;
+import javax.xml.namespace.QName;
+
 import org.apache.log4j.Logger;
 import org.apache.xml.security.encryption.EncryptionMethod;
 import org.apache.xml.security.exceptions.XMLSecurityException;
 import org.apache.xml.security.keys.KeyInfo;
+import org.bouncycastle.util.encoders.Hex;
 import org.opensaml.SAMLAttribute;
 import org.opensaml.SAMLBinding;
 import org.opensaml.SAMLBrowserProfile;
@@ -61,11 +53,12 @@ import org.w3c.dom.NodeList;
 
 import edu.internet2.middleware.shibboleth.common.Constants;
 import edu.internet2.middleware.shibboleth.metadata.*;
+import edu.internet2.middleware.shibboleth.serviceprovider.PluggableConfigurationComponent;
 
 /**
  * @author Scott Cantor
  */
-public class XMLMetadataProvider implements Metadata {
+public class XMLMetadataProvider implements Metadata, PluggableConfigurationComponent {
 
        private static Logger log = Logger.getLogger(XMLMetadataProvider.class.getName());
        private Map     /* <String,ArrayList<EntityDescriptor> > */ sites = new HashMap();
@@ -74,7 +67,13 @@ public class XMLMetadataProvider implements Metadata {
     private XMLEntitiesDescriptor rootGroup = null;
 
        public XMLMetadataProvider(Element e) throws SAMLException {
-        if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"EntitiesDescriptor"))
+        initialize(e);
+       }
+       
+       public XMLMetadataProvider() {} // Must call initialize
+
+       public void initialize(Element e) throws SAMLException {
+               if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"EntitiesDescriptor"))
             rootGroup=new XMLEntitiesDescriptor(e,this, Long.MAX_VALUE, null);
         else if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"EntityDescriptor"))
             rootProvider=new XMLEntityDescriptor(e,this, Long.MAX_VALUE, null);
@@ -315,14 +314,41 @@ public class XMLMetadataProvider implements Metadata {
         }
     }
 
+    class XMLKeyAuthority implements KeyAuthority {
+        private int depth = 1;
+        private ArrayList /* <KeyInfo> */ keys = new ArrayList();
+        
+        XMLKeyAuthority(Element e) {
+            if (e.hasAttributeNS(null,"VerifyDepth"))
+                depth = Integer.parseInt(e.getAttributeNS(null,"VerifyDepth"));
+            e = XML.getFirstChildElement(e, XML.XMLSIG_NS, "KeyInfo");
+            while (e != null) {
+                try {
+                    keys.add(new KeyInfo(e, null));
+                }
+                catch (XMLSecurityException e1) {
+                    log.error("unable to process ds:KeyInfo element: " + e1.getMessage());
+                }
+                e = XML.getNextSiblingElement(e, XML.XMLSIG_NS, "KeyInfo");
+            }
+        }
+        
+        public int getVerifyDepth() {
+            return depth;
+        }
+
+        public Iterator getKeyInfos() {
+            return keys.iterator();
+        }
+        
+    }
+        
     class XMLOrganization implements Organization {
-        private Element root = null;
         private HashMap /* <String,String> */ names = new HashMap();
         private HashMap /* <String,String> */ displays = new HashMap();
         private HashMap /* <String,URL> */ urls = new HashMap();
 
         public XMLOrganization(Element e) throws MetadataException {
-            root = e;
             e=XML.getFirstChildElement(e);
             while (e != null) {
                 if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"OrganizationName")) {
@@ -402,7 +428,6 @@ public class XMLMetadataProvider implements Metadata {
             }
             else {
                 rawType = root.getAttributeNS(null,"contactType");
-                Node n=null;
                 e=XML.getFirstChildElement(root);
                 while (e != null) {
                     if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"Company")) {
@@ -501,7 +526,7 @@ public class XMLMetadataProvider implements Metadata {
                         formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
                     formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
                     try {
-                        validUntil=Math.min(validUntil,formatter.parse(dateTime).getTime());
+                        this.validUntil=Math.min(validUntil,formatter.parse(dateTime).getTime());
                     }
                     catch (ParseException e1) {
                         log.warn("Role descriptor contains invalid expiration time");
@@ -600,10 +625,14 @@ public class XMLMetadataProvider implements Metadata {
                     nameid.add(new XMLEndpoint((Element)nlist.item(i)));
 
                 nlist=e.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"NameIDFormat");
-                for (i=0; i<nlist.getLength(); i++) {
-                    if (nlist.item(i).hasChildNodes())
-                        formats.add(nlist.item(i).getNodeValue());
-                }
+                for (i = 0; i < nlist.getLength(); i++) {
+                                       if (nlist.item(i).hasChildNodes()) {
+                                               Node tnode = nlist.item(i).getFirstChild();
+                                               if (tnode != null && tnode.getNodeType() == Node.TEXT_NODE) {
+                                                       formats.add(tnode.getNodeValue());
+                                               }
+                                       }
+                               }
             }
             else {
                 // For old style, we just do SAML 1.1 compatibility with Shib handles.
@@ -655,7 +684,7 @@ public class XMLMetadataProvider implements Metadata {
                     if (ext1 != null && ext1.hasChildNodes())
                         sourceId=ext1.getFirstChild().getNodeValue();
                     // Save off any domain elements for later.
-                    domains = ext.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SHIBMETA_NS,"Domain");
+                    domains = ext.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SHIBMETA_NS,"Scope");
                 }
                 
                 int i;
@@ -699,6 +728,7 @@ public class XMLMetadataProvider implements Metadata {
                 }
             }
             else {
+               protocolEnum.add(edu.internet2.middleware.shibboleth.common.XML.SHIB_NS);
                 attrprofs.add(Constants.SHIB_ATTRIBUTE_NAMESPACE_URI);
                 int i;
                 domains = e.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SHIB_NS,"Domain");
@@ -765,7 +795,7 @@ public class XMLMetadataProvider implements Metadata {
         }
     }
 
-    class AARole extends SSORole implements AttributeAuthorityDescriptor, ScopedRoleDescriptor {
+    class AARole extends Role implements AttributeAuthorityDescriptor, ScopedRoleDescriptor {
         private ArrayList /* <Scope> */ scopes = new ArrayList();
         private XMLEndpointManager query = new XMLEndpointManager();
         private XMLEndpointManager idreq = new XMLEndpointManager();
@@ -784,7 +814,7 @@ public class XMLMetadataProvider implements Metadata {
                 Element ext=XML.getFirstChildElement(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"Extensions");
                 if (ext != null) {
                     // Save off any domain elements for later.
-                    domains = ext.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SHIBMETA_NS,"Domain");
+                    domains = ext.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SHIBMETA_NS,"Scope");
                 }
                 
                 int i;
@@ -828,6 +858,7 @@ public class XMLMetadataProvider implements Metadata {
                 protocolEnum.add(XML.SAML11_PROTOCOL_ENUM);
                 formats.add(Constants.SHIB_NAMEID_FORMAT_URI);
                 attrprofs.add(Constants.SHIB_ATTRIBUTE_NAMESPACE_URI);
+                domains = e.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SHIB_NS,"Domain");
                 int i;
                 NodeList nlist=e.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SHIB_NS,"AttributeAuthority");
                 for (i=0; i<nlist.getLength(); i++) {
@@ -885,6 +916,10 @@ public class XMLMetadataProvider implements Metadata {
         public Iterator getAttributes() {
             return attrs.iterator();
         }
+
+        public Iterator getNameIDFormats() {
+            return formats.iterator();
+        }
     }
     
     class SPRole extends SSORole implements SPSSODescriptor {
@@ -894,7 +929,6 @@ public class XMLMetadataProvider implements Metadata {
         
         public SPRole(XMLEntityDescriptor provider, long validUntil, Element e) throws MetadataException {
             super(provider, validUntil, e);
-            // TODO Auto-generated constructor stub
 
             // Check the root element namespace. If SAML2, assume it's the std schema.
             if (edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS.equals(e.getNamespaceURI())) {
@@ -985,8 +1019,53 @@ public class XMLMetadataProvider implements Metadata {
             return null;
         }
     }
+
+    class AttributeRequesterRole extends Role implements AttributeRequesterDescriptor {
+        private boolean wantAssertionsSigned = false;
+        private ArrayList /* <String> */ formats = new ArrayList();
+        
+        public AttributeRequesterRole(XMLEntityDescriptor provider, long validUntil, Element e) throws MetadataException {
+            super(provider, validUntil, e);
+
+            String flag=XML.assign(e.getAttributeNS(null,"WantAssertionsSigned"));
+            wantAssertionsSigned=(XML.safeCompare(flag,"1") || XML.safeCompare(flag,"true"));
+
+            NodeList nlist=e.getElementsByTagNameNS(edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"NameIDFormat");
+            for (int i = 0; i < nlist.getLength(); i++) {
+                if (nlist.item(i).hasChildNodes()) {
+                    Node tnode = nlist.item(i).getFirstChild();
+                    if (tnode != null && tnode.getNodeType() == Node.TEXT_NODE) {
+                        formats.add(tnode.getNodeValue());
+                    }
+                }
+            }
+        }
+
+        public boolean getWantAssertionsSigned() {
+            return wantAssertionsSigned;
+        }
+
+        public Iterator getNameIDFormats() {
+            return formats.iterator();
+        }
+
+        public Iterator getAttributeConsumingServices() {
+            // TODO Auto-generated method stub
+            return null;
+        }
+
+        public AttributeConsumingService getDefaultAttributeConsumingService() {
+            // TODO Auto-generated method stub
+            return null;
+        }
+
+        public AttributeConsumingService getAttributeConsumingServiceByID(String id) {
+            // TODO Auto-generated method stub
+            return null;
+        }
+    }
     
-    class XMLEntityDescriptor implements EntityDescriptor {
+    class XMLEntityDescriptor implements ExtendedEntityDescriptor {
         private Element root = null;
         private EntitiesDescriptor parent = null;
         private String id = null;
@@ -996,7 +1075,8 @@ public class XMLMetadataProvider implements Metadata {
         private ArrayList /* <RoleDescriptor> */ roles = new ArrayList();
         private AffiliationDescriptor affiliation = null;
         private HashMap /* <String,String> */ locs = new HashMap();
-        private long validUntil = 0;
+        private long validUntil = Long.MAX_VALUE;
+        private ArrayList /* <KeyAuthority> */ keyauths = new ArrayList();
         
         public XMLEntityDescriptor(Element e, XMLMetadataProvider wrapper, long validUntil, EntitiesDescriptor parent) throws SAMLException {
             root = e;
@@ -1017,7 +1097,7 @@ public class XMLMetadataProvider implements Metadata {
                         formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
                     formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
                     try {
-                        validUntil=Math.min(validUntil,formatter.parse(dateTime).getTime());
+                        this.validUntil=Math.min(validUntil,formatter.parse(dateTime).getTime());
                     }
                     catch (ParseException e1) {
                         log.warn("Entity descriptor contains invalid expiration time");
@@ -1027,7 +1107,14 @@ public class XMLMetadataProvider implements Metadata {
                 Element child=XML.getFirstChildElement(e);
                 while (child != null) {
                     // Process the various kinds of children that we care about...
-                    if (XML.isElementNamed(child,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"ContactPerson")) {
+                    if (XML.isElementNamed(child,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"Extensions")) {
+                        Element ext = XML.getFirstChildElement(child,edu.internet2.middleware.shibboleth.common.XML.SHIBMETA_NS,"KeyAuthority");
+                        while (ext != null) {
+                            keyauths.add(new XMLKeyAuthority(ext));
+                            ext = XML.getNextSiblingElement(ext,edu.internet2.middleware.shibboleth.common.XML.SHIBMETA_NS,"KeyAuthority");
+                        }
+                    }
+                    else if (XML.isElementNamed(child,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"ContactPerson")) {
                         contacts.add(new XMLContactPerson(child));
                     }
                     else if (XML.isElementNamed(child,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"Organization")) {
@@ -1047,6 +1134,12 @@ public class XMLMetadataProvider implements Metadata {
                     else if (XML.isElementNamed(child,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"SPSSODescriptor")) {
                         roles.add(new SPRole(this,validUntil,child));
                     }
+                    else if (XML.isElementNamed(child,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"RoleDescriptor")) {
+                        QName xsitype = XML.getQNameAttribute(child,XML.XSI_NS,"type");
+                        if (edu.internet2.middleware.shibboleth.common.XML.SAML2METAEXT_NS.equals(xsitype.getNamespaceURI()) &&
+                                "AttributeRequesterDescriptorType".equals(xsitype.getLocalPart()))
+                            roles.add(new AttributeRequesterRole(this,validUntil,child));
+                    }
                     child = XML.getNextSiblingElement(child);
                 }
             }
@@ -1121,7 +1214,7 @@ public class XMLMetadataProvider implements Metadata {
                     else {
                         String sourceId;
                         try {
-                            sourceId = new String(Hex.encodeHex(Util.generateSourceId(id)));
+                            sourceId = new String(Hex.encode(Util.generateSourceId(id)));
                         }
                         catch (NoSuchAlgorithmException e1) {
                             log.error("caught exception while encoding sourceId: " + e1.getMessage());
@@ -1189,6 +1282,10 @@ public class XMLMetadataProvider implements Metadata {
             return (AttributeAuthorityDescriptor)getRoleByType(AttributeAuthorityDescriptor.class, protocol);
         }
 
+        public AttributeRequesterDescriptor getAttributeRequesterDescriptor(String protocol) {
+            return (AttributeRequesterDescriptor)getRoleByType(AttributeRequesterDescriptor.class, protocol);
+        }
+        
         public PDPDescriptor getPDPDescriptor(String protocol) {
             return (PDPDescriptor)getRoleByType(PDPDescriptor.class, protocol);
         }
@@ -1224,15 +1321,20 @@ public class XMLMetadataProvider implements Metadata {
         public URL getErrorURL() {
             return errorURL;
         }
+
+        public Iterator getKeyAuthorities() {
+            return keyauths.iterator();
+        }
     }
     
-    class XMLEntitiesDescriptor implements EntitiesDescriptor {
+    class XMLEntitiesDescriptor implements ExtendedEntitiesDescriptor {
         private Element root = null;
         private EntitiesDescriptor parent = null;
         private String name = null;
         private ArrayList /* <EntitiesDescriptor> */ groups = new ArrayList();
         private ArrayList /* <EntityDescriptor> */ providers = new ArrayList();
         private long validUntil = Long.MAX_VALUE;
+        private ArrayList /* <KeyAuthority> */ keyauths = new ArrayList();
         
         public XMLEntitiesDescriptor(Element e, XMLMetadataProvider wrapper, long validUntil, EntitiesDescriptor parent) throws SAMLException {
             root = e;
@@ -1253,7 +1355,7 @@ public class XMLMetadataProvider implements Metadata {
                         formatter = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");
                     formatter.setTimeZone(TimeZone.getTimeZone("UTC"));
                     try {
-                        validUntil=Math.min(validUntil,formatter.parse(dateTime).getTime());
+                        this.validUntil=Math.min(validUntil,formatter.parse(dateTime).getTime());
                     }
                     catch (ParseException e1) {
                         log.warn("Entities descriptor contains invalid expiration time");
@@ -1262,7 +1364,14 @@ public class XMLMetadataProvider implements Metadata {
 
                 e = XML.getFirstChildElement(e);
                 while (e != null) {
-                    if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"EntitiesDescriptor"))
+                    if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"Extensions")) {
+                        Element ext = XML.getFirstChildElement(e,edu.internet2.middleware.shibboleth.common.XML.SHIBMETA_NS,"KeyAuthority");
+                        while (ext != null) {
+                            keyauths.add(new XMLKeyAuthority(ext));
+                            ext = XML.getNextSiblingElement(ext,edu.internet2.middleware.shibboleth.common.XML.SHIBMETA_NS,"KeyAuthority");
+                        }
+                    }
+                    else if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"EntitiesDescriptor"))
                         groups.add(new XMLEntitiesDescriptor(e, wrapper, this.validUntil, this));
                     else if (XML.isElementNamed(e,edu.internet2.middleware.shibboleth.common.XML.SAML2META_NS,"EntityDescriptor"))
                         providers.add(new XMLEntityDescriptor(e, wrapper, this.validUntil, this));
@@ -1306,5 +1415,9 @@ public class XMLMetadataProvider implements Metadata {
         public Element getElement() {
             return root;
         }
+
+        public Iterator getKeyAuthorities() {
+            return keyauths.iterator();
+        }
     }
 }