decrease verbosity and logging messge of error message logged when a name ID can...
[java-idp.git] / src / main / java / edu / internet2 / middleware / shibboleth / idp / profile / saml1 / AbstractSAML1ProfileHandler.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.saml1;
18
19 import java.util.Collection;
20 import java.util.List;
21 import java.util.Map;
22
23 import javax.xml.namespace.QName;
24
25 import org.joda.time.DateTime;
26 import org.opensaml.Configuration;
27 import org.opensaml.common.SAMLObject;
28 import org.opensaml.common.SAMLObjectBuilder;
29 import org.opensaml.common.SAMLVersion;
30 import org.opensaml.common.binding.encoding.SAMLMessageEncoder;
31 import org.opensaml.saml1.core.Assertion;
32 import org.opensaml.saml1.core.AttributeQuery;
33 import org.opensaml.saml1.core.AttributeStatement;
34 import org.opensaml.saml1.core.Audience;
35 import org.opensaml.saml1.core.AudienceRestrictionCondition;
36 import org.opensaml.saml1.core.Conditions;
37 import org.opensaml.saml1.core.ConfirmationMethod;
38 import org.opensaml.saml1.core.NameIdentifier;
39 import org.opensaml.saml1.core.RequestAbstractType;
40 import org.opensaml.saml1.core.Response;
41 import org.opensaml.saml1.core.ResponseAbstractType;
42 import org.opensaml.saml1.core.Statement;
43 import org.opensaml.saml1.core.Status;
44 import org.opensaml.saml1.core.StatusCode;
45 import org.opensaml.saml1.core.StatusMessage;
46 import org.opensaml.saml1.core.Subject;
47 import org.opensaml.saml1.core.SubjectConfirmation;
48 import org.opensaml.saml1.core.SubjectStatement;
49 import org.opensaml.saml2.metadata.SPSSODescriptor;
50 import org.opensaml.ws.message.encoder.MessageEncodingException;
51 import org.opensaml.xml.XMLObjectBuilder;
52 import org.opensaml.xml.io.Marshaller;
53 import org.opensaml.xml.io.MarshallingException;
54 import org.opensaml.xml.security.SecurityException;
55 import org.opensaml.xml.security.SecurityHelper;
56 import org.opensaml.xml.security.credential.Credential;
57 import org.opensaml.xml.signature.Signature;
58 import org.opensaml.xml.signature.SignatureException;
59 import org.opensaml.xml.signature.Signer;
60 import org.opensaml.xml.util.Pair;
61 import org.slf4j.Logger;
62 import org.slf4j.LoggerFactory;
63 import org.slf4j.helpers.MessageFormatter;
64
65 import edu.internet2.middleware.shibboleth.common.attribute.AttributeRequestException;
66 import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
67 import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncodingException;
68 import edu.internet2.middleware.shibboleth.common.attribute.encoding.SAML1NameIdentifierEncoder;
69 import edu.internet2.middleware.shibboleth.common.attribute.provider.SAML1AttributeAuthority;
70 import edu.internet2.middleware.shibboleth.common.log.AuditLogEntry;
71 import edu.internet2.middleware.shibboleth.common.profile.ProfileException;
72 import edu.internet2.middleware.shibboleth.common.profile.provider.BaseSAMLProfileRequestContext;
73 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.CryptoOperationRequirementLevel;
74 import edu.internet2.middleware.shibboleth.common.relyingparty.provider.saml1.AbstractSAML1ProfileConfiguration;
75 import edu.internet2.middleware.shibboleth.idp.profile.AbstractSAMLProfileHandler;
76 import edu.internet2.middleware.shibboleth.idp.session.ServiceInformation;
77 import edu.internet2.middleware.shibboleth.idp.session.Session;
78
79 /** Common implementation details for profile handlers. */
80 public abstract class AbstractSAML1ProfileHandler extends AbstractSAMLProfileHandler {
81
82     /** SAML Version for this profile handler. */
83     public static final SAMLVersion SAML_VERSION = SAMLVersion.VERSION_11;
84
85     /** Class logger. */
86     private static Logger log = LoggerFactory.getLogger(AbstractSAML1ProfileHandler.class);
87
88     /** Builder of Response objects. */
89     private SAMLObjectBuilder<Response> responseBuilder;
90
91     /** Builder of Assertion objects. */
92     private SAMLObjectBuilder<Assertion> assertionBuilder;
93
94     /** Builder of Conditions objects. */
95     private SAMLObjectBuilder<Conditions> conditionsBuilder;
96
97     /** Builder of AudienceRestrictionCondition objects. */
98     private SAMLObjectBuilder<AudienceRestrictionCondition> audienceRestrictionConditionBuilder;
99
100     /** Builder of AudienceRestrictionCondition objects. */
101     private SAMLObjectBuilder<Audience> audienceBuilder;
102
103     /** Builder of SubjectConfirmation objects. */
104     private SAMLObjectBuilder<SubjectConfirmation> subjectConfirmationBuilder;
105
106     /** Builder of ConfirmationMethod objects. */
107     private SAMLObjectBuilder<ConfirmationMethod> confirmationMethodBuilder;
108
109     /** Builder of Subject objects. */
110     private SAMLObjectBuilder<Subject> subjectBuilder;
111
112     /** Builder for Status objects. */
113     private SAMLObjectBuilder<Status> statusBuilder;
114
115     /** Builder for StatusCode objects. */
116     private SAMLObjectBuilder<StatusCode> statusCodeBuilder;
117
118     /** Builder for StatusMessage objects. */
119     private SAMLObjectBuilder<StatusMessage> statusMessageBuilder;
120
121     /** For building signature. */
122     private XMLObjectBuilder<Signature> signatureBuilder;
123
124     /**
125      * Default constructor.
126      */
127     @SuppressWarnings("unchecked")
128     public AbstractSAML1ProfileHandler() {
129         super();
130         responseBuilder = (SAMLObjectBuilder<Response>) getBuilderFactory().getBuilder(Response.DEFAULT_ELEMENT_NAME);
131         assertionBuilder = (SAMLObjectBuilder<Assertion>) getBuilderFactory()
132                 .getBuilder(Assertion.DEFAULT_ELEMENT_NAME);
133         conditionsBuilder = (SAMLObjectBuilder<Conditions>) getBuilderFactory().getBuilder(
134                 Conditions.DEFAULT_ELEMENT_NAME);
135         audienceRestrictionConditionBuilder = (SAMLObjectBuilder<AudienceRestrictionCondition>) getBuilderFactory()
136                 .getBuilder(AudienceRestrictionCondition.DEFAULT_ELEMENT_NAME);
137         audienceBuilder = (SAMLObjectBuilder<Audience>) getBuilderFactory().getBuilder(Audience.DEFAULT_ELEMENT_NAME);
138         subjectConfirmationBuilder = (SAMLObjectBuilder<SubjectConfirmation>) getBuilderFactory().getBuilder(
139                 SubjectConfirmation.DEFAULT_ELEMENT_NAME);
140         confirmationMethodBuilder = (SAMLObjectBuilder<ConfirmationMethod>) getBuilderFactory().getBuilder(
141                 ConfirmationMethod.DEFAULT_ELEMENT_NAME);
142         subjectBuilder = (SAMLObjectBuilder<Subject>) getBuilderFactory().getBuilder(Subject.DEFAULT_ELEMENT_NAME);
143         statusBuilder = (SAMLObjectBuilder<Status>) getBuilderFactory().getBuilder(Status.DEFAULT_ELEMENT_NAME);
144         statusCodeBuilder = (SAMLObjectBuilder<StatusCode>) getBuilderFactory().getBuilder(
145                 StatusCode.DEFAULT_ELEMENT_NAME);
146         statusMessageBuilder = (SAMLObjectBuilder<StatusMessage>) getBuilderFactory().getBuilder(
147                 StatusMessage.DEFAULT_ELEMENT_NAME);
148         signatureBuilder = (XMLObjectBuilder<Signature>) getBuilderFactory().getBuilder(Signature.DEFAULT_ELEMENT_NAME);
149     }
150
151     /** {@inheritDoc} */
152     protected void populateRequestContext(BaseSAMLProfileRequestContext requestContext) throws ProfileException {
153         BaseSAML1ProfileRequestContext saml1Request = (BaseSAML1ProfileRequestContext) requestContext;
154         try {
155             super.populateRequestContext(requestContext);
156         } catch (ProfileException e) {
157             if (saml1Request.getFailureStatus() == null) {
158                 saml1Request.setFailureStatus(buildStatus(StatusCode.REQUESTER, null, e.getMessage()));
159             }
160             throw e;
161         }
162     }
163
164     /**
165      * Populates the request context with the information about the user.
166      * 
167      * This method requires the the following request context properties to be populated: inbound message transport,
168      * relying party ID
169      * 
170      * This methods populates the following request context properties: user's session, user's principal name, and
171      * service authentication method
172      * 
173      * @param requestContext current request context
174      */
175     protected void populateUserInformation(BaseSAMLProfileRequestContext requestContext) {
176         Session userSession = getUserSession(requestContext.getInboundMessageTransport());
177         if (userSession == null) {
178             NameIdentifier subject = (NameIdentifier) requestContext.getSubjectNameIdentifier();
179             if (subject != null && subject.getNameIdentifier() != null) {
180                 userSession = getUserSession(subject.getNameIdentifier());
181             }
182         }
183
184         if (userSession != null) {
185             requestContext.setUserSession(userSession);
186             requestContext.setPrincipalName(userSession.getPrincipalName());
187             ServiceInformation serviceInfo = userSession.getServicesInformation().get(
188                     requestContext.getInboundMessageIssuer());
189             if (serviceInfo != null) {
190                 requestContext.setPrincipalAuthenticationMethod(serviceInfo.getAuthenticationMethod()
191                         .getAuthenticationMethod());
192             }
193         }
194     }
195
196     /**
197      * Checks that the SAML major version for a request is 1.
198      * 
199      * @param requestContext current request context containing the SAML message
200      * 
201      * @throws ProfileException thrown if the major version of the SAML request is not 1
202      */
203     protected void checkSamlVersion(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
204         SAMLObject samlObject = requestContext.getInboundSAMLMessage();
205
206         if (samlObject instanceof RequestAbstractType) {
207             RequestAbstractType request = (RequestAbstractType) samlObject;
208             if (request.getMajorVersion() < 1) {
209                 requestContext.setFailureStatus(buildStatus(StatusCode.REQUESTER, StatusCode.REQUEST_VERSION_TOO_LOW,
210                         null));
211                 throw new ProfileException("SAML request major version too low");
212             } else if (request.getMajorVersion() > 1) {
213                 requestContext.setFailureStatus(buildStatus(StatusCode.REQUESTER, StatusCode.REQUEST_VERSION_TOO_HIGH,
214                         null));
215                 throw new ProfileException("SAML request major version too low");
216             }
217         }
218     }
219
220     /**
221      * Builds a response to the attribute query within the request context.
222      * 
223      * @param requestContext current request context
224      * @param statements the statements to include in the response
225      * 
226      * @return the built response
227      * 
228      * @throws ProfileException thrown if there is a problem creating the SAML response
229      */
230     protected Response buildResponse(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext, List<Statement> statements)
231             throws ProfileException {
232
233         DateTime issueInstant = new DateTime();
234
235         // create the SAML response and add the assertion
236         Response samlResponse = responseBuilder.buildObject();
237         samlResponse.setIssueInstant(issueInstant);
238         populateStatusResponse(requestContext, samlResponse);
239
240         // create the assertion and add the attribute statement
241         Assertion assertion = null;
242         if (statements != null && !statements.isEmpty()) {
243             assertion = buildAssertion(requestContext, issueInstant);
244             assertion.getStatements().addAll(statements);
245             samlResponse.getAssertions().add(assertion);
246             signAssertion(requestContext, assertion);
247         }
248
249         Status status = buildStatus(StatusCode.SUCCESS, null, null);
250         samlResponse.setStatus(status);
251
252         return samlResponse;
253     }
254
255     /**
256      * Builds a basic assertion with its id, issue instant, SAML version, issuer, subject, and conditions populated.
257      * 
258      * @param requestContext current request context
259      * @param issueInstant time to use as assertion issue instant
260      * 
261      * @return the built assertion
262      */
263     protected Assertion buildAssertion(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext, DateTime issueInstant) {
264         Assertion assertion = assertionBuilder.buildObject();
265         assertion.setID(getIdGenerator().generateIdentifier());
266         assertion.setIssueInstant(issueInstant);
267         assertion.setVersion(SAMLVersion.VERSION_11);
268         assertion.setIssuer(requestContext.getLocalEntityId());
269
270         Conditions conditions = buildConditions(requestContext, issueInstant);
271         assertion.setConditions(conditions);
272
273         return assertion;
274     }
275
276     /**
277      * Builds a SAML assertion condition set. The following fields are set; not before, not on or after, audience
278      * restrictions, and proxy restrictions.
279      * 
280      * @param requestContext current request context
281      * @param issueInstant timestamp the assertion was created
282      * 
283      * @return constructed conditions
284      */
285     protected Conditions buildConditions(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext, DateTime issueInstant) {
286         AbstractSAML1ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
287
288         Conditions conditions = conditionsBuilder.buildObject();
289         conditions.setNotBefore(issueInstant);
290         conditions.setNotOnOrAfter(issueInstant.plus(profileConfig.getAssertionLifetime()));
291
292         Collection<String> audiences;
293
294         AudienceRestrictionCondition audienceRestriction = audienceRestrictionConditionBuilder.buildObject();
295         conditions.getAudienceRestrictionConditions().add(audienceRestriction);
296
297         Audience audience = audienceBuilder.buildObject();
298         audience.setUri(requestContext.getInboundMessageIssuer());
299         audienceRestriction.getAudiences().add(audience);
300
301         // add other audience restrictions
302         audiences = profileConfig.getAssertionAudiences();
303         if (audiences != null && audiences.size() > 0) {
304             for (String audienceUri : audiences) {
305                 audience = audienceBuilder.buildObject();
306                 audience.setUri(audienceUri);
307                 audienceRestriction.getAudiences().add(audience);
308             }
309         }
310
311         return conditions;
312     }
313
314     /**
315      * Builds the SAML subject for the user for the service provider.
316      * 
317      * @param requestContext current request context
318      * @param confirmationMethod subject confirmation method used for the subject
319      * 
320      * @return SAML subject for the user for the service provider
321      * 
322      * @throws ProfileException thrown if a NameID can not be created either because there was a problem encoding the
323      *             name ID attribute or because there are no supported name formats
324      */
325     protected Subject buildSubject(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext, String confirmationMethod)
326             throws ProfileException {
327
328         ConfirmationMethod method = confirmationMethodBuilder.buildObject();
329         method.setConfirmationMethod(confirmationMethod);
330
331         SubjectConfirmation subjectConfirmation = subjectConfirmationBuilder.buildObject();
332         subjectConfirmation.getConfirmationMethods().add(method);
333
334         NameIdentifier nameID = buildNameId(requestContext);
335
336         Subject subject = subjectBuilder.buildObject();
337         subject.setSubjectConfirmation(subjectConfirmation);
338
339         if (nameID != null) {
340             subject.setNameIdentifier(nameID);
341             requestContext.setSubjectNameIdentifier(nameID);
342         }
343
344         return subject;
345     }
346
347     /**
348      * Builds a NameIdentifier appropriate for this request. NameIdentifier are built by inspecting the SAML request and
349      * metadata, picking a name format that was requested by the relying party or is mutually supported by both the
350      * relying party and asserting party as described in their metadata entries. Once a set of supported name formats is
351      * determined the principals attributes are inspected for an attribute supported an attribute encoder whose category
352      * is one of the supported name formats.
353      * 
354      * @param requestContext current request context
355      * 
356      * @return the NameIdentifier appropriate for this request
357      * 
358      * @throws ProfileException thrown if a NameIdentifier can not be created either because there was a problem
359      *             encoding the name ID attribute or because there are no supported name formats
360      */
361     protected NameIdentifier buildNameId(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext)
362             throws ProfileException {
363         log.debug("Attemping to build NameIdentifier for principal '{}' in response to request from relying party '{}",
364                 requestContext.getPrincipalName(), requestContext.getInboundMessageIssuer());
365
366         Pair<BaseAttribute, SAML1NameIdentifierEncoder> nameIdAttributeAndEncoder = null;
367         try {
368             nameIdAttributeAndEncoder = selectNameIDAttributeAndEncoder(SAML1NameIdentifierEncoder.class,
369                     requestContext);
370         } catch (ProfileException e) {
371             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
372                     "Required NameIdentifier format not supported"));
373             throw e;
374         }
375
376         BaseAttribute<?> nameIdAttribute = nameIdAttributeAndEncoder.getFirst();
377         SAML1NameIdentifierEncoder nameIdEncoder = nameIdAttributeAndEncoder.getSecond();
378
379         try {
380             log
381                     .debug(
382                             "Using attribute '{}' supporting name format '{}' to create the NameIdentifier for relying party '{}'",
383                             new Object[] { nameIdAttribute.getId(), nameIdEncoder.getNameFormat(),
384                                     requestContext.getInboundMessageIssuer(), });
385             NameIdentifier nameId = nameIdEncoder.encode(nameIdAttribute);
386             nameId.setNameQualifier(requestContext.getRelyingPartyConfiguration().getProviderId());
387             return nameId;
388         } catch (AttributeEncodingException e) {
389             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Unable to encode NameIdentifier"));
390             String msg = MessageFormatter.format("Unable to encode NameIdentifier for relying party '{}'",
391                     requestContext.getInboundMessageIssuer());
392             log.error(msg, e);
393             throw new ProfileException(msg, e);
394         }
395     }
396
397     /**
398      * Constructs an SAML response message carrying a request error.
399      * 
400      * @param requestContext current request context containing the failure status
401      * 
402      * @return the constructed error response
403      */
404     protected Response buildErrorResponse(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext) {
405         Response samlResponse = responseBuilder.buildObject();
406         samlResponse.setIssueInstant(new DateTime());
407         populateStatusResponse(requestContext, samlResponse);
408
409         samlResponse.setStatus(requestContext.getFailureStatus());
410
411         return samlResponse;
412     }
413
414     /**
415      * Populates the response's id, in response to, issue instant, version, and issuer properties.
416      * 
417      * @param requestContext current request context
418      * @param response the response to populate
419      */
420     protected void populateStatusResponse(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext,
421             ResponseAbstractType response) {
422         response.setID(getIdGenerator().generateIdentifier());
423
424         SAMLObject samlMessage = requestContext.getInboundSAMLMessage();
425         if (samlMessage != null && samlMessage instanceof RequestAbstractType) {
426             response.setInResponseTo(((RequestAbstractType) samlMessage).getID());
427         }
428
429         response.setVersion(SAMLVersion.VERSION_11);
430     }
431
432     /**
433      * Build a status message, with an optional second-level failure message.
434      * 
435      * @param topLevelCode top-level status code
436      * @param secondLevelCode second-level status code
437      * @param failureMessage An optional second-level failure message
438      * 
439      * @return a Status object.
440      */
441     protected Status buildStatus(QName topLevelCode, QName secondLevelCode, String failureMessage) {
442         Status status = statusBuilder.buildObject();
443
444         StatusCode statusCode = statusCodeBuilder.buildObject();
445         statusCode.setValue(topLevelCode);
446         status.setStatusCode(statusCode);
447
448         if (secondLevelCode != null) {
449             StatusCode secondLevelStatusCode = statusCodeBuilder.buildObject();
450             secondLevelStatusCode.setValue(secondLevelCode);
451             statusCode.setStatusCode(secondLevelStatusCode);
452         }
453
454         if (failureMessage != null) {
455             StatusMessage msg = statusMessageBuilder.buildObject();
456             msg.setMessage(failureMessage);
457             status.setStatusMessage(msg);
458         }
459
460         return status;
461     }
462
463     /**
464      * Resolved the attributes for the principal.
465      * 
466      * @param requestContext current request context
467      * 
468      * @throws ProfileException thrown if there is a problem resolving the attributes for the subject.
469      */
470     protected void resolveAttributes(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
471         AbstractSAML1ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
472         SAML1AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
473
474         try {
475             log.debug("Resolving attributes for principal '{}' for SAML request from relying party '{}'",
476                     requestContext.getPrincipalName(), requestContext.getInboundMessageIssuer());
477             Map<String, BaseAttribute> principalAttributes = attributeAuthority.getAttributes(requestContext);
478
479             requestContext.setAttributes(principalAttributes);
480         } catch (AttributeRequestException e) {
481             log
482                     .warn(
483                             "Error resolving attributes for principal '{}'.  No name identifier or attribute statement will be included in response",
484                             requestContext.getPrincipalName());
485         }
486     }
487
488     /**
489      * Executes a query for attributes and builds a SAML attribute statement from the results.
490      * 
491      * @param requestContext current request context
492      * @param subjectConfMethod subject confirmation method
493      * 
494      * @return attribute statement resulting from the query
495      * 
496      * @throws ProfileException thrown if there is a problem making the query
497      */
498     protected AttributeStatement buildAttributeStatement(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext,
499             String subjectConfMethod) throws ProfileException {
500
501         if (requestContext.getAttributes() == null) {
502             return null;
503         }
504
505         log.debug(
506                 "Creating attribute statement about principal '{}'in response to SAML request from relying party '{}'",
507                 requestContext.getPrincipalName(), requestContext.getInboundMessageIssuer());
508         AbstractSAML1ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
509         SAML1AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
510
511         try {
512             AttributeStatement statment;
513             if (requestContext.getInboundSAMLMessage() instanceof AttributeQuery) {
514                 statment = attributeAuthority.buildAttributeStatement((AttributeQuery) requestContext
515                         .getInboundSAMLMessage(), requestContext.getAttributes().values());
516             } else {
517                 statment = attributeAuthority.buildAttributeStatement(null, requestContext.getAttributes().values());
518             }
519
520             if (statment != null) {
521                 Subject statementSubject = buildSubject(requestContext, subjectConfMethod);
522                 statment.setSubject(statementSubject);
523             }
524
525             return statment;
526         } catch (AttributeRequestException e) {
527             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error resolving attributes"));
528             String msg = MessageFormatter.format("Error encoding attributes for principal '{}'", requestContext
529                     .getPrincipalName());
530             log.error(msg, e);
531             throw new ProfileException(msg, e);
532         }
533     }
534
535     /**
536      * Resolves the principal name of the subject of the request.
537      * 
538      * @param requestContext current request context
539      * 
540      * @throws ProfileException thrown if the principal name can not be resolved
541      */
542     protected void resolvePrincipal(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
543         AbstractSAML1ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
544         SAML1AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
545
546         log.debug("Resolving principal name for subject of SAML request from relying party '{}'", requestContext
547                 .getInboundMessageIssuer());
548
549         try {
550             String principal = attributeAuthority.getPrincipal(requestContext);
551             requestContext.setPrincipalName(principal);
552         } catch (AttributeRequestException e) {
553             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, StatusCode.REQUEST_DENIED,
554                     "Error resolving principal"));
555             String msg = MessageFormatter.arrayFormat(
556                     "Error resolving principal name for SAML request from relying party '{}'. Cause: {}", new Object[] {
557                             requestContext.getInboundMessageIssuer(), e.getMessage() });
558             log.warn(msg);
559             throw new ProfileException(msg, e);
560         }
561     }
562
563     /**
564      * Signs the given assertion if either the current profile configuration or the relying party configuration contains
565      * signing credentials.
566      * 
567      * @param requestContext current request context
568      * @param assertion assertion to sign
569      * 
570      * @throws ProfileException thrown if the metadata can not be located for the relying party or, if signing is
571      *             required, if a signing credential is not configured
572      */
573     protected void signAssertion(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext, Assertion assertion)
574             throws ProfileException {
575         log.debug("Determining if SAML assertion to relying party '{}' should be signed", requestContext
576                 .getInboundMessageIssuer());
577
578         boolean signAssertion = isSignAssertion(requestContext);
579
580         if (!signAssertion) {
581             return;
582         }
583
584         AbstractSAML1ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
585
586         log.debug("Determining credential to use to sign assertion to relying party '{}'", requestContext
587                 .getInboundMessageIssuer());
588         Credential signatureCredential = profileConfig.getSigningCredential();
589         if (signatureCredential == null) {
590             signatureCredential = requestContext.getRelyingPartyConfiguration().getDefaultSigningCredential();
591         }
592
593         if (signatureCredential == null) {
594             String msg = MessageFormatter.format(
595                     "No signing credential is specified for relying party configuration '{}'", requestContext
596                             .getRelyingPartyConfiguration().getProviderId());
597             log.warn(msg);
598             throw new ProfileException(msg);
599         }
600
601         log.debug("Signing assertion to relying party '{}'", requestContext.getInboundMessageIssuer());
602         Signature signature = signatureBuilder.buildObject(Signature.DEFAULT_ELEMENT_NAME);
603
604         signature.setSigningCredential(signatureCredential);
605         try {
606             // TODO pull SecurityConfiguration from SAMLMessageContext? needs to be added
607             // TODO how to pull what keyInfoGenName to use?
608             SecurityHelper.prepareSignatureParams(signature, signatureCredential, null, null);
609         } catch (SecurityException e) {
610             String msg = "Error preparing signature for signing";
611             log.error(msg);
612             throw new ProfileException(msg, e);
613         }
614
615         assertion.setSignature(signature);
616
617         Marshaller assertionMarshaller = Configuration.getMarshallerFactory().getMarshaller(assertion);
618         try {
619             assertionMarshaller.marshall(assertion);
620             Signer.signObject(signature);
621         } catch (MarshallingException e) {
622             String errMsg = "Unable to marshall assertion for signing";
623             log.error(errMsg, e);
624             throw new ProfileException(errMsg, e);
625         } catch (SignatureException e) {
626             String msg = "Unable to sign assertion";
627             log.error(msg, e);
628             throw new ProfileException(msg, e);
629         }
630     }
631
632     /**
633      * Determine whether issued assertions should be signed.
634      * 
635      * @param requestContext the current request context
636      * @return true if assertions should be signed, false otherwise
637      * @throws ProfileException if there is a problem determining whether assertions should be signed
638      */
639     protected boolean isSignAssertion(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
640
641         SAMLMessageEncoder encoder = getOutboundMessageEncoder(requestContext);
642         AbstractSAML1ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
643
644         try {
645             boolean signAssertion = profileConfig.getSignAssertions() == CryptoOperationRequirementLevel.always
646                     || (profileConfig.getSignAssertions() == CryptoOperationRequirementLevel.conditional && !encoder
647                             .providesMessageIntegrity(requestContext));
648
649             log.debug("IdP relying party configuration '{}' indicates to sign assertions: {}", requestContext
650                     .getRelyingPartyConfiguration().getRelyingPartyId(), signAssertion);
651
652             if (!signAssertion && requestContext.getPeerEntityRoleMetadata() instanceof SPSSODescriptor) {
653                 SPSSODescriptor ssoDescriptor = (SPSSODescriptor) requestContext.getPeerEntityRoleMetadata();
654                 if (ssoDescriptor.getWantAssertionsSigned() != null) {
655                     signAssertion = ssoDescriptor.getWantAssertionsSigned().booleanValue();
656                     log.debug("Entity metadata for relying party '{} 'indicates to sign assertions: {}", requestContext
657                             .getInboundMessageIssuer(), signAssertion);
658                 }
659             }
660
661             return signAssertion;
662         } catch (MessageEncodingException e) {
663             log.error("Unable to determine if outbound encoding '{}' provides message integrity protection", encoder
664                     .getBindingURI());
665             throw new ProfileException("Unable to determine if outbound assertion should be signed");
666         }
667     }
668
669     /**
670      * Writes an audit log entry indicating the successful response to the attribute request.
671      * 
672      * @param context current request context
673      */
674     protected void writeAuditLogEntry(BaseSAMLProfileRequestContext context) {
675         SAML1AuditLogEntry auditLogEntry = new SAML1AuditLogEntry();
676         auditLogEntry.setSAMLResponse((Response) context.getOutboundSAMLMessage());
677         auditLogEntry.setMessageProfile(getProfileId());
678         auditLogEntry.setPrincipalAuthenticationMethod(context.getPrincipalAuthenticationMethod());
679         auditLogEntry.setPrincipalName(context.getPrincipalName());
680         auditLogEntry.setAssertingPartyId(context.getLocalEntityId());
681         auditLogEntry.setRelyingPartyId(context.getInboundMessageIssuer());
682         auditLogEntry.setRequestBinding(context.getMessageDecoder().getBindingURI());
683         auditLogEntry.setRequestId(context.getInboundSAMLMessageId());
684         auditLogEntry.setResponseBinding(context.getMessageEncoder().getBindingURI());
685         auditLogEntry.setResponseId(context.getOutboundSAMLMessageId());
686         if (context.getReleasedAttributes() != null) {
687             auditLogEntry.getReleasedAttributes().addAll(context.getReleasedAttributes());
688         }
689
690         getAduitLog().info(auditLogEntry.toString());
691     }
692
693     /** SAML 1 specific audit log entry. */
694     protected class SAML1AuditLogEntry extends AuditLogEntry {
695
696         /** The response to the SAML 1 request. */
697         private Response samlResponse;
698
699         /**
700          * Gets the response to the SAML 1 request.
701          * 
702          * @return the response to the SAML 1 request
703          */
704         public Response getSAMLResponse() {
705             return samlResponse;
706         }
707
708         /**
709          * Sets the response to the SAML 1 request.
710          * 
711          * @param response the response to the SAML 1 request
712          */
713         public void setSAMLResponse(Response response) {
714             samlResponse = response;
715         }
716
717         /** {@inheritDoc} */
718         public String toString() {
719             StringBuilder entryString = new StringBuilder(super.toString());
720
721             NameIdentifier nameIdentifier = null;
722             StringBuilder assertionIds = new StringBuilder();
723             List<Assertion> assertions = samlResponse.getAssertions();
724             if (assertions != null && !assertions.isEmpty()) {
725                 for (Assertion assertion : assertions) {
726                     assertionIds.append(assertion.getID());
727                     assertionIds.append(",");
728
729                     if (nameIdentifier == null) {
730                         List<Statement> statements = assertion.getStatements();
731                         if (statements != null && !statements.isEmpty()) {
732                             for (Statement statement : statements) {
733                                 if (statement instanceof SubjectStatement) {
734                                     if (((SubjectStatement) statement).getSubject() != null) {
735                                         nameIdentifier = ((SubjectStatement) statement).getSubject()
736                                                 .getNameIdentifier();
737                                     }
738                                 }
739                             }
740                         }
741                     }
742                 }
743             }
744
745             if (nameIdentifier != null) {
746                 entryString.append(nameIdentifier.getNameIdentifier());
747             }
748             entryString.append("|");
749
750             entryString.append(assertionIds.toString());
751             entryString.append("|");
752
753             return entryString.toString();
754         }
755     }
756 }