net.yapbam.util.BinaryPBEKey Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of yapbam-commons Show documentation

Commons Yapbam classes used by desktop and Android versions.

There is a newer version: 1.9.1

package net.yapbam.util;

import java.security.spec.*;
import java.util.*;
import javax.crypto.*;

/** A PBEWithMD5AndDES key that allows non ascii char in password.
 * 
This class is copied from a stackoverflow question
 * 
This class is now deprecated because it hangs with Android systems. The preferred solution is to use a Base64 encoding of the password before creating the key.
 * @deprecated 
 */
@SuppressWarnings("serial")
@Deprecated
public class BinaryPBEKey implements SecretKey {
	private final byte[] key;

	/**
	 * Creates a PBE key from a given binary key.
	 * @param key The key.
	 * @throws InvalidKeySpecException if the key is invalid
	 */
	public BinaryPBEKey(byte[] key) throws InvalidKeySpecException {
		if (key == null) {
			this.key = new byte[0];
		} else {
			this.key = (byte[]) key.clone();
		}
	}

	public byte[] getEncoded() {
		return (byte[]) key.clone();
	}

	public String getAlgorithm() {
		return Crypto.ALGORITHM;
	}

	public String getFormat() {
		return "RAW";
	}

	/**
	 * Calculates a hash code value for the object. Objects that are equal will
	 * also have the same hashcode.
	 */
	public int hashCode() {
		int ret = 0;

		for (int xa = 1; xa < this.key.length; xa++) {
			ret += (this.key[xa] * xa);
		}
		ret ^= getAlgorithm().toUpperCase().hashCode();
		return ret;
	}

	public boolean equals(Object obj) {
		if (obj == this) {
			return true;
		}
		if ((obj == null) || !obj.getClass().equals(getClass())) {
			return false;
		}

		BinaryPBEKey oth = (BinaryPBEKey) obj;

		if (!(oth.getAlgorithm().equalsIgnoreCase(getAlgorithm()))) {
			return false;
		}

		byte[] othkey = oth.getEncoded();
		boolean ret = Arrays.equals(key, othkey);
		Arrays.fill(othkey, (byte) 0);
		return ret;
	}

	public void destroy() {
		Arrays.fill(this.key, (byte) 0);
	}

	/**
	 * Ensure that the password bytes of this key are zeroed out when there are no
	 * more references to it.
	 */
	protected void finalize() throws Throwable {
		try {
			destroy();
		} finally {
			super.finalize();
		}
	}
}