Provided a mechanism for AuthN systems to supply the actual time of user authenticati...
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / provider / SSOHandler.java
1 /*
2  * The Shibboleth License, Version 1. Copyright (c) 2002 University Corporation for Advanced Internet Development, Inc.
3  * All rights reserved Redistribution and use in source and binary forms, with or without modification, are permitted
4  * provided that the following conditions are met: Redistributions of source code must retain the above copyright
5  * notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above
6  * copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials
7  * provided with the distribution, if any, must include the following acknowledgment: "This product includes software
8  * developed by the University Corporation for Advanced Internet Development <http://www.ucaid.edu> Internet2 Project.
9  * Alternately, this acknowledegement may appear in the software itself, if and wherever such third-party
10  * acknowledgments normally appear. Neither the name of Shibboleth nor the names of its contributors, nor Internet2, nor
11  * the University Corporation for Advanced Internet Development, Inc., nor UCAID may be used to endorse or promote
12  * products derived from this software without specific prior written permission. For written permission, please contact
13  * shibboleth@shibboleth.org Products derived from this software may not be called Shibboleth, Internet2, UCAID, or the
14  * University Corporation for Advanced Internet Development, nor may Shibboleth appear in their name, without prior
15  * written permission of the University Corporation for Advanced Internet Development. THIS SOFTWARE IS PROVIDED BY THE
16  * COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE
18  * DISCLAIMED AND THE ENTIRE RISK OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. IN NO
19  * EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC.
20  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
21  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
23  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 package edu.internet2.middleware.shibboleth.idp.provider;
27
28 import java.text.ParseException;
29 import java.text.SimpleDateFormat;
30 import java.util.Date;
31
32 import javax.servlet.http.HttpServletRequest;
33
34 import org.apache.log4j.Logger;
35 import org.opensaml.SAMLException;
36 import org.w3c.dom.Element;
37
38 import edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
39 import edu.internet2.middleware.shibboleth.idp.IdPProtocolHandler;
40 import edu.internet2.middleware.shibboleth.idp.InvalidClientDataException;
41
42 /**
43  * @author Walter Hoehn
44  */
45 public abstract class SSOHandler extends BaseHandler implements IdPProtocolHandler {
46
47         private static Logger log = Logger.getLogger(BaseHandler.class.getName());
48
49         /**
50          * Required DOM-based constructor.
51          */
52         public SSOHandler(Element config) throws ShibbolethConfigurationException {
53
54                 super(config);
55
56         }
57
58         public static void validateEngineData(HttpServletRequest req) throws InvalidClientDataException {
59
60                 if ((req.getRemoteAddr() == null) || (req.getRemoteAddr().equals(""))) { throw new InvalidClientDataException(
61                                 "Unable to obtain client address."); }
62         }
63
64         protected Date getAuthNTime(HttpServletRequest request) throws SAMLException {
65
66                 // Determine, if possible, when the authentication actually happened
67                 String suppliedAuthNInstant = request.getHeader("SAMLAuthenticationInstant");
68                 if (suppliedAuthNInstant != null && !suppliedAuthNInstant.equals("")) {
69                         try {
70                                 return new SimpleDateFormat().parse(suppliedAuthNInstant);
71                         } catch (ParseException e) {
72                                 log.error("An error was encountered while receiving authentication "
73                                                 + "instant from authentication mechanism: " + e);
74                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.");
75                         }
76                 } else {
77                         return new Date(System.currentTimeMillis());
78                 }
79         }
80 }