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