/*
|
* 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
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
|
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
|
* 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
|
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. 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
|
*
|
*
|
* Portions Copyright 2006 Sun Microsystems, Inc.
|
*/
|
package org.opends.server.extensions;
|
|
|
|
import org.opends.server.api.PasswordStorageScheme;
|
import org.opends.server.config.ConfigEntry;
|
import org.opends.server.config.ConfigException;
|
import org.opends.server.types.ByteString;
|
import org.opends.server.types.ByteStringFactory;
|
import org.opends.server.types.DirectoryException;
|
import org.opends.server.types.InitializationException;
|
import org.opends.server.types.ResultCode;
|
import org.opends.server.util.Base64;
|
|
import static org.opends.server.extensions.ExtensionsConstants.*;
|
import static org.opends.server.loggers.Debug.*;
|
import static org.opends.server.messages.ExtensionsMessages.*;
|
import static org.opends.server.messages.MessageHandler.*;
|
import static org.opends.server.util.StaticUtils.*;
|
|
|
|
/**
|
* This class defines a Directory Server password storage scheme that will store
|
* the values in base64-encoded form. This is a reversible algorithm that
|
* offers very little actual protection -- it will merely obscure the plaintext
|
* value from the casual observer.
|
*/
|
public class Base64PasswordStorageScheme
|
extends PasswordStorageScheme
|
{
|
/**
|
* The fully-qualified name of this class for debugging purposes.
|
*/
|
private static final String CLASS_NAME =
|
"org.opends.server.extensions.Base64PasswordStorageScheme";
|
|
|
|
/**
|
* Creates a new instance of this password storage scheme. Note that no
|
* initialization should be performed here, as all initialization should be
|
* done in the <CODE>initializePasswordStorageScheme</CODE> method.
|
*/
|
public Base64PasswordStorageScheme()
|
{
|
super();
|
|
assert debugConstructor(CLASS_NAME);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public void initializePasswordStorageScheme(ConfigEntry configEntry)
|
throws ConfigException, InitializationException
|
{
|
assert debugEnter(CLASS_NAME, "initializePasswordStorageScheme",
|
String.valueOf(configEntry));
|
|
// No initialization is required.
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public String getStorageSchemeName()
|
{
|
assert debugEnter(CLASS_NAME, "getStorageSchemeName");
|
|
return STORAGE_SCHEME_NAME_BASE64;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public ByteString encodePassword(ByteString plaintext)
|
throws DirectoryException
|
{
|
assert debugEnter(CLASS_NAME, "encodePassword", "ByteString");
|
|
return ByteStringFactory.create(Base64.encode(plaintext.value()));
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public ByteString encodePasswordWithScheme(ByteString plaintext)
|
throws DirectoryException
|
{
|
assert debugEnter(CLASS_NAME, "encodePasswordWithScheme",
|
"ByteString");
|
|
StringBuilder buffer = new StringBuilder();
|
buffer.append('{');
|
buffer.append(STORAGE_SCHEME_NAME_BASE64);
|
buffer.append('}');
|
buffer.append(Base64.encode(plaintext.value()));
|
|
return ByteStringFactory.create(buffer.toString());
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean passwordMatches(ByteString plaintextPassword,
|
ByteString storedPassword)
|
{
|
assert debugEnter(CLASS_NAME, "passwordMatches",
|
String.valueOf(plaintextPassword),
|
String.valueOf(storedPassword));
|
|
|
String userString = Base64.encode(plaintextPassword.value());
|
String storedString = storedPassword.stringValue();
|
return userString.equals(storedString);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean isReversible()
|
{
|
assert debugEnter(CLASS_NAME, "isReversible");
|
|
return true;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public ByteString getPlaintextValue(ByteString storedPassword)
|
throws DirectoryException
|
{
|
assert debugEnter(CLASS_NAME, "getPlaintextValue",
|
String.valueOf(storedPassword));
|
|
try
|
{
|
return ByteStringFactory.create(Base64.decode(
|
storedPassword.stringValue()));
|
}
|
catch (Exception e)
|
{
|
assert debugException(CLASS_NAME, "getPlaintextValue", e);
|
|
int msgID = MSGID_PWSCHEME_CANNOT_BASE64_DECODE_STORED_PASSWORD;
|
String message = getMessage(msgID, storedPassword.stringValue(),
|
String.valueOf(e));
|
throw new DirectoryException(ResultCode.INVALID_CREDENTIALS, message,
|
msgID, e);
|
}
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean supportsAuthPasswordSyntax()
|
{
|
assert debugEnter(CLASS_NAME, "supportsAuthPasswordSyntax");
|
|
// This storage scheme does not support the authentication password syntax.
|
return false;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public ByteString encodeAuthPassword(ByteString plaintext)
|
throws DirectoryException
|
{
|
assert debugEnter(CLASS_NAME, "encodeAuthPassword",
|
String.valueOf(plaintext));
|
|
|
int msgID = MSGID_PWSCHEME_DOES_NOT_SUPPORT_AUTH_PASSWORD;
|
String message = getMessage(msgID, getStorageSchemeName());
|
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, message,
|
msgID);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean authPasswordMatches(ByteString plaintextPassword,
|
String authInfo, String authValue)
|
{
|
assert debugEnter(CLASS_NAME, "authPasswordMatches",
|
String.valueOf(plaintextPassword),
|
String.valueOf(authInfo), String.valueOf(authValue));
|
|
|
// This storage scheme does not support the authentication password syntax.
|
return false;
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public ByteString getAuthPasswordPlaintextValue(String authInfo,
|
String authValue)
|
throws DirectoryException
|
{
|
assert debugEnter(CLASS_NAME, "getAuthPasswordPlaintextValue",
|
String.valueOf(authInfo), String.valueOf(authValue));
|
|
int msgID = MSGID_PWSCHEME_DOES_NOT_SUPPORT_AUTH_PASSWORD;
|
String message = getMessage(msgID, getStorageSchemeName());
|
throw new DirectoryException(ResultCode.UNWILLING_TO_PERFORM, message,
|
msgID);
|
}
|
|
|
|
/**
|
* {@inheritDoc}
|
*/
|
@Override()
|
public boolean isStorageSchemeSecure()
|
{
|
assert debugEnter(CLASS_NAME, "isStorageSchemeSecure");
|
|
// Base64-encoded values may be easily decoded with no key or special
|
// knowledge.
|
return false;
|
}
|
}
|
