multipaz/org.multipaz.crypto/SecureByteString

SecureByteString

open class SecureByteString(data: ByteArray) : AutoCloseable

An immutable sequence of bytes containing sensitive data with memory clearing on disposal.

Instances of this class hold sensitive data in an internal buffer. When the data is no longer needed, callers should invoke destroy or close, or use Kotlin's use extension. Upon disposal, the internal memory is overwritten with zeros using ByteArray.secureZero.

As a secondary safety net, an automatic cleaner (KeyDisposer) is registered at creation to zero the memory when the object becomes unreachable, guarding against memory leaks if close is inadvertently omitted.

Parameters

data

the initial data. A defensive copy is stored.

Inheritors

Constructors

SecureByteString

constructor(data: ByteArray)

Properties

val encoded: ByteArray

Returns a defensive copy of the underlying bytes.

val isDestroyed: Boolean

Whether this byte string has been destroyed.

Size of the byte string in bytes.

Functions

checkNotDestroyed

fun checkNotDestroyed()

Throws IllegalStateException if this byte string has been destroyed.

open override fun close()

Wipes the data from memory and marks this byte string as destroyed.

open operator override fun equals(other: Any?): Boolean

operator fun get(index: Int): Byte

Returns the byte at the specified index.

open override fun hashCode(): Int

fun isEmpty(): Boolean

Returns true if this byte string is empty.

fun isNotEmpty(): Boolean

Returns true if this byte string is not empty.

fun toByteArray(): ByteArray

Returns a defensive copy of the underlying bytes as a ByteArray.

fun SecureByteString.toSecretKey(): SecretKey

Converts this SecureByteString to a SecretKey.

open override fun toString(): String