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