1 /*
2 * Copyright (c) 2002-2014, Mairie de Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.mylutece.modules.wssodatabase.authentication.util;
35
36 import java.util.Hashtable;
37
38 import javax.naming.Context;
39 import javax.naming.NamingEnumeration;
40 import javax.naming.NamingException;
41 import javax.naming.directory.DirContext;
42 import javax.naming.directory.InitialDirContext;
43 import javax.naming.directory.SearchControls;
44
45
46 /**
47 * Classe utilitaire de connexion au LDAP
48 */
49 public final class LdapUtil
50 {
51 /**
52 * Constructeur
53 */
54 private LdapUtil( )
55 {
56 // empty contructor
57 }
58
59 /**
60 * Search LDAP context
61 * @param strLDAPContext the ldap context
62 * @param strLDAPUrl the ldap url
63 * @param strAdminDN the admin dn
64 * @param strAdminPassword the admin password
65 * @return a DirContext object
66 * @throws NamingException in case of error
67 */
68 public static DirContext getContext( String strLDAPContext, String strLDAPUrl, String strAdminDN,
69 String strAdminPassword ) throws NamingException
70 {
71 Hashtable env = new Hashtable( );
72
73 env.put( Context.INITIAL_CONTEXT_FACTORY, strLDAPContext );
74 env.put( Context.PROVIDER_URL, strLDAPUrl );
75 env.put( Context.SECURITY_PRINCIPAL, strAdminDN );
76 env.put( Context.SECURITY_CREDENTIALS, strAdminPassword );
77
78 DirContext context = new InitialDirContext( env );
79
80 return context;
81 }
82
83 /**
84 * Free the context
85 * @param context the context to free
86 * @throws NamingException in case of error
87 */
88 public static void freeContext( DirContext context ) throws NamingException
89 {
90 if ( context != null )
91 {
92 context.close( );
93 }
94 }
95
96 /**
97 * Connects an user to the ldap
98 * @param strLDAPContext the ldap context
99 * @param strLDAPUrl the ldap url
100 * @param strDN the dn
101 * @param strPassword the password
102 * @return a DirContext object
103 * @throws NamingException in case of error
104 */
105 public static DirContext bindUser( String strLDAPContext, String strLDAPUrl, String strDN, String strPassword )
106 throws NamingException
107 {
108 DirContext context = null;
109
110 Hashtable env = new Hashtable( );
111
112 env.put( Context.INITIAL_CONTEXT_FACTORY, strLDAPContext );
113 env.put( Context.PROVIDER_URL, strLDAPUrl );
114 env.put( Context.SECURITY_PRINCIPAL, strDN );
115 env.put( Context.SECURITY_CREDENTIALS, strPassword );
116
117 context = new InitialDirContext( env );
118
119 return context;
120 }
121
122 /**
123 *
124 * @param context the ldap context
125 * @param strFilter the filter
126 * @param strUserDN the user dn
127 * @param strDNBase the base dn
128 * @param sc the search controls
129 * @return an enumeration of found elements
130 * @throws NamingException in case of error
131 */
132 public static NamingEnumeration searchUsers( DirContext context, String strFilter, String strUserDN,
133 String strDNBase, SearchControls sc ) throws NamingException
134 {
135 NamingEnumeration enumeration = context.search( strUserDN + strDNBase, strFilter, sc );
136
137 return enumeration;
138 }
139 }