src/edu/internet2/middleware/shibboleth/idp/profile/saml1/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.saml1;
  18
  19 import java.util.ArrayList;
  20
  21 import org.opensaml.common.SAMLObjectBuilder;
  22 import org.opensaml.common.binding.BasicEndpointSelector;
  23 import org.opensaml.common.binding.decoding.SAMLMessageDecoder;
  24 import org.opensaml.common.xml.SAMLConstants;
  25 import org.opensaml.saml1.core.AttributeQuery;
  26 import org.opensaml.saml1.core.AttributeStatement;
  27 import org.opensaml.saml1.core.Request;
  28 import org.opensaml.saml1.core.Response;
  29 import org.opensaml.saml1.core.Statement;
  30 import org.opensaml.saml1.core.StatusCode;
  31 import org.opensaml.saml1.core.Subject;
  32 import org.opensaml.saml2.metadata.AssertionConsumerService;
  33 import org.opensaml.saml2.metadata.AttributeAuthorityDescriptor;
  34 import org.opensaml.saml2.metadata.Endpoint;
  35 import org.opensaml.saml2.metadata.EntityDescriptor;
  36 import org.opensaml.saml2.metadata.SPSSODescriptor;
  37 import org.opensaml.saml2.metadata.provider.MetadataProvider;
  38 import org.opensaml.ws.message.decoder.MessageDecodingException;
  39 import org.opensaml.ws.transport.http.HTTPInTransport;
  40 import org.opensaml.ws.transport.http.HTTPOutTransport;
  41 import org.opensaml.xml.security.SecurityException;
  42 import org.slf4j.Logger;
  43 import org.slf4j.LoggerFactory;
  44
  45 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
  46 import edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext;
  47 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.AttributeQueryConfiguration;
  48 import edu.internet2.middleware.shibboleth.idp.session.AuthenticationMethodInformation;
  49 import edu.internet2.middleware.shibboleth.idp.session.Session;
  50
  51 /**
  52  * SAML 1 Attribute Query profile handler.
  53  */
  54 public class AttributeQueryProfileHandler extends AbstractSAML1ProfileHandler {
  55
  56     /** Class logger. */
  57     private final Logger log = LoggerFactory.getLogger(AttributeQueryProfileHandler.class);
  58
  59     /** Builder of assertion consumer service endpoints. */
  60     private SAMLObjectBuilder<AssertionConsumerService> acsEndpointBuilder;
  61
  62     /** Constructor. */
  63     public AttributeQueryProfileHandler() {
  64         super();
  65
  66         acsEndpointBuilder = (SAMLObjectBuilder<AssertionConsumerService>) getBuilderFactory().getBuilder(
  67                 AssertionConsumerService.DEFAULT_ELEMENT_NAME);
  68     }
  69
  70     /** {@inheritDoc} */
  71     public String getProfileId() {
  72         return AttributeQueryConfiguration.PROFILE_ID;
  73     }
  74
  75     /** {@inheritDoc} */
  76     public void processRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport) throws ProfileException {
  77         AttributeQueryContext requestContext = decodeRequest(inTransport, outTransport);
  78
  79         Response samlResponse;
  80         try {
  81             if (requestContext.getProfileConfiguration() == null) {
  82                 log.error("SAML 1 Attribute Query profile is not configured for relying party "
  83                         + requestContext.getInboundMessageIssuer());
  84                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, StatusCode.REQUEST_DENIED,
  85                         "SAML 1 Attribute Query profile is not configured for relying party "
  86                                 + requestContext.getInboundMessageIssuer()));
  87                 samlResponse = buildErrorResponse(requestContext);
  88             } else {
  89                 resolvePrincipal(requestContext);
  90
  91                 Session idpSession = getSessionManager().getSession(requestContext.getPrincipalName());
  92                 if (idpSession != null) {
  93                     AuthenticationMethodInformation authnInfo = idpSession.getAuthenticationMethods().get(
  94                             requestContext.getInboundMessageIssuer());
  95                     if (authnInfo != null) {
  96                         requestContext.setPrincipalAuthenticationMethod(authnInfo.getAuthenticationMethod());
  97                     }
  98                 }
  99
 100                 resolveAttributes(requestContext);
 101                 requestContext.setReleasedAttributes(requestContext.getAttributes().keySet());
 102
 103                 ArrayList<Statement> statements = new ArrayList<Statement>();
 104                 AttributeStatement attributeStatement = buildAttributeStatement(requestContext,
 105                         "urn:oasis:names:tc:SAML:1.0:cm:sender-vouches");
 106                 if (attributeStatement != null) {
 107                     statements.add(attributeStatement);
 108                 }
 109
 110                 samlResponse = buildResponse(requestContext, statements);
 111             }
 112         } catch (ProfileException e) {
 113             samlResponse = buildErrorResponse(requestContext);
 114         }
 115
 116         requestContext.setOutboundSAMLMessage(samlResponse);
 117         requestContext.setOutboundSAMLMessageId(samlResponse.getID());
 118         requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
 119         encodeResponse(requestContext);
 120         writeAuditLogEntry(requestContext);
 121     }
 122
 123     /**
 124      * Decodes an incoming request and populates a created request context with the resultant information.
 125      *
 126      * @param inTransport inbound message transport
 127      * @param outTransport outbound message transport
 128      *
 129      * @return the created request context
 130      *
 131      * @throws ProfileException throw if there is a problem decoding the request
 132      */
 133     protected AttributeQueryContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
 134             throws ProfileException {
 135         log.debug("Decoding message with decoder binding {}", getInboundBinding());
 136
 137         AttributeQueryContext requestContext = new AttributeQueryContext();
 138
 139         MetadataProvider metadataProvider = getMetadataProvider();
 140         requestContext.setMetadataProvider(metadataProvider);
 141
 142         requestContext.setInboundMessageTransport(inTransport);
 143         requestContext.setInboundSAMLProtocol(SAMLConstants.SAML11P_NS);
 144         requestContext.setSecurityPolicyResolver(getSecurityPolicyResolver());
 145         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
 146
 147         requestContext.setOutboundMessageTransport(outTransport);
 148         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML11P_NS);
 149
 150         try {
 151             SAMLMessageDecoder decoder = getMessageDecoders().get(getInboundBinding());
 152             if (decoder == null) {
 153                 throw new ProfileException("No message decoder configured for inbound binding " + getInboundBinding());
 154             }
 155             requestContext.setMessageDecoder(decoder);
 156             decoder.decode(requestContext);
 157             log.debug("Decoded request");
 158
 159             Request request = requestContext.getInboundSAMLMessage();
 160             if (request == null || !(request instanceof Request) || request.getAttributeQuery() == null) {
 161                 log.error("Incoming message was not an Attribute request");
 162                 requestContext.setFailureStatus(buildStatus(StatusCode.REQUESTER, null,
 163                         "Invalid SAML Attribute Request message."));
 164                 throw new ProfileException("Invalid SAML Attribute Request message.");
 165             }
 166
 167             return requestContext;
 168         } catch (MessageDecodingException e) {
 169             log.error("Error decoding attribute query message", e);
 170             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error decoding message"));
 171             throw new ProfileException("Error decoding attribute query message");
 172         } catch (SecurityException e) {
 173             log.error("Message did not meet security requirements", e);
 174             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, StatusCode.REQUEST_DENIED,
 175                     "Message did not meet security requirements"));
 176             throw new ProfileException("Message did not meet security policy requirements", e);
 177         } finally {
 178             // Set as much information as can be retrieved from the decoded message
 179             populateRequestContext(requestContext);
 180             populateSAMLMessageInformation(requestContext);
 181             populateProfileInformation(requestContext);
 182         }
 183     }
 184
 185     /** {@inheritDoc} */
 186     protected void populateRelyingPartyInformation(BaseSAMLProfileRequestContext requestContext)
 187             throws ProfileException {
 188         super.populateRelyingPartyInformation(requestContext);
 189
 190         EntityDescriptor relyingPartyMetadata = requestContext.getPeerEntityMetadata();
 191         if (relyingPartyMetadata != null) {
 192             requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
 193             requestContext.setPeerEntityRoleMetadata(relyingPartyMetadata.getSPSSODescriptor(SAMLConstants.SAML11P_NS));
 194         }
 195     }
 196
 197     /** {@inheritDoc} */
 198     protected void populateAssertingPartyInformation(BaseSAMLProfileRequestContext requestContext)
 199             throws ProfileException {
 200         super.populateAssertingPartyInformation(requestContext);
 201
 202         EntityDescriptor localEntityDescriptor = requestContext.getLocalEntityMetadata();
 203         if (localEntityDescriptor != null) {
 204             requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
 205             requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
 206                     .getAttributeAuthorityDescriptor(SAMLConstants.SAML11P_NS));
 207         }
 208     }
 209
 210     /**
 211      * Populates the request context with information from the inbound SAML message.
 212      *
 213      * This method requires the the following request context properties to be populated: inbound saml message
 214      *
 215      * This methods populates the following request context properties: subject name identifier
 216      *
 217      * @param requestContext current request context
 218      *
 219      * @throws ProfileException thrown if the inbound SAML message or subject identifier is null
 220      */
 221     protected void populateSAMLMessageInformation(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
 222         Request request = (Request) requestContext.getInboundSAMLMessage();
 223         if (request == null) {
 224             log.error("Decoder did not contain an attribute query, an error occured decoding the message");
 225             throw new ProfileException("Unable to decode message.");
 226         }
 227
 228         AttributeQuery query = request.getAttributeQuery();
 229         if (query != null) {
 230             Subject subject = query.getSubject();
 231             if (subject == null) {
 232                 log.error("Attribute query did not contain a proper subject");
 233                 ((AttributeQueryContext) requestContext).setFailureStatus(buildStatus(StatusCode.REQUESTER, null,
 234                         "Attribute query did not contain a proper subject"));
 235                 throw new ProfileException("Attribute query did not contain a proper subject");
 236             }
 237             requestContext.setSubjectNameIdentifier(subject.getNameIdentifier());
 238         }
 239     }
 240
 241     /**
 242      * Selects the appropriate endpoint for the relying party and stores it in the request context.
 243      *
 244      * @param requestContext current request context
 245      *
 246      * @return Endpoint selected from the information provided in the request context
 247      */
 248     protected Endpoint selectEndpoint(BaseSAMLProfileRequestContext requestContext) {
 249         Endpoint endpoint;
 250
 251         if (getInboundBinding().equals(SAMLConstants.SAML1_SOAP11_BINDING_URI)) {
 252             endpoint = acsEndpointBuilder.buildObject();
 253             endpoint.setBinding(SAMLConstants.SAML1_SOAP11_BINDING_URI);
 254         } else {
 255             BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
 256             endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
 257             endpointSelector.setMetadataProvider(getMetadataProvider());
 258             endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
 259             endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
 260             endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
 261             endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
 262             endpoint = endpointSelector.selectEndpoint();
 263         }
 264
 265         return endpoint;
 266     }
 267
 268     /** Basic data structure used to accumulate information as a request is being processed. */
 269     protected class AttributeQueryContext extends
 270             BaseSAML1ProfileRequestContext<Request, Response, AttributeQueryConfiguration> {}
 271 }