jvmMain.com.bkahlert.kommons.MessageDigests.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kommons-core-jvm Show documentation
Kommons Core is a Kotlin Multiplatform Library that offers shared features for all Kommons modules.
There is a newer version: 2.8.0
package com.bkahlert.kommons

import com.bkahlert.kommons.MessageDigestProviders.MD5
import com.bkahlert.kommons.MessageDigestProviders.`SHA-1`
import com.bkahlert.kommons.MessageDigestProviders.`SHA-256`
import java.io.InputStream
import java.nio.file.Path
import java.security.DigestInputStream
import java.security.MessageDigest
import kotlin.io.path.inputStream

/** Provider for [MessageDigest] implementations. */
public typealias MessageDigestProvider = () -> MessageDigest

/** [MessageDigestProvider] implementations safe to use on all Java platforms. */
public enum class MessageDigestProviders : MessageDigestProvider {
    /** [MD5](https://en.wikipedia.org/wiki/MD5) */
    MD5,

    /** [SHA-1](https://en.wikipedia.org/wiki/SHA-1) */
    @Suppress("EnumEntryName") `SHA-1`,

    /** [SHA-256](https://en.wikipedia.org/wiki/SHA-256) */
    @Suppress("EnumEntryName") `SHA-256`,
    ;

    /** Provides a new [MessageDigest] instance. */
    public override operator fun invoke(): MessageDigest =
        checkNotNull(MessageDigest.getInstance(name)) { "Failed to instantiate $name message digest" }
}

/** Computes the hash of this input stream using the specified [messageDigestProvider]. */
public fun InputStream.hash(messageDigestProvider: MessageDigestProvider = `SHA-256`): ByteArray =
    DigestInputStream(this, messageDigestProvider()).use {
        while (it.read() != -1) {
            // clear data
        }
        it.messageDigest.digest()
    }

/** Computes the hash of this byte array using the specified [messageDigestProvider]. */
public fun ByteArray.hash(messageDigestProvider: MessageDigestProvider = `SHA-256`): ByteArray =
    inputStream().hash(messageDigestProvider)

/** Computes the hash of this file using the specified [messageDigestProvider]. */
public fun Path.hash(messageDigestProvider: MessageDigestProvider = `SHA-256`): ByteArray =
    inputStream().hash(messageDigestProvider)

/**
 * Computes the hash of this object using [Any.toString] and the specified [messageDigestProvider].
 *
 * ***Important:** The resultant hash is as stable as the return value of [Any.toString].
 * The implementation **makes no use of [Any.hashCode]** as it produces less stable results
 * which in particular applies to enums (see [JDK-8050217](https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8050217)).*
 */
public fun Any.hash(messageDigestProvider: MessageDigestProvider = `SHA-256`): ByteArray =
    toString().encodeToByteArray().hash(messageDigestProvider)


/** Computes the hash of this input stream using the specified [messageDigestProvider] and returns it formatted as a hexadecimal checksum. */
public fun InputStream.checksum(messageDigestProvider: MessageDigestProvider = `SHA-256`): String =
    hash(messageDigestProvider).toHexadecimalString()

/** Computes the hash of this byte array using the specified [messageDigestProvider] and returns it formatted as a hexadecimal checksum. */
public fun ByteArray.checksum(messageDigestProvider: MessageDigestProvider = `SHA-256`): String =
    hash(messageDigestProvider).toHexadecimalString()

/** Computes the hash of this file using the specified [messageDigestProvider] and returns it formatted as a hexadecimal checksum. */
public fun Path.checksum(messageDigestProvider: MessageDigestProvider = `SHA-256`): String =
    hash(messageDigestProvider).toHexadecimalString()

/**
 * Computes the hash of this object using [Any.toString] and the specified [messageDigestProvider] and returns it formatted as a hexadecimal checksum.
 *
 * ***Important:** The resultant checksum is as stable as the return value of [Any.toString].
 * The implementation **makes no use of [Any.hashCode]** as it produces less stable results
 * which in particular applies to enums (see [JDK-8050217](https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8050217)).*
 */
public fun Any.checksum(messageDigestProvider: MessageDigestProvider = `SHA-256`): String =
    hash(messageDigestProvider).toHexadecimalString()


/** Computes the [MessageDigestProviders.MD5] hash of this input stream and returns it formatted as a hexadecimal checksum. */
public fun InputStream.md5Checksum(): String = checksum(MD5)

/** Computes the [MessageDigestProviders.MD5] hash of this byte array and returns it formatted as a hexadecimal checksum. */
public fun ByteArray.md5Checksum(): String = checksum(MD5)

/** Computes the [MessageDigestProviders.MD5] hash of this file and returns it formatted as a hexadecimal checksum. */
public fun Path.md5Checksum(): String = checksum(MD5)

/**
 * Computes the [MessageDigestProviders.MD5] hash of this object using [Any.toString] and returns it formatted as a hexadecimal checksum.
 *
 * ***Important:** The resultant checksum is as stable as the return value of [Any.toString].
 * The implementation **makes no use of [Any.hashCode]** as it produces less stable results
 * which in particular applies to enums (see [JDK-8050217](https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8050217)).*
 */
public fun Any.md5Checksum(): String = checksum(MD5)


/** Computes the [MessageDigestProviders.`SHA-1`] hash of this input stream and returns it formatted as a hexadecimal checksum. */
public fun InputStream.sha1Checksum(): String = checksum(`SHA-1`)

/** Computes the [MessageDigestProviders.`SHA-1`] hash of this byte array and returns it formatted as a hexadecimal checksum. */
public fun ByteArray.sha1Checksum(): String = checksum(`SHA-1`)

/** Computes the [MessageDigestProviders.`SHA-1`] hash of this file and returns it formatted as a hexadecimal checksum. */
public fun Path.sha1Checksum(): String = checksum(`SHA-1`)

/**
 * Computes the [MessageDigestProviders.`SHA-1`] hash of this object using [Any.toString] and returns it formatted as a hexadecimal checksum.
 *
 * ***Important:** The resultant checksum is as stable as the return value of [Any.toString].
 * The implementation **makes no use of [Any.hashCode]** as it produces less stable results
 * which in particular applies to enums (see [JDK-8050217](https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8050217)).*
 */
public fun Any.sha1Checksum(): String = checksum(`SHA-1`)


/** Computes the [MessageDigestProviders.`SHA-256`] hash of this input stream and returns it formatted as a hexadecimal checksum. */
public fun InputStream.sha256Checksum(): String = checksum(`SHA-256`)

/** Computes the [MessageDigestProviders.`SHA-256`] hash of this byte array and returns it formatted as a hexadecimal checksum. */
public fun ByteArray.sha256Checksum(): String = checksum(`SHA-256`)

/** Computes the [MessageDigestProviders.`SHA-256`] hash of this file and returns it formatted as a hexadecimal checksum. */
public fun Path.sha256Checksum(): String = checksum(`SHA-256`)

/**
 * Computes the [MessageDigestProviders.`SHA-256`] hash of this object using [Any.toString] and returns it formatted as a hexadecimal checksum.
 *
 * ***Important:** The resultant checksum is as stable as the return value of [Any.toString].
 * The implementation **makes no use of [Any.hashCode]** as it produces less stable results
 * which in particular applies to enums (see [JDK-8050217](https://bugs.java.com/bugdatabase/view_bug.do?bug_id=8050217)).*
 */
public fun Any.sha256Checksum(): String = checksum(`SHA-256`)