Fix compile time generics error
[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 javax.servlet.ServletRequest;
22 import javax.servlet.ServletResponse;
23
24 import org.apache.log4j.Logger;
25 import org.opensaml.common.binding.BindingException;
26 import org.opensaml.common.binding.decoding.MessageDecoder;
27 import org.opensaml.common.binding.encoding.MessageEncoder;
28 import org.opensaml.common.binding.security.SAMLSecurityPolicy;
29 import org.opensaml.common.xml.SAMLConstants;
30 import org.opensaml.saml1.binding.decoding.HTTPSOAP11Decoder;
31 import org.opensaml.saml1.binding.encoding.HTTPSOAP11Encoder;
32 import org.opensaml.saml1.core.AttributeQuery;
33 import org.opensaml.saml1.core.Response;
34 import org.opensaml.saml1.core.Statement;
35 import org.opensaml.saml1.core.StatusCode;
36 import org.opensaml.saml2.metadata.provider.MetadataProviderException;
37 import org.opensaml.ws.security.SecurityPolicyException;
38
39 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
40 import edu.internet2.middleware.shibboleth.common.profile.ProfileRequest;
41 import edu.internet2.middleware.shibboleth.common.profile.ProfileResponse;
42 import edu.internet2.middleware.shibboleth.common.relyingparty.RelyingPartyConfiguration;
43 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.AttributeQueryConfiguration;
44
45 /**
46  * SAML 1 Attribute Query profile handler.
47  */
48 public class AttributeQueryProfileHandler extends AbstractSAML1ProfileHandler {
49
50     /** Class logger. */
51     private final Logger log = Logger.getLogger(AttributeQueryProfileHandler.class);
52
53     /** {@inheritDoc} */
54     public String getProfileId() {
55         return "urn:mace:shibboleth:2.0:idp:profiles:saml1:query:attribute";
56     }
57
58     /** {@inheritDoc} */
59     public void processRequest(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response)
60             throws ProfileException {
61
62         AttributeQueryContext requestContext = new AttributeQueryContext(request, response);
63
64         Response samlResponse;
65         try {
66             decodeRequest(requestContext);
67
68             resolvePrincipal(requestContext);
69
70             ArrayList<Statement> statements = new ArrayList<Statement>();
71             statements.add(buildAttributeStatement(requestContext, "urn:oasis:names:tc:SAML:1.0:cm:sender-vouches"));
72
73             samlResponse = buildResponse(requestContext, statements);
74         } catch (ProfileException e) {
75             samlResponse = buildErrorResponse(requestContext);
76         }
77     }
78
79     /**
80      * Decodes the message in the request and adds it to the request context.
81      * 
82      * @param requestContext request context contianing the request to decode
83      * 
84      * @throws ProfileException throw if there is a problem decoding the request
85      */
86     protected void decodeRequest(AttributeQueryContext requestContext) throws ProfileException {
87         if (log.isDebugEnabled()) {
88             log.debug("Decoding incomming request");
89         }
90         MessageDecoder<ServletRequest> decoder = getMessageDecoderFactory().getMessageDecoder(
91                 HTTPSOAP11Decoder.BINDING_URI);
92         if (decoder == null) {
93             throw new ProfileException("No request decoder was registered for binding type: "
94                     + HTTPSOAP11Decoder.BINDING_URI);
95         }
96         super.populateMessageDecoder(decoder);
97
98         ProfileRequest<ServletRequest> profileRequest = requestContext.getProfileRequest();
99         decoder.setRequest(profileRequest.getRawRequest());
100         requestContext.setMessageDecoder(decoder);
101
102         try {
103             decoder.decode();
104             if (log.isDebugEnabled()) {
105                 log.debug("Decoded request");
106             }
107         } catch (BindingException e) {
108             log.error("Error decoding attribute query message", e);
109             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error decoding message"));
110             throw new ProfileException("Error decoding attribute query message");
111         } catch (SecurityPolicyException e) {
112             log.error("Message did not meet security policy requirements", e);
113             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, StatusCode.REQUEST_DENIED,
114                     "Message did not meet security policy requirements"));
115             throw new ProfileException("Message did not meet security policy requirements", e);
116         } finally {
117             // Set as much information as can be retrieved from the decoded message
118             SAMLSecurityPolicy securityPolicy = requestContext.getMessageDecoder().getSecurityPolicy();
119             requestContext.setRelyingPartyId(securityPolicy.getIssuer());
120
121             try {
122                 requestContext.setRelyingPartyMetadata(getMetadataProvider().getEntityDescriptor(
123                         requestContext.getRelyingPartyId()));
124
125                 requestContext.setRelyingPartyRoleMetadata(requestContext.getRelyingPartyMetadata().getSPSSODescriptor(
126                         SAMLConstants.SAML1P_NS));
127
128                 RelyingPartyConfiguration rpConfig = getRelyingPartyConfiguration(requestContext.getRelyingPartyId());
129                 requestContext.setRelyingPartyConfiguration(rpConfig);
130
131                 requestContext.setAssertingPartyId(requestContext.getRelyingPartyConfiguration().getProviderId());
132
133                 requestContext.setAssertingPartyMetadata(getMetadataProvider().getEntityDescriptor(
134                         requestContext.getAssertingPartyId()));
135
136                 requestContext.setAssertingPartyRoleMetadata(requestContext.getAssertingPartyMetadata()
137                         .getAttributeAuthorityDescriptor(SAMLConstants.SAML1P_NS));
138
139                 requestContext.setProfileConfiguration((AttributeQueryConfiguration) rpConfig
140                         .getProfileConfiguration(AttributeQueryConfiguration.PROFILE_ID));
141
142                 requestContext.setSamlRequest((AttributeQuery) requestContext.getMessageDecoder().getSAMLMessage());
143             } catch (MetadataProviderException e) {
144                 log.error("Unable to locate metadata for asserting or relying party");
145                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
146                         "Error locating party metadata"));
147                 throw new ProfileException("Error locating party metadata");
148             }
149         }
150     }
151
152     /**
153      * Encodes the request's SAML response and writes it to the servlet response.
154      * 
155      * @param requestContext current request context
156      * 
157      * @throws ProfileException thrown if no message encoder is registered for this profiles binding
158      */
159     protected void encodeResponse(AttributeQueryContext requestContext) throws ProfileException {
160         if (log.isDebugEnabled()) {
161             log.debug("Encoding response to SAML request from relying party " + requestContext.getRelyingPartyId());
162         }
163         MessageEncoder<ServletResponse> encoder = getMessageEncoderFactory().getMessageEncoder(
164                 HTTPSOAP11Encoder.BINDING_URI);
165         if (encoder == null) {
166             throw new ProfileException("No response encoder was registered for binding type: "
167                     + HTTPSOAP11Encoder.BINDING_URI);
168         }
169
170         super.populateMessageEncoder(encoder);
171         ProfileResponse<ServletResponse> profileResponse = requestContext.getProfileResponse();
172         encoder.setResponse(profileResponse.getRawResponse());
173         encoder.setSamlMessage(requestContext.getSamlResponse());
174         requestContext.setMessageEncoder(encoder);
175
176         try {
177             encoder.encode();
178         } catch (BindingException e) {
179             throw new ProfileException("Unable to encode response to relying party: "
180                     + requestContext.getRelyingPartyId(), e);
181         }
182     }
183
184     /** Basic data structure used to accumulate information as a request is being processed. */
185     protected class AttributeQueryContext extends
186             SAML1ProfileRequestContext<AttributeQuery, Response, AttributeQueryConfiguration> {
187
188         /**
189          * Constructor.
190          * 
191          * @param request current profile request
192          * @param response current profile response
193          */
194         public AttributeQueryContext(ProfileRequest<ServletRequest> request, ProfileResponse<ServletResponse> response) {
195             super(request, response);
196         }
197     }
198 }