io.github.astrapi69.checksum.ByteArrayChecksumExtensions Maven / Gradle / Ivy
Show all versions of checksum-up Show documentation
/**
* The MIT License
*
* Copyright (C) 2015 Asterios Raptis
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
* associated documentation files (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge, publish, distribute,
* sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all copies or
* substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
* NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package io.github.astrapi69.checksum;
import io.github.astrapi69.crypto.algorithm.Algorithm;
import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.zip.Adler32;
import java.util.zip.CRC32;
import java.util.zip.Checksum;
/**
* The class {@link ByteArrayChecksumExtensions} is a utility class for computing checksum from byte
* arrays
*
* @author Asterios Raptis
* @version 1.0
*/
public final class ByteArrayChecksumExtensions
{
private ByteArrayChecksumExtensions()
{
}
/**
* Gets the checksum from the given byte arrays with the given algorithm
*
* @param algorithm
* the algorithm to get the checksum. This could be for instance "MD4", "MD5",
* "SHA-1", "SHA-256", "SHA-384" or "SHA-512".
* @param byteArrays
* the array of byte arrays
* @return The checksum from the given byte arrays as a String object.
* @throws NoSuchAlgorithmException
* Is thrown if the algorithm is not supported or does not exists.
* {@link MessageDigest} object.
*/
public static String getChecksum(final Algorithm algorithm, final byte[]... byteArrays)
throws NoSuchAlgorithmException
{
StringBuilder sb = new StringBuilder();
for (byte[] byteArray : byteArrays)
{
sb.append(getChecksum(byteArray, algorithm.getAlgorithm()));
}
return sb.toString();
}
/**
* Gets the checksum from the given byte array with an instance of.
*
* @param bytes
* the byte array.
* @param algorithm
* the algorithm to get the checksum. This could be for instance "MD4", "MD5",
* "SHA-1", "SHA-256", "SHA-384" or "SHA-512".
* @return The checksum from the file as a String object.
* @throws NoSuchAlgorithmException
* Is thrown if the algorithm is not supported or does not exists.
* {@link MessageDigest} object.
*/
public static String getChecksum(final byte[] bytes, final Algorithm algorithm)
throws NoSuchAlgorithmException
{
return getChecksum(bytes, algorithm.getAlgorithm());
}
/**
* Gets the checksum from the given byte array with an instance of.
*
* @param bytes
* the byte array.
* @param algorithm
* the algorithm to get the checksum. This could be for instance "MD4", "MD5",
* "SHA-1", "SHA-256", "SHA-384" or "SHA-512".
* @return The checksum from the file as a String object.
* @throws NoSuchAlgorithmException
* Is thrown if the algorithm is not supported or does not exists.
* {@link MessageDigest} object.
*/
public static String getChecksum(final byte[] bytes, final String algorithm)
throws NoSuchAlgorithmException
{
final MessageDigest messageDigest = MessageDigest.getInstance(algorithm);
messageDigest.reset();
messageDigest.update(bytes);
final byte[] digest = messageDigest.digest();
final StringBuilder hexView = new StringBuilder();
for (final byte element : digest)
{
final String intAsHex = Integer.toHexString(0xFF & element);
if (intAsHex.length() == 1)
{
hexView.append('0');
}
hexView.append(intAsHex);
}
return hexView.toString();
}
/**
* Gets the checksum from the given byte array with an instance of.
*
* @param bytes
* the Byte object array.
* @param algorithm
* the algorithm to get the checksum. This could be for instance "MD4", "MD5",
* "SHA-1", "SHA-256", "SHA-384" or "SHA-512".
* @return The checksum from the file as a String object.
* @throws NoSuchAlgorithmException
* Is thrown if the algorithm is not supported or does not exists.
* {@link MessageDigest} object.
*/
public static String getChecksum(final Byte[] bytes, final Algorithm algorithm)
throws NoSuchAlgorithmException
{
return getChecksum(bytes, algorithm.getAlgorithm());
}
/**
* Gets the checksum from the given byte array with an instance of.
*
* @param bytes
* the Byte object array.
* @param algorithm
* the algorithm to get the checksum. This could be for instance "MD4", "MD5",
* "SHA-1", "SHA-256", "SHA-384" or "SHA-512".
* @return The checksum from the file as a String object.
* @throws NoSuchAlgorithmException
* Is thrown if the algorithm is not supported or does not exists.
* {@link MessageDigest} object.
*/
public static String getChecksum(final Byte[] bytes, final String algorithm)
throws NoSuchAlgorithmException
{
return getChecksum(toByteArray(bytes), algorithm);
}
/**
* Gets the checksum from the given byte array with an instance of.
*
* @param bytes
* The byte array.
* @return The checksum from the byte array as long. {@link Adler32} object.
*/
public static long getCheckSumAdler32(final byte[] bytes)
{
final Checksum checksum = new Adler32();
checksum.update(bytes, 0, bytes.length);
return checksum.getValue();
}
/**
* Gets the checksum from the given byte array with an instance of.
*
* @param bytes
* The byte array.
* @return The checksum from the byte array as long. {@link CRC32} object.
*/
public static long getCheckSumCRC32(final byte[] bytes)
{
final Checksum checksum = new CRC32();
checksum.update(bytes, 0, bytes.length);
return checksum.getValue();
}
private static byte[] toByteArray(Byte[] bytes)
{
byte[] byteArray = new byte[bytes.length];
for (int i = 0; i < bytes.length; i++)
{
byteArray[i] = bytes[i];
}
return byteArray;
}
}