Added option to indirect username from different header
[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 String username=null;
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
80         try {
81             edu.internet2.middleware.eduPerson.Init.init();
82             InputStream is = sctx.getResourceAsStream(getInitParameter("KSpath"));
83             hsSAML = new HandleServiceSAML( getInitParameter("domain"), 
84                                             getInitParameter("AAurl"),
85                                             getInitParameter("HSname"),
86                                             getInitParameter("KSpass"),
87                                             getInitParameter("KSkeyalias"),
88                                             getInitParameter("KSkeypass"),
89                                             getInitParameter("certalias"),
90                                             is );
91             
92             log.info("HS: Initializing Handle Repository with "+rep+" repository type.");
93             hrf = getHandleRepository();
94         }
95         catch (SAMLException ex) {
96             log.fatal("Error initializing SAML libraries: "+ ex);
97             throw new ServletException( "Error initializing SAML libraries: " + ex );
98         }
99         catch (java.security.KeyStoreException ex) {
100             log.fatal("Error initializing private KeyStore: "+ex);
101             throw new ServletException( "Error initializing private KeyStore: " + ex );
102         }
103         catch (RuntimeException ex) {
104             log.fatal("Error initializing eduPerson.Init: "+ ex); 
105             throw new ServletException( "Error initializing eduPerson.Init: "+ ex); 
106         }
107         catch (HandleException ex) {
108             log.fatal("Error initializing Handle Service: " +ex );
109             throw new ServletException( "Error initializing Handle Service: " +ex );
110         }
111         catch (Exception ex) {
112             log.fatal("Error in initialization: " +ex );
113             throw new ServletException( "Error in initialization: " +ex );
114         }
115
116         if (hsSAML == null) {
117             log.fatal("Error initializing SAML libraries: No Profile created." );
118             throw new ServletException( "Error initializing SAML libraries: No Profile created." );
119         }  
120
121     }
122
123
124     private void getInitParams() throws ServletException {
125
126         String ticket = getInitParameter("ticket");
127         if (ticket == null) {
128             ticket = "1400000";
129         }
130         ticketExp = Long.parseLong(ticket);
131
132         username=getInitParameter("username");
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(
189                 (username==null || username.equalsIgnoreCase("REMOTE_USER")) ? req.getRemoteUser() : req.getHeader(username),
190                 req.getAuthType(),
191                 ticketExp );
192             log.info("Issued Handle (" + he.getHandle() + ") to (" + he.getUsername() + ")");
193             hrf.insertHandleEntry( he );
194             
195             byte[] buf = hsSAML.prepare
196                 ( he.getHandle(), req.getParameter("shire"), 
197                   req.getRemoteAddr(), he.getAuthType(), 
198                   new Date(he.getAuthInstant()));
199
200             createForm( req, res, buf );
201         }
202         catch (HandleException ex) {
203             log.error(ex);
204             handleError( req, res, ex );
205         }
206
207     }
208     
209     private void createForm( HttpServletRequest req, 
210                              HttpServletResponse res,
211                              byte[] buf )  
212         throws HandleException
213     {
214         try {
215             /**
216              * forwarding to hs.jsp for submission
217              */
218             //Hardcoded to ASCII to ensure Base64 encoding compatibility
219             req.setAttribute("assertion", new String(buf, "ASCII"));
220             RequestDispatcher rd = req.getRequestDispatcher("/hs.jsp");
221             rd.forward(req, res);
222             
223         } catch (IOException ex) {
224             throw new HandleException
225                 ("IO interruption while displaying Handle Service UI." + ex);
226         } 
227         
228           catch (ServletException ex) {
229             throw new HandleException
230                 ("Problem displaying Handle Service UI." + ex);
231         }
232
233     }
234
235     private void handleError( HttpServletRequest req, 
236                              HttpServletResponse res,
237                              Exception e )  
238         throws ServletException, IOException {
239
240         req.setAttribute("errorText", e.toString());
241         req.setAttribute("requestURL", req.getRequestURI().toString());
242         RequestDispatcher rd = req.getRequestDispatcher("/hserror.jsp");
243         
244         rd.forward(req, res);
245         
246     }
247
248                      
249     private void checkRequestParams( HttpServletRequest req )
250         throws HandleException {
251
252         if ( req.getParameter("target") == null 
253              || req.getParameter("target").equals("")) {
254             throw new HandleException("Invalid data from SHIRE: no target URL received.");
255         }
256         if ((req.getParameter("shire") == null)
257             || (req.getParameter("shire").equals(""))) {
258             throw new HandleException("Invalid data from SHIRE: No acceptance URL received.");
259         }
260         if ((req.getRemoteUser() == null)
261             || (req.getRemoteUser().equals(""))) {
262             throw new HandleException("Unable to authenticate remote user");
263         }
264         if ((req.getAuthType() == null) || (req.getAuthType().equals(""))) {
265             throw new HandleException("Unable to obtain authentication type of user.");
266         }
267         if ((req.getRemoteAddr() == null)
268             || (req.getRemoteAddr().equals(""))) {
269             throw new HandleException("Unable to obtain client address.");
270         }    
271     }
272
273
274     private synchronized HandleRepositoryFactory getHandleRepository()
275         throws HandleException{
276
277         ServletConfig sc = getServletConfig();
278         ServletContext sctx = sc.getServletContext(); 
279         HandleRepositoryFactory hrf = (HandleRepositoryFactory)sctx.getAttribute("HandleRepository");
280
281         log.debug("Context attribute for HandleRepository: "+hrf);
282             
283         if(hrf == null){
284             // make one
285             String repositoryType = this.getServletContext().getInitParameter("repository");
286             hrf = HandleRepositoryFactory.getInstance(Constants.POLICY_CLUBSHIB,
287                                                       repositoryType,
288                                                       this );
289             sctx.setAttribute("HandleRepository", hrf);
290             log.info("A new HandleRepository created by HS: "+hrf);
291         }
292         return hrf;
293     }
294 }
295
296     
297