Added dependency support to DataConnectors
[java-idp.git] / src / edu / internet2 / middleware / shibboleth / aa / attrresolv / provider / JNDIDirectoryDataConnector.java
1 /* 
2  * The Shibboleth License, Version 1. 
3  * Copyright (c) 2002 
4  * University Corporation for Advanced Internet Development, Inc. 
5  * All rights reserved
6  * 
7  * 
8  * Redistribution and use in source and binary forms, with or without 
9  * modification, are permitted provided that the following conditions are met:
10  * 
11  * Redistributions of source code must retain the above copyright notice, this 
12  * list of conditions and the following disclaimer.
13  * 
14  * Redistributions in binary form must reproduce the above copyright notice, 
15  * this list of conditions and the following disclaimer in the documentation 
16  * and/or other materials provided with the distribution, if any, must include 
17  * the following acknowledgment: "This product includes software developed by 
18  * the University Corporation for Advanced Internet Development 
19  * <http://www.ucaid.edu>Internet2 Project. Alternately, this acknowledegement 
20  * may appear in the software itself, if and wherever such third-party 
21  * acknowledgments normally appear.
22  * 
23  * Neither the name of Shibboleth nor the names of its contributors, nor 
24  * Internet2, nor the University Corporation for Advanced Internet Development, 
25  * Inc., nor UCAID may be used to endorse or promote products derived from this 
26  * software without specific prior written permission. For written permission, 
27  * please contact shibboleth@shibboleth.org
28  * 
29  * Products derived from this software may not be called Shibboleth, Internet2, 
30  * UCAID, or the University Corporation for Advanced Internet Development, nor 
31  * may Shibboleth appear in their name, without prior written permission of the 
32  * University Corporation for Advanced Internet Development.
33  * 
34  * 
35  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
36  * AND WITH ALL FAULTS. ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
37  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A 
38  * PARTICULAR PURPOSE, AND NON-INFRINGEMENT ARE DISCLAIMED AND THE ENTIRE RISK 
39  * OF SATISFACTORY QUALITY, PERFORMANCE, ACCURACY, AND EFFORT IS WITH LICENSEE. 
40  * IN NO EVENT SHALL THE COPYRIGHT OWNER, CONTRIBUTORS OR THE UNIVERSITY 
41  * CORPORATION FOR ADVANCED INTERNET DEVELOPMENT, INC. BE LIABLE FOR ANY DIRECT, 
42  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES 
43  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
44  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 
45  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
46  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 
47  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
48  */
49
50 package edu.internet2.middleware.shibboleth.aa.attrresolv.provider;
51
52 import java.security.Principal;
53 import java.util.Properties;
54
55 import javax.naming.CommunicationException;
56 import javax.naming.NamingEnumeration;
57 import javax.naming.NamingException;
58 import javax.naming.directory.Attributes;
59 import javax.naming.directory.InitialDirContext;
60 import javax.naming.directory.SearchControls;
61 import javax.naming.directory.SearchResult;
62
63 import org.apache.log4j.Logger;
64 import org.w3c.dom.Element;
65 import org.w3c.dom.NodeList;
66
67 import edu.internet2.middleware.shibboleth.aa.attrresolv.AttributeResolver;
68 import edu.internet2.middleware.shibboleth.aa.attrresolv.DataConnectorPlugIn;
69 import edu.internet2.middleware.shibboleth.aa.attrresolv.Dependencies;
70 import edu.internet2.middleware.shibboleth.aa.attrresolv.ResolutionPlugInException;
71
72 /**
73  * <code>DataConnectorPlugIn</code> implementation that utilizes a user specified JNDI 
74  * <code>DirContext</code> to retrieve attribute data.
75  * 
76  * @author Walter Hoehn (wassa@columbia.edu)
77  *
78  */
79 public class JNDIDirectoryDataConnector extends BaseResolutionPlugIn implements DataConnectorPlugIn {
80
81         private static Logger log = Logger.getLogger(JNDIDirectoryDataConnector.class.getName());
82         protected String searchFilter;
83         protected Properties properties;
84         protected SearchControls controls;
85
86         public JNDIDirectoryDataConnector(Element e) throws ResolutionPlugInException {
87
88                 super(e);
89                 NodeList searchNodes = e.getElementsByTagNameNS(AttributeResolver.resolverNamespace, "Search");
90                 if (searchNodes.getLength() != 1) {
91                         log.error("JNDI Directory Data Connector requires a \"Search\" specification.");
92                         throw new ResolutionPlugInException("JNDI Directory Data Connector requires a \"Search\" specification.");
93                 }
94
95                 String searchFilterSpec = ((Element) searchNodes.item(0)).getAttribute("filter");
96                 if (searchFilterSpec != null && !searchFilterSpec.equals("")) {
97                         searchFilter = searchFilterSpec;
98                         log.debug("Search Filter: (" + searchFilter + ").");
99                 } else {
100                         log.error("Search spec requires a filter attribute.");
101                         throw new ResolutionPlugInException("Search spec requires a filter attribute.");
102                 }
103
104                 defineSearchControls(((Element) searchNodes.item(0)));
105
106                 NodeList propertyNodes = e.getElementsByTagNameNS(AttributeResolver.resolverNamespace, "Property");
107                 properties = System.getProperties();
108                 for (int i = 0; propertyNodes.getLength() > i; i++) {
109                         Element property = (Element) propertyNodes.item(i);
110                         String propName = property.getAttribute("name");
111                         String propValue = property.getAttribute("value");
112
113                         if (propName != null && !propName.equals("") && propValue != null && !propValue.equals("")) {
114                                 properties.setProperty(propName, propValue);
115                                 log.debug("Property: (" + propName + ").");
116                                 log.debug("   Value: (" + propValue + ").");
117                         } else {
118                                 log.error("Property is malformed.");
119                                 throw new ResolutionPlugInException("Property is malformed.");
120                         }
121                 }
122                 try {
123                         InitialDirContext context = new InitialDirContext(properties);
124                         context.close();
125                         log.debug("JNDI Directory context activated.");
126                 } catch (NamingException e1) {
127                         log.error("Failed to startup directory context: " + e1);
128                         throw new ResolutionPlugInException("Failed to startup directory context.");
129                 }
130
131         }
132
133         protected void defineSearchControls(Element searchNode) {
134
135                 controls = new SearchControls();
136
137                 NodeList controlNodes = searchNode.getElementsByTagNameNS(AttributeResolver.resolverNamespace, "Controls");
138                 if (controlNodes.getLength() < 1) {
139                         log.debug("No Search Control spec found.");
140                 } else {
141                         if (controlNodes.getLength() > 1) {
142                                 log.error("Found multiple Search Control specs for a Connector.  Ignoring all but the first.");
143                         }
144
145                         String searchScopeSpec = ((Element) controlNodes.item(0)).getAttribute("searchScope");
146                         if (searchScopeSpec != null && !searchScopeSpec.equals("")) {
147                                 if (searchScopeSpec.equals("OBJECT_SCOPE")) {
148                                         controls.setSearchScope(SearchControls.OBJECT_SCOPE);
149                                 } else if (searchScopeSpec.equals("ONELEVEL_SCOPE")) {
150                                         controls.setSearchScope(SearchControls.ONELEVEL_SCOPE);
151                                 } else if (searchScopeSpec.equals("SUBTREE_SCOPE")) {
152                                         controls.setSearchScope(SearchControls.SUBTREE_SCOPE);
153                                 } else {
154                                         try {
155                                                 controls.setSearchScope(Integer.parseInt(searchScopeSpec));
156                                         } catch (NumberFormatException nfe) {
157                                                 log.error("Control spec included an invalid (searchScope) attribute value.");
158                                         }
159                                 }
160                         }
161
162                         String timeLimitSpec = ((Element) controlNodes.item(0)).getAttribute("timeLimit");
163                         if (timeLimitSpec != null && !timeLimitSpec.equals("")) {
164                                 try {
165                                         System.err.println("hey");
166                                         controls.setTimeLimit(Integer.parseInt(timeLimitSpec));
167                                 } catch (NumberFormatException nfe) {
168                                         log.error("Control spec included an invalid (timeLimit) attribute value.");
169                                 }
170                         }
171
172                         String returningObjectsSpec = ((Element) controlNodes.item(0)).getAttribute("returningObjects");
173                         if (returningObjectsSpec != null && !returningObjectsSpec.equals("")) {
174                                 controls.setReturningObjFlag(new Boolean(returningObjectsSpec).booleanValue());
175                         }
176
177                         String linkDereferencingSpec = ((Element) controlNodes.item(0)).getAttribute("linkDereferencing");
178                         if (linkDereferencingSpec != null && !linkDereferencingSpec.equals("")) {
179                                 if (linkDereferencingSpec != null && !linkDereferencingSpec.equals("")) {
180                                         controls.setDerefLinkFlag(new Boolean(linkDereferencingSpec).booleanValue());
181                                 }
182                         }
183
184                         String countLimitSpec = ((Element) controlNodes.item(0)).getAttribute("countLimit");
185                         if (countLimitSpec != null && !countLimitSpec.equals("")) {
186                                 try {
187                                         controls.setCountLimit(Long.parseLong(countLimitSpec));
188                                 } catch (NumberFormatException nfe) {
189                                         log.error("Control spec included an invalid (countLimit) attribute value.");
190                                 }
191                         }
192                 }
193
194                 if (log.isDebugEnabled()) {
195                         log.debug("Search Control (searchScope): " + controls.getSearchScope());
196                         log.debug("Search Control (timeLimit): " + controls.getTimeLimit());
197                         log.debug("Search Control (returningObjects): " + controls.getReturningObjFlag());
198                         log.debug("Search Control (linkDereferencing): " + controls.getDerefLinkFlag());
199                         log.debug("Search Control (countLimit): " + controls.getCountLimit());
200                 }
201         }
202
203         /**
204          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.DataConnectorPlugIn#resolve(java.security.Principal)
205          */
206         public Attributes resolve(Principal principal, String requester, Dependencies depends) throws ResolutionPlugInException {
207
208                 try {
209                         InitialDirContext context = new InitialDirContext(properties);
210                         NamingEnumeration enum = null;
211
212                         try {
213                                 enum = context.search("", searchFilter.replaceAll("%PRINCIPAL%", principal.getName()), controls);
214                         } catch (CommunicationException e) {
215                                 log.debug(e);
216                                 log.warn(
217                                         "Encountered a connection problem while querying for attributes.  Re-initializing JNDI context and retrying...");
218                                 context = new InitialDirContext(context.getEnvironment());
219                                 enum = context.search("", searchFilter.replaceAll("%PRINCIPAL%", principal.getName()), controls);
220                         }
221
222                         if (enum == null || !enum.hasMore()) {
223                                 log.error("Could not locate a principal with the name (" + principal.getName() + ").");
224                                 throw new ResolutionPlugInException("No data available for this principal.");
225                         }
226
227                         SearchResult result = (SearchResult) enum.next();
228                         Attributes attributes = result.getAttributes();
229
230                         if (enum.hasMore()) {
231                                 log.error("Unable to disambiguate date for principal (" + principal.getName() + ") in search.");
232                                 throw new ResolutionPlugInException("Cannot disambiguate data for this principal.");
233                         }
234
235                         context.close();
236                         return attributes;
237
238                 } catch (NamingException e) {
239                         log.error(
240                                 "An error occurred while retieving data for principal ("
241                                         + principal.getName()
242                                         + ") :"
243                                         + e.getMessage());
244                         throw new ResolutionPlugInException("Error retrieving data for principal.");
245                 }
246         }
247
248 }