org.owasp.security.logging.Utils Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of security-logging-common Show documentation

The OWASP Security Logging project provides developers and ops personnel with APIs for logging security-related events.

There is a newer version: 1.1.7

Show newest version

package org.owasp.security.logging;

import java.security.MessageDigest;
import java.security.NoSuchAlgorithmException;
import java.util.Formatter;

/**
 * Utilities methods for logging.
 *
 * @author August Detlefsen [[email protected]]
 */
public class Utils {

    /**
     * Converts an input String to a SHA hash. The actual hash strength is
     * hidden by the method name to allow for future-proofing this API, but the
     * current default is SHA-256.
     *
     * @param input The string to hash
     * @return SHA hash of the input String, hex encoded.
     */
    public static String toSHA(String input) {
        return toSHA(input.getBytes());
    }

    /**
     * Converts an input byte array to a SHA hash. The actual hash strength is
     * hidden by the method name to allow for future-proofing this API, but the
     * current default is SHA-256.
     *
     * @param input Byte array to hash
     * @return SHA hash of the input String, hex encoded.
     */
    public static String toSHA(byte[] input) {
        try {
            MessageDigest md = MessageDigest.getInstance("SHA-256");
            return byteArray2Hex(md.digest(input));
        } catch (NoSuchAlgorithmException nsae) {
            // this code should never be reached!
        }
        return null;
    }

    /**
     * Converts an input byte array to a hex encoded String.
     *
     * @param input Byte array to hex encode
     * @return Hex encoded String of the input byte array
     */
    private static String byteArray2Hex(final byte[] hash) {
        Formatter formatter = new Formatter();
        for (byte b : hash) {
            formatter.format("%02x", b);
        }
        return formatter.toString();
    }

    /**
     * Determines if a string is null or empty
     *
     * @param value string to test
     * @return       true if the string is empty or null;
     * false otherwise
     */
    public static boolean isEmpty(String value) {
        return (value == null || value.trim().length() == 0);
    }

}