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