SimilarityBasedPasswordValidator.java revision ea1068c292e9b341af6d6b563cd8988a96be20a9
/*
* 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 2008 Sun Microsystems, Inc.
* Portions Copyright 2014-2015 ForgeRock AS
*/
package org.opends.server.extensions;
import static org.opends.messages.ExtensionMessages.*;
import java.util.List;
import java.util.Set;
import org.forgerock.i18n.LocalizableMessage;
import org.forgerock.i18n.LocalizableMessageBuilder;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.forgerock.opendj.config.server.ConfigException;
import org.forgerock.opendj.ldap.ByteString;
import org.opends.server.api.PasswordValidator;
import org.opends.server.types.*;
import org.opends.server.util.LevenshteinDistance;
import org.opends.server.admin.std.server.SimilarityBasedPasswordValidatorCfg;
import org.opends.server.admin.server.ConfigurationChangeListener;
/**
* This class provides a password validator that can ensure that the provided
* password meets minimum similarity requirements.
*/
public class SimilarityBasedPasswordValidator extends
PasswordValidator<SimilarityBasedPasswordValidatorCfg> implements
ConfigurationChangeListener<SimilarityBasedPasswordValidatorCfg>
{
// The current configuration for this password validator.
private SimilarityBasedPasswordValidatorCfg currentConfig;
/**
* Creates a new instance of this password validator.
*/
public SimilarityBasedPasswordValidator()
{
super();
// All initialization must be done in the initializePasswordValidator
// method.
}
/**
* {@inheritDoc}
*/
@Override
public void initializePasswordValidator(
SimilarityBasedPasswordValidatorCfg configuration)
throws ConfigException, InitializationException
{
configuration.addSimilarityBasedChangeListener(this);
currentConfig = configuration;
}
/**
* {@inheritDoc}
*/
@Override
public void finalizePasswordValidator()
{
currentConfig.removeSimilarityBasedChangeListener(this);
}
/**
* {@inheritDoc}
*/
@Override
public boolean passwordIsAcceptable(ByteString newPassword,
Set<ByteString> currentPasswords,
Operation operation, Entry userEntry,
LocalizableMessageBuilder invalidReason) {
int minDifference = currentConfig.getMinPasswordDifference();
ByteString passwd = newPassword == null
? ByteString.empty()
: newPassword;
if (currentPasswords == null || currentPasswords.size() == 0) {
// This validator requires access to at least one current password.
// If we don't have a current password, then we can't validate it, so
// we'll have to assume it is OK. Ideally, the password policy should be
// configured to always require the current password, but even then the
// current password probably won't be availble during an administrative
// password reset.
return true;
}
for (ByteString bs : currentPasswords) {
if (bs == null) {
continue;
}
int ldistance = LevenshteinDistance.calculate(passwd.toString(),
bs.toString());
if (ldistance < minDifference) {
invalidReason.append(ERR_PWDIFFERENCEVALIDATOR_TOO_SMALL.get(
minDifference));
return false;
}
}
return true;
}
/**
* {@inheritDoc}
*/
public boolean isConfigurationChangeAcceptable(
SimilarityBasedPasswordValidatorCfg configuration,
List<LocalizableMessage> unacceptableReasons)
{
return true;
}
/**
* {@inheritDoc}
*/
public ConfigChangeResult applyConfigurationChange(
SimilarityBasedPasswordValidatorCfg configuration)
{
currentConfig = configuration;
return new ConfigChangeResult();
}
}