Java File Checksum – MD5 and SHA-256 Hash Example

A checksum hash is an encrypted sequence of characters obtained after applying certain algorithms and manipulations on user-provided content. In this Java hashing tutorial, we will learn to generate the checksum hash for the files.

1. Why we may want to generate the hash for a file?

Any serious file provider provides a mechanism to have a checksum on their downloadable files. A checksum is a form of mechanism to ensure that the file we downloaded is properly downloaded.

Checksum acts like a proof of the validity of a file so if a file gets corrupted this checksum will change and thus let us know that this file is not the same file or the file has been corrupted between the transfer for any reason.

We can also create the checksum of the file to detect any possible change in the file by third party e.g. license files. We provide licenses to clients which they may upload to their server. We can cross verify the checksum of the file to verify that the license file has not been modified after creation.

Read More : Java MD5, SHA, PBKDF2, BCrypt and SCrypt Examples

2. How to generate checksum hash for a file

To create checksum for a file, we will need to read the content of file byte by byte in chunks, and then generate the hash for it using the given below function.

This function takes two arguments:

1. The message digest algorithm’s implementation
2. A file for which checksum needs to be generated

private static String getFileChecksum(MessageDigest digest, File file) throws IOException
{
	//Get file input stream for reading the file content
	FileInputStream fis = new FileInputStream(file);
	
	//Create byte array to read data in chunks
	byte[] byteArray = new byte[1024];
	int bytesCount = 0; 
	 
	//Read file data and update in message digest
	while ((bytesCount = fis.read(byteArray)) != -1) {
		digest.update(byteArray, 0, bytesCount);
	};
	
	//close the stream; We don't need it now.
	fis.close();
	
	//Get the hash's bytes
	byte[] bytes = digest.digest();
	
	//This bytes[] has bytes in decimal format;
	//Convert it to hexadecimal format
	StringBuilder sb = new StringBuilder();
	for(int i=0; i< bytes.length ;i++)
	{
		sb.append(Integer.toString((bytes[i] & 0xff) + 0x100, 16).substring(1));
	}
	
	//return complete hash
   return sb.toString();
}

Example 1: Generate MD5 Hash for a File in Java

//Create checksum for this file
File file = new File("c:/temp/testOut.txt");

//Use MD5 algorithm
MessageDigest md5Digest = MessageDigest.getInstance("MD5");

//Get the checksum
String checksum = getFileChecksum(md5Digest, file);

//see checksum
System.out.println(checksum);

Example 2: Generate SHA-256 Hash for a File in Java

//Use SHA-1 algorithm
MessageDigest shaDigest = MessageDigest.getInstance("SHA-256");

//SHA-1 checksum 
String shaChecksum = getFileChecksum(shaDigest, file);

Drop me a comment if something needs more explanation.

Happy Learning !!

Further Reading:

Java – Create a Secure Password Hash Python hashlib Java Read File to Byte Array