/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
* or http://forgerock.org/license/CDDLv1.0.html.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at legal-notices/CDDLv1_0.txt.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
* Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.extensions;
import static org.testng.Assert.*;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;
import org.opends.server.TestCaseUtils;
import org.forgerock.i18n.LocalizableMessageBuilder;
import org.forgerock.i18n.LocalizableMessage;
import org.opends.server.admin.std.meta.UniqueCharactersPasswordValidatorCfgDefn;
import org.opends.server.admin.std.server.UniqueCharactersPasswordValidatorCfg;
import org.opends.server.admin.server.AdminTestCaseUtils;
import org.forgerock.opendj.config.server.ConfigException;
import org.opends.server.core.ModifyOperationBasis;
import org.opends.server.protocols.internal.InternalClientConnection;
import org.opends.server.types.Attributes;
import org.forgerock.opendj.ldap.ByteString;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.opends.server.types.Control;
import org.opends.server.types.DN;
import org.opends.server.types.Entry;
import org.opends.server.types.InitializationException;
import org.opends.server.types.Modification;
import org.forgerock.opendj.ldap.ModificationType;
import org.forgerock.opendj.ldap.ResultCode;
/**
* A set of test cases for the unique characters password validator.
*/
public class UniqueCharactersPasswordValidatorTestCase
extends ExtensionsTestCase
{
/**
* Ensures that the Directory Server is running.
*
* @throws Exception If an unexpected problem occurs.
*/
@BeforeClass
public void startServer()
throws Exception
{
TestCaseUtils.startServer();
}
/**
* Retrieves a set of valid configuration entries that may be used to
* initialize the validator.
*
* @throws Exception If an unexpected problem occurs.
*/
@DataProvider(name = "validConfigs")
public Object[][] getValidConfigs()
throws Exception
{
List<Entry> entries = TestCaseUtils.makeEntries(
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"ds-cfg-case-sensitive-validation: false",
"",
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"ds-cfg-case-sensitive-validation: true",
"",
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 0",
"ds-cfg-case-sensitive-validation: false");
Object[][] array = new Object[entries.size()][1];
for (int i=0; i < array.length; i++)
{
array[i] = new Object[] { entries.get(i) };
}
return array;
}
/**
* Tests the process of initializing the server with valid configurations.
*
* @param entry The configuration entry to use for the initialization.
*
* @throws Exception If an unexpected problem occurs.
*/
@Test(dataProvider = "validConfigs")
public void testInitializeWithValidConfigs(Entry e)
throws Exception
{
UniqueCharactersPasswordValidatorCfg configuration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(), e);
UniqueCharactersPasswordValidator validator =
new UniqueCharactersPasswordValidator();
validator.initializePasswordValidator(configuration);
validator.finalizePasswordValidator();
}
/**
* Retrieves a set of invalid configuration entries.
*
* @throws Exception If an unexpected problem occurs.
*/
@DataProvider(name = "invalidConfigs")
public Object[][] getInvalidConfigs()
throws Exception
{
List<Entry> entries = TestCaseUtils.makeEntries(
// Missing minimum unique characters
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-case-sensitive-validation: false",
"",
// Missing case-sensitive validation
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"",
// Non-numeric minimum unique characters
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: non-numeric",
"ds-cfg-case-sensitive-validation: false",
"",
// Non-boolean case-sensitive validation
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"ds-cfg-case-sensitive-validation: non-boolean",
"",
// Minimum unique characters out of range.
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: -1",
"ds-cfg-case-sensitive-validation: false");
Object[][] array = new Object[entries.size()][1];
for (int i=0; i < array.length; i++)
{
array[i] = new Object[] { entries.get(i) };
}
return array;
}
/**
* Tests the process of initializing the server with invalid configurations.
*
* @param entry The configuration entry to use for the initialization.
*
* @throws Exception If an unexpected problem occurs.
*/
@Test(dataProvider = "invalidConfigs",
expectedExceptions = { ConfigException.class,
InitializationException.class })
public void testInitializeWithInvalidConfigs(Entry e)
throws Exception
{
UniqueCharactersPasswordValidatorCfg configuration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(), e);
UniqueCharactersPasswordValidator validator =
new UniqueCharactersPasswordValidator();
validator.initializePasswordValidator(configuration);
}
/**
* Tests the {@code passwordIsAcceptable} method with a password that falls
* within the constraints of the password validator. Case-sensitivity will
* not be an issue.
*
* @throws Exception If an unexpected problem occurs.
*/
@Test
public void testPasswordIsAcceptable7Unique()
throws Exception
{
TestCaseUtils.initializeTestBackend(true);
Entry userEntry = TestCaseUtils.makeEntry(
"dn: uid=test.user,o=test",
"objectClass: top",
"objectClass: person",
"objectClass: organizationalPerson",
"objectClass: inetOrgPerson",
"uid: test.user",
"givenName: Test",
"sn: User",
"cn: Test User",
"userPassword: doesntmatter");
Entry validatorEntry = TestCaseUtils.makeEntry(
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"ds-cfg-case-sensitive-validation: false");
UniqueCharactersPasswordValidatorCfg configuration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(),
validatorEntry);
UniqueCharactersPasswordValidator validator =
new UniqueCharactersPasswordValidator();
validator.initializePasswordValidator(configuration);
ByteString password = ByteString.valueOfUtf8("password");
ArrayList<Modification> mods = new ArrayList<>();
mods.add(new Modification(ModificationType.REPLACE,
Attributes.create("userpassword", "password")));
InternalClientConnection conn =
InternalClientConnection.getRootConnection();
ModifyOperationBasis modifyOperation =
new ModifyOperationBasis(conn, InternalClientConnection.nextOperationID(),
InternalClientConnection.nextMessageID(),
new ArrayList<Control>(),
DN.valueOf("uid=test.user,o=test"), mods);
LocalizableMessageBuilder invalidReason = new LocalizableMessageBuilder();
assertTrue(validator.passwordIsAcceptable(password,
new HashSet<ByteString>(0), modifyOperation,
userEntry, invalidReason),
invalidReason.toString());
validator.finalizePasswordValidator();
}
/**
* Tests the {@code passwordIsAcceptable} method with a password that falls
* outside the constraints of the password validator. Case-sensitivity will
* not be an issue.
*
* @throws Exception If an unexpected problem occurs.
*/
@Test
public void testPasswordIsAcceptable4Unique()
throws Exception
{
TestCaseUtils.initializeTestBackend(true);
Entry userEntry = TestCaseUtils.makeEntry(
"dn: uid=test.user,o=test",
"objectClass: top",
"objectClass: person",
"objectClass: organizationalPerson",
"objectClass: inetOrgPerson",
"uid: test.user",
"givenName: Test",
"sn: User",
"cn: Test User",
"userPassword: doesntmatter");
Entry validatorEntry = TestCaseUtils.makeEntry(
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"ds-cfg-case-sensitive-validation: false");
UniqueCharactersPasswordValidatorCfg configuration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(),
validatorEntry);
UniqueCharactersPasswordValidator validator =
new UniqueCharactersPasswordValidator();
validator.initializePasswordValidator(configuration);
ByteString password = ByteString.valueOfUtf8("passw");
ArrayList<Modification> mods = new ArrayList<>();
mods.add(new Modification(ModificationType.REPLACE,
Attributes.create("userpassword", "passw")));
InternalClientConnection conn =
InternalClientConnection.getRootConnection();
ModifyOperationBasis modifyOperation =
new ModifyOperationBasis(conn, InternalClientConnection.nextOperationID(),
InternalClientConnection.nextMessageID(),
new ArrayList<Control>(),
DN.valueOf("uid=test.user,o=test"), mods);
LocalizableMessageBuilder invalidReason = new LocalizableMessageBuilder();
assertFalse(validator.passwordIsAcceptable(password,
new HashSet<ByteString>(0), modifyOperation,
userEntry, invalidReason));
validator.finalizePasswordValidator();
}
/**
* Tests the {@code passwordIsAcceptable} method with a password that falls
* within the constraints of the password validator only because it uses
* case-sensitive validation.
*
* @throws Exception If an unexpected problem occurs.
*/
@Test
public void testPasswordIsAcceptableCaseSensitive()
throws Exception
{
TestCaseUtils.initializeTestBackend(true);
Entry userEntry = TestCaseUtils.makeEntry(
"dn: uid=test.user,o=test",
"objectClass: top",
"objectClass: person",
"objectClass: organizationalPerson",
"objectClass: inetOrgPerson",
"uid: test.user",
"givenName: Test",
"sn: User",
"cn: Test User",
"userPassword: doesntmatter");
Entry validatorEntry = TestCaseUtils.makeEntry(
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"ds-cfg-case-sensitive-validation: true");
UniqueCharactersPasswordValidatorCfg configuration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(),
validatorEntry);
UniqueCharactersPasswordValidator validator =
new UniqueCharactersPasswordValidator();
validator.initializePasswordValidator(configuration);
ByteString password = ByteString.valueOfUtf8("pasSw");
ArrayList<Modification> mods = new ArrayList<>();
mods.add(new Modification(ModificationType.REPLACE,
Attributes.create("userpassword", "pasSw")));
InternalClientConnection conn =
InternalClientConnection.getRootConnection();
ModifyOperationBasis modifyOperation =
new ModifyOperationBasis(conn, InternalClientConnection.nextOperationID(),
InternalClientConnection.nextMessageID(),
new ArrayList<Control>(),
DN.valueOf("uid=test.user,o=test"), mods);
LocalizableMessageBuilder invalidReason = new LocalizableMessageBuilder();
assertTrue(validator.passwordIsAcceptable(password,
new HashSet<ByteString>(0), modifyOperation,
userEntry, invalidReason),
invalidReason.toString());
validator.finalizePasswordValidator();
}
/**
* Tests the {@code passwordIsAcceptable} method with a password that falls
* outside the constraints of the password validator because it uses
* case-insensitive validation.
*
* @throws Exception If an unexpected problem occurs.
*/
@Test
public void testPasswordIsAcceptableCaseInsensitive()
throws Exception
{
TestCaseUtils.initializeTestBackend(true);
Entry userEntry = TestCaseUtils.makeEntry(
"dn: uid=test.user,o=test",
"objectClass: top",
"objectClass: person",
"objectClass: organizationalPerson",
"objectClass: inetOrgPerson",
"uid: test.user",
"givenName: Test",
"sn: User",
"cn: Test User",
"userPassword: doesntmatter");
Entry validatorEntry = TestCaseUtils.makeEntry(
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"ds-cfg-case-sensitive-validation: false");
UniqueCharactersPasswordValidatorCfg configuration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(),
validatorEntry);
UniqueCharactersPasswordValidator validator =
new UniqueCharactersPasswordValidator();
validator.initializePasswordValidator(configuration);
ByteString password = ByteString.valueOfUtf8("pasSw");
ArrayList<Modification> mods = new ArrayList<>();
mods.add(new Modification(ModificationType.REPLACE,
Attributes.create("userpassword", "pasSw")));
InternalClientConnection conn =
InternalClientConnection.getRootConnection();
ModifyOperationBasis modifyOperation =
new ModifyOperationBasis(conn, InternalClientConnection.nextOperationID(),
InternalClientConnection.nextMessageID(),
new ArrayList<Control>(),
DN.valueOf("uid=test.user,o=test"), mods);
LocalizableMessageBuilder invalidReason = new LocalizableMessageBuilder();
assertFalse(validator.passwordIsAcceptable(password,
new HashSet<ByteString>(0), modifyOperation,
userEntry, invalidReason));
validator.finalizePasswordValidator();
}
/**
* Tests the {@code passwordIsAcceptable} method when the validator is
* configured to accept any number of unique characters.
*
* @throws Exception If an unexpected problem occurs.
*/
@Test
public void testPasswordIsAcceptableAnyNumberOfCharacters()
throws Exception
{
TestCaseUtils.initializeTestBackend(true);
Entry userEntry = TestCaseUtils.makeEntry(
"dn: uid=test.user,o=test",
"objectClass: top",
"objectClass: person",
"objectClass: organizationalPerson",
"objectClass: inetOrgPerson",
"uid: test.user",
"givenName: Test",
"sn: User",
"cn: Test User",
"userPassword: doesntmatter");
Entry validatorEntry = TestCaseUtils.makeEntry(
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 0",
"ds-cfg-case-sensitive-validation: true");
UniqueCharactersPasswordValidatorCfg configuration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(),
validatorEntry);
UniqueCharactersPasswordValidator validator =
new UniqueCharactersPasswordValidator();
validator.initializePasswordValidator(configuration);
ByteString password = ByteString.valueOfUtf8("aaaaaaaa");
ArrayList<Modification> mods = new ArrayList<>();
mods.add(new Modification(ModificationType.REPLACE,
Attributes.create("userpassword", "aaaaaaaa")));
InternalClientConnection conn =
InternalClientConnection.getRootConnection();
ModifyOperationBasis modifyOperation =
new ModifyOperationBasis(conn, InternalClientConnection.nextOperationID(),
InternalClientConnection.nextMessageID(),
new ArrayList<Control>(),
DN.valueOf("uid=test.user,o=test"), mods);
LocalizableMessageBuilder invalidReason = new LocalizableMessageBuilder();
assertTrue(validator.passwordIsAcceptable(password,
new HashSet<ByteString>(0), modifyOperation,
userEntry, invalidReason),
invalidReason.toString());
validator.finalizePasswordValidator();
}
/**
* Tests the ability of the password validator to change its behavior when
* the configuration is updated.
*
* @throws Exception If an unexpected problem occurs.
*/
@Test
public void testPasswordIsAcceptableConfigurationChange()
throws Exception
{
TestCaseUtils.initializeTestBackend(true);
Entry userEntry = TestCaseUtils.makeEntry(
"dn: uid=test.user,o=test",
"objectClass: top",
"objectClass: person",
"objectClass: organizationalPerson",
"objectClass: inetOrgPerson",
"uid: test.user",
"givenName: Test",
"sn: User",
"cn: Test User",
"userPassword: doesntmatter");
Entry validatorEntry = TestCaseUtils.makeEntry(
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 0",
"ds-cfg-case-sensitive-validation: true");
UniqueCharactersPasswordValidatorCfg configuration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(),
validatorEntry);
UniqueCharactersPasswordValidator validator =
new UniqueCharactersPasswordValidator();
validator.initializePasswordValidator(configuration);
ByteString password = ByteString.valueOfUtf8("aaaaaaaa");
ArrayList<Modification> mods = new ArrayList<>();
mods.add(new Modification(ModificationType.REPLACE,
Attributes.create("userpassword", "aaaaaaaa")));
InternalClientConnection conn =
InternalClientConnection.getRootConnection();
ModifyOperationBasis modifyOperation =
new ModifyOperationBasis(conn, InternalClientConnection.nextOperationID(),
InternalClientConnection.nextMessageID(),
new ArrayList<Control>(),
DN.valueOf("uid=test.user,o=test"), mods);
LocalizableMessageBuilder invalidReason = new LocalizableMessageBuilder();
assertTrue(validator.passwordIsAcceptable(password,
new HashSet<ByteString>(0), modifyOperation,
userEntry, invalidReason),
invalidReason.toString());
Entry updatedValidatorEntry = TestCaseUtils.makeEntry(
"dn: cn=Unique Characters,cn=Password Validators,cn=config",
"objectClass: top",
"objectClass: ds-cfg-password-validator",
"objectClass: ds-cfg-unique-characters-password-validator",
"cn: Unique Characters",
"ds-cfg-java-class: org.opends.server.extensions." +
"UniqueCharactersPasswordValidator",
"ds-cfg-enabled: true",
"ds-cfg-min-unique-characters: 5",
"ds-cfg-case-sensitive-validation: true");
UniqueCharactersPasswordValidatorCfg updatedConfiguration =
AdminTestCaseUtils.getConfiguration(
UniqueCharactersPasswordValidatorCfgDefn.getInstance(),
updatedValidatorEntry);
ArrayList<LocalizableMessage> unacceptableReasons = new ArrayList<>();
assertTrue(validator.isConfigurationChangeAcceptable(updatedConfiguration,
unacceptableReasons),
String.valueOf(unacceptableReasons));
ConfigChangeResult changeResult =
validator.applyConfigurationChange(updatedConfiguration);
assertEquals(changeResult.getResultCode(), ResultCode.SUCCESS);
assertFalse(validator.passwordIsAcceptable(password,
new HashSet<ByteString>(0), modifyOperation,
userEntry, invalidReason));
validator.finalizePasswordValidator();
}
}