Authentication engine rewrite to properly support force and passive authentication
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / authn / Saml2LoginContext.java
1 /*
2  * Copyright [2006] [University Corporation for Advanced Internet Development, Inc.]
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package edu.internet2.middleware.shibboleth.idp.authn;
18
19 import java.io.Serializable;
20 import java.io.StringReader;
21 import java.io.StringWriter;
22 import java.util.ArrayList;
23 import java.util.List;
24
25 import javax.xml.parsers.DocumentBuilder;
26 import javax.xml.parsers.DocumentBuilderFactory;
27
28 import org.opensaml.Configuration;
29 import org.opensaml.saml2.core.AuthnContextClassRef;
30 import org.opensaml.saml2.core.AuthnContextComparisonTypeEnumeration;
31 import org.opensaml.saml2.core.AuthnContextDeclRef;
32 import org.opensaml.saml2.core.AuthnRequest;
33 import org.opensaml.saml2.core.RequestedAuthnContext;
34 import org.opensaml.xml.io.Marshaller;
35 import org.opensaml.xml.io.MarshallingException;
36 import org.opensaml.xml.io.Unmarshaller;
37 import org.opensaml.xml.io.UnmarshallingException;
38 import org.opensaml.xml.util.XMLHelper;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
41 import org.w3c.dom.Element;
42 import org.xml.sax.InputSource;
43
44 /**
45  * A SAML 2.0 {@link LoginContext}.
46  * 
47  * This class can interpret {@link RequestedAuthnContext} and act accordingly.
48  */
49 public class Saml2LoginContext extends LoginContext implements Serializable {
50
51     /** Serial version UID. */
52     private static final long serialVersionUID = -2518779446947534977L;
53
54     /** Class logger. */
55     private final Logger log = LoggerFactory.getLogger(Saml2LoginContext.class);
56     
57     /** Relay state from authentication request. */
58     private String relayState;
59
60     /** Serialized authentication request. */
61     private String serialAuthnRequest;
62
63     /** Unmarshalled authentication request. */
64     private transient AuthnRequest authnRequest;
65
66     /**
67      * Creates a new instance of Saml2LoginContext.
68      * 
69      * @param relyingParty entity ID of the relying party
70      * @param state relay state from incoming authentication request
71      * @param request SAML 2.0 Authentication Request
72      * 
73      * @throws MarshallingException thrown if the given request can not be marshalled and serialized into a string
74      */
75     public Saml2LoginContext(String relyingParty, String state, AuthnRequest request) throws MarshallingException {
76         super();
77         
78         if (relyingParty == null || request == null) {
79             throw new IllegalArgumentException("SAML 2 authentication request and relying party ID may not be null");
80         }
81         setRelyingParty(relyingParty);
82         relayState = state;
83         authnRequest = request;
84         serialAuthnRequest = serializeRequest(request);
85         
86         setForceAuthRequired(authnRequest.isForceAuthn());
87         setPassiveAuthRequired(authnRequest.isPassive());
88         getRequestedAuthenticationMethods().addAll(extractRequestedAuthenticationMethods());
89     }
90
91     /**
92      * Gets the authentication request that started the login process.
93      * 
94      * @return authentication request that started the login process
95      * 
96      * @throws UnmarshallingException thrown if the serialized form on the authentication request can be unmarshalled
97      */
98     public AuthnRequest getAuthenticationRequest() throws UnmarshallingException {
99         if (authnRequest == null) {
100             authnRequest = deserializeRequest(serialAuthnRequest);
101         }
102
103         return authnRequest;
104     }
105     
106     /**
107      * Gets the relay state from the orginating authentication request.
108      * 
109      * @return relay state from the orginating authentication request
110      */
111     public String getRelayState(){
112         return relayState;
113     }
114
115     /**
116      * Gets the requested authentication context information from the authentication request.
117      * 
118      * @return requested authentication context information or null
119      */
120     public RequestedAuthnContext getRequestedAuthenticationContext() {
121         try {
122             AuthnRequest request = getAuthenticationRequest();
123             return request.getRequestedAuthnContext();
124         } catch (UnmarshallingException e) {
125             return null;
126         }
127     }
128
129     /**
130      * Serializes an authentication request into a string.
131      * 
132      * @param request the request to serialize
133      * 
134      * @return the serialized form of the string
135      * 
136      * @throws MarshallingException thrown if the request can not be marshalled and serialized
137      */
138     protected String serializeRequest(AuthnRequest request) throws MarshallingException {
139         Marshaller marshaller = Configuration.getMarshallerFactory().getMarshaller(request);
140         Element requestElem = marshaller.marshall(request);
141         StringWriter writer = new StringWriter();
142         XMLHelper.writeNode(requestElem, writer);
143         return writer.toString();
144     }
145
146     /**
147      * Deserailizes an authentication request from a string.
148      * 
149      * @param request request to deserialize
150      * 
151      * @return the request XMLObject
152      * 
153      * @throws UnmarshallingException thrown if the request can no be deserialized and unmarshalled
154      */
155     protected AuthnRequest deserializeRequest(String request) throws UnmarshallingException {
156         DocumentBuilderFactory builderFactory = DocumentBuilderFactory.newInstance();
157         try {
158             DocumentBuilder docBuilder = builderFactory.newDocumentBuilder();
159             InputSource requestInput = new InputSource(new StringReader(request));
160             Element requestElem = docBuilder.parse(requestInput).getDocumentElement();
161             Unmarshaller unmarshaller = Configuration.getUnmarshallerFactory().getUnmarshaller(requestElem);
162             return (AuthnRequest) unmarshaller.unmarshall(requestElem);
163         } catch (Exception e) {
164             throw new UnmarshallingException("Unable to read serialized authentication request");
165         }
166     }
167     
168     /**
169      * Extracts the authentication methods requested within the request.
170      * 
171      * @return requested authentication methods
172      */
173     protected List<String> extractRequestedAuthenticationMethods(){
174         ArrayList<String> requestedMethods = new ArrayList<String>();
175
176         RequestedAuthnContext authnContext = getRequestedAuthenticationContext();
177         if (authnContext == null) {
178             return requestedMethods;
179         }
180
181         // For the immediate future, we only support the "exact" comparator.
182         AuthnContextComparisonTypeEnumeration comparator = authnContext.getComparison();
183         if (comparator != null && comparator != AuthnContextComparisonTypeEnumeration.EXACT) {
184             log.error("Unsupported comparision operator ( " + comparator
185                     + ") in RequestedAuthnContext. Only exact comparisions are supported.");
186             return requestedMethods;
187         }
188
189         // build a list of all requested authn classes and declrefs
190         List<AuthnContextClassRef> authnClasses = authnContext.getAuthnContextClassRefs();
191         List<AuthnContextDeclRef> authnDeclRefs = authnContext.getAuthnContextDeclRefs();
192
193         if (authnClasses != null) {
194             for (AuthnContextClassRef classRef : authnClasses) {
195                 if (classRef != null) {
196                     requestedMethods.add(classRef.getAuthnContextClassRef());
197                 }
198             }
199         }
200
201         if (authnDeclRefs != null) {
202             for (AuthnContextDeclRef declRef : authnDeclRefs) {
203                 if (declRef != null) {
204                     requestedMethods.add(declRef.getAuthnContextDeclRef());
205                 }
206             }
207         }
208
209         return requestedMethods;
210     }
211 }