1fc4750f348efc31c549c7985d88f22fecc62b6a
[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.*;
53 import java.text.*;
54 import java.util.*;
55 import javax.servlet.*;
56 import javax.servlet.http.*;
57 import edu.internet2.middleware.shibboleth.common.*;
58 import org.opensaml.*;
59 import org.apache.log4j.Logger;
60
61 public class HandleServlet extends HttpServlet {
62
63     private HandleRepositoryFactory hrf;
64     private long ticketExp; 
65     private HandleServiceSAML hsSAML;
66     private String rep;
67     private static Logger log = Logger.getLogger(HandleServlet.class.getName());; 
68
69     public void init(ServletConfig conf)
70         throws ServletException
71     {
72         super.init(conf);
73         ServletConfig sc = getServletConfig();
74         ServletContext sctx = sc.getServletContext();
75
76         getInitParams();
77         log.info("HS: Loading init params");
78         System.err.println("HS: initializing");
79
80         try {
81             edu.internet2.middleware.eduPerson.Init.init();
82             InputStream is = sctx.getResourceAsStream
83                 (getInitParameter("KSpath"));
84             hsSAML = new HandleServiceSAML( getInitParameter("domain"), 
85                                             getInitParameter("AAurl"),
86                                             getInitParameter("HSname"),
87                                             getInitParameter("KSpass"),
88                                             getInitParameter("KSkeyalias"),
89                                             getInitParameter("KSkeypass"),
90                                             getInitParameter("certalias"),
91                                             is );
92             
93             log.info("HS: Initializing Handle Repository with "+rep+" repository type.");
94             hrf = getHandleRepository();
95         }
96         catch (SAMLException ex) {
97             log.fatal("Error initializing SAML libraries: "+ ex);
98             throw new ServletException( "Error initializing SAML libraries: " + ex );
99         }
100         catch (java.security.KeyStoreException ex) {
101             log.fatal("Error initializing private KeyStore: "+ex);
102             throw new ServletException( "Error initializing private KeyStore: " + ex );
103         }
104         catch (RuntimeException ex) {
105             log.fatal("Error initializing eduPerson.Init: "+ ex); 
106             throw new ServletException( "Error initializing eduPerson.Init: "+ ex); 
107         }
108         catch (HandleException ex) {
109             log.fatal("Error initializing Handle Service: " +ex );
110             throw new ServletException( "Error initializing Handle Service: " +ex );
111         }
112         catch (Exception ex) {
113             log.fatal("Error in initialization: " +ex );
114             throw new ServletException( "Error in initialization: " +ex );
115         }
116
117         if (hsSAML == null) {
118             log.fatal("Error initializing SAML libraries: No Profile created." );
119             throw new ServletException( "Error initializing SAML libraries: No Profile created." );
120         }  
121
122     }
123
124
125     private void getInitParams() throws ServletException {
126
127         String ticket = getInitParameter("ticket");
128         if (ticket == null) {
129             ticket = "1400000";
130         }
131         ticketExp = Long.parseLong(ticket);
132
133         if ( getInitParameter("domain") == null || 
134              getInitParameter("domain").equals("")) {
135             throw new ServletException("Cannot find host domain in init parameters");
136         }
137         if ( getInitParameter("AAurl") == null || 
138              getInitParameter("AAurl").equals("")) {
139             throw new ServletException("Cannot find host Attribute Authority location in init parameters");
140         }
141         if ( getInitParameter("HSname") == null || 
142              getInitParameter("HSname").equals("")) {
143             throw new ServletException("Cannot find Handle Service name in init parameters");
144         }
145         if ( getInitParameter("KSpath") == null || 
146              getInitParameter("KSpath").equals("")) {
147             throw new ServletException("Cannot find path to KeyStore file in init parameters");
148         }
149         if ( getInitParameter("KSpass") == null || 
150              getInitParameter("KSpass").equals("")) {
151             throw new ServletException("Cannot find password to KeyStore in init parameters");
152         }
153         if ( getInitParameter("KSkeyalias") == null || 
154              getInitParameter("KSkeyalias").equals("")) {
155             throw new ServletException("Cannot find private key alias to KeyStore in init parameters");
156         }
157         if ( getInitParameter("KSkeypass") == null || 
158              getInitParameter("KSkeypass").equals("")) {
159             throw new ServletException("Cannot find private key password to Keystore in init parameters");
160         }
161         if ( getInitParameter("certalias") == null || 
162              getInitParameter("certalias").equals("")) {
163             throw new ServletException("Cannot find certificate alias in init parameters");
164         }
165         rep = getInitParameter("repository");
166         if ( rep == null || rep.equals("")) {
167             rep = "MEMORY"; 
168         }
169     }
170
171
172     public void doGet(HttpServletRequest req, 
173                       HttpServletResponse res)
174         throws ServletException, IOException
175     {
176
177
178
179         HandleEntry he = null;
180
181         try {
182             checkRequestParams(req);
183
184             req.setAttribute("shire", req.getParameter("shire"));
185             req.setAttribute("target", req.getParameter("target"));
186
187             he = new HandleEntry(req.getRemoteUser(), req.getAuthType(), ticketExp);
188             log.info("Issued Handle (" + he.getHandle() + ") to (" + he.getUsername() + ")");
189             hrf.insertHandleEntry( he );
190             
191             byte[] buf = hsSAML.prepare
192                 ( he.getHandle(), req.getParameter("shire"), 
193                   req.getRemoteAddr(), he.getAuthType(), 
194                   new Date(he.getAuthInstant()));
195
196             createForm( req, res, buf );
197         }
198         catch (HandleException ex) {
199             log.error(ex);
200             handleError( req, res, ex );
201         }
202
203     }
204     
205     private void createForm( HttpServletRequest req, 
206                              HttpServletResponse res,
207                              byte[] buf )  
208         throws HandleException
209     {
210         try {
211             /**
212              * forwarding to hs.jsp for submission
213              */
214             //Hardcoded to ASCII to ensure Base64 encoding compatibility
215             req.setAttribute("assertion", new String(buf, "ASCII"));
216             RequestDispatcher rd = req.getRequestDispatcher("/hs.jsp");
217             rd.forward(req, res);
218             
219         } catch (IOException ex) {
220             throw new HandleException
221                 ("IO interruption while displaying Handle Service UI." + ex);
222         } 
223         
224           catch (ServletException ex) {
225             throw new HandleException
226                 ("Problem displaying Handle Service UI." + ex);
227         }
228
229     }
230
231     private void handleError( HttpServletRequest req, 
232                              HttpServletResponse res,
233                              Exception e )  
234         throws ServletException, IOException {
235
236         req.setAttribute("errorText", e.toString());
237         req.setAttribute("requestURL", req.getRequestURI().toString());
238         RequestDispatcher rd = req.getRequestDispatcher("/hserror.jsp");
239         
240         rd.forward(req, res);
241         
242     }
243
244                      
245     private void checkRequestParams( HttpServletRequest req )
246         throws HandleException {
247
248         if ( req.getParameter("target") == null 
249              || req.getParameter("target").equals("")) {
250             throw new HandleException("Invalid data from SHIRE: no target URL received.");
251         }
252         if ((req.getParameter("shire") == null)
253             || (req.getParameter("shire").equals(""))) {
254             throw new HandleException("Invalid data from SHIRE: No acceptance URL received.");
255         }
256         if ((req.getRemoteUser() == null)
257             || (req.getRemoteUser().equals(""))) {
258             throw new HandleException("Unable to authenticate remote user");
259         }
260         if ((req.getAuthType() == null) || (req.getAuthType().equals(""))) {
261             throw new HandleException("Unable to obtain authentication type of user.");
262         }
263         if ((req.getRemoteAddr() == null)
264             || (req.getRemoteAddr().equals(""))) {
265             throw new HandleException("Unable to obtain client address.");
266         }    
267     }
268
269
270     private synchronized HandleRepositoryFactory getHandleRepository()
271         throws HandleException{
272
273         ServletConfig sc = getServletConfig();
274         ServletContext sctx = sc.getServletContext(); 
275         HandleRepositoryFactory hrf = (HandleRepositoryFactory)sctx.getAttribute("HandleRepository");
276
277         log.debug("Context attribute for HandleRepository: "+hrf);
278             
279         if(hrf == null){
280             // make one
281             String repositoryType = this.getServletContext().getInitParameter("repository");
282             hrf = HandleRepositoryFactory.getInstance(Constants.POLICY_CLUBSHIB,
283                                                       repositoryType,
284                                                       this );
285             sctx.setAttribute("HandleRepository", hrf);
286             log.info("A new HandleRepository created by HS: "+hrf);
287         }
288         return hrf;
289     }
290 }
291
292     
293