SAML 2 artifact unit tests and associated bug fixes
[java-idp.git] / 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 org.apache.log4j.Logger;
22 import org.opensaml.common.SAMLObjectBuilder;
23 import org.opensaml.common.binding.BasicEndpointSelector;
24 import org.opensaml.common.binding.decoding.SAMLMessageDecoder;
25 import org.opensaml.common.xml.SAMLConstants;
26 import org.opensaml.saml2.core.AttributeQuery;
27 import org.opensaml.saml2.core.Response;
28 import org.opensaml.saml2.core.Statement;
29 import org.opensaml.saml2.core.StatusCode;
30 import org.opensaml.saml2.metadata.AssertionConsumerService;
31 import org.opensaml.saml2.metadata.AttributeAuthorityDescriptor;
32 import org.opensaml.saml2.metadata.Endpoint;
33 import org.opensaml.saml2.metadata.SPSSODescriptor;
34 import org.opensaml.saml2.metadata.provider.MetadataProvider;
35 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
36 import org.opensaml.ws.message.decoder.MessageDecodingException;
37 import org.opensaml.ws.security.SecurityPolicyException;
38 import org.opensaml.ws.transport.http.HTTPInTransport;
39 import org.opensaml.ws.transport.http.HTTPOutTransport;
40
41 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
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     /** Builder of assertion consumer service endpoints. */
52     private SAMLObjectBuilder<AssertionConsumerService> acsEndpointBuilder;
53
54     /** Constructor. */
55     public AttributeQueryProfileHandler() {
56         super();
57
58         acsEndpointBuilder = (SAMLObjectBuilder<AssertionConsumerService>) getBuilderFactory().getBuilder(
59                 AssertionConsumerService.DEFAULT_ELEMENT_NAME);
60     }
61
62     /** {@inheritDoc} */
63     public String getProfileId() {
64         return "urn:mace:shibboleth:2.0:idp:profiles:saml2:query:attribute";
65     }
66
67     /** {@inheritDoc} */
68     public void processRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport) throws ProfileException {
69         Response samlResponse;
70
71         AttributeQueryContext requestContext = decodeRequest(inTransport, outTransport);
72
73         try {
74             if (requestContext.getProfileConfiguration() == null) {
75                 log.error("SAML 2 Attribute Query profile is not configured for relying party "
76                         + requestContext.getInboundMessageIssuer());
77                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.REQUEST_DENIED_URI,
78                         "SAML 2 Attribute Query profile is not configured for relying party "
79                                 + requestContext.getInboundMessageIssuer()));
80                 throw new ProfileException("SAML 2 Attribute Query profile is not configured for relying party "
81                                 + requestContext.getInboundMessageIssuer());
82             }
83
84             checkSamlVersion(requestContext);
85
86             // Resolve attribute query name id to principal name and place in context
87             resolvePrincipal(requestContext);
88             resolveAttributes(requestContext);
89             requestContext.setReleasedAttributes(requestContext.getPrincipalAttributes().keySet());
90
91             // Lookup principal name and attributes, create attribute statement from information
92             ArrayList<Statement> statements = new ArrayList<Statement>();
93             statements.add(buildAttributeStatement(requestContext));
94
95             // create the SAML response
96             samlResponse = buildResponse(requestContext, "urn:oasis:names:tc:SAML:2.0:cm:sender-vouches", statements);
97         } catch (ProfileException e) {
98             samlResponse = buildErrorResponse(requestContext);
99         }
100
101         requestContext.setOutboundSAMLMessage(samlResponse);
102         requestContext.setOutboundSAMLMessageId(samlResponse.getID());
103         requestContext.setOutboundSAMLMessageIssueInstant(samlResponse.getIssueInstant());
104
105         encodeResponse(requestContext);
106         writeAuditLogEntry(requestContext);
107     }
108
109     /**
110      * Decodes an incoming request and populates a created request context with the resultant information.
111      * 
112      * @param inTransport inbound message transport
113      * @param outTransport outbound message transport
114      * 
115      * @return the created request context
116      * 
117      * @throws ProfileException throw if there is a problem decoding the request
118      */
119     protected AttributeQueryContext decodeRequest(HTTPInTransport inTransport, HTTPOutTransport outTransport)
120             throws ProfileException {
121         if (log.isDebugEnabled()) {
122             log.debug("Decoding incomming request");
123         }
124
125         MetadataProvider metadataProvider = getMetadataProvider();
126
127         AttributeQueryContext requestContext = new AttributeQueryContext();
128         requestContext.setMetadataProvider(metadataProvider);
129         
130         requestContext.setInboundMessageTransport(inTransport);
131         requestContext.setInboundSAMLProtocol(SAMLConstants.SAML20P_NS);
132         requestContext.setPeerEntityRole(SPSSODescriptor.DEFAULT_ELEMENT_NAME);
133
134         
135         requestContext.setOutboundMessageTransport(outTransport);
136         requestContext.setOutboundSAMLProtocol(SAMLConstants.SAML20P_NS);
137
138         try {
139             SAMLMessageDecoder decoder = getMessageDecoders().get(getInboundBinding());
140             requestContext.setMessageDecoder(decoder);
141             decoder.decode(requestContext);
142             if (log.isDebugEnabled()) {
143                 log.debug("Decoded request");
144             }
145             return requestContext;
146         } catch (MessageDecodingException e) {
147             log.error("Error decoding attribute query message", e);
148             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error decoding message"));
149             throw new ProfileException("Error decoding attribute query message");
150         } catch (SecurityPolicyException e) {
151             log.error("Message did not meet security policy requirements", e);
152             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.REQUEST_DENIED_URI,
153                     "Message did not meet security policy requirements"));
154             throw new ProfileException("Message did not meet security policy requirements", e);
155         } finally {
156             // Set as much information as can be retrieved from the decoded message
157             try {
158                 AttributeQuery query = requestContext.getInboundSAMLMessage();
159                 requestContext.setSubjectNameIdentifier(query.getSubject().getNameID());
160                 
161                 String relyingPartyId = requestContext.getInboundMessageIssuer();
162                 RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(relyingPartyId);
163                 requestContext.setRelyingPartyConfiguration(rpConfig);
164                 requestContext.setPeerEntityEndpoint(selectEndpoint(requestContext));
165
166                 String assertingPartyId = requestContext.getRelyingPartyConfiguration().getProviderId();
167                 requestContext.setLocalEntityId(assertingPartyId);
168                 requestContext.setLocalEntityMetadata(metadataProvider.getEntityDescriptor(assertingPartyId));
169                 requestContext.setLocalEntityRole(AttributeAuthorityDescriptor.DEFAULT_ELEMENT_NAME);
170                 requestContext.setLocalEntityRoleMetadata(requestContext.getLocalEntityMetadata()
171                         .getAttributeAuthorityDescriptor(SAMLConstants.SAML20P_NS));
172
173                 AttributeQueryConfiguration profileConfig = (AttributeQueryConfiguration) rpConfig
174                         .getProfileConfiguration(AttributeQueryConfiguration.PROFILE_ID);
175                 if(profileConfig != null){
176                     requestContext.setProfileConfiguration(profileConfig);
177                     requestContext.setOutboundMessageArtifactType(profileConfig.getOutboundArtifactType());
178                     if (profileConfig.getSigningCredential() != null) {
179                         requestContext.setOutboundSAMLMessageSigningCredential(profileConfig.getSigningCredential());
180                     } else if (rpConfig.getDefaultSigningCredential() != null) {
181                         requestContext.setOutboundSAMLMessageSigningCredential(rpConfig.getDefaultSigningCredential());
182                     }
183                 }
184             } catch (MetadataProviderException e) {
185                 log.error("Unable to locate metadata for asserting or relying party");
186                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
187                         "Error locating party metadata"));
188                 throw new ProfileException("Error locating party metadata");
189             }
190         }
191     }
192     
193     /**
194      * Selects the appropriate endpoint for the relying party and stores it in the request context.
195      * 
196      * @param requestContext current request context
197      * 
198      * @return Endpoint selected from the information provided in the request context
199      */
200     protected Endpoint selectEndpoint(AttributeQueryContext requestContext) {
201         Endpoint endpoint;
202
203         if (getInboundBinding().equals(SAMLConstants.SAML2_SOAP11_BINDING_URI)) {
204             endpoint = acsEndpointBuilder.buildObject();
205             endpoint.setBinding(SAMLConstants.SAML2_SOAP11_BINDING_URI);
206         } else {
207             BasicEndpointSelector endpointSelector = new BasicEndpointSelector();
208             endpointSelector.setEndpointType(AssertionConsumerService.DEFAULT_ELEMENT_NAME);
209             endpointSelector.setMetadataProvider(getMetadataProvider());
210             endpointSelector.setEntityMetadata(requestContext.getPeerEntityMetadata());
211             endpointSelector.setEntityRoleMetadata(requestContext.getPeerEntityRoleMetadata());
212             endpointSelector.setSamlRequest(requestContext.getInboundSAMLMessage());
213             endpointSelector.getSupportedIssuerBindings().addAll(getSupportedOutboundBindings());
214             endpoint = endpointSelector.selectEndpoint();
215         }
216
217         return endpoint;
218     }
219
220     /** Basic data structure used to accumulate information as a request is being processed. */
221     protected class AttributeQueryContext extends
222             BaseSAML2ProfileRequestContext<AttributeQuery, Response, AttributeQueryConfiguration> {
223
224     }
225 }