View Javadoc

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.RoleDescriptor;
50  import org.opensaml.saml2.metadata.SPSSODescriptor;
51  import org.opensaml.ws.message.encoder.MessageEncodingException;
52  import org.opensaml.xml.XMLObjectBuilder;
53  import org.opensaml.xml.io.Marshaller;
54  import org.opensaml.xml.io.MarshallingException;
55  import org.opensaml.xml.security.SecurityException;
56  import org.opensaml.xml.security.SecurityHelper;
57  import org.opensaml.xml.security.credential.Credential;
58  import org.opensaml.xml.signature.Signature;
59  import org.opensaml.xml.signature.SignatureException;
60  import org.opensaml.xml.signature.Signer;
61  import org.slf4j.Logger;
62  import org.slf4j.LoggerFactory;
63  
64  import edu.internet2.middleware.shibboleth.common.attribute.AttributeRequestException;
65  import edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute;
66  import edu.internet2.middleware.shibboleth.common.attribute.encoding.AttributeEncoder;
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("Building assertion NameIdentifier to relying party {} for principal {}", requestContext
364                 .getInboundMessageIssuer(), requestContext.getPrincipalName());
365 
366         List<String> supportedNameFormats = getNameFormats(requestContext);
367         if (!supportedNameFormats.isEmpty()) {
368             log.debug("SP-supported name formats: {}", supportedNameFormats);
369         } else {
370             log.debug("SP indicated no preferred name formats.");
371         }
372 
373         Map<String, BaseAttribute> principalAttributes = requestContext.getAttributes();
374         if (principalAttributes == null || principalAttributes.isEmpty()) {
375             log.debug("No attributes for principal {}, no name identifier will be created.", requestContext
376                     .getPrincipalName());
377             return null;
378         }
379 
380         SAML1NameIdentifierEncoder nameIdEncoder;
381         try {
382             for (BaseAttribute<?> attribute : principalAttributes.values()) {
383                 for (AttributeEncoder encoder : attribute.getEncoders()) {
384                     if (encoder instanceof SAML1NameIdentifierEncoder) {
385                         nameIdEncoder = (SAML1NameIdentifierEncoder) encoder;
386                         if (supportedNameFormats.isEmpty()
387                                 || supportedNameFormats.contains(nameIdEncoder.getNameFormat())) {
388                             log.debug("Using attribute {} supporting name format {} to create the NameIdentifier",
389                                     attribute.getId(), nameIdEncoder.getNameFormat());
390                             return nameIdEncoder.encode(attribute);
391                         }
392                     }
393                 }
394             }
395 
396             log.debug("No attributes for principal {} support an encoding into a supported name ID format.",
397                     requestContext.getPrincipalName());
398             return null;
399         } catch (AttributeEncodingException e) {
400             log.error("Unable to construct NameIdentifier", e);
401             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null,
402                     "Unable to construct NameIdentifier"));
403             throw new ProfileException("Unable to encode NameIdentifier attribute", e);
404         }
405     }
406 
407     /**
408      * Constructs an SAML response message carrying a request error.
409      * 
410      * @param requestContext current request context containing the failure status
411      * 
412      * @return the constructed error response
413      */
414     protected Response buildErrorResponse(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext) {
415         Response samlResponse = responseBuilder.buildObject();
416         samlResponse.setIssueInstant(new DateTime());
417         populateStatusResponse(requestContext, samlResponse);
418 
419         samlResponse.setStatus(requestContext.getFailureStatus());
420 
421         return samlResponse;
422     }
423 
424     /**
425      * Populates the response's id, in response to, issue instant, version, and issuer properties.
426      * 
427      * @param requestContext current request context
428      * @param response the response to populate
429      */
430     protected void populateStatusResponse(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext,
431             ResponseAbstractType response) {
432         response.setID(getIdGenerator().generateIdentifier());
433 
434         SAMLObject samlMessage = requestContext.getInboundSAMLMessage();
435         if (samlMessage != null && samlMessage instanceof RequestAbstractType) {
436             response.setInResponseTo(((RequestAbstractType) samlMessage).getID());
437         }
438 
439         response.setVersion(SAMLVersion.VERSION_11);
440     }
441 
442     /**
443      * Build a status message, with an optional second-level failure message.
444      * 
445      * @param topLevelCode top-level status code
446      * @param secondLevelCode second-level status code
447      * @param failureMessage An optional second-level failure message
448      * 
449      * @return a Status object.
450      */
451     protected Status buildStatus(QName topLevelCode, QName secondLevelCode, String failureMessage) {
452         Status status = statusBuilder.buildObject();
453 
454         StatusCode statusCode = statusCodeBuilder.buildObject();
455         statusCode.setValue(topLevelCode);
456         status.setStatusCode(statusCode);
457 
458         if (secondLevelCode != null) {
459             StatusCode secondLevelStatusCode = statusCodeBuilder.buildObject();
460             secondLevelStatusCode.setValue(secondLevelCode);
461             statusCode.setStatusCode(secondLevelStatusCode);
462         }
463 
464         if (failureMessage != null) {
465             StatusMessage msg = statusMessageBuilder.buildObject();
466             msg.setMessage(failureMessage);
467             status.setStatusMessage(msg);
468         }
469 
470         return status;
471     }
472 
473     /**
474      * Resolved the attributes for the principal.
475      * 
476      * @param requestContext current request context
477      * 
478      * @throws ProfileException thrown if attributes can not be resolved
479      */
480     protected void resolveAttributes(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
481         AbstractSAML1ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
482         SAML1AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
483 
484         try {
485             log.debug("Resolving attributes for principal {} of SAML request from relying party {}", requestContext
486                     .getPrincipalName(), requestContext.getInboundMessageIssuer());
487             Map<String, BaseAttribute> principalAttributes = attributeAuthority.getAttributes(requestContext);
488 
489             requestContext.setAttributes(principalAttributes);
490         } catch (AttributeRequestException e) {
491             log.error("Error resolving attributes for SAML request from relying party "
492                     + requestContext.getInboundMessageIssuer(), e);
493             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error resolving attributes"));
494             throw new ProfileException("Error resolving attributes for SAML request from relying party "
495                     + requestContext.getInboundMessageIssuer(), e);
496         }
497     }
498 
499     /**
500      * Executes a query for attributes and builds a SAML attribute statement from the results.
501      * 
502      * @param requestContext current request context
503      * @param subjectConfMethod subject confirmation method
504      * 
505      * @return attribute statement resulting from the query
506      * 
507      * @throws ProfileException thrown if there is a problem making the query
508      */
509     protected AttributeStatement buildAttributeStatement(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext,
510             String subjectConfMethod) throws ProfileException {
511 
512         log.debug("Creating attribute statement in response to SAML request from relying party {}", requestContext
513                 .getInboundMessageIssuer());
514         AbstractSAML1ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
515         SAML1AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
516 
517         try {
518             AttributeStatement statment;
519             if (requestContext.getInboundSAMLMessage() instanceof AttributeQuery) {
520                 statment = attributeAuthority.buildAttributeStatement((AttributeQuery) requestContext
521                         .getInboundSAMLMessage(), requestContext.getAttributes().values());
522             } else {
523                 statment = attributeAuthority.buildAttributeStatement(null, requestContext.getAttributes().values());
524             }
525 
526             if (statment != null) {
527                 Subject statementSubject = buildSubject(requestContext, subjectConfMethod);
528                 statment.setSubject(statementSubject);
529             }
530 
531             return statment;
532         } catch (AttributeRequestException e) {
533             log.error("Error encoding attributes for principal " + requestContext.getPrincipalName(), e);
534             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, null, "Error resolving attributes"));
535             throw new ProfileException("Error encoding attributes for principal " + requestContext.getPrincipalName(),
536                     e);
537         }
538     }
539 
540     /**
541      * Resolves the principal name of the subject of the request.
542      * 
543      * @param requestContext current request context
544      * 
545      * @throws ProfileException thrown if the principal name can not be resolved
546      */
547     protected void resolvePrincipal(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext) throws ProfileException {
548         AbstractSAML1ProfileConfiguration profileConfiguration = requestContext.getProfileConfiguration();
549         SAML1AttributeAuthority attributeAuthority = profileConfiguration.getAttributeAuthority();
550 
551         log.debug("Resolving principal name for subject of SAML request from relying party {}", requestContext
552                 .getInboundMessageIssuer());
553 
554         try {
555             String principal = attributeAuthority.getPrincipal(requestContext);
556             requestContext.setPrincipalName(principal);
557         } catch (AttributeRequestException e) {
558             log.error("Error resolving attributes for SAML request from relying party "
559                     + requestContext.getInboundMessageIssuer(), e);
560             requestContext.setFailureStatus(buildStatus(StatusCode.RESPONDER, StatusCode.REQUEST_DENIED,
561                     "Error resolving principal"));
562             throw new ProfileException("Error resolving attributes for SAML request from relying party "
563                     + requestContext.getInboundMessageIssuer(), e);
564         }
565     }
566 
567     /**
568      * Signs the given assertion if either the current profile configuration or the relying party configuration contains
569      * signing credentials.
570      * 
571      * @param requestContext current request context
572      * @param assertion assertion to sign
573      * 
574      * @throws ProfileException thrown if the metadata can not be located for the relying party or, if signing is
575      *             required, if a signing credential is not configured
576      */
577     protected void signAssertion(BaseSAML1ProfileRequestContext<?, ?, ?> requestContext, Assertion assertion)
578             throws ProfileException {
579         log.debug("Determining if SAML assertion to relying party {} should be signed", requestContext
580                 .getInboundMessageIssuer());
581 
582         boolean signAssertion = false;
583 
584         RoleDescriptor relyingPartyRole = requestContext.getPeerEntityRoleMetadata();
585         SAMLMessageEncoder encoder = getMessageEncoders().get(requestContext.getPeerEntityEndpoint().getBinding());
586         AbstractSAML1ProfileConfiguration profileConfig = requestContext.getProfileConfiguration();
587 
588         try {
589             if (profileConfig.getSignAssertions() == CryptoOperationRequirementLevel.always
590                     || (profileConfig.getSignAssertions() == CryptoOperationRequirementLevel.conditional && !encoder
591                             .providesMessageIntegrity(requestContext))) {
592                 signAssertion = true;
593                 log.debug("IdP relying party configuration {} indicates to sign assertions: {}", requestContext
594                         .getRelyingPartyConfiguration().getRelyingPartyId(), signAssertion);
595             }
596         } catch (MessageEncodingException e) {
597             log.error("Unable to determine if outbound encoding {} can provide integrity", encoder.getBindingURI());
598             throw new ProfileException("Unable to determine if outbound message should be signed");
599         }
600 
601         if (!signAssertion && relyingPartyRole instanceof SPSSODescriptor) {
602             SPSSODescriptor ssoDescriptor = (SPSSODescriptor) relyingPartyRole;
603             if (ssoDescriptor.getWantAssertionsSigned() != null) {
604                 signAssertion = ssoDescriptor.getWantAssertionsSigned().booleanValue();
605                 log.debug("Entity metadata for relying party {} indicates to sign assertions: {}", requestContext
606                         .getInboundMessageIssuer(), signAssertion);
607             }
608         }
609 
610         if (!signAssertion) {
611             return;
612         }
613 
614         log.debug("Determining signing credntial for assertion to relying party {}", requestContext
615                 .getInboundMessageIssuer());
616         Credential signatureCredential = profileConfig.getSigningCredential();
617         if (signatureCredential == null) {
618             signatureCredential = requestContext.getRelyingPartyConfiguration().getDefaultSigningCredential();
619         }
620 
621         if (signatureCredential == null) {
622             throw new ProfileException("No signing credential is specified for relying party configuration "
623                     + requestContext.getRelyingPartyConfiguration().getProviderId()
624                     + " or it's SAML2 attribute query profile configuration");
625         }
626 
627         log.debug("Signing assertion to relying party {}", requestContext.getInboundMessageIssuer());
628         Signature signature = signatureBuilder.buildObject(Signature.DEFAULT_ELEMENT_NAME);
629 
630         signature.setSigningCredential(signatureCredential);
631         try {
632             // TODO pull SecurityConfiguration from SAMLMessageContext? needs to be added
633             // TODO how to pull what keyInfoGenName to use?
634             SecurityHelper.prepareSignatureParams(signature, signatureCredential, null, null);
635         } catch (SecurityException e) {
636             throw new ProfileException("Error preparing signature for signing", e);
637         }
638 
639         assertion.setSignature(signature);
640 
641         Marshaller assertionMarshaller = Configuration.getMarshallerFactory().getMarshaller(assertion);
642         try {
643             assertionMarshaller.marshall(assertion);
644             Signer.signObject(signature);
645         } catch (MarshallingException e) {
646             log.error("Unable to marshall assertion for signing", e);
647             throw new ProfileException("Unable to marshall assertion for signing", e);
648         } catch (SignatureException e) {
649             log.error("Unable to sign assertion", e);
650             throw new ProfileException("Unable to sign assertion", e);
651         }
652     }
653 
654     /**
655      * Writes an audit log entry indicating the successful response to the attribute request.
656      * 
657      * @param context current request context
658      */
659     protected void writeAuditLogEntry(BaseSAMLProfileRequestContext context) {
660         SAML1AuditLogEntry auditLogEntry = new SAML1AuditLogEntry();
661         auditLogEntry.setSAMLResponse((Response) context.getOutboundSAMLMessage());
662         auditLogEntry.setMessageProfile(getProfileId());
663         auditLogEntry.setPrincipalAuthenticationMethod(context.getPrincipalAuthenticationMethod());
664         auditLogEntry.setPrincipalName(context.getPrincipalName());
665         auditLogEntry.setAssertingPartyId(context.getLocalEntityId());
666         auditLogEntry.setRelyingPartyId(context.getInboundMessageIssuer());
667         auditLogEntry.setRequestBinding(context.getMessageDecoder().getBindingURI());
668         auditLogEntry.setRequestId(context.getInboundSAMLMessageId());
669         auditLogEntry.setResponseBinding(context.getMessageEncoder().getBindingURI());
670         auditLogEntry.setResponseId(context.getOutboundSAMLMessageId());
671         if (context.getReleasedAttributes() != null) {
672             auditLogEntry.getReleasedAttributes().addAll(context.getReleasedAttributes());
673         }
674 
675         getAduitLog().info(auditLogEntry.toString());
676     }
677 
678     /** SAML 1 specific audit log entry. */
679     protected class SAML1AuditLogEntry extends AuditLogEntry {
680 
681         /** The response to the SAML 1 request. */
682         private Response samlResponse;
683 
684         /**
685          * Gets the response to the SAML 1 request.
686          * 
687          * @return the response to the SAML 1 request
688          */
689         public Response getSAMLResponse() {
690             return samlResponse;
691         }
692 
693         /**
694          * Sets the response to the SAML 1 request.
695          * 
696          * @param response the response to the SAML 1 request
697          */
698         public void setSAMLResponse(Response response) {
699             samlResponse = response;
700         }
701 
702         /** {@inheritDoc} */
703         public String toString() {
704             StringBuilder entryString = new StringBuilder(super.toString());
705 
706             NameIdentifier nameIdentifier = null;
707             StringBuilder assertionIds = new StringBuilder();
708             List<Assertion> assertions = samlResponse.getAssertions();
709             if (assertions != null && !assertions.isEmpty()) {
710                 for (Assertion assertion : assertions) {
711                     assertionIds.append(assertion.getID());
712                     assertionIds.append(",");
713 
714                     if (nameIdentifier == null) {
715                         List<Statement> statements = assertion.getStatements();
716                         if (statements != null && !statements.isEmpty()) {
717                             for (Statement statement : statements) {
718                                 if (statement instanceof SubjectStatement) {
719                                     if (((SubjectStatement) statement).getSubject() != null) {
720                                         nameIdentifier = ((SubjectStatement) statement).getSubject()
721                                                 .getNameIdentifier();
722                                     }
723                                 }
724                             }
725                         }
726                     }
727                 }
728             }
729 
730             if (nameIdentifier != null) {
731                 entryString.append(nameIdentifier.getNameIdentifier());
732             }
733             entryString.append("|");
734 
735             entryString.append(assertionIds.toString());
736             entryString.append("|");
737 
738             return entryString.toString();
739         }
740     }
741 }