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