Code to encrypt assertions
[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         audiences = profileConfig.getAssertionAudiences();
306         if (audiences != null && audiences.size() > 0) {
307             AudienceRestriction audienceRestriction = audienceRestrictionBuilder.buildObject();
308             for (String audienceUri : audiences) {
309                 Audience audience = audienceBuilder.buildObject();
310                 audience.setAudienceURI(audienceUri);
311                 audienceRestriction.getAudiences().add(audience);
312             }
313             conditions.getAudienceRestrictions().add(audienceRestriction);
314         }
315
316         // add proxy restrictions
317         audiences = profileConfig.getProxyAudiences();
318         if (audiences != null && audiences.size() > 0) {
319             ProxyRestriction proxyRestriction = proxyRestrictionBuilder.buildObject();
320             Audience audience;
321             for (String audienceUri : audiences) {
322                 audience = audienceBuilder.buildObject();
323                 audience.setAudienceURI(audienceUri);
324                 proxyRestriction.getAudiences().add(audience);
325             }
326
327             proxyRestriction.setProxyCount(profileConfig.getProxyCount());
328             conditions.getConditions().add(proxyRestriction);
329         }
330
331         return conditions;
332     }
333
334     /**
335      * Populates the response's id, in response to, issue instant, version, and issuer properties.
336      * 
337      * @param requestContext current request context
338      * @param response the response to populate
339      */
340     protected void populateStatusResponse(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext,
341             StatusResponseType response) {
342         response.setID(getIdGenerator().generateIdentifier());
343         if (requestContext.getInboundSAMLMessage() != null) {
344             response.setInResponseTo(requestContext.getInboundSAMLMessageId());
345         }
346         response.setVersion(SAMLVersion.VERSION_20);
347         response.setIssuer(buildEntityIssuer(requestContext));
348     }
349
350     /**
351      * Resolves the attributes for the principal.
352      * 
353      * @param requestContext current request context
354      * 
355      * @throws ProfileException thrown if there is a problem resolved attributes
356      */
357     protected void resolveAttributes(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
358         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
359         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
360
361         try {
362             log.debug("Resolving attributes for principal {} of SAML request from relying party {}", requestContext
363                     .getPrincipalName(), requestContext.getInboundMessageIssuer());
364             Map<String, BaseAttribute> principalAttributes = attributeAuthority.getAttributes(requestContext);
365
366             requestContext.setAttributes(principalAttributes);
367         } catch (AttributeRequestException e) {
368             log.error("Error resolving attributes for SAML request " + requestContext.getInboundSAMLMessageId()
369                     + " from relying party " + requestContext.getInboundMessageIssuer(), e);
370             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
371             throw new ProfileException("Error resolving attributes for SAML request "
372                     + requestContext.getInboundSAMLMessageId() + " from relying party "
373                     + requestContext.getInboundMessageIssuer(), e);
374         }
375     }
376
377     /**
378      * Executes a query for attributes and builds a SAML attribute statement from the results.
379      * 
380      * @param requestContext current request context
381      * 
382      * @return attribute statement resulting from the query
383      * 
384      * @throws ProfileException thrown if there is a problem making the query
385      */
386     protected AttributeStatement buildAttributeStatement(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext)
387             throws ProfileException {
388         log.debug("Creating attribute statement in response to SAML request {} from relying party {}", requestContext
389                 .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
390
391         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
392         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
393         try {
394             if (requestContext.getInboundSAMLMessage() instanceof AttributeQuery) {
395                 return attributeAuthority.buildAttributeStatement((AttributeQuery) requestContext
396                         .getInboundSAMLMessage(), requestContext.getPrincipalAttributes().values());
397             } else {
398                 return attributeAuthority.buildAttributeStatement(null, requestContext.getPrincipalAttributes()
399                         .values());
400             }
401         } catch (AttributeRequestException e) {
402             log.error("Error encoding attributes for principal " + requestContext.getPrincipalName(), e);
403             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Error resolving attributes"));
404             throw new ProfileException("Error encoding attributes for principal " + requestContext.getPrincipalName(),
405                     e);
406         }
407     }
408
409     /**
410      * Resolves the principal name of the subject of the request.
411      * 
412      * @param requestContext current request context
413      * 
414      * @throws ProfileException thrown if the principal name can not be resolved
415      */
416     protected void resolvePrincipal(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
417         AbstractSAML2ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
418         if (profileConfiguration == null) {
419             log.error("Unable to resolve principal, no SAML 2 profile configuration for relying party "
420                     + requestContext.getInboundMessageIssuer());
421             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.REQUEST_DENIED_URI,
422                     "Error resolving principal"));
423             throw new ProfileException(
424                     "Unable to resolve principal, no SAML 2 profile configuration for relying party "
425                             + requestContext.getInboundMessageIssuer());
426         }
427         SAML2AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
428         log.debug("Resolving principal name for subject of SAML request {} from relying party {}", requestContext
429                 .getInboundSAMLMessageId(), requestContext.getInboundMessageIssuer());
430
431         try {
432             String principal = attributeAuthority.getPrincipal(requestContext);
433             requestContext.setPrincipalName(principal);
434         } catch (AttributeRequestException e) {
435             log.error("Error resolving attributes for SAML request " + requestContext.getInboundSAMLMessageId()
436                     + " from relying party " + requestContext.getInboundMessageIssuer(), e);
437             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.UNKNOWN_PRINCIPAL_URI,
438                     "Error resolving principal"));
439             throw new ProfileException("Error resolving attributes for SAML request "
440                     + requestContext.getInboundSAMLMessageId() + " from relying party "
441                     + requestContext.getInboundMessageIssuer(), e);
442         }
443     }
444
445     /**
446      * Signs the given assertion if either the current profile configuration or the relying party configuration contains
447      * signing credentials.
448      * 
449      * @param requestContext current request context
450      * @param assertion assertion to sign
451      * 
452      * @throws ProfileException thrown if the metadata can not be located for the relying party or, if signing is
453      *             required, if a signing credential is not configured
454      */
455     protected void signAssertion(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, Assertion assertion)
456             throws ProfileException {
457         log.debug("Determining if SAML assertion to relying party {} should be signed", requestContext
458                 .getInboundMessageIssuer());
459
460         boolean signAssertion = false;
461
462         AbstractSAML2ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
463         if (profileConfig.getSignAssertions()) {
464             signAssertion = true;
465             log.debug("IdP relying party configuration {} indicates to sign assertions: {}", requestContext
466                     .getRelyingPartyConfiguration().getRelyingPartyId(), signAssertion);
467         }
468
469         if (!signAssertion && requestContext.getPeerEntityRoleMetadata() instanceof SPSSODescriptor) {
470             SPSSODescriptor ssoDescriptor = (SPSSODescriptor) requestContext.getPeerEntityRoleMetadata();
471             if (ssoDescriptor.getWantAssertionsSigned() != null) {
472                 signAssertion = ssoDescriptor.getWantAssertionsSigned().booleanValue();
473                 log.debug("Entity metadata for relying party {} indicates to sign assertions: {}", requestContext
474                         .getInboundMessageIssuer(), signAssertion);
475             }
476         }
477
478         if (!signAssertion) {
479             return;
480         }
481
482         log.debug("Determining signing credntial for assertion to relying party {}", requestContext
483                 .getInboundMessageIssuer());
484         Credential signatureCredential = profileConfig.getSigningCredential();
485         if (signatureCredential == null) {
486             signatureCredential = requestContext.getRelyingPartyConfiguration().getDefaultSigningCredential();
487         }
488
489         if (signatureCredential == null) {
490             throw new ProfileException("No signing credential is specified for relying party configuration "
491                     + requestContext.getRelyingPartyConfiguration().getProviderId()
492                     + " or it's SAML2 attribute query profile configuration");
493         }
494
495         log.debug("Signing assertion to relying party {}", requestContext.getInboundMessageIssuer());
496         Signature signature = signatureBuilder.buildObject(Signature.DEFAULT_ELEMENT_NAME);
497
498         signature.setSigningCredential(signatureCredential);
499         try {
500             // TODO pull SecurityConfiguration from SAMLMessageContext? needs to be added
501             // TODO how to pull what keyInfoGenName to use?
502             SecurityHelper.prepareSignatureParams(signature, signatureCredential, null, null);
503         } catch (SecurityException e) {
504             throw new ProfileException("Error preparing signature for signing", e);
505         }
506
507         assertion.setSignature(signature);
508
509         Marshaller assertionMarshaller = Configuration.getMarshallerFactory().getMarshaller(assertion);
510         try {
511             assertionMarshaller.marshall(assertion);
512             Signer.signObject(signature);
513         } catch (MarshallingException e) {
514             log.error("Unable to marshall assertion for signing", e);
515             throw new ProfileException("Unable to marshall assertion for signing", e);
516         }
517     }
518
519     /**
520      * Build a status message, with an optional second-level failure message.
521      * 
522      * @param topLevelCode The top-level status code. Should be from saml-core-2.0-os, sec. 3.2.2.2
523      * @param secondLevelCode An optional second-level failure code. Should be from saml-core-2.0-is, sec 3.2.2.2. If
524      *            null, no second-level Status element will be set.
525      * @param failureMessage An optional second-level failure message
526      * 
527      * @return a Status object.
528      */
529     protected Status buildStatus(String topLevelCode, String secondLevelCode, String failureMessage) {
530         Status status = statusBuilder.buildObject();
531
532         StatusCode statusCode = statusCodeBuilder.buildObject();
533         statusCode.setValue(DatatypeHelper.safeTrimOrNullString(topLevelCode));
534         status.setStatusCode(statusCode);
535
536         if (secondLevelCode != null) {
537             StatusCode secondLevelStatusCode = statusCodeBuilder.buildObject();
538             secondLevelStatusCode.setValue(DatatypeHelper.safeTrimOrNullString(secondLevelCode));
539             statusCode.setStatusCode(secondLevelStatusCode);
540         }
541
542         if (failureMessage != null) {
543             StatusMessage msg = statusMessageBuilder.buildObject();
544             msg.setMessage(failureMessage);
545             status.setStatusMessage(msg);
546         }
547
548         return status;
549     }
550
551     /**
552      * Builds the SAML subject for the user for the service provider.
553      * 
554      * @param requestContext current request context
555      * @param confirmationMethod subject confirmation method used for the subject
556      * @param issueInstant instant the subject confirmation data should reflect for issuance
557      * 
558      * @return SAML subject for the user for the service provider
559      * 
560      * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
561      *             name ID attribute or because there are no supported name formats
562      */
563     protected Subject buildSubject(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext, String confirmationMethod,
564             DateTime issueInstant) throws ProfileException {
565         NameID nameID = buildNameId(requestContext);
566         requestContext.setSubjectNameIdentifier(nameID);
567
568         SubjectConfirmationData confirmationData = subjectConfirmationDataBuilder.buildObject();
569         HTTPInTransport inTransport = (HTTPInTransport) requestContext.getInboundMessageTransport();
570         confirmationData.setAddress(inTransport.getPeerAddress());
571         confirmationData.setInResponseTo(requestContext.getInboundSAMLMessageId());
572         confirmationData.setNotOnOrAfter(issueInstant.plus(requestContext.getProfileConfiguration()
573                 .getAssertionLifetime()));
574
575         Endpoint relyingPartyEndpoint = requestContext.getPeerEntityEndpoint();
576         if (relyingPartyEndpoint != null) {
577             if (relyingPartyEndpoint.getResponseLocation() != null) {
578                 confirmationData.setRecipient(relyingPartyEndpoint.getResponseLocation());
579             } else {
580                 confirmationData.setRecipient(relyingPartyEndpoint.getLocation());
581             }
582         }
583
584         SubjectConfirmation subjectConfirmation = subjectConfirmationBuilder.buildObject();
585         subjectConfirmation.setMethod(confirmationMethod);
586         subjectConfirmation.setSubjectConfirmationData(confirmationData);
587
588         Subject subject = subjectBuilder.buildObject();
589         subject.getSubjectConfirmations().add(subjectConfirmation);
590
591         if (requestContext.getProfileConfiguration().getEncryptNameID()) {
592             log.debug("Attempting to encrypt NameID to relying party {}", requestContext.getInboundMessageIssuer());
593             try {
594                 Encrypter encrypter = getEncrypter(requestContext.getInboundMessageIssuer());
595                 subject.setEncryptedID(encrypter.encrypt(nameID));
596             } catch (SecurityException e) {
597                 log.error("Unable to construct encrypter", e);
598                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
599                         "Unable to construct NameID"));
600                 throw new ProfileException("Unable to construct encrypter", e);
601             } catch (EncryptionException e) {
602                 log.error("Unable to encrypt NameID", e);
603                 requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null,
604                         "Unable to construct NameID"));
605                 throw new ProfileException("Unable to encrypt NameID", e);
606             }
607         } else {
608             subject.setNameID(nameID);
609         }
610
611         return subject;
612     }
613
614     /**
615      * Builds a NameID appropriate for this request. NameIDs are built by inspecting the SAML request and metadata,
616      * picking a name format that was requested by the relying party or is mutually supported by both the relying party
617      * and asserting party as described in their metadata entries. Once a set of supported name formats is determined
618      * the principals attributes are inspected for an attribute supported an attribute encoder whose category is one of
619      * the supported name formats.
620      * 
621      * @param requestContext current request context
622      * 
623      * @return the NameID appropriate for this request
624      * 
625      * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
626      *             name ID attribute or because there are no supported name formats
627      */
628     protected NameID buildNameId(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
629         log.debug("Building assertion NameID for principal/relying party:{}/{}", requestContext.getPrincipalName(),
630                 requestContext.getInboundMessageIssuer());
631         Map<String, BaseAttribute> principalAttributes = requestContext.getPrincipalAttributes();
632         List<String> supportedNameFormats = getNameFormats(requestContext);
633
634         log.debug("Supported NameID formats: {}", supportedNameFormats);
635
636         if (principalAttributes == null || supportedNameFormats == null) {
637             log.error("No attributes for principal " + requestContext.getPrincipalName()
638                     + " support constructions of NameID");
639             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, StatusCode.INVALID_NAMEID_POLICY_URI,
640                     "Unable to construct NameID"));
641             throw new ProfileException("No principal attributes support NameID construction");
642         }
643
644         try {
645             SAML2NameIDAttributeEncoder nameIdEncoder;
646             for (BaseAttribute<?> attribute : principalAttributes.values()) {
647                 for (AttributeEncoder encoder : attribute.getEncoders()) {
648                     if (encoder instanceof SAML2NameIDAttributeEncoder) {
649                         nameIdEncoder = (SAML2NameIDAttributeEncoder) encoder;
650                         if (supportedNameFormats.contains(nameIdEncoder.getNameFormat())) {
651                             log.debug("Using attribute {} suppoting NameID format {} to create the NameID.", attribute
652                                     .getId(), nameIdEncoder.getNameFormat());
653                             return nameIdEncoder.encode(attribute);
654                         }
655                     }
656                 }
657             }
658
659             log.error("No principal attribute supported encoding into a supported name ID format.");
660             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
661             throw new ProfileException("No principal attribute supported encoding into a supported name ID format.");
662         } catch (AttributeEncodingException e) {
663             log.error("Unable to encode NameID attribute", e);
664             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI, null, "Unable to construct NameID"));
665             throw new ProfileException("Unable to encode NameID attribute", e);
666         }
667     }
668
669     /**
670      * Gets the NameID format to use when creating NameIDs for the relying party.
671      * 
672      * @param requestContext current request context
673      * 
674      * @return list of nameID formats that may be used with the relying party
675      * 
676      * @throws ProfileException thrown if there is a problem determing the NameID format to use
677      */
678     protected List<String> getNameFormats(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext)
679             throws ProfileException {
680         ArrayList<String> nameFormats = new ArrayList<String>();
681
682         // Determine name formats supported by both SP and IdP
683         RoleDescriptor relyingPartyRole = requestContext.getPeerEntityRoleMetadata();
684         if (relyingPartyRole != null) {
685             List<String> relyingPartySupportedFormats = getEntitySupportedFormats(relyingPartyRole);
686             if (relyingPartySupportedFormats != null && !relyingPartySupportedFormats.isEmpty()) {
687                 nameFormats.addAll(relyingPartySupportedFormats);
688
689                 RoleDescriptor assertingPartyRole = requestContext.getLocalEntityRoleMetadata();
690                 if (assertingPartyRole != null) {
691                     List<String> assertingPartySupportedFormats = getEntitySupportedFormats(assertingPartyRole);
692                     if (assertingPartySupportedFormats != null && !assertingPartySupportedFormats.isEmpty()) {
693                         nameFormats.retainAll(assertingPartySupportedFormats);
694                     }
695                 }
696             }
697         }
698
699         if (nameFormats.isEmpty()) {
700             nameFormats.add("urn:oasis:names:tc:SAML:2.0:nameid-format:unspecified");
701         }
702
703         // If authn request and name ID policy format specified, make sure it's in the list of supported formats
704         String nameFormat = null;
705         if (requestContext.getInboundSAMLMessage() instanceof AuthnRequest) {
706             AuthnRequest authnRequest = (AuthnRequest) requestContext.getInboundSAMLMessage();
707             if (authnRequest.getNameIDPolicy() != null) {
708                 nameFormat = DatatypeHelper.safeTrimOrNullString(authnRequest.getNameIDPolicy().getFormat());
709                 if (nameFormat != null) {
710                     if (nameFormats.contains(nameFormat)) {
711                         nameFormats.clear();
712                         nameFormats.add(nameFormat);
713                     } else {
714                         requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER_URI,
715                                 StatusCode.INVALID_NAMEID_POLICY_URI, "Format not supported: " + nameFormat));
716                         throw new ProfileException("NameID format required by relying party is not supported");
717                     }
718                 }
719
720             }
721         }
722
723         return nameFormats;
724     }
725
726     /**
727      * Gets the list of NameID formats supported for a given role.
728      * 
729      * @param role the role to get the list of supported NameID formats
730      * 
731      * @return list of supported NameID formats
732      */
733     protected List<String> getEntitySupportedFormats(RoleDescriptor role) {
734         List<NameIDFormat> nameIDFormats = null;
735
736         if (role instanceof SSODescriptor) {
737             nameIDFormats = ((SSODescriptor) role).getNameIDFormats();
738         } else if (role instanceof AuthnAuthorityDescriptor) {
739             nameIDFormats = ((AuthnAuthorityDescriptor) role).getNameIDFormats();
740         } else if (role instanceof PDPDescriptor) {
741             nameIDFormats = ((PDPDescriptor) role).getNameIDFormats();
742         } else if (role instanceof AttributeAuthorityDescriptor) {
743             nameIDFormats = ((AttributeAuthorityDescriptor) role).getNameIDFormats();
744         }
745
746         ArrayList<String> supportedFormats = new ArrayList<String>();
747         if (nameIDFormats != null) {
748             for (NameIDFormat format : nameIDFormats) {
749                 supportedFormats.add(format.getFormat());
750             }
751         }
752
753         return supportedFormats;
754     }
755
756     /**
757      * Constructs an SAML response message carrying a request error.
758      * 
759      * @param requestContext current request context
760      * 
761      * @return the constructed error response
762      */
763     protected Response buildErrorResponse(BaseSAML2ProfileRequestContext<?, ?, ?> requestContext) {
764         Response samlResponse = responseBuilder.buildObject();
765         samlResponse.setIssueInstant(new DateTime());
766         populateStatusResponse(requestContext, samlResponse);
767
768         samlResponse.setStatus(requestContext.getFailureStatus());
769
770         return samlResponse;
771     }
772
773     /**
774      * Gets an encrypter that may be used encrypt content to a given peer.
775      * 
776      * @param peerEntityId entity ID of the peer
777      * 
778      * @return encrypter that may be used encrypt content to a given peer
779      * 
780      * @throws SecurityException thrown if there is a problem constructing the encrypter. This normally occurs if the
781      *             key encryption credential for the peer can not be resolved or a required encryption algorithm is not
782      *             supported by the VM's JCE.
783      */
784     protected Encrypter getEncrypter(String peerEntityId) throws SecurityException {
785         SecurityConfiguration securityConfiguration = Configuration.getGlobalSecurityConfiguration();
786
787         EncryptionParameters dataEncParams = SecurityHelper
788                 .buildDataEncryptionParams(null, securityConfiguration, null);
789
790         Credential keyEncryptionCredentials = getKeyEncryptionCredential(peerEntityId);
791         String wrappedJCAKeyAlgorithm = SecurityHelper.getKeyAlgorithmFromURI(dataEncParams.getAlgorithm());
792         KeyEncryptionParameters keyEncParams = SecurityHelper.buildKeyEncryptionParams(keyEncryptionCredentials,
793                 wrappedJCAKeyAlgorithm, securityConfiguration, null, null);
794
795         Encrypter encrypter = new Encrypter(dataEncParams, keyEncParams);
796         encrypter.setKeyPlacement(KeyPlacement.INLINE);
797         return encrypter;
798     }
799
800     /**
801      * Gets the credential that can be used to encrypt encryption keys for a peer.
802      * 
803      * @param peerEntityId entity ID of the peer
804      * 
805      * @return credential that can be used to encrypt encryption keys for a peer
806      * 
807      * @throws SecurityException thrown if there is a problem resolving the credential from the peer's metadata
808      */
809     protected Credential getKeyEncryptionCredential(String peerEntityId) throws SecurityException {
810         MetadataCredentialResolver kekCredentialResolver = new MetadataCredentialResolver(getMetadataProvider());
811
812         CriteriaSet criteriaSet = new CriteriaSet();
813         criteriaSet.add(new EntityIDCriteria(peerEntityId));
814         criteriaSet.add(new MetadataCriteria(SPSSODescriptor.DEFAULT_ELEMENT_NAME, SAMLConstants.SAML20P_NS));
815         criteriaSet.add(new UsageCriteria(UsageType.ENCRYPTION));
816
817         return kekCredentialResolver.resolveSingle(criteriaSet);
818     }
819 }