src/edu/internet2/middleware/shibboleth/idp/profile/saml2/AttributeQueryProfileHandler.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.profile.saml2;
  18
  19 import java.util.ArrayList;
  20
  21 import javax.servlet.ServletRequest;
  22 import javax.servlet.ServletResponse;
  23
  24 import org.apache.log4j.Logger;
  25 import org.opensaml.common.binding.BindingException;
  26 import org.opensaml.common.binding.decoding.MessageDecoder;
  27 import org.opensaml.common.binding.encoding.MessageEncoder;
  28 import org.opensaml.common.binding.security.SAMLSecurityPolicy;
  29 import org.opensaml.common.xml.SAMLConstants;
  30 import org.opensaml.saml2.binding.decoding.HTTPSOAP11Decoder;
  31 import org.opensaml.saml2.core.AttributeQuery;
  32 import org.opensaml.saml2.core.Response;
  33 import org.opensaml.saml2.core.Statement;
  34 import org.opensaml.saml2.core.StatusCode;
  35 import org.opensaml.saml2.core.Subject;
  36 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
  37 import org.opensaml.ws.security.SecurityPolicyException;
  38
  39 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
  40 import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
  41 import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
  42 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
  43 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.AttributeQueryConfiguration;
  44
  45 /** SAML 2.0 Attribute Query profile handler. */
  46 public class AttributeQueryProfileHandler extends AbstractSAML2ProfileHandler {
  47
  48     /** Class logger. */
  49     private static Logger log = Logger.getLogger(AttributeQueryProfileHandler.class);
  50
  51     /** SAML binding URI. */
  52     private static final String BINDING = "urn:oasis:names:tc:SAML:2.0:bindings:SOAP";
  53
  54     /** {@inheritDoc} */
  55     public String getProfileId() {
  56         return "urn:mace:shibboleth:2.0:idp:profiles:saml2:query:attribute";
  57     }
  58
  59     /** {@inheritDoc} */
  60     public void processRequest(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response)
  61             throws ProfileException {
  62
  63         AttributeQueryContext requestContext = new AttributeQueryContext(request, response);
  64
  65         Response samlResponse;
  66         try {
  67             decodeRequest(requestContext);
  68
  69             checkSamlVersion(requestContext);
  70
  71             // Resolve attribute query name id to principal name and place in context
  72             resolvePrincipal(requestContext);
  73
  74             // Lookup principal name and attributes, create attribute statement from information
  75             ArrayList<Statement> statements = new ArrayList<Statement>();
  76             statements.add(buildAttributeStatement(requestContext));
  77
  78             // create the assertion subject
  79             Subject assertionSubject = buildSubject(requestContext, "urn:oasis:names:tc:SAML:2.0:cm:sender-vouches");
  80
  81             // create the SAML response
  82             samlResponse = buildResponse(requestContext, assertionSubject, statements);
  83         } catch (ProfileException e) {
  84             samlResponse = buildErrorResponse(requestContext);
  85         }
  86
  87         requestContext.setSamlResponse(samlResponse);
  88
  89         encodeResponse(requestContext);
  90         writeAuditLogEntry(requestContext);
  91     }
  92
  93     /**
  94      * Decodes the message in the request and adds it to the request context.
  95      *
  96      * @param requestContext request context contianing the request to decode
  97      *
  98      * @throws ProfileException throw if there is a problem decoding the request
  99      */
 100     protected void decodeRequest(AttributeQueryContext requestContext) throws ProfileException {
 101         if (log.isDebugEnabled()) {
 102             log.debug("Decoding incomming request");
 103         }
 104         MessageDecoder<ServletRequest> decoder = getMessageDecoderFactory().getMessageDecoder(
 105                 HTTPSOAP11Decoder.BINDING_URI);
 106         if (decoder == null) {
 107             throw new ProfileException("No request decoder was registered for binding type: "
 108                     + HTTPSOAP11Decoder.BINDING_URI);
 109         }
 110         super.populateMessageDecoder(decoder);
 111
 112         decoder.setRequest(requestContext.getProfileRequest().getRawRequest());
 113         requestContext.setMessageDecoder(decoder);
 114
 115         try {
 116             decoder.decode();
 117             if (log.isDebugEnabled()) {
 118                 log.debug("Decoded request");
 119             }
 120         } catch (BindingException e) {
 121             log.error("Error decoding attribute query message", e);
 122             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error decoding message"));
 123             throw new ProfileException("Error decoding attribute query message");
 124         } catch (SecurityPolicyException e) {
 125             log.error("Message did not meet security policy requirements", e);
 126             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.REQUEST_DENIED_URI,
 127                     "Message did not meet security policy requirements"));
 128             throw new ProfileException("Message did not meet security policy requirements", e);
 129         } finally {
 130             // Set as much information as can be retrieved from the decoded message
 131             SAMLSecurityPolicy securityPolicy = requestContext.getMessageDecoder().getSecurityPolicy();
 132             requestContext.setRelyingPartyId(securityPolicy.getIssuer());
 133
 134             try {
 135                 requestContext.setRelyingPartyMetadata(getMetadataProvider().getEntityDescriptor(
 136                         requestContext.getRelyingPartyId()));
 137
 138                 requestContext.setRelyingPartyRoleMetadata(requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
 139                         SAMLConstants.SAML20P_NS));
 140
 141                 RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(requestContext.getRelyingPartyId());
 142                 requestContext.setRelyingPartyConfiguration(rpConfig);
 143
 144                 requestContext.setAssertingPartyId(requestContext.getRelyingPartyConfiguration().getProviderId());
 145
 146                 requestContext.setAssertingPartyMetadata(getMetadataProvider().getEntityDescriptor(
 147                         requestContext.getAssertingPartyId()));
 148
 149                 requestContext.setAssertingPartyRoleMetadata(requestContext.getAssertingPartyMetadata()
 150                         .getAttributeAuthorityDescriptor(SAMLConstants.SAML20P_NS));
 151
 152                 requestContext.setProfileConfiguration((AttributeQueryConfiguration) rpConfig
 153                         .getProfileConfiguration(AttributeQueryConfiguration.PROFILE_ID));
 154
 155                 requestContext.setSamlRequest((AttributeQuery) requestContext.getMessageDecoder().getSAMLMessage());
 156             } catch (MetadataProviderException e) {
 157                 log.error("Unable to locate metadata for asserting or relying party");
 158                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
 159                         "Error locating party metadata"));
 160                 throw new ProfileException("Error locating party metadata");
 161             }
 162         }
 163     }
 164
 165     /**
 166      * Encodes the request's SAML response and writes it to the servlet response.
 167      *
 168      * @param requestContext current request context
 169      *
 170      * @throws ProfileException thrown if no message encoder is registered for this profiles binding
 171      */
 172     protected void encodeResponse(AttributeQueryContext requestContext) throws ProfileException {
 173         if (log.isDebugEnabled()) {
 174             log.debug("Encoding response to SAML request " + requestContext.getSamlRequest().getID()
 175                     + " from relying party " + requestContext.getRelyingPartyId());
 176         }
 177         MessageEncoder<ServletResponse> encoder = getMessageEncoderFactory().getMessageEncoder(BINDING);
 178         if (encoder == null) {
 179             throw new ProfileException("No response encoder was registered for binding type: " + BINDING);
 180         }
 181
 182         super.populateMessageEncoder(encoder);
 183         encoder.setResponse(requestContext.getProfileResponse().getRawResponse());
 184         encoder.setSamlMessage(requestContext.getSamlResponse());
 185         requestContext.setMessageEncoder(encoder);
 186
 187         try {
 188             encoder.encode();
 189         } catch (BindingException e) {
 190             throw new ProfileException("Unable to encode response to relying party: "
 191                     + requestContext.getRelyingPartyId(), e);
 192         }
 193     }
 194
 195     /** Basic data structure used to accumulate information as a request is being processed. */
 196     protected class AttributeQueryContext extends
 197             SAML2ProfileRequestContext<AttributeQuery, Response, AttributeQueryConfiguration> {
 198
 199         /**
 200          * Constructor.
 201          *
 202          * @param request current profile request
 203          * @param response current profile response
 204          */
 205         public AttributeQueryContext(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response) {
 206             super(request, response);
 207         }
 208     }
 209 }