temporary fix for SIDP-72 so Nate can continue testing
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / idp / profile / saml2 / AbstractSAML2ProfileHandler.java
1 /*
2  * Copyright [2007] [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 import java.util.Collection;
21 import java.util.List;
22 import java.util.Map;
23
24 import org.joda.time.DateTime;
25 import org.opensaml.Configuration;
26 import org.opensaml.common.SAMLObjectBuilder;
27 import org.opensaml.common.SAMLVersion;
28 import org.opensaml.common.xml.SAMLConstants;
29 import org.opensaml.saml2.core.Assertion;
30 import org.opensaml.saml2.core.AttributeQuery;
31 import org.opensaml.saml2.core.AttributeStatement;
32 import org.opensaml.saml2.core.Audience;
33 import org.opensaml.saml2.core.AudienceRestriction;
34 import org.opensaml.saml2.core.AuthnRequest;
35 import org.opensaml.saml2.core.Conditions;
36 import org.opensaml.saml2.core.Issuer;
37 import org.opensaml.saml2.core.NameID;
38 import org.opensaml.saml2.core.ProxyRestriction;
39 import org.opensaml.saml2.core.Response;
40 import org.opensaml.saml2.core.Statement;
41 import org.opensaml.saml2.core.Status;
42 import org.opensaml.saml2.core.StatusCode;
43 import org.opensaml.saml2.core.StatusMessage;
44 import org.opensaml.saml2.core.StatusResponseType;
45 import org.opensaml.saml2.core.Subject;
46 import org.opensaml.saml2.core.SubjectConfirmation;
47 import org.opensaml.saml2.core.SubjectConfirmationData;
48 import org.opensaml.saml2.encryption.Encrypter;
49 import org.opensaml.saml2.encryption.Encrypter.KeyPlacement;
50 import org.opensaml.saml2.metadata.AttributeAuthorityDescriptor;
51 import org.opensaml.saml2.metadata.AuthnAuthorityDescriptor;
52 import org.opensaml.saml2.metadata.Endpoint;
53 import org.opensaml.saml2.metadata.NameIDFormat;
54 import org.opensaml.saml2.metadata.PDPDescriptor;
55 import org.opensaml.saml2.metadata.RoleDescriptor;
56 import org.opensaml.saml2.metadata.SPSSODescriptor;
57 import org.opensaml.saml2.metadata.SSODescriptor;
58 import org.opensaml.security.MetadataCredentialResolver;
59 import org.opensaml.security.MetadataCriteria;
60 import org.opensaml.ws.transport.http.HTTPInTransport;
61 import org.opensaml.xml.XMLObjectBuilder;
62 import org.opensaml.xml.encryption.EncryptionException;
63 import org.opensaml.xml.encryption.EncryptionParameters;
64 import org.opensaml.xml.encryption.KeyEncryptionParameters;
65 import org.opensaml.xml.io.Marshaller;
66 import org.opensaml.xml.io.MarshallingException;
67 import org.opensaml.xml.security.CriteriaSet;
68 import org.opensaml.xml.security.SecurityConfiguration;
69 import org.opensaml.xml.security.SecurityException;
70 import org.opensaml.xml.security.SecurityHelper;
71 import org.opensaml.xml.security.credential.Credential;
72 import org.opensaml.xml.security.credential.UsageType;
73 import org.opensaml.xml.security.criteria.EntityIDCriteria;
74 import org.opensaml.xml.security.criteria.UsageCriteria;
75 import org.opensaml.xml.signature.Signature;
76 import org.opensaml.xml.signature.Signer;
77 import org.opensaml.xml.util.DatatypeHelper;
78 import org.slf4j.Logger;
79 import org.slf4j.LoggerFactory;
80
81 import edu.internet2.middleware.shibboleth.common.attribute.AttributeRequestException;
82 import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
83 import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncoder;
84 import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncodingException;
85 import edu.internet2.middleware.shibboleth.common.attribute.encoding.SAML2NameIDAttributeEncoder;
86 import edu.internet2.middleware.shibboleth.common.attribute.provider.SAML2AttributeAuthority;
87 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
88 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml2.AbstractSAML2ProfileConfiguration;
89 import edu.internet2.middleware.shibboleth.idp.profile.AbstractSAMLProfileHandler;
90
91 /** Common implementation details for profile handlers. */
92 public abstract class AbstractSAML2ProfileHandler extends AbstractSAMLProfileHandler {
93
94     /** SAML Version for this profile handler. */
95     public static final SAMLVersion SAML_VERSION = SAMLVersion.VERSION_20;
96
97     /** Class logger. */
98     private Logger log = LoggerFactory.getLogger(AbstractSAML2ProfileHandler.class);
99
100     /** For building response. */
101     private SAMLObjectBuilder<Response> responseBuilder;
102
103     /** For building status. */
104     private SAMLObjectBuilder<Status> statusBuilder;
105
106     /** For building statuscode. */
107     private SAMLObjectBuilder<StatusCode> statusCodeBuilder;
108
109     /** For building StatusMessages. */
110     private SAMLObjectBuilder<StatusMessage> statusMessageBuilder;
111
112     /** For building assertion. */
113     private SAMLObjectBuilder<Assertion> assertionBuilder;
114
115     /** For building issuer. */
116     private SAMLObjectBuilder<Issuer> issuerBuilder;
117
118     /** For building subject. */
119     private SAMLObjectBuilder<Subject> subjectBuilder;
120
121     /** For building subject confirmation. */
122     private SAMLObjectBuilder<SubjectConfirmation> subjectConfirmationBuilder;
123
124     /** For building subject confirmation data. */
125     private SAMLObjectBuilder<SubjectConfirmationData> subjectConfirmationDataBuilder;
126
127     /** For building conditions. */
128     private SAMLObjectBuilder<Conditions> conditionsBuilder;
129
130     /** For building audience restriction. */
131     private SAMLObjectBuilder<AudienceRestriction> audienceRestrictionBuilder;
132
133     /** For building proxy retrictions. */
134     private SAMLObjectBuilder<ProxyRestriction> proxyRestrictionBuilder;
135
136     /** For building audience. */
137     private SAMLObjectBuilder<Audience> audienceBuilder;
138
139     /** For building signature. */
140     private XMLObjectBuilder<Signature> signatureBuilder;
141
142     /** Constructor. */
143     @SuppressWarnings("unchecked")
144     protected AbstractSAML2ProfileHandler() {
145         super();
146
147         responseBuilder = (SAMLObjectBuilder<Response>) getBuilderFactory().getBuilder(Response.DEFAULT_ELEMENT_NAME);
148         statusBuilder = (SAMLObjectBuilder<Status>) getBuilderFactory().getBuilder(Status.DEFAULT_ELEMENT_NAME);
149         statusCodeBuilder = (SAMLObjectBuilder<StatusCode>) getBuilderFactory().getBuilder(
150                 StatusCode.DEFAULT_ELEMENT_NAME);
151         statusMessageBuilder = (SAMLObjectBuilder<StatusMessage>) getBuilderFactory().getBuilder(
152                 StatusMessage.DEFAULT_ELEMENT_NAME);
153         issuerBuilder = (SAMLObjectBuilder<Issuer>) getBuilderFactory().getBuilder(Issuer.DEFAULT_ELEMENT_NAME);
154         assertionBuilder = (SAMLObjectBuilder<Assertion>) getBuilderFactory()
155                 .getBuilder(Assertion.DEFAULT_ELEMENT_NAME);
156         subjectBuilder = (SAMLObjectBuilder<Subject>) getBuilderFactory().getBuilder(Subject.DEFAULT_ELEMENT_NAME);
157         subjectConfirmationBuilder = (SAMLObjectBuilder<SubjectConfirmation>) getBuilderFactory().getBuilder(
158                 SubjectConfirmation.DEFAULT_ELEMENT_NAME);
159         subjectConfirmationDataBuilder = (SAMLObjectBuilder<SubjectConfirmationData>) getBuilderFactory().getBuilder(
160                 SubjectConfirmationData.DEFAULT_ELEMENT_NAME);
161         conditionsBuilder = (SAMLObjectBuilder<Conditions>) getBuilderFactory().getBuilder(
162                 Conditions.DEFAULT_ELEMENT_NAME);
163         audienceRestrictionBuilder = (SAMLObjectBuilder<AudienceRestriction>) getBuilderFactory().getBuilder(
164                 AudienceRestriction.DEFAULT_ELEMENT_NAME);
165         proxyRestrictionBuilder = (SAMLObjectBuilder<ProxyRestriction>) getBuilderFactory().getBuilder(
166                 ProxyRestriction.DEFAULT_ELEMENT_NAME);
167         audienceBuilder = (SAMLObjectBuilder<Audience>) getBuilderFactory().getBuilder(Audience.DEFAULT_ELEMENT_NAME);
168         signatureBuilder = (XMLObjectBuilder<Signature>) getBuilderFactory().getBuilder(Signature.DEFAULT_ELEMENT_NAME);
169     }
170
171     /**
172      * Checks that the SAML major version for a request is 2.
173      * 
174      * @param requestContext current request context containing the SAML message
175      * 
176      * @throws ProfileException thrown if the major version of the SAML request is not 2
177      */
178     protected void checkSamlVersion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
179         SAMLVersion version = requestContext.getInboundSAMLMessage().getVersion();
180         if (version.getMajorVersion() < 2) {
181             requestContext.setFailureStatus(buildStatus(StatusCode.VERSION_MISMATCH_URI,
182                     StatusCode.REQUEST_VERSION_TOO_LOW_URI, null));
183             throw new ProfileException("SAML request version too low");
184         } else if (version.getMajorVersion() > 2) {
185             requestContext.setFailureStatus(buildStatus(StatusCode.VERSION_MISMATCH_URI,
186                     StatusCode.REQUEST_VERSION_TOO_HIGH_URI, null));
187             throw new ProfileException("SAML request version too high");
188         }
189     }
190
191     /**
192      * Builds a response to the attribute query within the request context.
193      * 
194      * @param requestContext current request context
195      * @param subjectConfirmationMethod confirmation method used for the subject
196      * @param statements the statements to include in the response
197      * 
198      * @return the built response
199      * 
200      * @throws ProfileException thrown if there is a problem creating the SAML response
201      */
202     protected Response buildResponse(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext,
203             String subjectConfirmationMethod, List<Statement> statements) throws ProfileException {
204
205         DateTime issueInstant = new DateTime();
206
207         Subject subject = buildSubject(requestContext, subjectConfirmationMethod, issueInstant);
208
209         // create the assertion and add the attribute statement
210         Assertion assertion = buildAssertion(requestContext, issueInstant);
211         assertion.setSubject(subject);
212         if (statements != null && !statements.isEmpty()) {
213             assertion.getStatements().addAll(statements);
214         }
215
216         // create the SAML response and add the assertion
217         Response samlResponse = responseBuilder.buildObject();
218         samlResponse.setIssueInstant(issueInstant);
219         populateStatusResponse(requestContext, samlResponse);
220
221         // sign the assertion if it should be signed
222         signAssertion(requestContext, assertion);
223
224         if (requestContext.getProfileConfiguration().getEncryptAssertion()) {
225             log.debug("Attempting to encrypt assertion to relying party {}", requestContext.getInboundMessageIssuer());
226             try {
227                 Encrypter encrypter = getEncrypter(requestContext.getInboundMessageIssuer());
228                 samlResponse.getEncryptedAssertions().add(encrypter.encrypt(assertion));
229             } catch (SecurityException e) {
230                 log.error("Unable to construct encrypter", e);
231                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
232                         "Unable to encrypt assertion"));
233                 throw new ProfileException("Unable to construct encrypter", e);
234             } catch (EncryptionException e) {
235                 log.error("Unable to encrypt assertion", e);
236                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
237                         "Unable to encrypt assertion"));
238                 throw new ProfileException("Unable to encrypt assertion", e);
239             }
240         } else {
241             samlResponse.getAssertions().add(assertion);
242         }
243
244         Status status = buildStatus(StatusCode.SUCCESS_URI, null, null);
245         samlResponse.setStatus(status);
246
247         return samlResponse;
248     }
249
250     /**
251      * Builds a basic assertion with its id, issue instant, SAML version, issuer, subject, and conditions populated.
252      * 
253      * @param requestContext current request context
254      * @param issueInstant time to use as assertion issue instant
255      * 
256      * @return the built assertion
257      */
258     protected Assertion buildAssertion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, DateTime issueInstant) {
259         Assertion assertion = assertionBuilder.buildObject();
260         assertion.setID(getIdGenerator().generateIdentifier());
261         assertion.setIssueInstant(issueInstant);
262         assertion.setVersion(SAMLVersion.VERSION_20);
263         assertion.setIssuer(buildEntityIssuer(requestContext));
264
265         Conditions conditions = buildConditions(requestContext, issueInstant);
266         assertion.setConditions(conditions);
267
268         return assertion;
269     }
270
271     /**
272      * Creates an {@link Issuer} populated with information about the relying party.
273      * 
274      * @param requestContext current request context
275      * 
276      * @return the built issuer
277      */
278     protected Issuer buildEntityIssuer(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) {
279         Issuer issuer = issuerBuilder.buildObject();
280         issuer.setFormat(Issuer.ENTITY);
281         issuer.setValue(requestContext.getLocalEntityId());
282
283         return issuer;
284     }
285
286     /**
287      * Builds a SAML assertion condition set. The following fields are set; not before, not on or after, audience
288      * restrictions, and proxy restrictions.
289      * 
290      * @param requestContext current request context
291      * @param issueInstant timestamp the assertion was created
292      * 
293      * @return constructed conditions
294      */
295     protected Conditions buildConditions(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, DateTime issueInstant) {
296         AbstractSAML2ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
297
298         Conditions conditions = conditionsBuilder.buildObject();
299         conditions.setNotBefore(issueInstant);
300         conditions.setNotOnOrAfter(issueInstant.plus(profileConfig.getAssertionLifetime()));
301
302         Collection<String> audiences;
303
304         // add audience restrictions
305         AudienceRestriction audienceRestriction = audienceRestrictionBuilder.buildObject();
306         //TODO we should only do this for certain outgoing bindings, not globally
307         Audience audience = audienceBuilder.buildObject();
308         audience.setAudienceURI(requestContext.getInboundMessageIssuer());
309         audiences = profileConfig.getAssertionAudiences();
310         if (audiences != null && audiences.size() > 0) {
311             for (String audienceUri : audiences) {
312                 audience = audienceBuilder.buildObject();
313                 audience.setAudienceURI(audienceUri);
314                 audienceRestriction.getAudiences().add(audience);
315             }
316             conditions.getAudienceRestrictions().add(audienceRestriction);
317         }
318
319         // add proxy restrictions
320         audiences = profileConfig.getProxyAudiences();
321         if (audiences != null && audiences.size() > 0) {
322             ProxyRestriction proxyRestriction = proxyRestrictionBuilder.buildObject();
323             for (String audienceUri : audiences) {
324                 audience = audienceBuilder.buildObject();
325                 audience.setAudienceURI(audienceUri);
326                 proxyRestriction.getAudiences().add(audience);
327             }
328
329             proxyRestriction.setProxyCount(profileConfig.getProxyCount());
330             conditions.getConditions().add(proxyRestriction);
331         }
332
333         return conditions;
334     }
335
336     /**
337      * Populates the response's id, in response to, issue instant, version, and issuer properties.
338      * 
339      * @param requestContext current request context
340      * @param response the response to populate
341      */
342     protected void populateStatusResponse(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext,
343             StatusResponseType response) {
344         response.setID(getIdGenerator().generateIdentifier());
345         if (requestContext.getInboundSAMLMessage() != null) {
346             response.setInResponseTo(requestContext.getInboundSAMLMessageId());
347         }
348         response.setVersion(SAMLVersion.VERSION_20);
349         response.setIssuer(buildEntityIssuer(requestContext));
350     }
351
352     /**
353      * Resolves the attributes for the principal.
354      * 
355      * @param requestContext current request context
356      * 
357      * @throws ProfileException thrown if there is a problem resolved attributes
358      */
359     protected void resolveAttributes(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
360         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
361         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
362
363         try {
364             log.debug("Resolving attributes for principal {} of SAML request from relying party {}", requestContext
365                     .getPrincipalName(), requestContext.getInboundMessageIssuer());
366             Map<String, BaseAttribute> principalAttributes = attributeAuthority.getAttributes(requestContext);
367
368             requestContext.setAttributes(principalAttributes);
369         } catch (AttributeRequestException e) {
370             log.error("Error resolving attributes for SAML request " + requestContext.getInboundSAMLMessageId()
371                     + " from relying party " + requestContext.getInboundMessageIssuer(), e);
372             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
373             throw new ProfileException("Error resolving attributes for SAML request "
374                     + requestContext.getInboundSAMLMessageId() + " from relying party "
375                     + requestContext.getInboundMessageIssuer(), e);
376         }
377     }
378
379     /**
380      * Executes a query for attributes and builds a SAML attribute statement from the results.
381      * 
382      * @param requestContext current request context
383      * 
384      * @return attribute statement resulting from the query
385      * 
386      * @throws ProfileException thrown if there is a problem making the query
387      */
388     protected AttributeStatement buildAttributeStatement(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext)
389             throws ProfileException {
390         log.debug("Creating attribute statement in response to SAML request {} from relying party {}", requestContext
391                 .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
392
393         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
394         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
395         try {
396             if (requestContext.getInboundSAMLMessage() instanceof AttributeQuery) {
397                 return attributeAuthority.buildAttributeStatement((AttributeQuery) requestContext
398                         .getInboundSAMLMessage(), requestContext.getPrincipalAttributes().values());
399             } else {
400                 return attributeAuthority.buildAttributeStatement(null, requestContext.getPrincipalAttributes()
401                         .values());
402             }
403         } catch (AttributeRequestException e) {
404             log.error("Error encoding attributes for principal " + requestContext.getPrincipalName(), e);
405             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
406             throw new ProfileException("Error encoding attributes for principal " + requestContext.getPrincipalName(),
407                     e);
408         }
409     }
410
411     /**
412      * Resolves the principal name of the subject of the request.
413      * 
414      * @param requestContext current request context
415      * 
416      * @throws ProfileException thrown if the principal name can not be resolved
417      */
418     protected void resolvePrincipal(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
419         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
420         if (profileConfiguration == null) {
421             log.error("Unable to resolve principal, no SAML 2 profile configuration for relying party "
422                     + requestContext.getInboundMessageIssuer());
423             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.REQUEST_DENIED_URI,
424                     "Error resolving principal"));
425             throw new ProfileException(
426                     "Unable to resolve principal, no SAML 2 profile configuration for relying party "
427                             + requestContext.getInboundMessageIssuer());
428         }
429         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
430         log.debug("Resolving principal name for subject of SAML request {} from relying party {}", requestContext
431                 .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
432
433         try {
434             String principal = attributeAuthority.getPrincipal(requestContext);
435             requestContext.setPrincipalName(principal);
436         } catch (AttributeRequestException e) {
437             log.error("Error resolving attributes for SAML request " + requestContext.getInboundSAMLMessageId()
438                     + " from relying party " + requestContext.getInboundMessageIssuer(), e);
439             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.UNKNOWN_PRINCIPAL_URI,
440                     "Error resolving principal"));
441             throw new ProfileException("Error resolving attributes for SAML request "
442                     + requestContext.getInboundSAMLMessageId() + " from relying party "
443                     + requestContext.getInboundMessageIssuer(), e);
444         }
445     }
446
447     /**
448      * Signs the given assertion if either the current profile configuration or the relying party configuration contains
449      * signing credentials.
450      * 
451      * @param requestContext current request context
452      * @param assertion assertion to sign
453      * 
454      * @throws ProfileException thrown if the metadata can not be located for the relying party or, if signing is
455      *             required, if a signing credential is not configured
456      */
457     protected void signAssertion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, Assertion assertion)
458             throws ProfileException {
459         log.debug("Determining if SAML assertion to relying party {} should be signed", requestContext
460                 .getInboundMessageIssuer());
461
462         boolean signAssertion = false;
463
464         AbstractSAML2ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
465         if (profileConfig.getSignAssertions()) {
466             signAssertion = true;
467             log.debug("IdP relying party configuration {} indicates to sign assertions: {}", requestContext
468                     .getRelyingPartyConfiguration().getRelyingPartyId(), signAssertion);
469         }
470
471         if (!signAssertion && requestContext.getPeerEntityRoleMetadata() instanceof SPSSODescriptor) {
472             SPSSODescriptor ssoDescriptor = (SPSSODescriptor) requestContext.getPeerEntityRoleMetadata();
473             if (ssoDescriptor.getWantAssertionsSigned() != null) {
474                 signAssertion = ssoDescriptor.getWantAssertionsSigned().booleanValue();
475                 log.debug("Entity metadata for relying party {} indicates to sign assertions: {}", requestContext
476                         .getInboundMessageIssuer(), signAssertion);
477             }
478         }
479
480         if (!signAssertion) {
481             return;
482         }
483
484         log.debug("Determining signing credntial for assertion to relying party {}", requestContext
485                 .getInboundMessageIssuer());
486         Credential signatureCredential = profileConfig.getSigningCredential();
487         if (signatureCredential == null) {
488             signatureCredential = requestContext.getRelyingPartyConfiguration().getDefaultSigningCredential();
489         }
490
491         if (signatureCredential == null) {
492             throw new ProfileException("No signing credential is specified for relying party configuration "
493                     + requestContext.getRelyingPartyConfiguration().getProviderId()
494                     + " or it's SAML2 attribute query profile configuration");
495         }
496
497         log.debug("Signing assertion to relying party {}", requestContext.getInboundMessageIssuer());
498         Signature signature = signatureBuilder.buildObject(Signature.DEFAULT_ELEMENT_NAME);
499
500         signature.setSigningCredential(signatureCredential);
501         try {
502             // TODO pull SecurityConfiguration from SAMLMessageContext? needs to be added
503             // TODO how to pull what keyInfoGenName to use?
504             SecurityHelper.prepareSignatureParams(signature, signatureCredential, null, null);
505         } catch (SecurityException e) {
506             throw new ProfileException("Error preparing signature for signing", e);
507         }
508
509         assertion.setSignature(signature);
510
511         Marshaller assertionMarshaller = Configuration.getMarshallerFactory().getMarshaller(assertion);
512         try {
513             assertionMarshaller.marshall(assertion);
514             Signer.signObject(signature);
515         } catch (MarshallingException e) {
516             log.error("Unable to marshall assertion for signing", e);
517             throw new ProfileException("Unable to marshall assertion for signing", e);
518         }
519     }
520
521     /**
522      * Build a status message, with an optional second-level failure message.
523      * 
524      * @param topLevelCode The top-level status code. Should be from saml-core-2.0-os, sec. 3.2.2.2
525      * @param secondLevelCode An optional second-level failure code. Should be from saml-core-2.0-is, sec 3.2.2.2. If
526      *            null, no second-level Status element will be set.
527      * @param failureMessage An optional second-level failure message
528      * 
529      * @return a Status object.
530      */
531     protected Status buildStatus(String topLevelCode, String secondLevelCode, String failureMessage) {
532         Status status = statusBuilder.buildObject();
533
534         StatusCode statusCode = statusCodeBuilder.buildObject();
535         statusCode.setValue(DatatypeHelper.safeTrimOrNullString(topLevelCode));
536         status.setStatusCode(statusCode);
537
538         if (secondLevelCode != null) {
539             StatusCode secondLevelStatusCode = statusCodeBuilder.buildObject();
540             secondLevelStatusCode.setValue(DatatypeHelper.safeTrimOrNullString(secondLevelCode));
541             statusCode.setStatusCode(secondLevelStatusCode);
542         }
543
544         if (failureMessage != null) {
545             StatusMessage msg = statusMessageBuilder.buildObject();
546             msg.setMessage(failureMessage);
547             status.setStatusMessage(msg);
548         }
549
550         return status;
551     }
552
553     /**
554      * Builds the SAML subject for the user for the service provider.
555      * 
556      * @param requestContext current request context
557      * @param confirmationMethod subject confirmation method used for the subject
558      * @param issueInstant instant the subject confirmation data should reflect for issuance
559      * 
560      * @return SAML subject for the user for the service provider
561      * 
562      * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
563      *             name ID attribute or because there are no supported name formats
564      */
565     protected Subject buildSubject(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, String confirmationMethod,
566             DateTime issueInstant) throws ProfileException {
567         NameID nameID = buildNameId(requestContext);
568         requestContext.setSubjectNameIdentifier(nameID);
569
570         SubjectConfirmationData confirmationData = subjectConfirmationDataBuilder.buildObject();
571         HTTPInTransport inTransport = (HTTPInTransport) requestContext.getInboundMessageTransport();
572         confirmationData.setAddress(inTransport.getPeerAddress());
573         confirmationData.setInResponseTo(requestContext.getInboundSAMLMessageId());
574         confirmationData.setNotOnOrAfter(issueInstant.plus(requestContext.getProfileConfiguration()
575                 .getAssertionLifetime()));
576
577         Endpoint relyingPartyEndpoint = requestContext.getPeerEntityEndpoint();
578         if (relyingPartyEndpoint != null) {
579             if (relyingPartyEndpoint.getResponseLocation() != null) {
580                 confirmationData.setRecipient(relyingPartyEndpoint.getResponseLocation());
581             } else {
582                 confirmationData.setRecipient(relyingPartyEndpoint.getLocation());
583             }
584         }
585
586         SubjectConfirmation subjectConfirmation = subjectConfirmationBuilder.buildObject();
587         subjectConfirmation.setMethod(confirmationMethod);
588         subjectConfirmation.setSubjectConfirmationData(confirmationData);
589
590         Subject subject = subjectBuilder.buildObject();
591         subject.getSubjectConfirmations().add(subjectConfirmation);
592
593         if (requestContext.getProfileConfiguration().getEncryptNameID()) {
594             log.debug("Attempting to encrypt NameID to relying party {}", requestContext.getInboundMessageIssuer());
595             try {
596                 Encrypter encrypter = getEncrypter(requestContext.getInboundMessageIssuer());
597                 subject.setEncryptedID(encrypter.encrypt(nameID));
598             } catch (SecurityException e) {
599                 log.error("Unable to construct encrypter", e);
600                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
601                         "Unable to construct NameID"));
602                 throw new ProfileException("Unable to construct encrypter", e);
603             } catch (EncryptionException e) {
604                 log.error("Unable to encrypt NameID", e);
605                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
606                         "Unable to construct NameID"));
607                 throw new ProfileException("Unable to encrypt NameID", e);
608             }
609         } else {
610             subject.setNameID(nameID);
611         }
612
613         return subject;
614     }
615
616     /**
617      * Builds a NameID appropriate for this request. NameIDs are built by inspecting the SAML request and metadata,
618      * picking a name format that was requested by the relying party or is mutually supported by both the relying party
619      * and asserting party as described in their metadata entries. Once a set of supported name formats is determined
620      * the principals attributes are inspected for an attribute supported an attribute encoder whose category is one of
621      * the supported name formats.
622      * 
623      * @param requestContext current request context
624      * 
625      * @return the NameID appropriate for this request
626      * 
627      * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
628      *             name ID attribute or because there are no supported name formats
629      */
630     protected NameID buildNameId(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
631         log.debug("Building assertion NameID for principal/relying party:{}/{}", requestContext.getPrincipalName(),
632                 requestContext.getInboundMessageIssuer());
633         
634         Map<String, BaseAttribute> principalAttributes = requestContext.getPrincipalAttributes();
635         if (principalAttributes == null || principalAttributes.isEmpty()) {
636             log.error("No attributes for principal {}, unable to construct of NameID", requestContext
637                     .getPrincipalName());
638             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.INVALID_NAMEID_POLICY_URI,
639                     "Unable to construct NameID"));
640             throw new ProfileException("No principal attributes support NameID construction");
641         }
642         
643         List<String> supportedNameFormats = getNameFormats(requestContext);        
644         if (supportedNameFormats == null || supportedNameFormats.isEmpty()) {
645             log.error("No common NameID formats supported by SP {} and IdP", requestContext.getInboundMessageIssuer());
646             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.INVALID_NAMEID_POLICY_URI,
647                     "Unable to construct NameID"));
648             throw new ProfileException("No principal attributes support NameID construction");
649         }
650         
651         log.debug("Supported NameID formats: {}", supportedNameFormats);
652         try {
653             SAML2NameIDAttributeEncoder nameIdEncoder;
654             for (BaseAttribute<?> attribute : principalAttributes.values()) {
655                 for (AttributeEncoder encoder : attribute.getEncoders()) {
656                     if (encoder instanceof SAML2NameIDAttributeEncoder) {
657                         nameIdEncoder = (SAML2NameIDAttributeEncoder) encoder;
658                         if (supportedNameFormats.contains(nameIdEncoder.getNameFormat())) {
659                             log.debug("Using attribute {} suppoting NameID format {} to create the NameID.", attribute
660                                     .getId(), nameIdEncoder.getNameFormat());
661                             return nameIdEncoder.encode(attribute);
662                         }
663                     }
664                 }
665             }
666
667             log.error("No principal attribute supported encoding into a supported name ID format.");
668             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
669             throw new ProfileException("No principal attribute supported encoding into a supported name ID format.");
670         } catch (AttributeEncodingException e) {
671             log.error("Unable to encode NameID attribute", e);
672             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
673             throw new ProfileException("Unable to encode NameID attribute", e);
674         }
675     }
676
677     /**
678      * Gets the NameID format to use when creating NameIDs for the relying party.
679      * 
680      * @param requestContext current request context
681      * 
682      * @return list of nameID formats that may be used with the relying party
683      * 
684      * @throws ProfileException thrown if there is a problem determing the NameID format to use
685      */
686     protected List<String> getNameFormats(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext)
687             throws ProfileException {
688         ArrayList<String> nameFormats = new ArrayList<String>();
689
690         // Determine name formats supported by both SP and IdP
691         RoleDescriptor relyingPartyRole = requestContext.getPeerEntityRoleMetadata();
692         if (relyingPartyRole != null) {
693             List<String> relyingPartySupportedFormats = getEntitySupportedFormats(relyingPartyRole);
694             if (relyingPartySupportedFormats != null && !relyingPartySupportedFormats.isEmpty()) {
695                 nameFormats.addAll(relyingPartySupportedFormats);
696
697                 RoleDescriptor assertingPartyRole = requestContext.getLocalEntityRoleMetadata();
698                 if (assertingPartyRole != null) {
699                     List<String> assertingPartySupportedFormats = getEntitySupportedFormats(assertingPartyRole);
700                     if (assertingPartySupportedFormats != null && !assertingPartySupportedFormats.isEmpty()) {
701                         nameFormats.retainAll(assertingPartySupportedFormats);
702                     }
703                 }
704             }
705         }
706
707         if (nameFormats.isEmpty()) {
708             nameFormats.add("urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified");
709         }
710
711         // If authn request and name ID policy format specified, make sure it's in the list of supported formats
712         String nameFormat = null;
713         if (requestContext.getInboundSAMLMessage() instanceof AuthnRequest) {
714             AuthnRequest authnRequest = (AuthnRequest) requestContext.getInboundSAMLMessage();
715             if (authnRequest.getNameIDPolicy() != null) {
716                 nameFormat = DatatypeHelper.safeTrimOrNullString(authnRequest.getNameIDPolicy().getFormat());
717                 if (nameFormat != null) {
718                     if (nameFormats.contains(nameFormat)) {
719                         nameFormats.clear();
720                         nameFormats.add(nameFormat);
721                     } else {
722                         requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI,
723                                 StatusCode.INVALID_NAMEID_POLICY_URI, "Format not supported: " + nameFormat));
724                         throw new ProfileException("NameID format required by relying party is not supported");
725                     }
726                 }
727
728             }
729         }
730
731         return nameFormats;
732     }
733
734     /**
735      * Gets the list of NameID formats supported for a given role.
736      * 
737      * @param role the role to get the list of supported NameID formats
738      * 
739      * @return list of supported NameID formats
740      */
741     protected List<String> getEntitySupportedFormats(RoleDescriptor role) {
742         List<NameIDFormat> nameIDFormats = null;
743
744         if (role instanceof SSODescriptor) {
745             nameIDFormats = ((SSODescriptor) role).getNameIDFormats();
746         } else if (role instanceof AuthnAuthorityDescriptor) {
747             nameIDFormats = ((AuthnAuthorityDescriptor) role).getNameIDFormats();
748         } else if (role instanceof PDPDescriptor) {
749             nameIDFormats = ((PDPDescriptor) role).getNameIDFormats();
750         } else if (role instanceof AttributeAuthorityDescriptor) {
751             nameIDFormats = ((AttributeAuthorityDescriptor) role).getNameIDFormats();
752         }
753
754         ArrayList<String> supportedFormats = new ArrayList<String>();
755         if (nameIDFormats != null) {
756             for (NameIDFormat format : nameIDFormats) {
757                 supportedFormats.add(format.getFormat());
758             }
759         }
760
761         return supportedFormats;
762     }
763
764     /**
765      * Constructs an SAML response message carrying a request error.
766      * 
767      * @param requestContext current request context
768      * 
769      * @return the constructed error response
770      */
771     protected Response buildErrorResponse(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) {
772         Response samlResponse = responseBuilder.buildObject();
773         samlResponse.setIssueInstant(new DateTime());
774         populateStatusResponse(requestContext, samlResponse);
775
776         samlResponse.setStatus(requestContext.getFailureStatus());
777
778         return samlResponse;
779     }
780
781     /**
782      * Gets an encrypter that may be used encrypt content to a given peer.
783      * 
784      * @param peerEntityId entity ID of the peer
785      * 
786      * @return encrypter that may be used encrypt content to a given peer
787      * 
788      * @throws SecurityException thrown if there is a problem constructing the encrypter. This normally occurs if the
789      *             key encryption credential for the peer can not be resolved or a required encryption algorithm is not
790      *             supported by the VM's JCE.
791      */
792     protected Encrypter getEncrypter(String peerEntityId) throws SecurityException {
793         SecurityConfiguration securityConfiguration = Configuration.getGlobalSecurityConfiguration();
794
795         EncryptionParameters dataEncParams = SecurityHelper
796                 .buildDataEncryptionParams(null, securityConfiguration, null);
797
798         Credential keyEncryptionCredentials = getKeyEncryptionCredential(peerEntityId);
799         String wrappedJCAKeyAlgorithm = SecurityHelper.getKeyAlgorithmFromURI(dataEncParams.getAlgorithm());
800         KeyEncryptionParameters keyEncParams = SecurityHelper.buildKeyEncryptionParams(keyEncryptionCredentials,
801                 wrappedJCAKeyAlgorithm, securityConfiguration, null, null);
802
803         Encrypter encrypter = new Encrypter(dataEncParams, keyEncParams);
804         encrypter.setKeyPlacement(KeyPlacement.INLINE);
805         return encrypter;
806     }
807
808     /**
809      * Gets the credential that can be used to encrypt encryption keys for a peer.
810      * 
811      * @param peerEntityId entity ID of the peer
812      * 
813      * @return credential that can be used to encrypt encryption keys for a peer
814      * 
815      * @throws SecurityException thrown if there is a problem resolving the credential from the peer's metadata
816      */
817     protected Credential getKeyEncryptionCredential(String peerEntityId) throws SecurityException {
818         MetadataCredentialResolver kekCredentialResolver = new MetadataCredentialResolver(getMetadataProvider());
819
820         CriteriaSet criteriaSet = new CriteriaSet();
821         criteriaSet.add(new EntityIDCriteria(peerEntityId));
822         criteriaSet.add(new MetadataCriteria(SPSSODescriptor.DEFAULT_ELEMENT_NAME, SAMLConstants.SAML20P_NS));
823         criteriaSet.add(new UsageCriteria(UsageType.ENCRYPTION));
824
825         return kekCredentialResolver.resolveSingle(criteriaSet);
826     }
827 }