multipaz/org.multipaz.util

Package-level declarations

Types

AndroidAttestationExtensionParser

class AndroidAttestationExtensionParser(cert: X509Cert)

ByteDataReader

class ByteDataReader(val byteArray: ByteArray)

This class provides methods for reading various data types from a byte array ByteArray.

Constants

object Constants

Various constants used by other classes.

Eager

class Eager<T>(val value: T) : Lazy<T>

Implementation of Lazy for the cases where the value needs to be eagerly created.

HexUtil

object HexUtil

Logger

object Logger

Logging facility.

Platform

actual object Platform

expect object Platform

Object for selecting platform specific functionality.

actual object Platform

UUID

data class UUID(val mostSignificantBits: ULong, val leastSignificantBits: ULong)

Functions

adler32

fun ByteArray.adler32(): ByteArray

Computes Andler32 checksum.

appendByteArray

fun ByteStringBuilder.appendByteArray(bArray: ByteArray): ByteStringBuilder

Appends a byte array to this ByteStringBuilder.

appendByteString

fun ByteStringBuilder.appendByteString(bString: ByteString): ByteStringBuilder

Appends a ByteString to this ByteStringBuilder.

appendInt16

fun ByteStringBuilder.appendInt16(value: Int, validRange: IntRange = Int.MIN_VALUE..Int.MAX_VALUE): ByteStringBuilder

Appends a 16-bit signed integer to this ByteStringBuilder.

appendInt16Le

fun ByteStringBuilder.appendInt16Le(value: Int, validRange: IntRange = Short.MIN_VALUE..Short.MAX_VALUE): ByteStringBuilder

Appends a 16-bit signed integer to this ByteStringBuilder in Little-Endian order.

appendInt32

fun ByteStringBuilder.appendInt32(value: Int, validRange: IntRange = Int.MIN_VALUE..Int.MAX_VALUE): ByteStringBuilder

Appends a 32-bit signed integer to this ByteStringBuilder.

appendInt32Le

fun ByteStringBuilder.appendInt32Le(value: Int, validRange: IntRange = Int.MIN_VALUE..Int.MAX_VALUE): ByteStringBuilder

Appends a 32-bit signed integer to this ByteStringBuilder in Little-Endian order.

appendInt64

fun ByteStringBuilder.appendInt64(value: Long, validRange: LongRange = Long.MIN_VALUE..Long.MAX_VALUE): ByteStringBuilder

Appends a 64-bit signed integer to this ByteStringBuilder.

appendInt64Le

fun ByteStringBuilder.appendInt64Le(value: Long, validRange: LongRange = Long.MIN_VALUE..Long.MAX_VALUE): ByteStringBuilder

Appends a 64-bit signed integer to this ByteStringBuilder in Little-Endian order.

appendInt8

