You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2012/10/29 19:39:21 UTC
svn commit: r1403458 - in /directory/site/trunk/content/apacheds/basic-ug:
./ images/
Author: elecharny
Date: Mon Oct 29 18:39:20 2012
New Revision: 1403458
URL: http://svn.apache.org/viewvc?rev=1403458&view=rev
Log:
Added the 2-handling-data, 3-basic-security and 3.1-authentication-options pages
Added:
directory/site/trunk/content/apacheds/basic-ug/images/anonymous-access.png (with props)
directory/site/trunk/content/apacheds/basic-ug/images/authentication-options-ls.png (with props)
directory/site/trunk/content/apacheds/basic-ug/images/confluence-logon.png (with props)
directory/site/trunk/content/apacheds/basic-ug/images/password-edit-ls.png (with props)
directory/site/trunk/content/apacheds/basic-ug/images/sample-structure.gif (with props)
Modified:
directory/site/trunk/content/apacheds/basic-ug/2-handling-data.mdtext
directory/site/trunk/content/apacheds/basic-ug/3-basic-security.mdtext
directory/site/trunk/content/apacheds/basic-ug/3.1-authentication-options.mdtext
Modified: directory/site/trunk/content/apacheds/basic-ug/2-handling-data.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/2-handling-data.mdtext?rev=1403458&r1=1403457&r2=1403458&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/2-handling-data.mdtext (original)
+++ directory/site/trunk/content/apacheds/basic-ug/2-handling-data.mdtext Mon Oct 29 18:39:20 2012
@@ -22,4 +22,6 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-# 2 - Handling of data within your directory
\ No newline at end of file
+# 2 - Handling of data within your directory
+
+TODO...
\ No newline at end of file
Modified: directory/site/trunk/content/apacheds/basic-ug/3-basic-security.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/3-basic-security.mdtext?rev=1403458&r1=1403457&r2=1403458&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/3-basic-security.mdtext (original)
+++ directory/site/trunk/content/apacheds/basic-ug/3-basic-security.mdtext Mon Oct 29 18:39:20 2012
@@ -22,4 +22,8 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-# 3 - Basic Security
\ No newline at end of file
+# 3 - Basic Security
+
+* [3.1 - Authentication options](3.1-authentication-options.html)
+* [3.2 - Basic authorization](3.2-basic-authorization.html)
+* [3.3 - How to enable SSL](3.3-enabling-ssl.html)
Modified: directory/site/trunk/content/apacheds/basic-ug/3.1-authentication-options.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/3.1-authentication-options.mdtext?rev=1403458&r1=1403457&r2=1403458&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/basic-ug/3.1-authentication-options.mdtext (original)
+++ directory/site/trunk/content/apacheds/basic-ug/3.1-authentication-options.mdtext Mon Oct 29 18:39:20 2012
@@ -22,4 +22,374 @@ Notice: Licensed to the Apache Software
specific language governing permissions and limitations
under the License.
-# 3.1 - Authentication options
\ No newline at end of file
+# 3.1 - Authentication options
+
+This section describes the authentication options of ApacheDS 2.0. Anonymous and simple binds are supported, as well as SASL mechanisms. Configuring and using the first two of them is described below with the help of examples.
+
+[TOC]
+
+## What is authentication?
+
+*Authentication* is the process of determining whether someone (or something) in fact is what he/she/it asserts to be.
+
+Within ApacheDS you will likely want to authenticate clients in order to check whether they are allowed to read, add or manipulate certain data stored within the directory. The latter, i.e. whether an authenticated client is permitted to do something, is deduced during *authorization*.
+
+Quite often, the process of authentication is delegated to a directory service by other software components. Because in doing so, authentication data (e.g. username, password) and authorization data (e.g. group relationships) are stored and managed centrally in the directory, and all connected software solutions benefit from it. The integration sections of this guide provide examples for Apache Tomcat, Apache HTTP servers, and others.
+
+ApacheDS 2.0 supports simple authentication and anonymous binds while storing passwords within _userPassword_ attributes in user entries. Passwords can be stored in clear text or one-way encrypted with a hash algorithm like MD5 or SHA1. Since version 1.5.1, SASL mechanism are supported as well. We start with anonymous binds.
+
+## Simple binds
+
+Authentication via simple bind is widely used. The method is supported by ApacheDS 2.0 for all person entries stored within any partition, if they contain a password attribute. How does it work? An LDAP client provides the DN of a user entry and a password to the server, the parameters of the bind operation. ApacheDS checks whether the given password is the same as the one stored in the _userpassword_ attribute of the given entry. If not, the bind operation fails (LDAP error code 49, LDAP_INVALID_CREDENTIALS), and the user is not authenticated.
+
+### Using command line tools
+
+Assume this entry from the Seven Seas partition is stored within the directory (only a fragment with the relevant attributes is shown).
+
+ dn: cn=Horatio Hornblower,ou=people,o=sevenSeas
+ objectclass: person
+ objectclass: organizationalPerson
+ cn: Horatio Hornblower
+ sn: Hornblower
+ userpassword: pass
+ ...
+
+In the following search command, a user tries to bind with the given DN (option -D) but a wrong password (option -w). The bind fails and the command terminates without performing the search.
+
+ $ ldapsearch -h zanzibar -p 10389 -D "cn=Horatio Hornblower,ou=people,o=sevenSeas" \\
+ -w wrong -b "ou=people,o=sevenSeas" -s base "(objectclass=*)"
+ ldap_simple_bind: Invalid credentials
+ ldap_simple_bind: additional info: Bind failed: null
+
+If the user provides the correct password during the call of the ldapsearch command, the bind operation succeeds and the seach operation is performed afterwards.
+
+ $ ldapsearch -h zanzibar -p 10389 -D "cn=Horatio Hornblower,ou=people,o=sevenSeas" \\
+ -w pass -b "ou=people,o=sevenSeas" -s base "(objectclass=*)"
+ version: 1
+ dn: ou=people,o=sevenSeas
+ ou: people
+ description: Contains entries which describe persons (seamen)
+ objectclass: organizationalUnit
+ objectclass: top
+
+### Binds from Java components using JNDI
+
+Using JNDI, authentication via simple binds is accomplished by appropriate configuration. One option is to provide the parameters in a Hashtable object like this
+
+ import java.util.Hashtable;
+
+ import javax.naming.Context;
+ import javax.naming.InitialContext;
+ import javax.naming.NamingEnumeration;
+ import javax.naming.NamingException;
+
+ public class SimpleBindDemo {
+
+ public static void main(String[] args) throws NamingException {
+
+ if (args.length < 2) {
+ System.err.println("Usage: java SimpleBindDemo <userDN> <password>");
+ System.exit(1);
+ }
+
+ Hashtable env = new Hashtable();
+ env.put(Context.INITIAL_CONTEXT_FACTORY, "com.sun.jndi.ldap.LdapCtxFactory");
+ env.put(Context.PROVIDER_URL, "ldap://zanzibar:10389/o=sevenSeas");
+
+ env.put(Context.SECURITY_AUTHENTICATION, "simple");
+ env.put(Context.SECURITY_PRINCIPAL, args[0]);
+ env.put(Context.SECURITY_CREDENTIALS, args[1]);
+
+ try {
+ Context ctx = new InitialContext(env);
+ NamingEnumeration enm = ctx.list("");
+
+ while (enm.hasMore()) {
+ System.out.println(enm.next());
+ }
+
+ enm.close();
+ ctx.close();
+ } catch (NamingException e) {
+ System.out.println(e.getMessage());
+ }
+ }
+ }
+
+
+If the DN of a user entry and the fitting password are provided as command line arguments, the program binds successfully and performs a search:
+
+ $ java SimpleBindDemo "cn=Horatio Hornblower,ou=people,o=sevenSeas" pass
+ ou=people: javax.naming.directory.DirContext
+ ou=groups: javax.naming.directory.DirContext
+
+On the other hand, providing an incorrect password results in a failed bind operation. JNDI maps it to a _NamingException_:
+
+ $ java SimpleBindDemo "cn=Horatio Hornblower,ou=people,o=sevenSeas" quatsch
+ [LDAP: error code 49 - Bind failed: null]
+
+In real life, you obviously want to separate most of the configuration data from the source code, for instance with the help of the _jndi.properties_ file.
+
+## Passwords stored one-way encrypted
+
+If passwords are stored in the directory in clear like above, the administrator (_uid=admin,ou=system_) is able to read them. This holds true even if authorization is enabled. The passwords would also be visible in exported LDIF files. This is often unacceptable.
+
+<DIV class="warning" markdown="1">
+Not only the administrator will be able to read your password, or be visible in LDIF files, but if one does not use SSL, the the password is transmitted in clear text above the wire...
+</DIV>
+
+### Passwords not stored in clear text
+
+ApacheDS does also support simple binds, if user passwords are stored one-way encrypted. An LDAP client, which creates user entries, applies a hash-function (SHA for instance) to the user passwords beforehand, and stores the users with these fingerprints as _userpassword_ values (instead of the clear text values), for instance:
+
+ dn: cn=Horatio Hornblower,ou=people,o=sevenSeas
+ objectclass: person
+ objectclass: organizationalPerson
+ cn: Horatio Hornblower
+ sn: Hornblower
+ userpassword: {SHA}nU4eI71bcnBGqeO0t9tXvY1u5oQ=
+ ...
+
+The value "{SHA}nU4eI71bcnBGqeO0t9tXvY1u5oQ=" means that _SHA_ (Secure Hash Algorithm) was applied to the password, and "nU4eI71bcnBGqeO0t9tXvY1u5oQ=" was the result (Base-64 encoded). Please note that it is not possible to calculate the source ("pass" in our case) back from the result. This is why it is called one-way encrypted -- it is rather difficult to decrypt it. One may guess many times, calculate the hash values (the algorithms are public) and compare the result. But this would take a long time, especially if you choose a more complex password than we did ("pass").
+
+### But how to obtain the hash value for a password?
+
+With some lines of code, it is quite easy to accomplish this task programatically in Java:
+
+ import java.security.MessageDigest;
+ import java.security.NoSuchAlgorithmException;
+ import sun.misc.BASE64Encoder;
+
+ public class DigestDemo {
+ public static void main(String[] args) throws NoSuchAlgorithmException {
+ String password = "pass";
+ String algorithm = "SHA";
+
+ // Calculate hash value
+ MessageDigest md = MessageDigest.getInstance(algorithm);
+ md.update(password.getBytes());
+ byte[] bytes = md.digest();
+
+ // Print out value in Base64 encoding
+ BASE64Encoder base64encoder = new BASE64Encoder();
+ String hash = base64encoder.encode(bytes);
+ System.out.println('{'+algorithm+'}'+hash);
+ }
+ }
+
+The output is "{SHA}nU4eI71bcnBGqeO0t9tXvY1u5oQ=".
+
+Another option is to use command line tools to calculate the hash value; the [OpenSSL](http://www.openssl.org) project provides such stuff. Furthermore many UI LDAP tools allow you to store passwords automatically encrypted with the hash algorithm of your choice. See below [Apache Directory Studio](http://directory.apache.org/studio/) as an example. The dialog automatically shows up if a _userPassword_ attribute is to be manipulated (added, changed).
+
+
+
+### From an LDAP client point of view
+
+From an LDAP client point of view, the behavior during authentication is the same as with passwords stored in clear. During a simple bind, a client sends DN and password (unencrypted, i.e. no hash algorithm applied) to the server. If ApacheDS detects, that the user password for the given DN is stored in the directory with a hash function applied, it calculates the hash value of the given password with the appropriate algorithm (this is why the algorithm is stored together with the hashed password). Afterwards it compares the result with the stored attribute value. In case of a match, the bind operation ends successfully:
+
+ $ ldapsearch -h zanzibar -p 10389 -D "cn=Horatio Hornblower,ou=people,o=sevenSeas" \\
+ -w pass -b "ou=people,o=sevenSeas" -s base "(objectclass=*)"
+ version: 1
+ dn: ou=people,o=sevenSeas
+ ou: people
+ description: Contains entries which describe persons (seamen)
+ objectclass: organizationalUnit
+ objectclass: top
+
+Providing the hashed value of the _userPassword_ attribute instead of the original value will be rejected by ApacheDS:
+
+ $ ldapsearch -h zanzibar -p 10389 -D "cn=Horatio Hornblower,ou=people,o=sevenSeas" \\
+ -w "{SHA}nU4eI71bcnBGqeO0t9tXvY1u5oQ=" -b "ou=people,o=sevenSeas" -s base "(objectclass=*)"
+ ldap_simple_bind: Invalid credentials
+ ldap_simple_bind: additional info: Bind failed: null
+
+This is intended. If someone was able to catch this value (from an LDIF export for instance), s/he must still provide the password itself in order to get authenticated.
+
+<DIV class="note" markdown="1">
+**Be Warned: Limited security added**
+
+Please note that storing user passwords one-way encrypted only adds limited security. During the bind operation, the credentials are still transmitted unencrypted, if no SSL/TLS communication is used (thus you should definitely consider to do so).
+
+Furthermore, if someone gets an LDIF file with userpassword values digested with SHA etc., s/he may be able to determine some of the passwords with brute force. Calculation of hash functions can be done very fast, and the attacker can attempt millions of values with ease, without you getting notice of it. Therefore protect your data, even if one-way encryption is applied to the passwords!
+</DIV>
+
+
+## Anonymous binds
+
+In some occasions it is appropriate to allow LDAP clients to permit operations without authentication. If data managed by the directory service is well known by all clients, it is not uncommon to allow search operations (not manipulation) within this data to all clients -- without providing credentials. An example for this are enterprise wide telephone books, if clients access the directory service from the intranet.
+
+### Enable/disable anonymous binds
+
+Anonymous access is enabled by default. Changing this is one of the basic configuration tasks (see [1.4.5 - Enable and disable anonymous access](1.4.5-anonymous-access.html)).
+
+### Example: Server behavior with anonymous binds disabled
+
+Assume anonymous binds are disabled and our sample partition _Seven Seaes_ present in the server. Here is an example with a search operation performed by a command line tool as a client. It tries to connect anonymously (no DN and password given, i.e. options -D and -w missing) to the server. Afterwards the entry _ou=people,o=sevenSeas_ should be displayed.
+
+See the command and the resulting error message provided by the server below
+
+ $ ldapsearch -h zanzibar -p 10389 -b "ou=people,o=sevenSeas" -s one "(objectclass=*)"
+ ldap_search: Insufficient access
+ ldap_search: additional info: failed on search operation: Anonymous binds have been disabled!
+
+### Example: Server behavior with anonymous binds enabled
+
+Now the same command performed against ApacheDS 1.5 with anonymous access enabled as described above. The behavior is different -- the entry is visible.
+
+ $ ldapsearch -h zanzibar -p 10389 -b "ou=people,o=sevenSeas" -s base "(objectclass=*)"
+ version: 1
+ dn: ou=people,o=sevenSeas
+ ou: people
+ description: Contains entries which describe persons (seamen)
+ objectclass: organizationalUnit
+ objectclass: top
+
+### Other clients
+
+The examples above have used a command line tool. Of course graphical tools and programmatical access (JNDI etc.) allow anonymous binds as well. Below is a screen shot from the configuration dialog of [Apache Directory Studio](http://directory.apache.org/studio/) as an example. During configuration of the connection data ("New LDAP Connection", for instance), the option _Anonymous Authentication_ leads to anonymous binds. Other UI tools offer this feature as well.
+
+
+
+<DIV class="note" markdown="1">
+**Use this feature wisely**
+
+With anonymous access enabled it is not only possible to search the directory without providing username and password. With autorization disabled, anonymous users may also be able to modify data. It is therefore highly recommended to enable and configure the authorization subsystem as well. Learn more about authorization in the [3.2. Basic authorization] section.
+</DIV>
+
+## How to authenticate a user by uid and password?
+
+If you want to use simple binds with user DN and password within a Java component, in order to authenticate users programatically, in practice one problem arises: Most users do not know their DN. Therefore they will not be able to enter it. And even if they know it, it would be frequently very laborious due to the length of the DN. It would be easier for a user if s/he only has to probvide a short, unique _ID_ and the password, like in this web form
+
+
+
+Usually the ID is an attribute within the user's entry. In our sample data (Seven Seas), each user entry contains the _uid_ attribute, for instance uid=hhornblo for Captain Hornblower:
+
+ dn: cn=Horatio Hornblower,ou=people,o=sevenSeas
+ objectclass: person
+ objectclass: organizationalPerson
+ objectclass: inetOrgPerson
+ objectclass: top
+ cn: Horatio Hornblower
+ description: Capt. Horatio Hornblower, R.N
+ givenname: Horatio
+ sn: Hornblower
+ uid: hhornblo
+ mail: hhornblo@royalnavy.mod.uk
+ userpassword: {SHA}nU4eI71bcnBGqeO0t9tXvY1u5oQ=
+
+But how to authenticate a user who provides "hhornblo"/"pass" instead of "cn=Horatio Hornblower,ou=people,o=sevenSeas"/"pass" with the help of ApacheDS?
+
+### An algorithm
+
+In order to accomplish this task programmatically, one option is to perform the following steps
+
+#### Arguments
+* _uid_ of a user (e.g. "hhornblow")
+* _password_ proclaimed to be correct for the user
+
+#### Steps
+
+* Bind to ApacheDS anonymously, or with the DN of a technical user. In both cases it must be possible to search the directory afterwards (authorization has to be configured that way)
+* Perform a search operation with an appropriate filter to find the user entry for the given ID, in our case "(&(objectClass=inetorgperson)(uid=hhornblo))"
+ * If the search result is empty, the user does not exist -- terminate
+ * If the search result contains more than one entry, the given ID is not unique, this is likely a data error within your directory
+* Bind to ApacheDS with the DN of the entry found in the previous search, and the _password_ provided as argument
+ * If the bind operation fails, the password is wrong, and the result is _false_ (not authenticated)
+ * If the bind is successful, authenticate the user
+
+### Sample code with JNDI
+
+The algorithm described above is implemented by many software solutions which are able to integrate LDAP directories. You will learn more about some of them and their configuration options within a later section of this guide.
+
+For illustration purposes, here is a simple Java program which performs the steps with the help of JNDI. It uses anonymous bind for the first step, hence it must be enabled (replace with a technical user, if it better meets your requirements).
+
+ import java.util.Hashtable;
+ import javax.naming.Context;
+ import javax.naming.NamingEnumeration;
+ import javax.naming.NamingException;
+ import javax.naming.directory.DirContext;
+ import javax.naming.directory.InitialDirContext;
+ import javax.naming.directory.SearchControls;
+ import javax.naming.directory.SearchResult;
+
+ public class AdvancedBindDemo {
+
+ public static void main(String[] args) throws NamingException {
+
+ if (args.length < 2) {
+ System.err.println("Usage: java AdvancedBindDemo <uid> <password>");
+ System.exit(1);
+ }
+
+ Hashtable env = new Hashtable();
+ env.put(Context.INITIAL_CONTEXT_FACTORY, "com.sun.jndi.ldap.LdapCtxFactory");
+ env.put(Context.PROVIDER_URL, "ldap://zanzibar:10389/");
+ env.put(Context.SECURITY_AUTHENTICATION, "simple");
+
+ String uid = args[0];
+ String password = args[1];
+
+ DirContext ctx = null;
+
+ try {
+ // Step 1: Bind anonymously
+ ctx = new InitialDirContext(env);
+
+ // Step 2: Search the directory
+ String base = "o=sevenSeas";
+ String filter = "(&(objectClass=inetOrgPerson)(uid={0}))";
+ SearchControls ctls = new SearchControls();
+ ctls.setSearchScope(SearchControls.SUBTREE_SCOPE);
+ ctls.setReturningAttributes(new String[0]);
+ ctls.setReturningObjFlag(true);
+ NamingEnumeration enm = ctx.search(base, filter, new String[] { uid }, ctls);
+
+ String dn = null;
+
+ if (enm.hasMore()) {
+ SearchResult result = (SearchResult) enm.next();
+ dn = result.getNameInNamespace();
+
+ System.out.println("dn: "+dn);
+ }
+
+ if (dn == null || enm.hasMore()) {
+ // uid not found or not unique
+ throw new NamingException("Authentication failed");
+ }
+
+ // Step 3: Bind with found DN and given password
+ ctx.addToEnvironment(Context.SECURITY_PRINCIPAL, dn);
+ ctx.addToEnvironment(Context.SECURITY_CREDENTIALS, password);
+ // Perform a lookup in order to force a bind operation with JNDI
+ ctx.lookup(dn);
+ System.out.println("Authentication successful");
+
+ enm.close();
+ } catch (NamingException e) {
+ System.out.println(e.getMessage());
+ } finally {
+ ctx.close();
+ }
+ }
+ }
+
+Some example calls:
+
+ $ java AdvancedBindDemo unknown sailor
+ Authentication failed
+
+ $ java AdvancedBindDemo hornblo pass
+ dn: cn=Horatio Hornblower,ou=people,o=sevenSeas
+ Authentication successful
+
+ $ java AdvancedBindDemo hornblo quatsch
+ dn: cn=Horatio Hornblower,ou=people,o=sevenSeas
+ [LDAP: error code 49 - Bind failed: null]
+
+The examples consist of an unknown user (an _inetOrgPerson_ entry with uid=unknown does not exist), a successful authenttication, and an attempt with an existing uid but a wrong password.
+
+## Resources
+
+* [RFC 2829](http://www.faqs.org/rfcs/rfc2829.html) Authentication Methods for LDAP
+* [The Secure Hash Algorithm Directory](http://www.secure-hash-algorithm-md5-sha-1.co.uk/) MD5, SHA-1 and HMAC Resources
\ No newline at end of file
Added: directory/site/trunk/content/apacheds/basic-ug/images/anonymous-access.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/images/anonymous-access.png?rev=1403458&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/apacheds/basic-ug/images/anonymous-access.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/site/trunk/content/apacheds/basic-ug/images/authentication-options-ls.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/images/authentication-options-ls.png?rev=1403458&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/apacheds/basic-ug/images/authentication-options-ls.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/site/trunk/content/apacheds/basic-ug/images/confluence-logon.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/images/confluence-logon.png?rev=1403458&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/apacheds/basic-ug/images/confluence-logon.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/site/trunk/content/apacheds/basic-ug/images/password-edit-ls.png
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/images/password-edit-ls.png?rev=1403458&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/apacheds/basic-ug/images/password-edit-ls.png
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: directory/site/trunk/content/apacheds/basic-ug/images/sample-structure.gif
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/basic-ug/images/sample-structure.gif?rev=1403458&view=auto
==============================================================================
Binary file - no diff available.
Propchange: directory/site/trunk/content/apacheds/basic-ug/images/sample-structure.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream