All Downloads are FREE. Search and download functionalities are using the official Maven repository.

leap.lang.codec.Digests Maven / Gradle / Ivy

The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 leap.lang.codec;

import java.io.IOException;
import java.io.InputStream;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;

import leap.lang.Strings;

//from apache commons-codec

/**
 * Operations to simplify common {@link java.security.MessageDigest} tasks. This class is thread safe.
 * 
 * @author Apache Software Foundation
 * @version $Id: DigestUtils.java 1157192 2011-08-12 17:27:38Z ggregory $
 */
public class Digests {

	private static final int	STREAM_BUFFER_LENGTH	= 1024;
	
	/**
	 * Returns a MessageDigest for the given algorithm.
	 * 
	 * @param algorithm the name of the algorithm requested. See Appendix A in the Java
	 *            Cryptography Architecture API Specification & Reference for information about standard algorithm
	 *            names.
	 * @return An MD5 digest instance.
	 * @see MessageDigest#getInstance(String)
	 * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught.
	 */
	public static MessageDigest getDigest(String algorithm) {
		try {
			return MessageDigest.getInstance(algorithm);
		} catch (NoSuchAlgorithmException e) {
			throw new RuntimeException(e.getMessage());
		}
	}	
	
	/**
	 * Calculates the MD5 digest and returns the value as a 16 element byte[].
	 * 
	 * @param data Data to digest
	 * @return MD5 digest
	 */
	public static byte[] md5(byte[] data) {
		return getMd5Digest().digest(data);
	}

	/**
	 * Calculates the MD5 digest and returns the value as a 16 element byte[].
	 * 
	 * @param data Data to digest
	 * @return MD5 digest
	 * @throws IOException On error reading from the stream
	 * @since 1.4
	 */
	public static byte[] md5(InputStream data) throws IOException {
		return digest(getMd5Digest(), data);
	}

	/**
	 * Calculates the MD5 digest and returns the value as a 16 element byte[].
	 * 
	 * @param data Data to digest
	 * @return MD5 digest
	 */
	public static byte[] md5(String data) {
		return md5(getBytesUtf8(data));
	}
	
	/**
	 * Calculates the MD5 digest and returns the value as a base64 string.
	 * 
	 * @param data Data to digest
	 * @return MD5 digest as a base64 string
	 */
	public static String md5Base64(byte[] data) {
		return Base64.encode(md5(data));
	}
	
	/**
	 * Calculates the MD5 digest and returns the value as a base64 string.
	 * 
	 * @param data Data to digest
	 * @return MD5 digest as a base64 string
	 */
	public static String md5Base64(String data) {
		return Base64.encode(md5(data));
	}	
	
	/**
	 * Calculates the MD5 digest and returns the value as a base64 string.
	 * 
	 * @param data Data to digest
	 * @return MD5 digest as a base64 string
	 * @throws IOException On error reading from the stream
	 * @since 1.4
	 */
	public static String md5Base64(InputStream data) throws IOException {
		return Base64.encode(md5(data));
	}
	
	/**
	 * Calculates the MD5 digest and returns the value as a 32 character hex string.
	 * 
	 * @param data Data to digest
	 * @return MD5 digest as a hex string
	 */
	public static String md5Hex(byte[] data) {
		return Hex.encode(md5(data));
	}

	/**
	 * Calculates the MD5 digest and returns the value as a 32 character hex string.
	 * 
	 * @param data Data to digest
	 * @return MD5 digest as a hex string
	 */
	public static String md5Hex(String data) {
		return Hex.encode(md5(data));
	}	

	/**
	 * Calculates the MD5 digest and returns the value as a 32 character hex string.
	 * 
	 * @param data Data to digest
	 * @return MD5 digest as a hex string
	 * @throws IOException On error reading from the stream
	 * @since 1.4
	 */
	public static String md5Hex(InputStream data) throws IOException {
		return Hex.encode(md5(data));
	}

	/**
	 * Calculates the SHA-1 digest and returns the value as a byte[].
	 * 
	 * @param data Data to digest
	 * @return SHA-1 digest
	 */
	public static byte[] sha(byte[] data) {
		return getShaDigest().digest(data);
	}

	/**
	 * Calculates the SHA-1 digest and returns the value as a byte[].
	 * 
	 * @param data Data to digest
	 * @return SHA-1 digest
	 * @throws IOException On error reading from the stream
	 * @since 1.4
	 */
	public static byte[] sha(InputStream data) throws IOException {
		return digest(getShaDigest(), data);
	}

	/**
	 * Calculates the SHA-1 digest and returns the value as a byte[].
	 * 
	 * @param data Data to digest
	 * @return SHA-1 digest
	 */
	public static byte[] sha(String data) {
		return sha(getBytesUtf8(data));
	}
	
	/**
	 * Calculates the SHA-1 digest and returns the value as a hex string.
	 * 
	 * @param data Data to digest
	 * @return SHA-1 digest as a hex string
	 */
	public static String shaHex(byte[] data) {
		return Hex.encode(sha(data));
	}

	/**
	 * Calculates the SHA-1 digest and returns the value as a hex string.
	 * 
	 * @param data Data to digest
	 * @return SHA-1 digest as a hex string
	 * @throws IOException On error reading from the stream
	 * @since 1.4
	 */
	public static String shaHex(InputStream data) throws IOException {
		return Hex.encode(sha(data));
	}