fun ByteStringBuilder.appendInt8(value: Byte, validRange: IntRange = Byte.MIN_VALUE..Byte.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendInt8(value: Int, validRange: IntRange = Byte.MIN_VALUE..Byte.MAX_VALUE): ByteStringBuilder

Appends an 8-bit signed integer to this ByteStringBuilder.

appendString

fun ByteStringBuilder.appendString(string: String): ByteStringBuilder

Appends a string to this ByteStringBuilder.

appendUInt16

fun ByteStringBuilder.appendUInt16(value: Int, validRange: UIntRange = UShort.MIN_VALUE..UShort.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendUInt16(value: UInt, validRange: UIntRange = UShort.MIN_VALUE..UShort.MAX_VALUE): ByteStringBuilder

Appends a 16-bit unsigned integer to this ByteStringBuilder.

appendUInt16Le

fun ByteStringBuilder.appendUInt16Le(value: Int, validRange: UIntRange = UShort.MIN_VALUE..UShort.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendUInt16Le(value: UInt, validRange: UIntRange = UShort.MIN_VALUE..UShort.MAX_VALUE): ByteStringBuilder

Appends a 16-bit unsigned integer to this ByteStringBuilder in Little-Endian order.

appendUInt32

fun ByteStringBuilder.appendUInt32(value: Int, validRange: UIntRange = UInt.MIN_VALUE..UInt.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendUInt32(value: UInt, validRange: UIntRange = UInt.MIN_VALUE..UInt.MAX_VALUE): ByteStringBuilder

Appends a 32-bit unsigned integer to this ByteStringBuilder.

appendUInt32Le

fun ByteStringBuilder.appendUInt32Le(value: Int, validRange: UIntRange = UInt.MIN_VALUE..UInt.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendUInt32Le(value: UInt, validRange: UIntRange = UInt.MIN_VALUE..UInt.MAX_VALUE): ByteStringBuilder

Appends a 32-bit unsigned integer to this ByteStringBuilder in Little-Endian order.

appendUInt64

fun ByteStringBuilder.appendUInt64(value: Long, validRange: ULongRange = ULong.MIN_VALUE..ULong.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendUInt64(value: ULong, validRange: ULongRange = ULong.MIN_VALUE..ULong.MAX_VALUE): ByteStringBuilder

Appends a 64-bit unsigned integer to this ByteStringBuilder.

appendUInt64Le

fun ByteStringBuilder.appendUInt64Le(value: Long, validRange: ULongRange = ULong.MIN_VALUE..ULong.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendUInt64Le(value: ULong, validRange: ULongRange = ULong.MIN_VALUE..ULong.MAX_VALUE): ByteStringBuilder

Appends a 64-bit unsigned integer to this ByteStringBuilder in Little-Endian order.

appendUInt8

fun ByteStringBuilder.appendUInt8(value: Int, validRange: UIntRange = UByte.MIN_VALUE..UByte.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendUInt8(value: UByte, validRange: UIntRange = UByte.MIN_VALUE..UByte.MAX_VALUE): ByteStringBuilder

fun ByteStringBuilder.appendUInt8(value: UInt, validRange: UIntRange = UByte.MIN_VALUE..UByte.MAX_VALUE): ByteStringBuilder

Appends an 8-bit unsigned integer to this ByteStringBuilder.

concat

fun ByteString.concat(bStr: ByteString): ByteString

Concatenates this ByteString with another ByteString.

deflate

expect suspend fun ByteArray.deflate(compressionLevel: Int = 5): ByteArray

Compresses data using DEFLATE algorithm according to RFC 1951.

actual suspend fun ByteArray.deflate(compressionLevel: Int): ByteArray

fromBase64

fun String.fromBase64(): ByteArray

Extension to decode a ByteArray from a base64 encoded (not URL-safe base64) string as defined in Section 4 of RFC 4648.

fromBase64Url

fun String.fromBase64Url(): ByteArray

Extension to decode a ByteArray from a URL-safe base64 encoded string as defined in Section 5 of RFC 4648.

fromGlob

fun Regex.Companion.fromGlob(glob: String): Regex

Creates regular expression pattern from simplified glob syntax:

fromHex

fun String.fromHex(): ByteArray

Extension to decode a ByteArray from a string with hexadecimal numbers.

fromHexByteString

fun String.fromHexByteString(): ByteString

Extension to decode a ByteString from a string with hexadecimal numbers.

fromJavaUuid

fun UUID.Companion.fromJavaUuid(javaUuid: <Error class: unknown class>): UUID

fromNSUUID

fun <Error class: unknown class>.fromNSUUID(nsUUID: <Error class: unknown class>): <Error class: unknown class>

generateAllPaths

fun List<Int>.generateAllPaths(): List<List<Int>>

Given a list (X0, X1, X2, ..., Xn, ...) generates a number of lists of the same length where each the list element in the nth position can assume values 0 up to Xn

getByteString

fun ByteArray.getByteString(offset: Int, numBytes: Int): ByteString

Extracts a ByteString from a portion of the byte array.

getInt16

fun ByteArray.getInt16(offset: Int): Short

Reads an Int16 value from the byte array at the specified offset.

fun ByteString.getInt16(offset: Int): Short

Gets a 16-bit signed integer (Int16) from this ByteString at the specified offset.

getInt16Le

fun ByteArray.getInt16Le(offset: Int): Short

Reads an Int16 value from the byte array at the specified offset in little-endian order.

fun ByteString.getInt16Le(offset: Int): Short

Gets a 16-bit signed integer (Int16) from this ByteString at the specified offset in Little-Endian order.

getInt32

fun ByteArray.getInt32(offset: Int): Int

Reads an Int32 value from the byte array at the specified offset.

fun ByteString.getInt32(offset: Int): Int

Gets a 32-bit signed integer (Int32) from this ByteString at the specified offset.

getInt32Le

fun ByteArray.getInt32Le(offset: Int): Int

Reads an Int32 value from the byte array at the specified offset in little-endian order.

fun ByteString.getInt32Le(offset: Int): Int

Gets a 32-bit signed integer (Int32) from this ByteString at the specified offset in Little-Endian order.

getInt64

fun ByteArray.getInt64(offset: Int): Long

Reads an Int64 value from the byte array at the specified offset.

fun ByteString.getInt64(offset: Int): Long

Gets a 64-bit signed integer (Int64) from this ByteString at the specified offset.

getInt64Le

fun ByteArray.getInt64Le(offset: Int): Long

Reads an Int64 value from the byte array at the specified offset in little-endian order.

fun ByteString.getInt64Le(offset: Int): Long

Gets a 64-bit signed integer (Int64) from this ByteString at the specified offset in Little-Endian order.

getInt8

fun ByteArray.getInt8(offset: Int): Byte

Reads an Int8 value from the byte array at the specified offset.

fun ByteString.getInt8(offset: Int): Byte

Gets an 8-bit signed integer (Int8) from this ByteString at the specified offset.

getPlatformLogPrinter

actual fun getPlatformLogPrinter(): Logger.LogPrinter

getString

fun ByteArray.getString(offset: Int, numBytes: Int): String

Decodes a portion of the byte array to a String.

getSystem

fun <Error class: unknown class>.getSystem(): <Error class: unknown class>

getUInt16

fun ByteArray.getUInt16(offset: Int): UShort

Reads a UInt16 value from the byte array at the specified offset.

fun ByteString.getUInt16(offset: Int): UShort

Gets a 16-bit unsigned integer (UInt16) from this ByteString at the specified offset.

getUInt16Le

fun ByteArray.getUInt16Le(offset: Int): UShort

Reads a UInt16 value from the byte array at the specified offset in little-endian order.

fun ByteString.getUInt16Le(offset: Int): UShort

Gets a 16-bit unsigned integer (UInt16) from this ByteString at the specified offset in Little-Endian order.

getUInt32

fun ByteArray.getUInt32(offset: Int): UInt

Reads a UInt32 value from the byte array at the specified offset.

fun ByteString.getUInt32(offset: Int): UInt

Gets a 32-bit unsigned integer (UInt32) from this ByteString at the specified offset.

getUInt32Le

fun ByteArray.getUInt32Le(offset: Int): UInt

Reads a UInt32 value from the byte array at the specified offset in little-endian order.

fun ByteString.getUInt32Le(offset: Int): UInt

Gets a 32-bit unsigned integer (UInt32) from this ByteString at the specified offset in Little-Endian order.

getUInt64

fun ByteArray.getUInt64(offset: Int): ULong

Reads a UInt64 value from the byte array at the specified offset.

fun ByteString.getUInt64(offset: Int): ULong

Gets a 64-bit unsigned integer (UInt64) from this ByteString at the specified offset.

getUInt64Le

fun ByteArray.getUInt64Le(offset: Int): ULong

Reads a UInt64 value from the byte array at the specified offset in little-endian order.

fun ByteString.getUInt64Le(offset: Int): ULong

Gets a 64-bit unsigned integer (UInt64) from this ByteString at the specified offset in Little-Endian order.

getUInt8

fun ByteArray.getUInt8(offset: Int): UByte

Reads a UInt8 value from the byte array at the specified offset.

fun ByteString.getUInt8(offset: Int): UByte

Gets an 8-bit unsigned integer (UInt8) from this ByteString at the specified offset.

htmlEscape

fun String.htmlEscape(): String

inflate

expect suspend fun ByteArray.inflate(): ByteArray

Decompresses data compressed DEFLATE algorithm according to RFC 1951.

actual suspend fun ByteArray.inflate(): ByteArray

isCloudKeyAttestation

fun isCloudKeyAttestation(chain: X509CertChain): Boolean

putInt16

fun ByteArray.putInt16(offset: Int, value: Int, validRange: IntRange = Short.MIN_VALUE..Short.MAX_VALUE)

Writes an Int16 value to the byte array at the specified offset.

putInt16Le

fun ByteArray.putInt16Le(offset: Int, value: Int, validRange: IntRange = Short.MIN_VALUE..Short.MAX_VALUE)

Writes an Int16 value to the byte array at the specified offset in little-endian order.

putInt32

fun ByteArray.putInt32(offset: Int, value: Int, validRange: IntRange = Int.MIN_VALUE..Int.MAX_VALUE)

Writes an Int32 value to the byte array at the specified offset.

putInt32Le

fun ByteArray.putInt32Le(offset: Int, value: Int, validRange: IntRange = Int.MIN_VALUE..Int.MAX_VALUE)

Writes an Int32 value to the byte array at the specified offset in little-endian order.

putInt64

fun ByteArray.putInt64(offset: Int, value: Long, validRange: LongRange = Long.MIN_VALUE..Long.MAX_VALUE)

Writes an Int64 value to the byte array at the specified offset.

putInt64Le

fun ByteArray.putInt64Le(offset: Int, value: Long, validRange: LongRange = Long.MIN_VALUE..Long.MAX_VALUE)

Writes an Int64 value to the byte array at the specified offset in little-endian order.

putInt8

fun ByteArray.putInt8(offset: Int, value: Int, validRange: IntRange = Byte.MIN_VALUE..Byte.MAX_VALUE)

Writes an Int8 value to the byte array at the specified offset.

putUInt16

fun ByteArray.putUInt16(offset: Int, value: UInt, validRange: UIntRange = UShort.MIN_VALUE.toUInt()..UShort.MAX_VALUE.toUInt())

Writes a UInt16 value to the byte array at the specified offset.

putUInt16Le

fun ByteArray.putUInt16Le(offset: Int, value: UInt, validRange: UIntRange = UShort.MIN_VALUE.toUInt()..UShort.MAX_VALUE.toUInt())

Writes a UInt16 value to the byte array at the specified offset in little-endian order.

putUInt32

fun ByteArray.putUInt32(offset: Int, value: UInt, validRange: UIntRange = UInt.MIN_VALUE..UInt.MAX_VALUE)

Writes a UInt32 value to the byte array at the specified offset.

putUInt32Le

fun ByteArray.putUInt32Le(offset: Int, value: UInt, validRange: UIntRange = UInt.MIN_VALUE..UInt.MAX_VALUE)

Writes a UInt32 value to the byte array at the specified offset in little-endian order.

putUInt64

fun ByteArray.putUInt64(offset: Int, value: ULong, validRange: ULongRange = ULong.MIN_VALUE..ULong.MAX_VALUE)

Writes a UInt64 value to the byte array at the specified offset.

putUInt64Le

fun ByteArray.putUInt64Le(offset: Int, value: ULong, validRange: ULongRange = ULong.MIN_VALUE..ULong.MAX_VALUE)

Writes a UInt64 value to the byte array at the specified offset in little-endian order.

putUInt8

fun ByteArray.putUInt8(offset: Int, value: UInt, validRange: UIntRange = UByte.MIN_VALUE.toUInt()..UByte.MAX_VALUE.toUInt())

Writes a UInt8 value to the byte array at the specified offset.

toBase64

fun ByteArray.toBase64(): String

Extension to encode a ByteArray to a base64 encoding (not URL-safe base64) without padding as defined in Section 4 of RFC 4648.

toBase64Url

fun ByteArray.toBase64Url(): String

Extension to encode a ByteArray to a URL-safe base64 encoding without padding as defined in Section 5 of RFC 4648.

toBufferSource

fun ByteArray.toBufferSource(): <Error class: unknown class>

Converts to a BufferSource

toByteArray

fun <Error class: unknown class>.toByteArray(): ByteArray

toHex

fun ByteArray.toHex(upperCase: Boolean = false, byteDivider: String = "", decodeAsString: Boolean = false): String

Extension to encode a ByteArray to a string with hexadecimal numbers.

fun ByteString.toHex(upperCase: Boolean = false, byteDivider: String = "", decodeAsString: Boolean = false): String

toJavaUuid

fun UUID.toJavaUuid(): <Error class: unknown class>

toKotlinError

fun <Error class: unknown class>.toKotlinError(): <Error class: unknown class>

toKotlinInstant

fun <Error class: unknown class>.toKotlinInstant(): <Error class: unknown class>

toNSData

fun ByteArray.toNSData(): <Error class: unknown class>

toNSUUID

fun <Error class: unknown class>.toNSUUID(): <Error class: unknown class>

truncateToWholeSeconds

fun Instant.truncateToWholeSeconds(): Instant

Returns a new Instant with the fractional part of seconds removed.

unsignedBigIntToString

fun ByteArray.unsignedBigIntToString(base: Int = 10): String

Convert the Serial number represented as a big endian byte array form base256 unsigned integer to the requested base (Base-10 by default) unsigned integer number. Required to display very long serial numbers discovered in some certificates as a numeric string value in the UI.

validateAndroidKeyAttestation

suspend fun validateAndroidKeyAttestation(chain: X509CertChain, challenge: ByteString?, requireGmsAttestation: Boolean, requireVerifiedBootGreen: Boolean, requireKeyMintSecurityLevel: AndroidKeystoreSecurityLevel, requireAppSignatureCertificateDigests: Set<ByteString>, requireAppPackages: Set<String>)

validateCloudKeyAttestation

suspend fun validateCloudKeyAttestation(chain: X509CertChain, nonce: ByteString, trustedRootKeys: Set<ByteString>)

zlibDeflate

suspend fun ByteArray.zlibDeflate(compressionLevel: Int = 9): ByteArray

Compresses data using DEFLATE algorithm according to RFC 1951 with zlib wrapper RFC 1950.

zlibInflate

suspend fun ByteArray.zlibInflate(): ByteArray

Decompresses data compressed DEFLATE algorithm according to RFC 1951 with zlib wrapper RFC 1950.