Trim trailing whitespace from config properties, since this seems to cause hard to...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / AAServlet.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;
51
52 import java.io.ByteArrayOutputStream;
53 import java.io.IOException;
54 import java.io.PrintStream;
55 import java.net.MalformedURLException;
56 import java.net.URI;
57 import java.net.URISyntaxException;
58 import java.net.URL;
59 import java.security.Principal;
60 import java.util.ArrayList;
61 import java.util.Arrays;
62 import java.util.Enumeration;
63 import java.util.Iterator;
64 import java.util.List;
65 import java.util.Properties;
66
67 import javax.servlet.ServletException;
68 import javax.servlet.UnavailableException;
69 import javax.servlet.http.HttpServlet;
70 import javax.servlet.http.HttpServletRequest;
71 import javax.servlet.http.HttpServletResponse;
72
73 import org.apache.log4j.Logger;
74 import org.apache.log4j.MDC;
75 import org.opensaml.QName;
76 import org.opensaml.SAMLAttribute;
77 import org.opensaml.SAMLException;
78 import org.opensaml.SAMLIdentifier;
79
80 import edu.internet2.middleware.shibboleth.aa.arp.ArpEngine;
81 import edu.internet2.middleware.shibboleth.aa.arp.ArpException;
82 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver;
83 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolverException;
84 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
85 import edu.internet2.middleware.shibboleth.common.ShibResource;
86 import edu.internet2.middleware.shibboleth.hs.HandleRepository;
87 import edu.internet2.middleware.shibboleth.hs.HandleRepositoryException;
88 import edu.internet2.middleware.shibboleth.hs.HandleRepositoryFactory;
89 import edu.internet2.middleware.shibboleth.hs.InvalidHandleException;
90
91 /**
92  *  Attribute Authority & Release Policy
93  *  Handles Initialization and incoming requests to AA
94  *
95  * @author Parviz Dousti (dousti@cmu.edu)
96  * @author      Walter Hoehn (wassa@columbia.edu)
97  */
98
99 public class AAServlet extends HttpServlet {
100
101     protected AAResponder responder;
102     protected HandleRepository handleRepository;
103     protected Properties configuration;
104     private static Logger log = Logger.getLogger(AAServlet.class.getName());    
105     
106         public void init() throws ServletException {
107                 super.init();
108
109                 MDC.put("serviceId", "[AA] Core");
110                 log.info("Initializing Attribute Authority.");
111
112                 try {
113
114                         configuration = loadConfiguration();
115
116                         ArpEngine arpEngine = new ArpEngine(configuration);
117                         AttributeResolver resolver = new AttributeResolver(configuration);
118
119                         handleRepository = HandleRepositoryFactory.getInstance(configuration);
120
121                         responder = new AAResponder(arpEngine, resolver);
122
123                         log.info("Attribute Authority initialization complete.");
124
125                 } catch (ArpException ae) {
126                         log.fatal("The AA could not be initialized due to a problem with the ARP Engine configuration: " + ae);
127                         throw new UnavailableException("Attribute Authority failed to initialize.");
128                 } catch (AttributeResolverException ne) {
129                         log.fatal("The AA could not be initialized due to a problem with the Attribute Resolver configuration: " + ne);
130                         throw new UnavailableException("Attribute Authority failed to initialize.");
131                 } catch (AAException ae) {
132                         log.fatal("The AA could not be initialized: " + ae);
133                         throw new UnavailableException("Attribute Authority failed to initialize.");
134                 } catch (HandleRepositoryException he) {
135                         log.fatal(
136                                 "The AA could not be initialized due to a problem with the Handle Repository configuration: " + he);
137                         throw new UnavailableException("Attribute Authority failed to initialize.");
138                 }
139         }
140         protected Properties loadConfiguration() throws AAException {
141
142                 //Set defaults
143                 Properties defaultProps = new Properties();
144                 defaultProps.setProperty(
145                         "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository.Path",
146                         "/conf/arps/");
147                 defaultProps.setProperty(
148                                         "edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver.ResolverConfig",
149                                         "/conf/resolver.xml");
150                 defaultProps.setProperty(
151                         "edu.internet2.middleware.shibboleth.aa.arp.ArpRepository.implementation",
152                         "edu.internet2.middleware.shibboleth.aa.arp.provider.FileSystemArpRepository");
153                 defaultProps.setProperty(
154                         "edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePath",
155                         "/conf/handle.jks");
156                 defaultProps.setProperty("edu.internet2.middleware.shibboleth.audiences", "urn:mace:incommon:pilot");
157                 defaultProps.setProperty("edu.internet2.middleware.shibboleth.aa.AAServlet.passThruErrors", "false");
158
159                 //Load from file
160                 Properties properties = new Properties(defaultProps);
161                 String propertiesFileLocation = getInitParameter("OriginPropertiesFile");
162                 if (propertiesFileLocation == null) {
163                         propertiesFileLocation = "/conf/origin.properties";
164                 }
165                 try {
166                         log.debug("Loading Configuration from (" + propertiesFileLocation + ").");
167                         properties.load(new ShibResource(propertiesFileLocation, this.getClass()).getInputStream());
168
169                         //Make sure we have all required parameters
170                         StringBuffer missingProperties = new StringBuffer();
171                         String[] requiredProperties =
172                                 {
173                                         "edu.internet2.middleware.shibboleth.aa.AAServlet.authorityName",
174                                         "edu.internet2.middleware.shibboleth.aa.arp.ArpRepository.implementation",
175                                         "edu.internet2.middleware.shibboleth.audiences" };
176
177                         for (int i = 0; i < requiredProperties.length; i++) {
178                                 if (properties.getProperty(requiredProperties[i]) == null) {
179                                         missingProperties.append("\"");
180                                         missingProperties.append(requiredProperties[i]);
181                                         missingProperties.append("\" ");
182                                 }
183                         }
184                         if (missingProperties.length() > 0) {
185                                 log.error(
186                                         "Missing configuration data.  The following configuration properites have not been set: "
187                                                 + missingProperties.toString());
188                                 throw new AAException("Missing configuration data.");
189                         }
190
191                 } catch (IOException e) {
192                         log.error("Could not load AA servlet configuration: " + e);
193                         throw new AAException("Could not load AA servlet configuration.");
194                 }
195
196                 if (log.isDebugEnabled()) {
197                         ByteArrayOutputStream debugStream = new ByteArrayOutputStream();
198                         PrintStream debugPrinter = new PrintStream(debugStream);
199                         properties.list(debugPrinter);
200                         log.debug(
201                                 "Runtime configuration parameters: " + System.getProperty("line.separator") + debugStream.toString());
202                         try {
203                                 debugStream.close();
204                         } catch (IOException e) {
205                                 log.error("Encountered a problem cleaning up resources: could not close debug stream.");
206                         }
207                 }
208                 
209                 //Be nice and trim "extra" whitespace from config properties
210                 Enumeration propNames = properties.propertyNames();
211                 while (propNames.hasMoreElements()) {
212                         String propName = (String) propNames.nextElement();
213                         if (properties.getProperty(propName, "").matches(".+\\s$")) {
214                                 log.debug(
215                                         "The configuration property ("
216                                                 + propName
217                                                 + ") contains trailing whitespace.  Trimming... ");
218                                 properties.setProperty(propName, properties.getProperty(propName).trim());
219                         }
220                 }
221
222                 return properties;
223         }
224
225         public void doPost(HttpServletRequest req, HttpServletResponse resp)
226                 throws ServletException, IOException {
227
228                 MDC.put("serviceId", "[AA] " + new SAMLIdentifier().toString());
229                 MDC.put("remoteAddr", req.getRemoteAddr());
230                 log.info("Handling request.");
231
232                 AASaml saml = null;
233
234                 try {
235                         saml =
236                                 new AASaml(
237                                         configuration.getProperty(
238                                                 "edu.internet2.middleware.shibboleth.aa.AAServlet.authorityName"),
239                                         configuration.getProperty("edu.internet2.middleware.shibboleth.audiences").replaceAll(
240                                                 "\\s",
241                                                 "").split(
242                                                 ","));
243                         saml.receive(req);
244
245                         log.info("Attribute Query Handle for this request: (" + saml.getHandle() + ").");
246                         Principal principal = null;
247                         if (saml.getHandle().equalsIgnoreCase("foo")) {
248                                 // for testing
249                                 principal = new AuthNPrincipal("test-handle");
250                         } else {
251                                 principal = handleRepository.getPrincipal(saml.getHandle());
252                         }
253
254                         URL resource = null;
255                         try {
256                                 resource = new URL(saml.getResource());
257                         } catch (MalformedURLException mue) {
258                                 log.error(
259                                         "Request contained an improperly formatted resource identifier.  Attempting to "
260                                                 + "handle request without one.");
261                         }
262
263                         if (saml.getShar() == null || saml.getShar().equals("")) {
264                                 log.info("Request is from an unauthenticated SHAR.");
265                         } else {
266                                 log.info("Request is from SHAR: (" + saml.getShar() + ").");
267                         }
268
269                         List attrs;
270                         Iterator requestedAttrsIterator = saml.getDesignators();
271                         if (requestedAttrsIterator.hasNext()) {
272                                 log.info("Request designates specific attributes, resolving this set.");
273                                 ArrayList requestedAttrs = new ArrayList();
274                                 while (requestedAttrsIterator.hasNext()) {
275                                         SAMLAttribute attribute = (SAMLAttribute) requestedAttrsIterator.next();
276                                         try {
277                                                 log.debug("Designated attribute: (" + attribute.getName() + ")");
278                                                 requestedAttrs.add(new URI(attribute.getName()));
279                                         } catch (URISyntaxException use) {
280                                                 log.error(
281                                                         "Request designated an attribute name that does not conform to the required URI syntax ("
282                                                                 + attribute.getName()
283                                                                 + ").  Ignoring this attribute");
284                                         }
285                                 }
286                                 attrs =
287                                         Arrays.asList(
288                                                 responder.getReleaseAttributes(
289                                                         principal,
290                                                         saml.getShar(),
291                                                         resource,
292                                                         (URI[]) requestedAttrs.toArray(new URI[0])));
293                         } else {
294                                 log.info("Request does not designate specific attributes, resolving all available.");
295                                 attrs = Arrays.asList(responder.getReleaseAttributes(principal, saml.getShar(), resource));
296                         }
297
298                         log.info("Found " + attrs.size() + " attribute(s) for " + principal.getName());
299                         saml.respond(resp, attrs, null);
300                         log.info("Successfully responded about " + principal.getName());
301
302                 } catch (InvalidHandleException e) {
303                         log.info("Could not associate the Attribute Query Handle with a principal: " + e);
304                         try {
305                                 QName[] codes =
306                                         {
307                                                 SAMLException.REQUESTER,
308                                                 new QName(edu.internet2.middleware.shibboleth.common.XML.SHIB_NS, "InvalidHandle")};
309                                 if (configuration
310                                         .getProperty("edu.internet2.middleware.shibboleth.aa.AAServlet.passThruErrors", "false")
311                                         .equals("true")) {
312                                         saml.fail(
313                                                 resp,
314                                                 new SAMLException(
315                                                         Arrays.asList(codes),
316                                                         "The supplied Attribute Query Handle was unrecognized or expired.",
317                                                         e));
318
319                                 } else {
320                                         saml.fail(
321                                                 resp,
322                                                 new SAMLException(
323                                                         Arrays.asList(codes),
324                                                         "The supplied Attribute Query Handle was unrecognized or expired."));
325                                 }
326                                 return;
327                         } catch (Exception ee) {
328                                 log.fatal("Could not construct a SAML error response: " + ee);
329                                 throw new ServletException("Attribute Authority response failure.");
330                         }
331
332                 } catch (Exception e) {
333                         log.error("Error while processing request: " + e);
334                         try {
335                                 if (configuration
336                                         .getProperty("edu.internet2.middleware.shibboleth.aa.AAServlet.passThruErrors", "false")
337                                         .equals("true")) {
338                                         saml.fail(
339                                                 resp,
340                                                 new SAMLException(SAMLException.RESPONDER, "General error processing request.", e));
341                                 } else {
342                                         saml.fail(
343                                                 resp,
344                                                 new SAMLException(SAMLException.RESPONDER, "General error processing request."));
345                                 }
346                                 return;
347                         } catch (Exception ee) {
348                                 log.fatal("Could not construct a SAML error response: " + ee);
349                                 throw new ServletException("Attribute Authority response failure.");
350                         }
351
352                 }
353         }
354
355
356 }