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