Port of new AAP plugin, and new algorithm that evals all policies.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / serviceprovider / ServiceProviderConfig.java
1 /*
2  * ServiceProviderConfig.java
3  * 
4  * A ServiceProviderConfig object holds an instance of the Shibboleth
5  * configuration data from the main configuration file and from all
6  * secondary files referenced by the main file.
7  * 
8  * The configuration file is typically processed during Context 
9  * initialization. In a Servlet environment, this is done from
10  * the ServletContextInitializer, while in JUnit testing it is 
11  * done during test setup (unless you are testing configuration
12  * in which case it is part of the test itself). This occurs 
13  * during init() processing and is inheritly synchronized.
14  * 
15  * Initialization is a two step process. First create an
16  * instance of this class, then find a path to the configuration
17  * file and call loadConfigObjects().
18  * 
19  * In addition to the option of loading external classes that
20  * implement one of the Plugin service interfaces by providing
21  * the name of the class in the type= attribute of the Plugin
22  * configuration XML, there is also a manual wiring interface.
23  * Create an implimenting object yourself, then add it to the
24  * configuration by passing an identifying URI and the object 
25  * to a addOrReplaceXXXImplementation() method.
26  * 
27  * These wiring calls are agressive, while the XML is passive.
28  * If the wiring call is made before loadConfigObject(), then
29  * XML referencing this same URI will find that it has already
30  * been loaded and use it. Alternately, if the call is made
31  * after loadConfigObject() then the XML will have processed
32  * the URI, loaded the file, and built an implimenting object.
33  * However, the wiring call will replace that object with the
34  * one provided in the call. Obviously making these calls 
35  * first will be slightly more efficient, and is necessary if
36  * the XML configuration specifies URIs that will be provided
37  * by the wiring call and are not represented by any actual file.
38  * 
39  * After initialization completes, this object and its arrays
40  * and collections should be structurally immutable. A map or
41  * array should not be changed by adding or removing members.
42  * Thus iteration over the collections can be unsynchronized.
43  * The reference to a value in the map can be swapped for a 
44  * new object, because this doesn't effect iteration.
45  * 
46  * Any method may obtain a copy of the current ServiceProviderConfig
47  * object by calling ServiceProviderContext.getServiceProviderConfig().
48  * This reference should only be held locally (for the duration
49  * of the request). Should the entire Shibboleth configuration file 
50  * be reparsed (because of a dynamic update), then a new reference will
51  * be stored in the SPContext. Picking up a new reference for each
52  * request ensures that a program uses the latest configuration.
53  * 
54  * When a secondary file (Metadata, Trust, AAP, etc.) is reloaded,
55  * a new object is constructed for that interface and the entry in
56  * the corresponding Map of providers of that interface is replaced.
57  * Therefore, non-local variables must only store the URI for such
58  * objects. A method can pass the URI to the Map lookup method and
59  * obtain a local variable reference to the current implementing
60  * object which can be used during the processing of the current
61  * request. 
62  * 
63  * Note: The URI for a secondary file cannot change just by 
64  * reloading the file, but it can change if this main configuration
65  * file object is rebuilt. Therefore, if an external object stores
66  * a URI for a plugin object, it must be prepared for the Map lookup
67  * to return null. This would indicate that the main configuration 
68  * file has been reloaded and the previously valid URI now no longer
69  * points to any implementing object.
70  * 
71  * XML configuration data is parsed into two formats. First, it 
72  * is processed by an ordinary JAXP XML parser into a W3C DOM format.
73  * The parser may validate the XML against an XSD schema, but the 
74  * resulting DOM is "untyped". The XML becomes a tree of Element,
75  * Attribute, and Text nodes. The program must still convert an
76  * attribute or text string to a number, date, boolean, or any other
77  * data type even through the XSD declares that it must be of that 
78  * type. The program must also search through the elements of the tree
79  * to find specific names for expected contents.
80  * 
81  * This module then subjects the DOM to a secondary parse through
82  * some classes generated by compiling the XSD file with tools 
83  * provided by the Apache XML Bean project. This turns the valid
84  * XML into strongly typed Java objects. A class is generated to
85  * represent every data type defined in the XSD schemas. Attribute
86  * values and child elements become properties of the objects of
87  * these classes. The XMLBean objects simplify the configuration 
88  * logic.
89  * 
90  * If the configuration file directly reflected the program logic,
91  * the XML Bean classes would probably be enough. However, there
92  * are two important considerations:
93  * 
94  * First, the Metadata is in transition. Currently we support an
95  * ad-hoc format defined by Shibboleth. However, it is expected
96  * that this will change in the next release to support a new
97  * standard accompanying SAML 2.0. The program logic anticipates
98  * this change, and is largely designed around concepts and 
99  * structures of the new SAML standard. The actual configuration 
100  * file and XML Beans support the old format, which must be mapped
101  * into this new structure.
102  * 
103  * Second, secondary configuration elements (Credentials, Trust,
104  * Metadata, AAP, etc.) are "Pluggable" components. There is a 
105  * built-in implementation of these services based on the XML
106  * configuration described in the Shibboleth documentation. 
107  * However, the administrator can provide other classes that 
108  * implement the required interfaces by simply coding the class
109  * name in the type= parameter of the XML element referencing the
110  * plugin. In this case we don't know the format of the opaque
111  * XML and simply pass it to the plugin. 
112  * 
113  * 
114  * Dependencies: Requires XML Beans and the generated classes.
115  * Requires access to XSD schema files for configuration file formats.
116  * Logic depends on the order of enums in the XSD files.
117  * 
118  * Error Strategy: A failure parsing the main configuration file
119  * prevents further processing. However, a problem parsing a plug-in
120  * configuration file should be noted while processing continues.
121  * This strategy reports all the errors in all the files to the log
122  * rather than stopping at the first error.
123  * 
124  * --------------------
125  * Copyright 2002, 2004 
126  * University Corporation for Advanced Internet Development, Inc. 
127  * All rights reserved
128  * [Thats all we have to say to protect ourselves]
129  * Your permission to use this code is governed by "The Shibboleth License".
130  * A copy may be found at http://shibboleth.internet2.edu/license.html
131  * [Nothing in copyright law requires license text in every file.]
132  */
133
134 package edu.internet2.middleware.shibboleth.serviceprovider;
135
136 import java.net.MalformedURLException;
137 import java.net.URL;
138 import java.util.ArrayList;
139 import java.util.Collection;
140 import java.util.Iterator;
141 import java.util.Map;
142 import java.util.TreeMap;
143
144 import org.apache.log4j.Logger;
145 import org.apache.xmlbeans.XmlException;
146 import org.apache.xmlbeans.XmlOptions;
147 import org.opensaml.SAMLAssertion;
148 import org.opensaml.SAMLAttribute;
149 import org.opensaml.SAMLAttributeStatement;
150 import org.opensaml.SAMLException;
151 import org.opensaml.SAMLObject;
152 import org.opensaml.artifact.Artifact;
153 import org.w3c.dom.Document;
154 import org.w3c.dom.Element;
155 import org.w3c.dom.Node;
156
157 import x0.maceShibboleth1.AttributeAcceptancePolicyDocument;
158 import x0.maceShibbolethTargetConfig1.ApplicationDocument;
159 import x0.maceShibbolethTargetConfig1.PluggableType;
160 import x0.maceShibbolethTargetConfig1.RequestMapDocument;
161 import x0.maceShibbolethTargetConfig1.ShibbolethTargetConfigDocument;
162 import x0.maceShibbolethTargetConfig1.ApplicationDocument.Application;
163 import x0.maceShibbolethTargetConfig1.ApplicationsDocument.Applications;
164 import x0.maceShibbolethTargetConfig1.HostDocument.Host;
165 import x0.maceShibbolethTargetConfig1.PathDocument.Path;
166 import x0.maceShibbolethTargetConfig1.SHIREDocument.SHIRE;
167 import x0.maceShibbolethTargetConfig1.ShibbolethTargetConfigDocument.ShibbolethTargetConfig;
168 import edu.internet2.middleware.shibboleth.aap.AAP;
169 import edu.internet2.middleware.shibboleth.aap.AttributeRule;
170 import edu.internet2.middleware.shibboleth.common.Credentials;
171 import edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
172 import edu.internet2.middleware.shibboleth.common.XML;
173 import edu.internet2.middleware.shibboleth.metadata.EntityDescriptor;
174 import edu.internet2.middleware.shibboleth.metadata.Metadata;
175 import edu.internet2.middleware.shibboleth.metadata.RoleDescriptor;
176 import edu.internet2.middleware.shibboleth.xml.Parser;
177
178 /**
179  * Load the configuration files into objects, index them, and return them on request.
180  * 
181  * <p>A new instance of the ServiceProviderConfig object can be created to 
182  * parse a new version of the configuration file. It can then be swapped
183  * into the ServiceProviderContext reference and will be picked up by
184  * subsequent requests.</p>
185  * 
186  * @author Howard Gilbert
187  */
188 public class ServiceProviderConfig {
189
190         
191         private static final String INLINEURN = "urn:inlineBS:ID";
192     private static Logger log = Logger.getLogger(ServiceProviderConfig.class);
193
194         private ShibbolethTargetConfig  // The XMLBean from the main config file
195                 config = null;              // (i.e. shibboleth.xml)
196         
197         
198         /*
199          * The following Maps reference objects that implement a plugin
200          * interface indexed by their URI. There are builtin objects
201          * created from inline or external XML files, but external 
202          * objects implementing the interfaces may be injected by 
203          * calling the addOrReplaceXXX method. Public access to these
204          * Maps is indirect, through methods the ApplicationInfo object
205          * for a given configured or default application.
206          */
207         
208         private Map/*<String, Metadata>*/ entityLocators = 
209                 new TreeMap/*<String, Metadata>*/();
210         
211         public void addOrReplaceMetadataImplementor(String uri, Metadata m) {
212             entityLocators.put(uri, m);
213         }
214         
215         public Metadata getMetadataImplementor(String uri) {
216             return (Metadata)entityLocators.get(uri);
217         }
218         
219         private Map/*<String, AAP>*/ attributePolicies = 
220                 new TreeMap/*<String, AAP>*/();
221         
222         public void addOrReplaceAAPImplementor(String uri, AAP a) {
223             attributePolicies.put(uri,a);
224         }
225         
226         public AAP getAAPImplementor(String uri) {
227             return (AAP) attributePolicies.get(uri);
228         }
229         
230         private Map/*<String, ITrust>*/ certificateValidators = 
231                 new TreeMap/*<String, ITrust>*/();
232         
233         public void addOrReplaceTrustImplementor(String uri, ITrust t) {
234             certificateValidators.put(uri,t);
235         }
236         
237         public ITrust getTrustImplementor(String uri) {
238             return (ITrust) certificateValidators.get(uri);
239         }
240         
241         
242         /*
243          * Objects created from the <Application(s)> elements.
244          * They manage collections of URI-Strings that index the
245          * previous maps to return Metadata, Trust, and AAP info
246          * applicable to this applicationId.
247          */
248         private Map/*<String, ApplicationInfo>*/ applications = 
249                 new TreeMap/*<String, ApplicationInfo>*/();
250         
251         // Default application info from <Applications> element
252         private ApplicationInfo defaultApplicationInfo = null;
253
254     public ApplicationInfo getApplication(String applicationId) {
255         ApplicationInfo app=null;
256         app = (ApplicationInfo) applications.get(applicationId);
257         if (app==null)  // If no specific match, return default
258                 return defaultApplicationInfo;
259         return app;
260     }
261         
262         
263         // Objects created from single configuration file elements
264         private Credentials credentials = null;
265         private RequestMapDocument.RequestMap requestMap = null;
266         
267         
268         /*
269          * A few constants
270          */
271         private final String SCHEMADIR = "/schemas/";
272         private final String MAINSCHEMA = SCHEMADIR + XML.MAIN_SHEMA_ID;
273         //private final String METADATASCHEMA = SCHEMADIR + XML.SHIB_SCHEMA_ID;    //TODO: is this needed anymore?
274         //private final String TRUSTSCHEMA = SCHEMADIR + XML.TRUST_SCHEMA_ID;
275         //private final String AAPSCHEMA = SCHEMADIR + XML.SHIB_SCHEMA_ID;
276
277         private static final String XMLTRUSTPROVIDERTYPE = 
278                 "edu.internet2.middleware.shibboleth.common.provider.XMLTrust";
279         private static final String XMLAAPPROVIDERTYPE = 
280                 "edu.internet2.middleware.shibboleth.serviceprovider.XMLAAP";
281         private static final String XMLFEDERATIONPROVIDERTYPE = 
282                 "edu.internet2.middleware.shibboleth.common.provider.XMLMetadata";
283         private static final String XMLREVOCATIONPROVIDERTYPE =
284             "edu.internet2.middleware.shibboleth.common.provider.XMLRevocation";
285         private static final String XMLREQUESTMAPPROVIDERTYPE = 
286             "edu.internet2.middleware.shibboleth.serviceprovider.XMLRequestMap";
287         private static final String XMLCREDENTIALSPROVIDERTYPE = 
288             "edu.internet2.middleware.shibboleth.common.Credentials";
289         
290         
291         
292         
293         /**
294          * The constructor prepares for, but does not parse the configuration.
295          * 
296          * @throws ShibbolethConfigurationException
297          *        if XML Parser cannot be initialized (Classpath problem)
298          */
299         public ServiceProviderConfig() {
300         }
301
302         /**
303          * loadConfigObjects must be called once to parse the configuration.
304          * 
305          * <p>To reload a modified configuration file, create and load a second 
306          * object and swap the reference in the context object.</p>
307          * 
308          * @param configFilePath URL or resource name of file
309          * @return the DOM Document
310          * @throws ShibbolethConfigurationException
311          *             if there was an error loading the file
312          */
313         public synchronized void loadConfigObjects(String configFilePath)
314                         throws ShibbolethConfigurationException {
315             
316             if (config!=null) {
317                         log.error("ServiceProviderConfig.loadConfigObjects may not be called twice for the same object.");
318                         throw new ShibbolethConfigurationException("Cannot reload configuration into same object.");
319                 }
320
321                 Document configDoc;
322         try {
323                         configDoc = Parser.loadDom(configFilePath, true);
324                 } catch (Exception e) {
325             throw new ShibbolethConfigurationException("XML error in "+configFilePath);
326         }
327         loadConfigBean(configDoc);
328
329                 return;
330         }
331         
332         /*
333          * Given a URL, determine its ApplicationId from the RequestMap config.
334          * 
335          * <p>Note: This is not a full implementation of all RequestMap
336          * configuration options. Other functions will be added as needed.</p>
337          */
338         public String mapRequest(String urlreq) {
339             String applicationId = "default";
340             URL url;
341             
342             try {
343             url = new URL(urlreq);
344         } catch (MalformedURLException e) {
345             return applicationId;
346         }
347         
348         String urlscheme = url.getProtocol();
349         String urlhostname = url.getHost();
350         String urlpath = url.getPath();
351         int urlport = url.getPort();
352         if (urlport==0) {
353             if (urlscheme.equals("http"))
354                 urlport=80;
355             else if (urlscheme.equals("https"))
356                 urlport=443;
357         }
358         
359         // find Host entry for this virtual server
360         Host[] hostArray = requestMap.getHostArray();
361         for (int ihost=0;ihost<hostArray.length;ihost++) {
362             Host host = hostArray[ihost];
363             String hostScheme = host.getScheme().toString();
364             String hostName = host.getName();
365             String hostApplicationId = host.getApplicationId();
366             long hostport = host.getPort();
367             if (hostport==0) {
368                 if (hostScheme.equals("http"))
369                     hostport=80;
370                 else if (hostScheme.equals("https"))
371                     hostport=443;
372             }
373             
374             if (!urlscheme.equals(hostScheme) ||
375                 !urlhostname.equals(hostName)||
376                 urlport!=hostport)
377                 continue;
378             
379             // find Path entry for this subdirectory
380             Path[] pathArray = host.getPathArray();
381             if (hostApplicationId!=null)
382                 applicationId=hostApplicationId;
383             for (int i=0;i<pathArray.length;i++) {
384                 String dirname = pathArray[i].getName();
385                 if (urlpath.equals(dirname)||
386                     urlpath.startsWith(dirname+"/")){
387                     String pthid= pathArray[i].getApplicationId();
388                     if (pthid!=null)
389                         applicationId=pthid;
390                 }
391             }
392         }
393             
394             return applicationId;
395         }
396
397         /**
398          * <p>Parse the main configuration file DOM into XML Bean</p>
399          * 
400          * <p>Automatically load secondary configuration files designated
401          * by URLs in the main configuration file</p>
402          * 
403          * @throws ShibbolethConfigurationException
404          */
405         private void loadConfigBean(Document configDoc) 
406                 throws ShibbolethConfigurationException {
407             boolean anyError=false;
408                 ShibbolethTargetConfigDocument configBeanDoc;
409         try {
410                         // reprocess the already validated DOM to create a bean with typed fields
411                         // dump the trash (comments, processing instructions, extra whitespace)
412                         configBeanDoc = ShibbolethTargetConfigDocument.Factory.parse(configDoc,
413                                 new XmlOptions().setLoadStripComments().setLoadStripProcinsts().setLoadStripWhitespace());
414                         config=configBeanDoc.getShibbolethTargetConfig();
415                 } catch (XmlException e) {
416                         // Since the DOM was already validated against the schema, errors will not typically occur here
417                         log.error("Error while parsing shibboleth configuration");
418                         throw new ShibbolethConfigurationException("Error while parsing shibboleth configuration");
419                 }
420                 
421                 // Extract the "root Element" object from the "Document" object
422                 ShibbolethTargetConfig config = configBeanDoc.getShibbolethTargetConfig();
423                 
424                 Applications apps = config.getApplications(); // <Applications>
425                 
426                 
427                 
428                 /*
429                  * Create an <Application> id "default" from <Applications>
430                  */
431                 ApplicationDocument defaultAppDoc = 
432                     // Create a new XMLBeans "Document" level object
433                         ApplicationDocument.Factory.newInstance(); 
434                 ApplicationDocument.Application defaultApp = 
435                     // Add an XMLBeans "root Element" object to the Document
436                         defaultAppDoc.addNewApplication();
437                 // set or copy over fields from unrelated Applications object
438                 defaultApp.setId("default");
439                 defaultApp.setAAPProviderArray(apps.getAAPProviderArray());
440                 defaultApp.setAttributeDesignatorArray(apps.getAttributeDesignatorArray());
441                 defaultApp.setAudienceArray(apps.getAudienceArray());
442                 defaultApp.setCredentialUse(apps.getCredentialUse());
443                 defaultApp.setErrors(apps.getErrors());
444                 defaultApp.setFederationProviderArray(apps.getFederationProviderArray());
445                 defaultApp.setProviderId(apps.getProviderId());
446                 defaultApp.setRevocationProviderArray(apps.getRevocationProviderArray());
447                 defaultApp.setSessions(apps.getSessions());
448                 defaultApp.setSignedAssertions(apps.getSignedAssertions());
449                 defaultApp.setSignedResponse(apps.getSignedResponse());
450                 defaultApp.setSignRequest(apps.getSignRequest());
451                 defaultApp.setTrustProviderArray(apps.getTrustProviderArray());
452                 
453                 /*
454                  * Now process secondary files configured in the applications
455                  */
456                 anyError |= processApplication(defaultApp);
457                 
458                 Application[] apparray = apps.getApplicationArray();
459                 for (int i=0;i<apparray.length;i++){
460                         Application tempapp = apparray[i];
461                         applications.put(tempapp.getId(),tempapp);
462                         anyError |= processApplication(tempapp);
463                 }
464                 
465                 /*
466                  * Now process other secondary files
467                  */
468                 anyError |= processCredentials();
469                 anyError |= processPluggableRequestMapProvider();
470                 
471                 if (anyError)
472                     throw new ShibbolethConfigurationException("Errors processing configuration file, see log");
473         }
474
475         
476         /**
477          * Routine to handle CredentialProvider
478          * 
479          * <p>Note: This only handles in-line XML.
480          * Also, Credentials was an existing Origin class, so it doesn't
481          * implement the new PluggableConfigurationComponent interface and
482          * can't be loaded by generic plugin support.
483          * </p>
484          */
485         private boolean processCredentials() {
486             boolean anyError=false;
487             PluggableType[] pluggable = config.getCredentialsProviderArray();
488             for (int i=0;i<pluggable.length;i++) {
489                         String pluggabletype = pluggable[i].getType();
490                 if (!pluggabletype.equals(
491                         "edu.internet2.middleware.shibboleth.common.Credentials")) {
492                                 log.error("Unsupported CredentialsProvider type "+pluggabletype);
493                                 anyError=true;
494                                 continue;
495                 }
496                 PluggableType credentialsProvider = pluggable[i];
497             Node fragment = credentialsProvider.newDomNode();
498             // newDomNode returns the current node wrapped in a Fragment
499             try {
500                 Node credentialsProviderNode = fragment.getFirstChild();
501                 Node credentialsNode=credentialsProviderNode.getFirstChild();
502                 credentials = new Credentials((Element)credentialsNode);
503             } catch(Exception e) {
504                 log.error("Cannot process Credentials element of Shibboleth configuration");
505                 log.error(e);
506                 anyError=true;
507                 continue;
508             }
509             }
510             return anyError;
511         }
512
513     /**
514          * Find and load secondary configuration files referenced in an Application(s) 
515          * 
516          * @param app Application object
517          * @throws ShibbolethConfigurationException
518          */
519         private boolean processApplication(Application app) 
520                 throws ShibbolethConfigurationException {
521             
522             boolean anyError=false;
523             
524             String applicationId = app.getId();
525                 
526                 ApplicationInfo appinfo = new ApplicationInfo(app);
527                 
528                 anyError |= processPluggableMetadata(appinfo);
529                 anyError |= processPluggableAAPs(appinfo);
530                 anyError |= processPluggableTrusts(appinfo);
531                 
532                 applications.put(applicationId, appinfo);
533                 
534                 return anyError;
535         }
536
537     /**
538      * Generic code to create an object of a Pluggable type that implements
539      * a configuration interface.
540      * 
541      * <p>The configuration schema defines "PluggableType" as a type of
542      * XML element that has opaque contents and attributes "type" and 
543      * "uri". If the uri attribute is omitted, then the configuration
544      * data is inline XML content. The XSD files typically define the
545      * format of pluggable configuration elements, but without binding
546      * them to the PluggableType element that may contain them.</p>
547      * 
548      * <p>The implimentation of pluggable objects is provided by 
549      * external classes. There are "builtin" classes provided with
550      * Shibboleth (XMLMetadataImpl, XMLTrustImpl, XMLAAPImpl) that 
551      * provide examples of how this is done. By design, others can
552      * provide their own classes just by putting the class name as
553      * the value of the type attribute.</p>
554      * 
555      * <p>This routine handles the common setup. It creates objects
556      * of one of the builtin types, or it uses Class.forName() to
557      * access a user specified class. It then locates either the
558      * inline XML elements or the external XML file. It passes the
559      * XML to initialize the object. Finally, a reference to the 
560      * object is stored in the appropriate Map.</p>
561      * 
562      * <p>The objects created implement two interfaces. Mostly they
563      * implement a configuration interface (EntityDescriptor, ITrust,
564      * AAP, etc). However, for the purpose of this routine they also
565      * must be declared to implement PluggableConfigurationComponent
566      * and provide an initialize() method that parses a DOM Node 
567      * containing their root XML configuration element.</p>
568      * 
569      * @param pluggable XMLBean for element defined in XSD to be of "PluggableType"
570      * @param implclass java.lang.Class of Builtin implementation class
571      * @param interfaceClass java.lang.Class of Interface
572      * @param builtinName alias type to choose Builtin imlementation
573      * @param uriMap ApplicationInfo Map for this interface
574      * @return
575      */
576     private 
577         String 
578     processPluggable(
579             PluggableType pluggable,
580                 Class implclass,
581                 Class interfaceClass,
582                 String builtinName,
583                 //String schemaname,
584                 Map /*<String,PluggableConfigurationComponent>*/uriMap
585                 ) {
586         
587         String pluggabletype = pluggable.getType();
588         
589         if (!pluggabletype.equals(builtinName)) {
590             // Not the builtin type, try to load user class by name
591             try {
592                 implclass = Class.forName(pluggabletype);
593             } catch (ClassNotFoundException e) {
594                         log.error("Type value "+pluggabletype+" not found as supplied Java class");
595                     return null;
596             }
597             if (!interfaceClass.isAssignableFrom(implclass)||
598                 !PluggableConfigurationComponent.class.isAssignableFrom(implclass)) {
599                         log.error(pluggabletype+" class does not support required interfaces.");
600                     return null;
601             }
602         }
603         
604         PluggableConfigurationComponent impl;
605         try {
606             impl = (PluggableConfigurationComponent) implclass.newInstance();
607         } catch (Exception e) {
608             log.error("Unable to instantiate "+pluggabletype);
609             return null;
610         }
611         
612         String uri = pluggable.getUri();
613         if (uri==null) { // inline
614             
615                 uri=genDummyUri();
616                 try {
617                         Node fragment = pluggable.newDomNode();        // XML-Fragment node
618                         Node pluggableNode = fragment.getFirstChild(); // PluggableType 
619                         Node contentNode=pluggableNode.getFirstChild();// root element
620                         impl.initialize(contentNode);
621                 } catch (Exception e) {
622                         log.error("XML error " + e);
623                         return null;
624                 }
625                 
626         } else { // external file
627                 
628                 if (uriMap.get(uri)!=null) { // Already parsed this file
629                     return "";
630                 }
631                 
632             /*
633             String tempname = impl.getSchemaPathname();
634             if (tempname!=null)
635                 schemaname=tempname;
636             */
637                 try {
638                         Document extdoc = Parser.loadDom(uri,true);
639                         if (extdoc==null)
640                             return null;
641                         impl.initialize(extdoc);
642                 } catch (Exception e) {
643                         log.error("XML error " + e);
644                         return null;
645                 }
646         }
647         
648         uriMap.put(uri,impl);
649         return uri;
650     }
651         
652         
653
654         /**
655          * Handle a FederationProvider 
656          */
657         private boolean processPluggableMetadata(ApplicationInfo appinfo) {
658             boolean anyError = false;
659                 PluggableType[] pluggable = appinfo.getApplicationConfig().getFederationProviderArray();
660                 for (int i = 0;i<pluggable.length;i++) {
661                     String uri = processPluggable(pluggable[i],
662                             XMLMetadataImpl.class,
663                             Metadata.class,
664                             XMLFEDERATIONPROVIDERTYPE,
665                             //METADATASCHEMA,
666                             entityLocators);
667                     if (uri==null)
668                         anyError=true;
669                     else if (uri.length()>0) {
670                                 appinfo.addGroupUri(uri);
671                     }
672                 }
673                 return anyError;
674         }
675         
676         /**
677          * Reload XML Metadata configuration after file changed.
678          * @param uri Path to Metadata XML configuration
679          * @return true if file reloaded.
680          */
681         public boolean reloadFederation(String uri) {
682             if (getMetadataImplementor(uri)!=null||
683                     uri.startsWith(INLINEURN))
684                 return false;
685                 try {
686                         Document sitedoc = Parser.loadDom(uri,true);
687                         if (sitedoc==null)
688                             return false;
689                         XMLMetadataImpl impl = new XMLMetadataImpl();
690                         impl.initialize(sitedoc);
691                         addOrReplaceMetadataImplementor(uri,impl);
692                 } catch (Exception e) {
693                         log.error("Error while parsing Metadata file "+uri);
694                         log.error("XML error " + e);
695                         return false;
696                 }
697             return true;
698         }
699
700         /**
701          * Handle an AAPProvider element with
702          *      type="edu.internet2.middleware.shibboleth.common.provider.XMLAAP"
703          * @throws InternalConfigurationException
704          */
705         private boolean processPluggableAAPs(ApplicationInfo appinfo){
706             boolean anyError=false;
707                 PluggableType[] pluggable = appinfo.getApplicationConfig().getAAPProviderArray();
708                 for (int i = 0;i<pluggable.length;i++) {
709                     String uri = processPluggable(pluggable[i],
710                             XMLAAPImpl.class,
711                             AAP.class,
712                             XMLAAPPROVIDERTYPE,
713                             //AAPSCHEMA,
714                             attributePolicies);
715                     if (uri==null)
716                         anyError=true;
717                     else if (uri.length()>0) {
718                                 appinfo.addAapUri(uri);
719                     }
720                 }
721                 return anyError;
722         }
723         
724         /**
725          * Reload XML AAP configuration after file changed.
726          * @param uri AAP to Trust XML configuration
727          * @return true if file reloaded.
728          */
729         public boolean reloadAAP(String uri) {
730             if (getAAPImplementor(uri)!=null||
731                     uri.startsWith(INLINEURN))
732                 return false;
733                 try {
734                         Document aapdoc = Parser.loadDom(uri,true);
735                         if (aapdoc==null)
736                             return false;
737                         AttributeAcceptancePolicyDocument aap = AttributeAcceptancePolicyDocument.Factory.parse(aapdoc);
738                         XMLAAPImpl impl = new XMLAAPImpl();
739                         impl.initialize(aapdoc);
740                         addOrReplaceAAPImplementor(uri,impl);
741                 } catch (Exception e) {
742                         log.error("Error while parsing AAP file "+uri);
743                         log.error("XML error " + e);
744                         return false;
745                 }
746             return true;
747         }
748         
749         
750         /**
751          * Handle a TrustProvider element with
752          *      type="edu.internet2.middleware.shibboleth.common.provider.XMLTrust"
753          * 
754          * Note: This code builds the semantic structure of trust. That is, it knows
755          * about certificates and keys. The actual logic of Trust (signature generation
756          * and validation) is implemented in a peer object defined in the external
757          * class XMLTrustImpl.
758          * 
759          * @throws ShibbolethConfigurationException if X.509 certificate cannot be processed 
760          * @throws InternalConfigurationException
761          */
762         private boolean processPluggableTrusts(ApplicationInfo appinfo){
763             boolean anyError=false;
764                 PluggableType[] pluggable = appinfo.getApplicationConfig().getTrustProviderArray();
765                 for (int i = 0;i<pluggable.length;i++) {
766                     String uri = processPluggable(pluggable[i],
767                             XMLTrustImpl.class,
768                             ITrust.class,
769                             XMLTRUSTPROVIDERTYPE,
770                             //TRUSTSCHEMA,
771                             certificateValidators);
772                     if (uri==null)
773                         anyError=true;
774                     else if (uri.length()>0) {
775                                 appinfo.addTrustUri(uri);
776                     }
777                 }
778                 return anyError;
779         }
780
781         /**
782          * Reload XML Trust configuration after file changed.
783          * @param uri Path to Trust XML configuration
784          * @return true if file reloaded.
785          */
786         public boolean reloadTrust(String uri) {
787             if (getTrustImplementor(uri)!=null||
788                     uri.startsWith(INLINEURN))
789                 return false;
790                 try {
791                         Document trustdoc = Parser.loadDom(uri,true);
792                         if (trustdoc==null)
793                             return false;
794                         XMLTrustImpl impl = new XMLTrustImpl();
795                         impl.initialize(trustdoc);
796                         addOrReplaceTrustImplementor(uri,impl);
797                 } catch (Exception e) {
798                         log.error("Error while parsing Trust file "+uri);
799                         log.error("XML error " + e);
800                         return false;
801                 }
802             return true;
803         }
804         
805         
806         private boolean processPluggableRequestMapProvider(){
807             SHIRE shire = config.getSHIRE();
808             PluggableType mapProvider = shire.getRequestMapProvider();
809             
810             String pluggabletype = mapProvider.getType();
811             if (!pluggabletype.equals(XMLREQUESTMAPPROVIDERTYPE)) {
812                 log.error("Unsupported RequestMapProvider type "+pluggabletype);
813                 return true;
814             }
815             
816             RequestMapDocument requestMapDoc = null;
817             Document mapdoc = null;
818             Element maproot = null;
819             String uri = mapProvider.getUri();
820             
821             if (uri==null) { // inline
822                 
823                 uri=genDummyUri();
824                 try {
825                     Node fragment = mapProvider.newDomNode();
826                     Node pluggableNode = fragment.getFirstChild();
827                     Node contentNode=pluggableNode.getFirstChild();
828                     
829                     requestMapDoc = RequestMapDocument.Factory.parse(contentNode);
830                 } catch (Exception e) {
831                     log.error("Error while parsing inline RequestMap");
832                     log.error("XML error " + e);
833                     return true;
834                 }
835                 
836             } else { // external file
837                 try {
838                     mapdoc = Parser.loadDom(uri,true);
839                     if (mapdoc==null)
840                         return true;
841                     requestMapDoc = RequestMapDocument.Factory.parse(mapdoc);
842                 } catch (Exception e) {
843                     log.error("Error while parsing RequestMap file "+uri);
844                     log.error("XML error " + e);
845                     return true;
846                 }
847             }
848             
849             requestMap = requestMapDoc.getRequestMap();
850             return false;
851         }
852
853         
854         
855         private int inlinenum = 1;
856         private String genDummyUri() {
857                 return INLINEURN+Integer.toString(inlinenum++);
858         }
859         
860         
861         
862
863
864
865     /**
866          * ApplicationInfo represents the <Application(s)> object, its fields,
867          * and the pluggable configuration elements under it.
868          * 
869          * <p>It can return arrays of Metadata, Trust, or AAP providers, but
870          * it also exposes convenience methods that shop the lookup(),
871          * validate(), and trust() calls to each object in the collection
872          * until success or failure is determined.</p>
873          * 
874          * <p>For all other parameters, such as Session parameters, you
875          * can fetch the XMLBean by calling getApplicationConf() and 
876          * query their value directly.
877          */
878         public class ApplicationInfo 
879                 implements Metadata, ITrust {
880                 
881                 private Application applicationConfig;
882         public Application getApplicationConfig() {
883             return applicationConfig;
884         }
885                 
886                 /**
887                  * Construct this object from the XML Bean.
888                  * @param application XMLBean for Application element
889                  */
890                 ApplicationInfo(Application application) {
891                     this.applicationConfig=application;
892                 }
893                 
894                 
895                 /*
896                  * Following the general rule, this object may not keep 
897                  * direct references to the plugin interface implementors,
898                  * but must look them up on every call through their URI keys.
899                  * So we keep collections of URI strings instead.
900                  */
901                 ArrayList groupUris = new ArrayList();
902                 ArrayList trustUris = new ArrayList();
903                 ArrayList aapUris   =   new ArrayList();
904                 
905         void addGroupUri(String uri) {
906                         groupUris.add(uri);
907                 }
908                 void addTrustUri(String uri) {
909                         trustUris.add(uri);
910                 }
911                 void addAapUri(String uri) {
912                         aapUris.add(uri);
913                 }
914                 
915                 /**
916                  * Return the current array of objects that implement the
917                  * ...metadata.Metadata interface
918                  * 
919                  * @return Metadata[]
920                  */
921                 Metadata[] getMetadataProviders() {
922                         Iterator iuris = groupUris.iterator();
923                         int count = groupUris.size();
924                         Metadata[] metadatas = new Metadata[count];
925                         for (int i=0;i<count;i++) {
926                                 String uri =(String) iuris.next();
927                                 metadatas[i]=getMetadataImplementor(uri);
928                         }
929                         return metadatas;
930                 }
931                 
932                 /**
933                  * A convenience function based on the Metadata interface.
934                  * 
935                  * <p>Look for an entity ID through each implementor until the
936                  * first one finds locates a describing object.</p>
937                  * 
938                  * <p>Unfortunately, Metadata.lookup() was originally specified to
939                  * return a "Provider". In current SAML 2.0 terms, the object
940                  * returned should be an EntityDescriptor. So this is the new 
941                  * function in the new interface that will use the new term, but
942                  * it does the same thing.</p>
943                  *  
944                  * @param id ID of the OriginSite entity
945                  * @return EntityDescriptor metadata object for that site.
946                  */
947         public EntityDescriptor lookup(String id) {
948                         Iterator iuris = groupUris.iterator();
949                         while (iuris.hasNext()) {
950                                 String uri =(String) iuris.next();
951                                 Metadata locator=getMetadataImplementor(uri);
952                                 EntityDescriptor entity = locator.lookup(id);
953                                 if (entity!=null)
954                                         return entity;
955                         }
956                         return null;
957                 }
958
959         public EntityDescriptor lookup(Artifact artifact) {
960             Iterator iuris = groupUris.iterator();
961             while (iuris.hasNext()) {
962                 String uri =(String) iuris.next();
963                 Metadata locator=getMetadataImplementor(uri);
964                 EntityDescriptor entity = locator.lookup(artifact);
965                 if (entity!=null)
966                     return entity;
967             }
968             return null;
969         }
970         
971                 /**
972                  * Return the current array of objects that implement the ITrust interface
973                  * 
974                  * @return ITrust[]
975                  */
976                 public ITrust[] getTrustProviders() {
977                         Iterator iuris = groupUris.iterator();
978                         int count = groupUris.size();
979                         ITrust[] trusts = new ITrust[count];
980                         for (int i=0;i<count;i++) {
981                                 String uri =(String) iuris.next();
982                                 trusts[i]=getTrustImplementor(uri);
983                         }
984                         return trusts;
985                 }
986                 
987                 /**
988                  * Return the current array of objects that implement the AAP interface
989                  * 
990                  * @return AAP[]
991                  */
992                 public AAP[] getAAPProviders() {
993                         Iterator iuris = aapUris.iterator();
994                         int count = aapUris.size();
995                         AAP[] aaps = new AAP[count];
996                         for (int i=0;i<count;i++) {
997                                 String uri =(String) iuris.next();
998                                 aaps[i]=getAAPImplementor(uri);
999                         }
1000                         return aaps;
1001                 }
1002                 
1003                 /**
1004                  * Convenience function to apply AAP by calling the apply()
1005                  * method of each AAP implementor.
1006                  * 
1007                  * <p>Any AAP implementor can delete an assertion or value.
1008                  * Empty SAML elements get removed from the assertion.
1009                  * This can yield an AttributeAssertion with no attributes. 
1010                  * 
1011                  * @param assertion  SAML Attribute Assertion
1012          * @param role     Role that issued the assertion
1013                  * @throws SAMLException  Raised if assertion is mangled beyond repair
1014                  */
1015                 void applyAAP(SAMLAssertion assertion, RoleDescriptor role) throws SAMLException {
1016                     
1017                     // Foreach AAP in the collection
1018                         AAP[] providers = getAAPProviders();
1019             if (providers.length == 0) {
1020                 log.info("no filters specified, accepting entire assertion");
1021                 return;
1022             }
1023                         for (int i=0;i<providers.length;i++) {
1024                                 AAP aap = providers[i];
1025                                 if (aap.anyAttribute()) {
1026                     log.info("any attribute enabled, accepting entire assertion");
1027                                         continue;
1028                 }
1029             }
1030             
1031                         // Foreach Statement in the Assertion
1032                         Iterator statements = assertion.getStatements();
1033                         int istatement=0;
1034                         while (statements.hasNext()) {
1035                                 Object statement = statements.next();
1036                                 if (statement instanceof SAMLAttributeStatement) {
1037                                         SAMLAttributeStatement attributeStatement =     (SAMLAttributeStatement) statement;
1038                                         
1039                     // Check each attribute, applying any matching rules.
1040                                         Iterator attributes = attributeStatement.getAttributes();
1041                                         int iattribute=0;
1042                                         while (attributes.hasNext()) {
1043                                                 SAMLAttribute attribute = (SAMLAttribute) attributes.next();
1044                         boolean ruleFound = false;
1045                         for (int i=0;i<providers.length;i++) {
1046                                                 AttributeRule rule = providers[i].lookup(attribute.getName(),attribute.getNamespace());
1047                                                 if (rule!=null) {
1048                                                     ruleFound = true;
1049                                 try {
1050                                     rule.apply(attribute,role);
1051                                 }
1052                                 catch (SAMLException ex) {
1053                                     log.info("no values remain, removing attribute");
1054                                                                 attributeStatement.removeAttribute(iattribute--);
1055                                     break;
1056                                 }
1057                             }
1058                         }
1059                         if (!ruleFound) {
1060                             log.warn("no rule found for attribute (" + attribute.getName() + "), filtering it out");
1061                             attributeStatement.removeAttribute(iattribute--);
1062                         }
1063                         iattribute++;
1064                                         }
1065                     
1066                     try {
1067                         attributeStatement.checkValidity();
1068                         istatement++;
1069                                         }
1070                     catch (SAMLException ex) {
1071                         // The statement is now defunct.
1072                         log.info("no attributes remain, removing statement");
1073                                                 assertion.removeStatement(istatement);
1074                                         }
1075                                 }
1076                         }
1077
1078             // Now see if we trashed it irrevocably.
1079             assertion.checkValidity();
1080         }
1081                 
1082                 
1083                 /**
1084                  * Returns a collection of attribute names to request from the AA.
1085                  * 
1086                  * @return Collection of attribute Name values
1087                  */
1088                 public Collection getAttributeDesignators() {
1089                         // TODO Not sure where this should come from
1090                         return new ArrayList();
1091                 }
1092
1093                 
1094                 /**
1095                  * Convenience method implementing ITrust.validate() across 
1096                  * the collection of implementing objects. Returns true if
1097                  * any Trust implementor approves the signatures in the object.
1098                  * 
1099                  * <p>In the interface, validate() is passed several arguments
1100                  * that come from this object. In this function, those
1101                  * arguments are ignored "this" is used. 
1102                  */
1103                 public boolean 
1104                 validate(
1105                                 Iterator revocations,  // Currently unused 
1106                                 RoleDescriptor role,
1107                                 SAMLObject token, 
1108                                 Metadata dummy    // "this" is an EntityLocator 
1109                                         ) {
1110                         
1111                         // TODO If revocations are supported, "this" will provide them
1112                         
1113                         ITrust[] trustProviders = getTrustProviders();
1114                         for (int i=0;i<trustProviders.length;i++) {
1115                                 ITrust trust = trustProviders[i];
1116                                 if (trust.validate(null,role,token,this))
1117                                         return true;
1118                         }
1119                         return false;
1120                 }
1121                 
1122                 /**
1123                  * Simpler version of validate that avoids dummy arguments
1124                  * 
1125                  * @param role  Entity that sent Token (from Metadata)
1126                  * @param token Signed SAMLObject
1127                  * @return
1128                  */
1129                 public boolean validate(RoleDescriptor role, SAMLObject token) {
1130                         return validate(null,role,token,null);
1131                 }
1132
1133                 /**
1134                  * A method of ITrust that we must declare to claim that 
1135                  * ApplicationInfo implements ITrust. However, no code in the
1136                  * ServiceProvider calls this (probably an Origin thing).
1137                  * 
1138                  * @param revocations
1139                  * @param role
1140                  * @return  This dummy always returns false.
1141                  */
1142                 public boolean attach(Iterator revocations, RoleDescriptor role) {
1143                         // Unused
1144                         return false;
1145                 }
1146         }
1147         
1148
1149         
1150         private static class InternalConfigurationException extends Exception {
1151             InternalConfigurationException() {
1152                 super();
1153             }
1154         }
1155         
1156 }