5d5ee2375f1bb8945ae96b33e3a433e875841786
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / provider / SAMLv1_AttributeQueryHandler.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.io.IOException;
29 import java.net.URI;
30 import java.net.URISyntaxException;
31 import java.security.Principal;
32 import java.security.cert.X509Certificate;
33 import java.util.ArrayList;
34 import java.util.Arrays;
35 import java.util.Collections;
36 import java.util.Date;
37 import java.util.Iterator;
38
39 import javax.security.auth.x500.X500Principal;
40 import javax.servlet.ServletException;
41 import javax.servlet.http.HttpServletRequest;
42 import javax.servlet.http.HttpServletResponse;
43
44 import org.apache.log4j.Logger;
45 import org.opensaml.SAMLAssertion;
46 import org.opensaml.SAMLAttribute;
47 import org.opensaml.SAMLAttributeDesignator;
48 import org.opensaml.SAMLAttributeQuery;
49 import org.opensaml.SAMLAttributeStatement;
50 import org.opensaml.SAMLAudienceRestrictionCondition;
51 import org.opensaml.SAMLCondition;
52 import org.opensaml.SAMLException;
53 import org.opensaml.SAMLRequest;
54 import org.opensaml.SAMLResponse;
55 import org.opensaml.SAMLStatement;
56 import org.opensaml.SAMLSubject;
57 import org.w3c.dom.Element;
58
59 import sun.misc.BASE64Decoder;
60 import edu.internet2.middleware.shibboleth.aa.AAException;
61 import edu.internet2.middleware.shibboleth.common.InvalidNameIdentifierException;
62 import edu.internet2.middleware.shibboleth.common.NameIdentifierMappingException;
63 import edu.internet2.middleware.shibboleth.common.RelyingParty;
64 import edu.internet2.middleware.shibboleth.common.ShibBrowserProfile;
65 import edu.internet2.middleware.shibboleth.common.ShibbolethConfigurationException;
66 import edu.internet2.middleware.shibboleth.idp.IdPProtocolHandler;
67 import edu.internet2.middleware.shibboleth.idp.IdPProtocolSupport;
68 import edu.internet2.middleware.shibboleth.metadata.EntityDescriptor;
69
70 /**
71  * @author Walter Hoehn
72  */
73 public class SAMLv1_AttributeQueryHandler extends BaseServiceHandler implements IdPProtocolHandler {
74
75         private static Logger log = Logger.getLogger(SAMLv1_AttributeQueryHandler.class.getName());
76
77         /**
78          * Required DOM-based constructor.
79          */
80         public SAMLv1_AttributeQueryHandler(Element config) throws ShibbolethConfigurationException {
81
82                 super(config);
83         }
84
85         /*
86          * @see edu.internet2.middleware.shibboleth.idp.ProtocolHandler#getHandlerName()
87          */
88         public String getHandlerName() {
89
90                 return "SAML v1.1 Attribute Query";
91         }
92
93         private String getEffectiveName(HttpServletRequest req, RelyingParty relyingParty, IdPProtocolSupport support)
94                         throws InvalidProviderCredentialException {
95
96                 X509Certificate credential = getCredentialFromProvider(req);
97
98                 if (credential == null || credential.getSubjectX500Principal().getName(X500Principal.RFC2253).equals("")) {
99                         log.info("Request is from an unauthenticated service provider.");
100                         return null;
101
102                 } else {
103                         log.info("Request contains credential: ("
104                                         + credential.getSubjectX500Principal().getName(X500Principal.RFC2253) + ").");
105                         // Mockup old requester name for requests from < 1.2 targets
106                         if (fromLegacyProvider(req)) {
107                                 String legacyName = ShibBrowserProfile.getHostNameFromDN(credential.getSubjectX500Principal());
108                                 if (legacyName == null) {
109                                         log.error("Unable to extract legacy requester name from certificate subject.");
110                                 }
111
112                                 log.info("Request from legacy service provider: (" + legacyName + ").");
113                                 return legacyName;
114
115                         } else {
116
117                                 // See if we have metadata for this provider
118                                 EntityDescriptor provider = support.lookup(relyingParty.getProviderId());
119                                 if (provider == null) {
120                                         log.info("No metadata found for provider: (" + relyingParty.getProviderId() + ").");
121                                         log.info("Treating remote provider as unauthenticated.");
122                                         return null;
123                                 }
124
125                                 // Make sure that the suppplied credential is valid for the
126                                 // selected relying party
127                                 if (isValidCredential(provider, credential)) {
128                                         log.info("Supplied credential validated for this provider.");
129                                         log.info("Request from service provider: (" + relyingParty.getProviderId() + ").");
130                                         return relyingParty.getProviderId();
131                                 } else {
132                                         log.error("Supplied credential ("
133                                                         + credential.getSubjectX500Principal().getName(X500Principal.RFC2253)
134                                                         + ") is NOT valid for provider (" + relyingParty.getProviderId() + ").");
135                                         throw new InvalidProviderCredentialException("Invalid credential.");
136                                 }
137                         }
138                 }
139         }
140
141         /*
142          * @see edu.internet2.middleware.shibboleth.idp.ProtocolHandler#processRequest(javax.servlet.http.HttpServletRequest,
143          *      javax.servlet.http.HttpServletResponse, org.opensaml.SAMLRequest,
144          *      edu.internet2.middleware.shibboleth.idp.ProtocolSupport)
145          */
146         public SAMLResponse processRequest(HttpServletRequest request, HttpServletResponse response,
147                         SAMLRequest samlRequest, IdPProtocolSupport support) throws SAMLException, IOException, ServletException {
148
149                 if (samlRequest.getQuery() == null || !(samlRequest.getQuery() instanceof SAMLAttributeQuery)) {
150                         log.error("Protocol Handler can only respond to SAML Attribute Queries.");
151                         throw new SAMLException(SAMLException.RESPONDER, "General error processing request.");
152                 }
153
154                 RelyingParty relyingParty = null;
155
156                 SAMLAttributeQuery attributeQuery = (SAMLAttributeQuery) samlRequest.getQuery();
157
158                 if (!fromLegacyProvider(request)) {
159                         log.info("Remote provider has identified itself as: (" + attributeQuery.getResource() + ").");
160                 }
161
162                 // This is the requester name that will be passed to subsystems
163                 String effectiveName = null;
164
165                 X509Certificate credential = getCredentialFromProvider(request);
166                 if (credential == null || credential.getSubjectX500Principal().getName(X500Principal.RFC2253).equals("")) {
167                         log.info("Request is from an unauthenticated service provider.");
168                 } else {
169
170                         // Identify a Relying Party
171                         relyingParty = support.getServiceProviderMapper().getRelyingParty(attributeQuery.getResource());
172
173                         try {
174                                 effectiveName = getEffectiveName(request, relyingParty, support);
175                         } catch (InvalidProviderCredentialException ipc) {
176                                 throw new SAMLException(SAMLException.REQUESTER, "Invalid credentials for request.");
177                         }
178                 }
179
180                 if (effectiveName == null) {
181                         log.debug("Using default Relying Party for unauthenticated provider.");
182                         relyingParty = support.getServiceProviderMapper().getRelyingParty(null);
183                 }
184
185                 // Fail if we can't honor SAML Subject Confirmation
186                 if (!fromLegacyProvider(request)) {
187                         Iterator iterator = attributeQuery.getSubject().getConfirmationMethods();
188                         boolean hasConfirmationMethod = false;
189                         while (iterator.hasNext()) {
190                                 log.info("Request contains SAML Subject Confirmation method: (" + (String) iterator.next() + ").");
191                         }
192                         if (hasConfirmationMethod) { throw new SAMLException(SAMLException.REQUESTER,
193                                         "This SAML authority cannot honor requests containing the supplied SAML Subject Confirmation Method."); }
194                 }
195
196                 // Map Subject to local principal
197                 Principal principal;
198                 try {
199                         principal = support.getNameMapper().getPrincipal(attributeQuery.getSubject().getName(), relyingParty,
200                                         relyingParty.getIdentityProvider());
201
202                         log.info("Request is for principal (" + principal.getName() + ").");
203
204                         SAMLAttribute[] attrs;
205                         Iterator requestedAttrsIterator = attributeQuery.getDesignators();
206                         if (requestedAttrsIterator.hasNext()) {
207                                 log.info("Request designates specific attributes, resolving this set.");
208                                 ArrayList requestedAttrs = new ArrayList();
209                                 while (requestedAttrsIterator.hasNext()) {
210                                         SAMLAttributeDesignator attribute = (SAMLAttributeDesignator) requestedAttrsIterator.next();
211                                         try {
212                                                 log.debug("Designated attribute: (" + attribute.getName() + ")");
213                                                 requestedAttrs.add(new URI(attribute.getName()));
214                                         } catch (URISyntaxException use) {
215                                                 log.error("Request designated an attribute name that does not conform "
216                                                                 + "to the required URI syntax (" + attribute.getName() + ").  Ignoring this attribute");
217                                         }
218                                 }
219
220                                 attrs = support.getReleaseAttributes(principal, effectiveName, null, (URI[]) requestedAttrs
221                                                 .toArray(new URI[0]));
222                         } else {
223                                 log.info("Request does not designate specific attributes, resolving all available.");
224                                 attrs = support.getReleaseAttributes(principal, effectiveName, null);
225                         }
226
227                         log.info("Found " + attrs.length + " attribute(s) for " + principal.getName());
228
229                         SAMLResponse samlResponse = null;
230
231                         if (attrs == null || attrs.length == 0) {
232                                 // No attribute found
233                                 samlResponse = new SAMLResponse(samlRequest.getId(), null, null, null);
234
235                         } else {
236                                 // Reference requested subject
237                                 SAMLSubject rSubject = (SAMLSubject) attributeQuery.getSubject().clone();
238
239                                 ArrayList audiences = new ArrayList();
240                                 if (relyingParty.getProviderId() != null) {
241                                         audiences.add(relyingParty.getProviderId());
242                                 }
243                                 if (relyingParty.getName() != null && !relyingParty.getName().equals(relyingParty.getProviderId())) {
244                                         audiences.add(relyingParty.getName());
245                                 }
246                                 SAMLCondition condition = new SAMLAudienceRestrictionCondition(audiences);
247
248                                 // Put all attributes into an assertion
249                                 SAMLStatement statement = new SAMLAttributeStatement(rSubject, Arrays.asList(attrs));
250
251                                 // Set assertion expiration to longest attribute expiration
252                                 long max = 0;
253                                 for (int i = 0; i < attrs.length; i++) {
254                                         if (max < attrs[i].getLifetime()) {
255                                                 max = attrs[i].getLifetime();
256                                         }
257                                 }
258                                 Date now = new Date();
259                                 Date then = new Date(now.getTime() + (max * 1000)); // max is in
260                                 // seconds
261
262                                 SAMLAssertion sAssertion = new SAMLAssertion(relyingParty.getIdentityProvider().getProviderId(), now,
263                                                 then, Collections.singleton(condition), null, Collections.singleton(statement));
264
265                                 samlResponse = new SAMLResponse(samlRequest.getId(), null, Collections.singleton(sAssertion), null);
266                                 IdPProtocolSupport.addSignatures(samlResponse, relyingParty, support.lookup(relyingParty
267                                                 .getProviderId()), false);
268                         }
269
270                         if (log.isDebugEnabled()) { // This takes some processing, so only do it if we need to
271                                 try {
272                                         log.debug("Dumping generated SAML Response:"
273                                                         + System.getProperty("line.separator")
274                                                         + new String(
275                                                                         new BASE64Decoder().decodeBuffer(new String(samlResponse.toBase64(), "ASCII")),
276                                                                         "UTF8"));
277                                 } catch (SAMLException e) {
278                                         log.error("Encountered an error while decoding SAMLReponse for logging purposes.");
279                                 } catch (IOException e) {
280                                         log.error("Encountered an error while decoding SAMLReponse for logging purposes.");
281                                 }
282                         }
283
284                         log.info("Successfully created response for principal (" + principal.getName() + ").");
285
286                         if (effectiveName == null) {
287                                 if (fromLegacyProvider(request)) {
288                                         support.getTransactionLog().info(
289                                                         "Attribute assertion issued to anonymous legacy provider at (" + request.getRemoteAddr()
290                                                                         + ") on behalf of principal (" + principal.getName() + ").");
291                                 } else {
292                                         support.getTransactionLog().info(
293                                                         "Attribute assertion issued to anonymous provider at (" + request.getRemoteAddr()
294                                                                         + ") on behalf of principal (" + principal.getName() + ").");
295                                 }
296                         } else {
297                                 if (fromLegacyProvider(request)) {
298                                         support.getTransactionLog().info(
299                                                         "Attribute assertion issued to legacy provider (" + effectiveName
300                                                                         + ") on behalf of principal (" + principal.getName() + ").");
301                                 } else {
302                                         support.getTransactionLog().info(
303                                                         "Attribute assertion issued to provider (" + effectiveName + ") on behalf of principal ("
304                                                                         + principal.getName() + ").");
305                                 }
306                         }
307
308                         return samlResponse;
309
310                 } catch (SAMLException e) {
311                         if (relyingParty.passThruErrors()) {
312                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.", e);
313                         } else {
314                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.");
315                         }
316
317                 } catch (InvalidNameIdentifierException e) {
318                         log.error("Could not associate the request's subject with a principal: " + e);
319                         if (relyingParty.passThruErrors()) {
320                                 throw new SAMLException(Arrays.asList(e.getSAMLErrorCodes()), "The supplied Subject was unrecognized.",
321                                                 e);
322                         } else {
323                                 throw new SAMLException(Arrays.asList(e.getSAMLErrorCodes()), "The supplied Subject was unrecognized.");
324                         }
325
326                 } catch (NameIdentifierMappingException e) {
327                         log.error("Encountered an error while mapping the name identifier from the request: " + e);
328                         if (relyingParty.passThruErrors()) {
329                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.", e);
330                         } else {
331                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.");
332                         }
333
334                 } catch (AAException e) {
335                         log.error("Encountered an error while resolving resolving attributes: " + e);
336                         if (relyingParty.passThruErrors()) {
337                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.", e);
338                         } else {
339                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.");
340                         }
341
342                 } catch (CloneNotSupportedException e) {
343                         log.error("Encountered an error while cloning request subject for use in response: " + e);
344                         if (relyingParty.passThruErrors()) {
345                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.", e);
346                         } else {
347                                 throw new SAMLException(SAMLException.RESPONDER, "General error processing request.");
348                         }
349                 }
350         }
351
352         private static boolean fromLegacyProvider(HttpServletRequest request) {
353
354                 String version = request.getHeader("Shibboleth");
355                 if (version != null) {
356                         log.debug("Request from Shibboleth version: " + version);
357                         return false;
358                 }
359                 log.debug("No version header found.");
360                 return true;
361         }
362
363 }