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