View Javadoc

    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 = new AttributeQueryContext();
    78          Response samlResponse;
    79          try {
    80              decodeRequest(requestContext, 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      * @param requestContext the request context to which decoded information should be added
    130      *
    131      * @throws ProfileException throw if there is a problem decoding the request
    132      */
    133     protected void decodeRequest(AttributeQueryContext requestContext, HTTPInTransport inTransport,
    134             HTTPOutTransport outTransport) throws ProfileException {
    135         if (log.isDebugEnabled()) {
    136             log.debug("Decoding message with decoder binding {}",
    137                     getInboundMessageDecoder(requestContext).getBindingURI());
    138         }
    139
    140         requestContext.setCommunicationProfileId(getProfileId());
    141
    142         MetadataProvider metadataProvider = getMetadataProvider();
    143         requestContext.setMetadataProvider(metadataProvider);
    144
    145         requestContext.setInboundMessageTransport(inTransport);
    146         requestContext.setInboundSAMLProtocol(SAMLConstants.SAML11P_NS);
    147         requestContext.setSecurityPolicyResolver(getSecurityPolicyResolver());
    148         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
    149
    150         requestContext.setOutboundMessageTransport(outTransport);
    151         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML11P_NS);
    152
    153         try {
    154             SAMLMessageDecoder decoder = getInboundMessageDecoder(requestContext);
    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         } catch (MessageDecodingException e) {
    167             log.warn("Error decoding attribute query message", e);
    168             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error decoding message"));
    169             throw new ProfileException("Error decoding attribute query message", e);
    170         } catch (SecurityException e) {
    171             log.warn("Message did not meet security requirements", e);
    172             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, StatusCode.REQUEST_DENIED,
    173                     "Message did not meet security requirements"));
    174             throw new ProfileException("Message did not meet security policy requirements", e);
    175         } finally {
    176             // Set as much information as can be retrieved from the decoded message
    177             populateRequestContext(requestContext);
    178         }
    179     }
    180
    181     /** {@inheritDoc} */
    182     protected void populateRelyingPartyInformation(BaseSAMLProfileRequestContext requestContext)
    183             throws ProfileException {
    184         super.populateRelyingPartyInformation(requestContext);
    185
    186         EntityDescriptor relyingPartyMetadata = requestContext.getPeerEntityMetadata();
    187         if (relyingPartyMetadata != null) {
    188             requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
    189             requestContext.setPeerEntityRoleMetadata(relyingPartyMetadata.getSPSSODescriptor(SAMLConstants.SAML11P_NS));
    190         }
    191     }
    192
    193     /** {@inheritDoc} */
    194     protected void populateAssertingPartyInformation(BaseSAMLProfileRequestContext requestContext)
    195             throws ProfileException {
    196         super.populateAssertingPartyInformation(requestContext);
    197
    198         EntityDescriptor localEntityDescriptor = requestContext.getLocalEntityMetadata();
    199         if (localEntityDescriptor != null) {
    200             requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
    201             requestContext.setLocalEntityRoleMetadata(localEntityDescriptor
    202                     .getAttributeAuthorityDescriptor(SAMLConstants.SAML11P_NS));
    203         }
    204     }
    205
    206     /**
    207      * Populates the request context with information from the inbound SAML message.
    208      *
    209      * This method requires the the following request context properties to be populated: inbound saml message
    210      *
    211      * This methods populates the following request context properties: subject name identifier
    212      *
    213      * @param requestContext current request context
    214      *
    215      * @throws ProfileException thrown if the inbound SAML message or subject identifier is null
    216      */
    217     protected void populateSAMLMessageInformation(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
    218         Request request = (Request) requestContext.getInboundSAMLMessage();
    219         if (request == null) {
    220             log.error("Decoder did not contain an attribute query, an error occured decoding the message");
    221             throw new ProfileException("Unable to decode message.");
    222         }
    223
    224         AttributeQuery query = request.getAttributeQuery();
    225         if (query != null) {
    226             Subject subject = query.getSubject();
    227             if (subject == null) {
    228                 log.error("Attribute query did not contain a proper subject");
    229                 ((AttributeQueryContext) requestContext).setFailureStatus(buildStatus(StatusCode.REQUESTER, null,
    230                         "Attribute query did not contain a proper subject"));
    231                 throw new ProfileException("Attribute query did not contain a proper subject");
    232             }
    233             requestContext.setSubjectNameIdentifier(subject.getNameIdentifier());
    234         }
    235     }
    236
    237     /**
    238      * Selects the appropriate endpoint for the relying party and stores it in the request context.
    239      *
    240      * @param requestContext current request context
    241      *
    242      * @return Endpoint selected from the information provided in the request context
    243      */
    244     protected Endpoint selectEndpoint(BaseSAMLProfileRequestContext requestContext) {
    245         Endpoint endpoint;
    246
    247         if (getInboundBinding().equals(SAMLConstants.SAML1_SOAP11_BINDING_URI)) {
    248             endpoint = acsEndpointBuilder.buildObject();
    249             endpoint.setBinding(SAMLConstants.SAML1_SOAP11_BINDING_URI);
    250         } else {
    251             BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
    252             endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
    253             endpointSelector.setMetadataProvider(getMetadataProvider());
    254             endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
    255             endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
    256             endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
    257             endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
    258             endpoint = endpointSelector.selectEndpoint();
    259         }
    260
    261         return endpoint;
    262     }
    263
    264     /** Basic data structure used to accumulate information as a request is being processed. */
    265     protected class AttributeQueryContext extends
    266             BaseSAML1ProfileRequestContext<Request, Response, AttributeQueryConfiguration> {}
    267 }