src/org/jsecurity/crypto/hash/Sha1Hash.java

/*
 * Copyright 2005-2008 Les Hazlewood
 *
 * 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.jsecurity.crypto.hash;

import org.jsecurity.codec.Base64;
import org.jsecurity.codec.Hex;

/**
 * Generates an SHA-1 Hash (Secure Hash Standard, NIST FIPS 180-1) from a given input <tt>source</tt> with an
 * optional <tt>salt</tt> and hash iterations.
 *
 * <p>See the {@link AbstractHash AbstractHash} parent class JavaDoc for a detailed explanation of Hashing
 * techniques and how the overloaded constructors function.
 *
 * @author Les Hazlewood
 * @since 0.9
 */
public class Sha1Hash extends AbstractHash {

    public static final String ALGORITHM_NAME = "SHA-1";

    public Sha1Hash() {
    }

    public Sha1Hash(Object source) {
        super( source );
    }

    public Sha1Hash(Object source, Object salt) {
        super(source, salt);
    }

    public Sha1Hash(Object source, Object salt, int hashIterations) {
        super(source, salt, hashIterations);
    }

    protected String getAlgorithmName() {
        return ALGORITHM_NAME;
    }

    public static Sha1Hash fromHexString( String hex ) {
        Sha1Hash hash = new Sha1Hash();
        hash.setBytes( Hex.decode( hex ) );
        return hash;
    }

    public static Sha1Hash fromBase64String( String base64 ) {
        Sha1Hash hash = new Sha1Hash();
        hash.setBytes( Base64.decode( base64 ) );
        return hash;
    }
}