More specific errors in the HS.
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / hs / HandleServlet.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.hs;
51
52 import java.io.ByteArrayOutputStream;
53 import java.io.IOException;
54 import java.io.PrintStream;
55 import java.security.KeyStore;
56 import java.security.KeyStoreException;
57 import java.security.NoSuchAlgorithmException;
58 import java.security.PrivateKey;
59 import java.security.UnrecoverableKeyException;
60 import java.security.cert.Certificate;
61 import java.security.cert.CertificateException;
62 import java.util.Arrays;
63 import java.util.Collections;
64 import java.util.Date;
65 import java.util.Properties;
66
67 import javax.servlet.RequestDispatcher;
68 import javax.servlet.ServletException;
69 import javax.servlet.UnavailableException;
70 import javax.servlet.http.HttpServlet;
71 import javax.servlet.http.HttpServletRequest;
72 import javax.servlet.http.HttpServletResponse;
73
74 import org.apache.log4j.Logger;
75 import org.apache.log4j.MDC;
76 import org.doomdark.uuid.UUIDGenerator;
77 import org.opensaml.QName;
78 import org.opensaml.SAMLAuthorityBinding;
79 import org.opensaml.SAMLBinding;
80 import org.opensaml.SAMLException;
81 import org.opensaml.SAMLResponse;
82 import sun.misc.BASE64Decoder;
83
84 import edu.internet2.middleware.shibboleth.common.AuthNPrincipal;
85 import edu.internet2.middleware.shibboleth.common.Constants;
86 import edu.internet2.middleware.shibboleth.common.ShibPOSTProfile;
87 import edu.internet2.middleware.shibboleth.common.ShibPOSTProfileFactory;
88
89 public class HandleServlet extends HttpServlet {
90
91         protected Properties configuration;
92         protected HandleRepository handleRepository;
93         protected ShibPOSTProfile postProfile;
94         private static Logger log = Logger.getLogger(HandleServlet.class.getName());
95         private Certificate[] certificates;
96         private PrivateKey privateKey;
97         protected Properties loadConfiguration() throws HSConfigurationException {
98
99                 //Set defaults
100                 Properties defaultProps = new Properties();
101                 defaultProps.setProperty(
102                         "edu.internet2.middleware.shibboleth.hs.HandleRepository.implementation",
103                         "edu.internet2.middleware.shibboleth.hs.provider.MemoryHandleRepository");
104                 defaultProps.setProperty("edu.internet2.middleware.shibboleth.hs.BaseHandleRepository.handleTTL", "1800000");
105                 defaultProps.setProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.issuer", "shib2.internet2.edu");
106                 defaultProps.setProperty(
107                         "edu.internet2.middleware.shibboleth.hs.provider.CryptoHandleRepository.keyStorePath",
108                         getServletContext().getRealPath("/WEB-INF/conf/handle.jks"));
109
110                 //Load from file
111                 Properties properties = new Properties(defaultProps);
112                 String propertiesFileLocation = getInitParameter("OriginPropertiesFile");
113                 if (propertiesFileLocation == null) {
114                         propertiesFileLocation = "/WEB-INF/conf/origin.properties";
115                 }
116                 try {
117                         log.debug("Loading Configuration from (" + propertiesFileLocation + ").");
118                         properties.load(getServletContext().getResourceAsStream(propertiesFileLocation));
119                 } catch (IOException e) {
120                         log.error("Could not load HS servlet configuration: " + e);
121                         throw new HSConfigurationException("Could not load HS servlet configuration.");
122                 }
123
124                 if (log.isDebugEnabled()) {
125                         ByteArrayOutputStream debugStream = new ByteArrayOutputStream();
126                         PrintStream debugPrinter = new PrintStream(debugStream);
127                         properties.list(debugPrinter);
128                         log.debug(
129                                 "Runtime configuration parameters: " + System.getProperty("line.separator") + debugStream.toString());
130                 }
131
132                 return properties;
133         }
134
135         public void init() throws ServletException {
136                 super.init();
137                 MDC.put("serviceId", "[HS] Core");
138                 try {
139                         log.info("Initializing Handle Service.");
140                         configuration = loadConfiguration();
141
142                         edu.internet2.middleware.eduPerson.Init.init();
143
144                         initPKI();
145
146                         postProfile =
147                                 ShibPOSTProfileFactory.getInstance(
148                                         Arrays.asList(new String[] { Constants.POLICY_CLUBSHIB }),
149                                         configuration.getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.issuer"));
150
151                         handleRepository = HandleRepositoryFactory.getInstance(configuration);
152                         log.info("Handle Service initialization complete.");
153
154                 } catch (SAMLException ex) {
155                         log.fatal("Error initializing SAML libraries: " + ex);
156                         throw new UnavailableException("Handle Service failed to initialize.");
157                 } catch (HSConfigurationException ex) {
158                         log.fatal("Handle Service runtime configuration error.  Please fix and re-initialize. Cause: " + ex);
159                         throw new UnavailableException("Handle Service failed to initialize.");
160                 } catch (HandleRepositoryException ex) {
161                         log.fatal("Unable to load Handle Repository: " + ex);
162                         throw new UnavailableException("Handle Service failed to initialize.");
163                 }
164         }
165
166         protected void initPKI() throws HSConfigurationException {
167                 try {
168                         KeyStore keyStore = KeyStore.getInstance("JKS");
169
170                         keyStore.load(
171                                 getServletContext().getResourceAsStream(
172                                         configuration.getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePath")),
173                                 configuration
174                                         .getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStorePassword")
175                                         .toCharArray());
176
177                         privateKey =
178                                 (PrivateKey) keyStore.getKey(
179                                         configuration.getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyAlias"),
180                                         configuration
181                                                 .getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyPassword")
182                                                 .toCharArray());
183
184                         if (configuration.getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.certAlias") != null) {
185                                 certificates =
186                                         keyStore.getCertificateChain(
187                                                 configuration.getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.certAlias"));
188                         } else {
189                                 certificates =
190                                         keyStore.getCertificateChain(
191                                                 configuration.getProperty(
192                                                         "edu.internet2.middleware.shibboleth.hs.HandleServlet.keyStoreKeyAlias"));
193                         }
194                 } catch (KeyStoreException e) {
195                         throw new HSConfigurationException("An error occurred while accessing the java keystore: " + e);
196                 } catch (NoSuchAlgorithmException e) {
197                         throw new HSConfigurationException("Appropriate JCE provider not found in the java environment: " + e);
198                 } catch (CertificateException e) {
199                         throw new HSConfigurationException(
200                                 "The java keystore contained a certificate that could not be loaded: " + e);
201                 } catch (IOException e) {
202                         throw new HSConfigurationException("An error occurred while reading the java keystore: " + e);
203                 } catch (UnrecoverableKeyException e) {
204                         throw new HSConfigurationException(
205                                 "An error occurred while attempting to load the key from the java keystore: " + e);
206                 }
207         }
208         public void doGet(HttpServletRequest req, HttpServletResponse res) throws ServletException, IOException {
209
210                 log.debug("Recieved a request.");
211                 MDC.put("serviceId", "[HS] " + UUIDGenerator.getInstance().generateRandomBasedUUID());
212                 MDC.put("remoteAddr", req.getRemoteAddr());
213                 log.info("Handling request.");
214
215                 try {
216                         checkRequestParams(req);
217
218                         req.setAttribute("shire", req.getParameter("shire"));
219                         req.setAttribute("target", req.getParameter("target"));
220
221                         String handle = handleRepository.getHandle(new AuthNPrincipal(req.getRemoteUser()));
222                         log.info("Issued Handle (" + handle + ") to (" + req.getRemoteUser() + ")");
223
224                         byte[] buf = generateAssertion(handle, req.getParameter("shire"), req.getRemoteAddr(), req.getAuthType());
225
226                         createForm(req, res, buf);
227
228                 } catch (HandleRepositoryException ex) {
229                         log.error(ex);
230                         handleError(req, res, ex);
231                         return;
232                 } catch (InvalidClientDataException ex) {
233                         log.error(ex);
234                         handleError(req, res, ex);
235                         return;
236                 } catch (SAMLException ex) {
237                         log.error(ex);
238                         handleError(req, res, ex);
239                         return;
240                 }
241
242         }
243
244         protected byte[] generateAssertion(String handle, String shireURL, String clientAddress, String authType)
245                 throws SAMLException, IOException {
246
247                 SAMLAuthorityBinding binding =
248                         new SAMLAuthorityBinding(
249                                 SAMLBinding.SAML_SOAP_HTTPS,
250                                 configuration.getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.AAUrl"),
251                                 new QName(org.opensaml.XML.SAMLP_NS, "AttributeQuery"));
252
253                 SAMLResponse r =
254                         postProfile.prepare(
255                                 shireURL,
256                                 handle,
257                                 configuration.getProperty("edu.internet2.middleware.shibboleth.hs.HandleServlet.authenticationDomain"),
258                                 clientAddress,
259                                 authType,
260                                 new Date(System.currentTimeMillis()),
261                                 Collections.singleton(binding),
262                                 privateKey,
263                                 Arrays.asList(certificates),
264                                 null,
265                                 null);
266                                 
267                 return r.toBase64();
268         }
269
270         protected void createForm(HttpServletRequest req, HttpServletResponse res, byte[] buf)
271                 throws IOException, ServletException {
272
273                 //Hardcoded to ASCII to ensure Base64 encoding compatibility
274                 req.setAttribute("assertion", new String(buf, "ASCII"));
275
276                 if (log.isDebugEnabled()) {
277                         try {
278                                 log.debug(
279                                         "Dumping generated SAML Response:"
280                                                 + System.getProperty("line.separator")
281                                                 + new String(new BASE64Decoder().decodeBuffer(new String(buf, "ASCII")), "UTF8"));
282                         } catch (IOException e) {
283                                 log.error("Encountered an error while decoding SAMLReponse for logging purposes.");
284                         }
285                 }
286
287                 RequestDispatcher rd = req.getRequestDispatcher("/hs.jsp");
288                 rd.forward(req, res);
289         }
290
291         protected void handleError(HttpServletRequest req, HttpServletResponse res, Exception e)
292                 throws ServletException, IOException {
293
294                 req.setAttribute("errorText", e.toString());
295                 req.setAttribute("requestURL", req.getRequestURI().toString());
296                 RequestDispatcher rd = req.getRequestDispatcher("/hserror.jsp");
297
298                 rd.forward(req, res);
299
300         }
301
302         protected void checkRequestParams(HttpServletRequest req) throws InvalidClientDataException {
303
304                 if (req.getParameter("target") == null || req.getParameter("target").equals("")) {
305                         throw new InvalidClientDataException("Invalid data from SHIRE: no target URL received.");
306                 }
307                 if ((req.getParameter("shire") == null) || (req.getParameter("shire").equals(""))) {
308                         throw new InvalidClientDataException("Invalid data from SHIRE: No acceptance URL received.");
309                 }
310                 if ((req.getRemoteUser() == null) || (req.getRemoteUser().equals(""))) {
311                         throw new InvalidClientDataException("Unable to authenticate remote user");
312                 }
313                 if ((req.getRemoteAddr() == null) || (req.getRemoteAddr().equals(""))) {
314                         throw new InvalidClientDataException("Unable to obtain client address.");
315                 }
316         }
317
318         class InvalidClientDataException extends Exception {
319                 public InvalidClientDataException(String message) {
320                         super(message);
321                 }
322         }
323 }
324
325
326     
327