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