AttributeValuePasswordValidator.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 2012-2015 ForgeRock AS.
*/
package org.opends.server.extensions;
import org.forgerock.i18n.LocalizableMessage;
import java.util.List;
import java.util.Set;
import org.opends.server.admin.server.ConfigurationChangeListener;
import org.opends.server.admin.std.server.AttributeValuePasswordValidatorCfg;
import org.opends.server.admin.std.server.PasswordValidatorCfg;
import org.opends.server.api.PasswordValidator;
import org.opends.server.types.*;
import org.forgerock.opendj.config.server.ConfigChangeResult;
import org.forgerock.opendj.ldap.ByteString;
import static org.opends.messages.ExtensionMessages.*;
import org.forgerock.i18n.LocalizableMessageBuilder;
/**
* This class provides an OpenDS password validator that may be used to ensure
* that proposed passwords are not contained in another attribute in the user's
* entry.
*/
public class AttributeValuePasswordValidator
extends PasswordValidator<AttributeValuePasswordValidatorCfg>
implements ConfigurationChangeListener<
AttributeValuePasswordValidatorCfg>
{
// The current configuration for this password validator.
private AttributeValuePasswordValidatorCfg currentConfig;
/**
* Creates a new instance of this attribute value password validator.
*/
public AttributeValuePasswordValidator()
{
super();
// No implementation is required here. All initialization should be
// performed in the initializePasswordValidator() method.
}
/**
* {@inheritDoc}
*/
@Override
public void initializePasswordValidator(
AttributeValuePasswordValidatorCfg configuration)
{
configuration.addAttributeValueChangeListener(this);
currentConfig = configuration;
}
/**
* {@inheritDoc}
*/
@Override
public void finalizePasswordValidator()
{
currentConfig.removeAttributeValueChangeListener(this);
}
/**
* Search for substrings of the password in an Attribute. The search is
* case-insensitive.
*
* @param password the password
* @param minSubstringLength the minimum substring length to check
* @param a the attribute to search
* @return true if an attribute value matches a substring of the password,
* false otherwise.
*/
private boolean containsSubstring(String password, int minSubstringLength,
Attribute a)
{
final int passwordLength = password.length();
for (int i = 0; i < passwordLength; i++)
{
for (int j = i + minSubstringLength; j <= passwordLength; j++)
{
Attribute substring = Attributes.create(a.getAttributeType(),
password.substring(i, j));
for (ByteString val : a)
{
if (substring.contains(val))
{
return true;
}
}
}
}
return false;
}
/**
* {@inheritDoc}
*/
@Override
public boolean passwordIsAcceptable(ByteString newPassword,
Set<ByteString> currentPasswords,
Operation operation, Entry userEntry,
LocalizableMessageBuilder invalidReason)
{
// Get a handle to the current configuration.
AttributeValuePasswordValidatorCfg config = currentConfig;
// Get the string representation (both forward and reversed) for the
// password.
String password = newPassword.toString();
String reversed = new StringBuilder(password).reverse().toString();
// Check to see if we should verify the whole password or the substrings.
int minSubstringLength = password.length();
if (config.isCheckSubstrings())
{
// We apply the minimal substring length only if the provided value
// is smaller then the actual password length
if (config.getMinSubstringLength() < password.length())
{
minSubstringLength = config.getMinSubstringLength();
}
}
// If we should check a specific set of attributes, then do that now.
// Otherwise, check all user attributes.
Set<AttributeType> matchAttributes = config.getMatchAttribute();
if ((matchAttributes == null) || matchAttributes.isEmpty())
{
matchAttributes = userEntry.getUserAttributes().keySet();
}
for (AttributeType t : matchAttributes)
{
List<Attribute> attrList = userEntry.getAttribute(t);
if ((attrList == null) || attrList.isEmpty())
{
continue;
}
ByteString vf = ByteString.valueOf(password);
ByteString vr = ByteString.valueOf(reversed);
for (Attribute a : attrList)
{
if (a.contains(vf) ||
(config.isTestReversedPassword() && a.contains(vr)) ||
(config.isCheckSubstrings() &&
containsSubstring(password, minSubstringLength, a)))
{
invalidReason.append(ERR_ATTRVALUE_VALIDATOR_PASSWORD_IN_ENTRY.get());
return false;
}
}
}
// If we've gotten here, then the password is acceptable.
return true;
}
/**
* {@inheritDoc}
*/
@Override
public boolean isConfigurationAcceptable(PasswordValidatorCfg configuration,
List<LocalizableMessage> unacceptableReasons)
{
AttributeValuePasswordValidatorCfg config =
(AttributeValuePasswordValidatorCfg) configuration;
return isConfigurationChangeAcceptable(config, unacceptableReasons);
}
/**
* {@inheritDoc}
*/
public boolean isConfigurationChangeAcceptable(
AttributeValuePasswordValidatorCfg configuration,
List<LocalizableMessage> unacceptableReasons)
{
// If we've gotten this far, then we'll accept the change.
return true;
}
/**
* {@inheritDoc}
*/
public ConfigChangeResult applyConfigurationChange(
AttributeValuePasswordValidatorCfg configuration)
{
currentConfig = configuration;
return new ConfigChangeResult();
}
}