Make sure connections are closed in the event of an error.
[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                 InitialDirContext context = null;
123                 try {
124                         context = new InitialDirContext(properties);
125                         log.debug("JNDI Directory context activated.");
126                         
127                 } catch (NamingException e1) {
128                         log.error("Failed to startup directory context: " + e1);
129                         throw new ResolutionPlugInException("Failed to startup directory context.");
130                 } finally {
131                         try {
132                                 if (context != null) {
133                                         context.close();
134                                 }
135                         } catch (NamingException ne) {
136                                 //Squelch
137                         }
138
139                 }
140         }
141
142         protected void defineSearchControls(Element searchNode) {
143
144                 controls = new SearchControls();
145
146                 NodeList controlNodes = searchNode.getElementsByTagNameNS(AttributeResolver.resolverNamespace, "Controls");
147                 if (controlNodes.getLength() < 1) {
148                         log.debug("No Search Control spec found.");
149                 } else {
150                         if (controlNodes.getLength() > 1) {
151                                 log.error("Found multiple Search Control specs for a Connector.  Ignoring all but the first.");
152                         }
153
154                         String searchScopeSpec = ((Element) controlNodes.item(0)).getAttribute("searchScope");
155                         if (searchScopeSpec != null && !searchScopeSpec.equals("")) {
156                                 if (searchScopeSpec.equals("OBJECT_SCOPE")) {
157                                         controls.setSearchScope(SearchControls.OBJECT_SCOPE);
158                                 } else if (searchScopeSpec.equals("ONELEVEL_SCOPE")) {
159                                         controls.setSearchScope(SearchControls.ONELEVEL_SCOPE);
160                                 } else if (searchScopeSpec.equals("SUBTREE_SCOPE")) {
161                                         controls.setSearchScope(SearchControls.SUBTREE_SCOPE);
162                                 } else {
163                                         try {
164                                                 controls.setSearchScope(Integer.parseInt(searchScopeSpec));
165                                         } catch (NumberFormatException nfe) {
166                                                 log.error("Control spec included an invalid (searchScope) attribute value.");
167                                         }
168                                 }
169                         }
170
171                         String timeLimitSpec = ((Element) controlNodes.item(0)).getAttribute("timeLimit");
172                         if (timeLimitSpec != null && !timeLimitSpec.equals("")) {
173                                 try {
174                                         System.err.println("hey");
175                                         controls.setTimeLimit(Integer.parseInt(timeLimitSpec));
176                                 } catch (NumberFormatException nfe) {
177                                         log.error("Control spec included an invalid (timeLimit) attribute value.");
178                                 }
179                         }
180
181                         String returningObjectsSpec = ((Element) controlNodes.item(0)).getAttribute("returningObjects");
182                         if (returningObjectsSpec != null && !returningObjectsSpec.equals("")) {
183                                 controls.setReturningObjFlag(new Boolean(returningObjectsSpec).booleanValue());
184                         }
185
186                         String linkDereferencingSpec = ((Element) controlNodes.item(0)).getAttribute("linkDereferencing");
187                         if (linkDereferencingSpec != null && !linkDereferencingSpec.equals("")) {
188                                 if (linkDereferencingSpec != null && !linkDereferencingSpec.equals("")) {
189                                         controls.setDerefLinkFlag(new Boolean(linkDereferencingSpec).booleanValue());
190                                 }
191                         }
192
193                         String countLimitSpec = ((Element) controlNodes.item(0)).getAttribute("countLimit");
194                         if (countLimitSpec != null && !countLimitSpec.equals("")) {
195                                 try {
196                                         controls.setCountLimit(Long.parseLong(countLimitSpec));
197                                 } catch (NumberFormatException nfe) {
198                                         log.error("Control spec included an invalid (countLimit) attribute value.");
199                                 }
200                         }
201                 }
202
203                 if (log.isDebugEnabled()) {
204                         log.debug("Search Control (searchScope): " + controls.getSearchScope());
205                         log.debug("Search Control (timeLimit): " + controls.getTimeLimit());
206                         log.debug("Search Control (returningObjects): " + controls.getReturningObjFlag());
207                         log.debug("Search Control (linkDereferencing): " + controls.getDerefLinkFlag());
208                         log.debug("Search Control (countLimit): " + controls.getCountLimit());
209                 }
210         }
211
212         /**
213          * @see edu.internet2.middleware.shibboleth.aa.attrresolv.DataConnectorPlugIn#resolve(java.security.Principal)
214          */
215         public Attributes resolve(Principal principal, String requester, Dependencies depends)
216                 throws ResolutionPlugInException {
217
218                 InitialDirContext context = null;
219                 try {
220                         context = new InitialDirContext(properties);
221                         NamingEnumeration enum = null;
222
223                         try {
224                                 enum = context.search("", searchFilter.replaceAll("%PRINCIPAL%", principal.getName()), controls);
225                         } catch (CommunicationException e) {
226                                 log.debug(e);
227                                 log.warn(
228                                         "Encountered a connection problem while querying for attributes.  Re-initializing JNDI context and retrying...");
229                                 context = new InitialDirContext(context.getEnvironment());
230                                 enum = context.search("", searchFilter.replaceAll("%PRINCIPAL%", principal.getName()), controls);
231                         }
232
233                         if (enum == null || !enum.hasMore()) {
234                                 log.error("Could not locate a principal with the name (" + principal.getName() + ").");
235                                 throw new ResolutionPlugInException("No data available for this principal.");
236                         }
237
238                         SearchResult result = (SearchResult) enum.next();
239                         Attributes attributes = result.getAttributes();
240
241                         if (enum.hasMore()) {
242                                 log.error("Unable to disambiguate date for principal (" + principal.getName() + ") in search.");
243                                 throw new ResolutionPlugInException("Cannot disambiguate data for this principal.");
244                         }
245
246                         return attributes;
247
248                 } catch (NamingException e) {
249                         log.error(
250                                 "An error occurred while retieving data for principal ("
251                                         + principal.getName()
252                                         + ") :"
253                                         + e.getMessage());
254                         throw new ResolutionPlugInException("Error retrieving data for principal.");
255                 } finally {
256                         try {
257                                 if (context != null) {
258                                         context.close();
259                                 }
260                         } catch (NamingException e) {
261                                 //Squelch
262                         }
263                 }
264         }
265
266 }