	/**
	 * Calculates the SHA-1 digest and returns the value as a hex string.
	 * 
	 * @param data Data to digest
	 * @return SHA-1 digest as a hex string
	 */
	public static String shaHex(String data) {
		return Hex.encode(sha(data));
	}	

	/**
	 * Calculates the SHA-256 digest and returns the value as a byte[].
	 * 

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-256 digest * @since 1.4 */ public static byte[] sha256(byte[] data) { return getSha256Digest().digest(data); } /** * Calculates the SHA-256 digest and returns the value as a byte[]. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-256 digest * @throws IOException On error reading from the stream * @since 1.4 */ public static byte[] sha256(InputStream data) throws IOException { return digest(getSha256Digest(), data); } /** * Calculates the SHA-256 digest and returns the value as a byte[]. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-256 digest * @since 1.4 */ public static byte[] sha256(String data) { return sha256(getBytesUtf8(data)); } /** * Calculates the SHA-256 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-256 digest as a hex string * @since 1.4 */ public static String sha256Hex(byte[] data) { return Hex.encode(sha256(data)); } /** * Calculates the SHA-256 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-256 digest as a hex string * @throws IOException On error reading from the stream * @since 1.4 */ public static String sha256Hex(InputStream data) throws IOException { return Hex.encode(sha256(data)); } /** * Calculates the SHA-256 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-256 digest as a hex string * @since 1.4 */ public static String sha256Hex(String data) { return Hex.encode(sha256(data)); } /** * Calculates the SHA-384 digest and returns the value as a byte[]. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-384 digest * @since 1.4 */ public static byte[] sha384(byte[] data) { return getSha384Digest().digest(data); } /** * Calculates the SHA-384 digest and returns the value as a byte[]. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-384 digest * @throws IOException On error reading from the stream * @since 1.4 */ public static byte[] sha384(InputStream data) throws IOException { return digest(getSha384Digest(), data); } /** * Calculates the SHA-384 digest and returns the value as a byte[]. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-384 digest * @since 1.4 */ public static byte[] sha384(String data) { return sha384(getBytesUtf8(data)); } /** * Calculates the SHA-384 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-384 digest as a hex string * @since 1.4 */ public static String sha384Hex(byte[] data) { return Hex.encode(sha384(data)); } /** * Calculates the SHA-384 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-384 digest as a hex string * @throws IOException On error reading from the stream * @since 1.4 */ public static String sha384Hex(InputStream data) throws IOException { return Hex.encode(sha384(data)); } /** * Calculates the SHA-384 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-384 digest as a hex string * @since 1.4 */ public static String sha384Hex(String data) { return Hex.encode(sha384(data)); } /** * Calculates the SHA-512 digest and returns the value as a byte[]. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-512 digest * @since 1.4 */ public static byte[] sha512(byte[] data) { return getSha512Digest().digest(data); } /** * Calculates the SHA-512 digest and returns the value as a byte[]. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-512 digest * @throws IOException On error reading from the stream * @since 1.4 */ public static byte[] sha512(InputStream data) throws IOException { return digest(getSha512Digest(), data); } /** * Calculates the SHA-512 digest and returns the value as a byte[]. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-512 digest * @since 1.4 */ public static byte[] sha512(String data) { return sha512(getBytesUtf8(data)); } /** * Calculates the SHA-512 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-512 digest as a hex string * @since 1.4 */ public static String sha512Hex(byte[] data) { return Hex.encode(sha512(data)); } /** * Calculates the SHA-512 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-512 digest as a hex string * @throws IOException On error reading from the stream * @since 1.4 */ public static String sha512Hex(InputStream data) throws IOException { return Hex.encode(sha512(data)); } /** * Calculates the SHA-512 digest and returns the value as a hex string. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @param data Data to digest * @return SHA-512 digest as a hex string * @since 1.4 */ public static String sha512Hex(String data) { return Hex.encode(sha512(data)); } //Private Methods //---------------------------------------------------------------------------------------------- /** * Read through an InputStream and returns the digest for the data * * @param digest The MessageDigest to use (e.g. MD5) * @param data Data to digest * @return MD5 digest * @throws IOException On error reading from the stream */ private static byte[] digest(MessageDigest digest, InputStream data) throws IOException { byte[] buffer = new byte[STREAM_BUFFER_LENGTH]; int read = data.read(buffer, 0, STREAM_BUFFER_LENGTH); while (read > -1) { digest.update(buffer, 0, read); read = data.read(buffer, 0, STREAM_BUFFER_LENGTH); } return digest.digest(); } private static byte[] getBytesUtf8(String data) { return Strings.getBytesUtf8(data); } /** * Returns an MD5 MessageDigest. * * @return An MD5 digest instance. * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught. */ private static MessageDigest getMd5Digest() { return getDigest("MD5"); } /** * Returns an SHA-256 digest. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @return An SHA-256 digest instance. * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught. */ private static MessageDigest getSha256Digest() { return getDigest("SHA-256"); } /** * Returns an SHA-384 digest. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @return An SHA-384 digest instance. * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught. */ private static MessageDigest getSha384Digest() { return getDigest("SHA-384"); } /** * Returns an SHA-512 digest. *

* Throws a RuntimeException on JRE versions prior to 1.4.0. *

* * @return An SHA-512 digest instance. * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught. */ private static MessageDigest getSha512Digest() { return getDigest("SHA-512"); } /** * Returns an SHA-1 digest. * * @return An SHA-1 digest instance. * @throws RuntimeException when a {@link java.security.NoSuchAlgorithmException} is caught. */ private static MessageDigest getShaDigest() { return getDigest("SHA"); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy