992c86028d395ab00e73a831c26e2809a88f6670
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / serviceprovider / AttributeRequestor.java
1 /*
2  * AttributeRequestor.java
3  * 
4  * Generate a SAMLRequest to the AA for Attributes, then process the
5  * reply. In C++, this logic was InternalCCacheEntry::getNewResponse() 
6  * in shib-ccache.cpp.
7  * 
8  * The User Authentication was previously processed by ShibPOSTProfile
9  * and was stored by SessionManager in a Session object. Although the
10  * attributes might be fetched immediately, that is a strategy issue.
11  * In Java, we isolate the Attribute fetch in this separate module.
12  * 
13  * The Session block retains a copy of the original SAMLStatement from
14  * the POST, and it contains information about the remote Entity.
15  * However, the POST came from the HS (or IIDPProvider if you want to
16  * use SAML 2 terms), and this transaction has to go to the AA. So
17  * Metadata must be used to obtain the AttributeAuthorityRole and its
18  * associated Endpoint (URL).
19  * 
20  * The ApplicationInfo object for the configured Application presents
21  * a getAttributeDesignators method that can return a list of attributes
22  * to specify in the request. However, I can find no configuration element
23  * that corresponds to this, and no example logic. For now that method
24  * returns an empty collection and no particular attributes are requested.
25  * 
26  * The actual SSL session and exchange of data is performed by OpenSAML.
27  * Our interface to SAML is through the separate ShibBind module. The
28  * layers of processing and responsibilites need to be understood.
29  * 
30  * ShibBind uses the Metadata for the User's ID Providing Entity to
31  * locate the AttributeAuthorityRole and therefore the AA URL. This
32  * is passed to OpenSAML along with the request. Upon return, if any
33  * statements are signed it is the responsiblilty of ShibBind to call
34  * the Trust implementations to validate the signatures.
35  * 
36  * This module then checks, by calling the isSigned() property of
37  * SAMLObjects, to make sure that everything that is supposed to be
38  * signed actually was signed. ShibBind knows if a signature is valid,
39  * but this module knows if a signature was requred. This module also
40  * applies AAP to examine attributes and values and discard those that
41  * the policy doesn't accept.
42  * 
43  * Recovery Context: All exceptions handled and logged internally.
44  * --------------------
45  * Copyright 2002, 2004 
46  * University Corporation for Advanced Internet Development, Inc. 
47  * All rights reserved
48  * [Thats all we have to say to protect ourselves]
49  * Your permission to use this code is governed by "The Shibboleth License".
50  * A copy may be found at http://shibboleth.internet2.edu/license.html
51  * [Nothing in copyright law requires license text in every file.]
52  */
53 package edu.internet2.middleware.shibboleth.serviceprovider;
54
55 import java.util.Collection;
56 import java.util.Iterator;
57
58 import org.apache.log4j.Logger;
59 import org.opensaml.SAMLAssertion;
60 import org.opensaml.SAMLAttributeQuery;
61 import org.opensaml.SAMLException;
62 import org.opensaml.SAMLRequest;
63 import org.opensaml.SAMLResponse;
64 import org.opensaml.SAMLSubject;
65
66 import x0.maceShibbolethTargetConfig1.ApplicationDocument.Application;
67
68 import edu.internet2.middleware.shibboleth.metadata.AttributeAuthorityRole;
69 import edu.internet2.middleware.shibboleth.metadata.EntityDescriptor;
70 import edu.internet2.middleware.shibboleth.metadata.MetadataException;
71 import edu.internet2.middleware.shibboleth.serviceprovider.ServiceProviderConfig.ApplicationInfo;
72
73 /**
74  * A static class with a static method. No objects are created
75  * 
76  * @author Howard Gilbert
77  */
78 public class AttributeRequestor {
79         
80         private static Logger log = Logger.getLogger(AttributeRequestor.class);
81         private static ServiceProviderContext context   = ServiceProviderContext.getInstance();
82         
83         private AttributeRequestor() {} // Prevent instantiation
84         
85         /**
86          * Request SAML Attribute response from AA
87          * 
88          * @param session Session object (from authentication POST)
89          * @return true if Attributes successfully stored in the Session
90          * @throws MetadataException If Origin has no configured AA
91          * @throws SAMLException If there is a problem with the reply
92          */
93         static 
94                         boolean    // return false if attributes are not fetched
95         fetchAttributes(
96                         Session session){
97                 
98             log.debug("Fetching attributes for session "+session.getKey()+
99                     " from "+session.getEntityId());
100             
101                 // Get local references to configuration objects
102                 ServiceProviderConfig config = context.getServiceProviderConfig();
103                 ApplicationInfo appinfo = config.getApplication(session.getApplicationId());
104                 
105                 // The Entity name was fed by by ShibPOSTProfile.accept(). Look it up now.
106                 EntityDescriptor entity = appinfo.getEntityDescriptor(session.getEntityId());
107                 if (entity==null) {
108                         log.error("Entity(Site) deleted from Metadata since authentication POST received: "+session.getEntityId());
109                         return false;
110                 }
111                 Application applicationConfig = appinfo.getApplicationConfig();
112                 boolean signRequest = applicationConfig.getSignRequest();
113                 boolean signedAssertions = applicationConfig.getSignedAssertions();
114                 boolean signedResponse = applicationConfig.getSignedResponse();
115                 
116                 SAMLRequest request = null;
117                 
118                 AttributeAuthorityRole aa = 
119                     entity.getAttributeAuthorityRole(); // throws MetadataException
120                 if (aa==null) {
121                     log.error("No Attribute Authority in Metadata for ID="+entity.getId());
122                     return false;
123                 }
124                 
125                 // Build the Attribute Query 
126                 SAMLAttributeQuery query = null;
127                 SAMLSubject subject = session.getAuthenticationStatement().getSubject();
128                 log.debug("Subject (Handle) is "+subject.getName());
129                 Collection attributeDesignators = appinfo.getAttributeDesignators();
130                 try {
131             query = 
132                 new SAMLAttributeQuery(
133                         subject,             // Subject (i.e. Handle) from authentication
134                         entity.getId(),      // ID of user's Entity (i.e. Origin Site)
135                         attributeDesignators // Attributes to request, null for everything
136                         );
137
138             // Wrap the Query in a request
139             request = new SAMLRequest();
140             request.setQuery(query);
141         } catch (SAMLException e) {
142             log.error("AttributeRequestor unable to build SAML Query for Session "+session.getKey());
143             return false;
144         }
145                 
146                 if (signRequest) {
147                         // TODO Attribute requests are not typically signed, but add
148                         // code to do so optionally later.
149                 }
150                 
151                 // ShibBinding will extract URLs from the Metadata and build
152                 // parameters so SAML can create the session. It also interfaces
153                 // to Trust to verify that any signed objects have trusted signatures.
154                 SAMLResponse response = null;
155                 try {
156             ShibBinding binding = new ShibBinding(session.getApplicationId());
157                         response = binding.send(request,aa,null,null);
158                 } catch (SAMLException e) {;} // response will be null
159                 if (response==null) {
160                         log.error("AttributeRequestor Query to remote AA returned no response from "+session.getEntityId());
161                         return false;
162                 }
163                 
164                 if (signedResponse && 
165                         !response.isSigned()) {
166                         log.error("AttributeRequestor rejected unsigned attribute response from "+session.getEntityId());
167                         return false;
168                 }
169                 
170                 // Check each assertion in the response.
171                 Iterator assertions = response.getAssertions();
172                 while (assertions.hasNext()) {
173                         SAMLAssertion assertion = (SAMLAssertion) assertions.next();
174                         if (signedAssertions && 
175                        !assertion.isSigned()) {
176                                 log.warn("AttributeRequestor has removed unsigned assertion from response from "+session.getEntityId());
177                                 assertions.remove();
178                                 continue;
179                         }
180                         
181                         appinfo.applyAAP(entity,assertion); // apply each AAP to this assertion
182                         
183                         if (!assertion.getStatements().hasNext())
184                                 assertions.remove(); // AAP rejected all statements for this assertion
185                 }
186
187                 // A response may end up with no attributes, but that is not an error.
188                 // Maybe there is just nothing important to say about this user.
189                 
190                 session.setAttributeResponse(response); // Save response in Session object
191                 return true;
192         }
193
194 }