org.wildfly.security.password.interfaces.SimpleDigestPassword Maven / Gradle / Ivy
/*
* JBoss, Home of Professional Open Source.
* Copyright 2014 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.wildfly.security.password.interfaces;
import org.wildfly.common.Assert;
import org.wildfly.security.password.OneWayPassword;
import org.wildfly.security.password.Password;
import org.wildfly.security.password.PasswordFactory;
/**
* A simple single digest based password.
*
* @author David M. Lloyd
*/
public interface SimpleDigestPassword extends OneWayPassword {
/**
* The algorithm name "simple-digest-md2".
*/
String ALGORITHM_SIMPLE_DIGEST_MD2 = "simple-digest-md2";
/**
* The algorithm name "simple-digest-md5".
*/
String ALGORITHM_SIMPLE_DIGEST_MD5 = "simple-digest-md5";
/**
* The algorithm name "simple-digest-sha-1".
*/
String ALGORITHM_SIMPLE_DIGEST_SHA_1 = "simple-digest-sha-1";
/**
* The algorithm name "simple-digest-sha-256".
*/
String ALGORITHM_SIMPLE_DIGEST_SHA_256 = "simple-digest-sha-256";
/**
* The algorithm name "simple-digest-sha-384".
*/
String ALGORITHM_SIMPLE_DIGEST_SHA_384 = "simple-digest-sha-384";
/**
* The algorithm name "simple-digest-sha-512".
*/
String ALGORITHM_SIMPLE_DIGEST_SHA_512 = "simple-digest-sha-512";
/**
* Get the digest of this password.
*
* @return the digest
*/
byte[] getDigest();
/**
* Creates and returns a copy of this {@link Password}.
*
* @return a copy of this {@link Password}.
*/
SimpleDigestPassword clone();
/**
* Create a raw implementation of this password type. No validation of the content is performed, and the password
* must be "adopted" in to a {@link PasswordFactory} (via the {@link PasswordFactory#translate(Password)} method)
* before it can be validated and used to verify guesses.
*
* @param algorithm the algorithm name
* @param digest the digest
* @return the raw password implementation
*/
static SimpleDigestPassword createRaw(String algorithm, byte[] digest) {
Assert.checkNotNullParam("algorithm", algorithm);
Assert.checkNotNullParam("digest", digest);
return new RawSimpleDigestPassword(algorithm, digest.clone());
}
}