Metadata support for old and new schemas, and API changes.
[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 import org.opensaml.XML;
66
67 import x0.maceShibbolethTargetConfig1.ApplicationDocument.Application;
68
69 import edu.internet2.middleware.shibboleth.metadata.AttributeAuthorityDescriptor;
70 import edu.internet2.middleware.shibboleth.metadata.EntityDescriptor;
71 import edu.internet2.middleware.shibboleth.metadata.MetadataException;
72 import edu.internet2.middleware.shibboleth.serviceprovider.ServiceProviderConfig.ApplicationInfo;
73
74 /**
75  * A static class with a static method. No objects are created
76  * 
77  * @author Howard Gilbert
78  */
79 public class AttributeRequestor {
80         
81         private static Logger log = Logger.getLogger(AttributeRequestor.class);
82         private static ServiceProviderContext context   = ServiceProviderContext.getInstance();
83         
84         private AttributeRequestor() {} // Prevent instantiation
85         
86         /**
87          * Request SAML Attribute response from AA
88          * 
89          * @param session Session object (from authentication POST)
90          * @return true if Attributes successfully stored in the Session
91          * @throws MetadataException If Origin has no configured AA
92          * @throws SAMLException If there is a problem with the reply
93          */
94         static 
95                         boolean    // return false if attributes are not fetched
96         fetchAttributes(
97                         Session session){
98                 
99             log.debug("Fetching attributes for session "+session.getKey()+
100                     " from "+session.getEntityId());
101             
102                 // Get local references to configuration objects
103                 ServiceProviderConfig config = context.getServiceProviderConfig();
104                 ApplicationInfo appinfo = config.getApplication(session.getApplicationId());
105                 
106                 // The Entity name was fed by by ShibPOSTProfile.accept(). Look it up now.
107                 EntityDescriptor entity = appinfo.lookup(session.getEntityId());
108                 if (entity==null) {
109                         log.error("Entity(Site) deleted from Metadata since authentication POST received: "+session.getEntityId());
110                         return false;
111                 }
112                 Application applicationConfig = appinfo.getApplicationConfig();
113                 boolean signRequest = applicationConfig.getSignRequest();
114                 boolean signedAssertions = applicationConfig.getSignedAssertions();
115                 boolean signedResponse = applicationConfig.getSignedResponse();
116                 
117                 SAMLRequest request = null;
118                 
119                 AttributeAuthorityDescriptor aa = 
120                     entity.getAttributeAuthorityDescriptor(XML.SAML11_PROTOCOL_ENUM); // throws MetadataException
121                 if (aa==null) {
122                     log.error("No Attribute Authority in Metadata for ID="+entity.getId());
123                     return false;
124                 }
125                 
126                 // Build the Attribute Query 
127                 SAMLAttributeQuery query = null;
128                 SAMLSubject subject = session.getAuthenticationStatement().getSubject();
129                 log.debug("Subject (Handle) is "+subject.getName());
130                 Collection attributeDesignators = appinfo.getAttributeDesignators();
131                 try {
132             query = 
133                 new SAMLAttributeQuery(
134                         subject,             // Subject (i.e. Handle) from authentication
135                         entity.getId(),      // ID of user's Entity (i.e. Origin Site)
136                         attributeDesignators // Attributes to request, null for everything
137                         );
138
139             // Wrap the Query in a request
140             request = new SAMLRequest();
141             request.setQuery(query);
142         } catch (SAMLException e) {
143             log.error("AttributeRequestor unable to build SAML Query for Session "+session.getKey());
144             return false;
145         }
146                 
147                 if (signRequest) {
148                         // TODO Attribute requests are not typically signed, but add
149                         // code to do so optionally later.
150                 }
151                 
152                 // ShibBinding will extract URLs from the Metadata and build
153                 // parameters so SAML can create the session. It also interfaces
154                 // to Trust to verify that any signed objects have trusted signatures.
155                 SAMLResponse response = null;
156                 try {
157             ShibBinding binding = new ShibBinding(session.getApplicationId());
158                         response = binding.send(request,aa,null,null);
159                 } catch (SAMLException e) {;} // response will be null
160                 if (response==null) {
161                         log.error("AttributeRequestor Query to remote AA returned no response from "+session.getEntityId());
162                         return false;
163                 }
164                 
165                 if (signedResponse && 
166                         !response.isSigned()) {
167                         log.error("AttributeRequestor rejected unsigned attribute response from "+session.getEntityId());
168                         return false;
169                 }
170                 
171                 // Check each assertion in the response.
172                 Iterator assertions = response.getAssertions();
173                 while (assertions.hasNext()) {
174                         SAMLAssertion assertion = (SAMLAssertion) assertions.next();
175                         if (signedAssertions && 
176                        !assertion.isSigned()) {
177                                 log.warn("AttributeRequestor has removed unsigned assertion from response from "+session.getEntityId());
178                                 assertions.remove();
179                                 continue;
180                         }
181                         
182                         appinfo.applyAAP(entity,assertion); // apply each AAP to this assertion
183                         
184                         if (!assertion.getStatements().hasNext())
185                                 assertions.remove(); // AAP rejected all statements for this assertion
186                 }
187
188                 // A response may end up with no attributes, but that is not an error.
189                 // Maybe there is just nothing important to say about this user.
190                 
191                 session.setAttributeResponse(response); // Save response in Session object
192                 return true;
193         }
194
195 }