MultipazProject

multipaz-android-legacy/com.android.identity.android.legacy/Util

Util

object Util

Utility functions.

Functions

fun base16(bytes: ByteArray): String

bleCalculateAttributeValueSize

fun bleCalculateAttributeValueSize(mtuSize: Int): Int

buildSessionTranscript

fun buildSessionTranscript(ephemeralKeyPair: KeyPair): ByteArray?

calcEMacKeyForReader

fun calcEMacKeyForReader(authenticationPublicKey: PublicKey, ephemeralReaderPrivateKey: PrivateKey, encodedSessionTranscript: ByteArray): SecretKey

canonicalizeCbor

fun canonicalizeCbor(encodedCbor: ByteArray): ByteArray

cborBuildCoseKey

fun cborBuildCoseKey(key: PublicKey, curve: EcCurve): DataItem

cborBuildCoseKeyWithMalformedYPoint

fun cborBuildCoseKeyWithMalformedYPoint(key: PublicKey): DataItem

cborBuildDateTime

fun cborBuildDateTime(timestamp: Timestamp): DataItem

Returns #6.0(tstr) where tstr is the ISO 8601 encoding of the given point in time. Only supports UTC times.

cborBuildTaggedByteString

fun cborBuildTaggedByteString(encodedCbor: ByteArray): DataItem

Returns #6.24(bstr) of the given already encoded CBOR

fun cborDecode(encodedBytes: ByteArray): DataItem

cborDecodeBoolean

fun cborDecodeBoolean(data: ByteArray): Boolean

cborDecodeByteString

fun cborDecodeByteString(data: ByteArray): ByteArray

cborDecodeDateTime

fun cborDecodeDateTime(di: DataItem): Timestamp

fun cborDecodeDateTime(data: ByteArray): Timestamp

fun cborDecodeLong(data: ByteArray): Long

cborDecodeString

fun cborDecodeString(data: ByteArray): String

fun cborEncode(dataItem: DataItem): ByteArray

cborEncodeBoolean

fun cborEncodeBoolean(value: Boolean): ByteArray

cborEncodeBytestring

fun cborEncodeBytestring(value: ByteArray): ByteArray

cborEncodeDateTime

fun cborEncodeDateTime(timestamp: Timestamp): ByteArray

cborEncodeNumber

fun cborEncodeNumber(value: Long): ByteArray

cborEncodeString

fun cborEncodeString(value: String): ByteArray

cborExtractFirstDataItem

fun cborExtractFirstDataItem(pendingDataBaos: ByteArrayOutputStream): ByteArray?

Extracts the first CBOR data item from a stream of bytes.

cborExtractTaggedAndEncodedCbor

fun cborExtractTaggedAndEncodedCbor(item: DataItem): DataItem

For a #6.24(bstr), extracts the bytes and decodes it and returns the decoded CBOR as a DataItem.

cborExtractTaggedCbor

fun cborExtractTaggedCbor(encodedTaggedBytestring: ByteArray): ByteArray

For a #6.24(bstr), extracts the bytes.

fun cborGetLength(data: ByteArray?): Int

Helper to determine the length of a single encoded CBOR data item.

fun cborMapExtract(map: DataItem, key: String): DataItem

cborMapExtractArray

fun cborMapExtractArray(map: DataItem, key: Long): List<DataItem>

fun cborMapExtractArray(map: DataItem, key: String): List<DataItem>

cborMapExtractBoolean

fun cborMapExtractBoolean(map: DataItem, key: Long): Boolean

fun cborMapExtractBoolean(map: DataItem, key: String): Boolean

cborMapExtractByteString

fun cborMapExtractByteString(map: DataItem, key: Long): ByteArray

fun cborMapExtractByteString(map: DataItem, key: String): ByteArray

cborMapExtractDateTime

fun cborMapExtractDateTime(map: DataItem, key: String): Timestamp

cborMapExtractMap

fun cborMapExtractMap(map: DataItem, key: String): DataItem

cborMapExtractMapNumberKeys

fun cborMapExtractMapNumberKeys(map: DataItem): Collection<Long>

cborMapExtractMapStringKeys

fun cborMapExtractMapStringKeys(map: DataItem): Collection<String>

cborMapExtractNumber

fun cborMapExtractNumber(map: DataItem, key: Long): Long

fun cborMapExtractNumber(map: DataItem, key: String): Long

cborMapExtractString

fun cborMapExtractString(map: DataItem, key: Long): String

fun cborMapExtractString(map: DataItem, key: String): String

fun cborMapHasKey(map: DataItem, key: Long): Boolean

fun cborMapHasKey(map: DataItem, key: String): Boolean

cborPrettyPrint

fun cborPrettyPrint(dataItem: DataItem): String

fun cborPrettyPrint(encodedBytes: ByteArray): String

checkedLongValue

fun checkedLongValue(item: DataItem): Long

Accepts a DataItem, attempts to cast it to a Number, then returns the value Throws IllegalArgumentException if the DataItem is not a Number. This method also checks bounds, and if the given data item is too large to fit in a long, it throws ArithmeticException.

checkedStringValue

fun checkedStringValue(item: DataItem): String

Accepts a DataItem, attempts to cast it to a UnicodeString, then returns the value. Throws IllegalArgumentException if the DataItem is not a UnicodeString.

fun computeHkdf(macAlgorithm: String, ikm: ByteArray, salt: ByteArray?, info: ByteArray?, size: Int): ByteArray

Computes an HKDF.

fun coseKeyDecode(coseKey: DataItem): PublicKey

coseKeyGetCurve

fun coseKeyGetCurve(coseKey: DataItem): EcCurve

fun coseMac0(key: SecretKey, data: ByteArray?, detachedContent: ByteArray?): DataItem

fun coseMac0GetTag(coseMac0: DataItem): ByteArray

coseSign1CheckSignature

fun coseSign1CheckSignature(coseSign1: DataItem, detachedContent: ByteArray?, publicKey: PublicKey): Boolean

Currently only ECDSA signatures are supported.

coseSign1GetData

fun coseSign1GetData(coseSign1: DataItem): ByteArray

Returns the empty byte-array if no data is included in the structure.

coseSign1GetX5Chain

fun coseSign1GetX5Chain(coseSign1: DataItem): List<X509Certificate>

Returns the empty collection if no x5chain is included in the structure.

fun coseSign1Sign(s: Signature, data: ByteArray?, detachedContent: ByteArray?, certificateChain: Collection<X509Certificate>?): DataItem

fun coseSign1Sign(key: PrivateKey, algorithm: String, data: ByteArray?, additionalData: ByteArray?, certificateChain: Collection<X509Certificate>?): DataItem

Note: this uses the default JCA provider which may not support a lot of curves, for example it doesn't support Brainpool curves. If you need to use such curves, use .coseSign1Sign instead with a Signature created using a provider that does have support.

createEphemeralKeyPair

fun createEphemeralKeyPair(curve: EcCurve): KeyPair

createItemsRequest

fun createItemsRequest(entriesToRequest: Map<String?, Collection<String?>>, docType: String?): ByteArray

Helper function to create a CBOR data for requesting data items. The IntentToRetain value will be set to false for all elements.

extractDeviceRetrievalMethods

fun extractDeviceRetrievalMethods(encodedDeviceEngagement: ByteArray): List<ByteArray>

fun fromHex(stringWithHex: String): ByteArray

getDeviceRetrievalMethodType

fun getDeviceRetrievalMethodType(encodeDeviceRetrievalMethod: ByteArray): Long

getPopSha256FromAuthKeyCert

fun getPopSha256FromAuthKeyCert(cert: X509Certificate): ByteArray?

getPrivateKeyFromInteger

fun getPrivateKeyFromInteger(s: BigInteger): PrivateKey

getPublicKeyFromIntegers

fun getPublicKeyFromIntegers(x: BigInteger, y: BigInteger): PublicKey

hasSubByteArray

fun hasSubByteArray(haystack: ByteArray, needle: ByteArray): Boolean

Brute-force but good enough since users will only pass relatively small amounts of data.

issuerSignedItemClearValue

fun issuerSignedItemClearValue(encodedIssuerSignedItem: ByteArray): ByteArray

Clears elementValue in IssuerSignedItemBytes CBOR.

issuerSignedItemSetValue

fun issuerSignedItemSetValue(encodedIssuerSignedItem: ByteArray, encodedElementValue: ByteArray): ByteArray

Sets elementValue in IssuerSignedItem CBOR.

mdocVersionCompare

fun mdocVersionCompare(a: String, b: String): Int

Version comparison method for mdoc versions.

fun readBytes(inputStream: InputStream, numBytes: Int): ByteBuffer?

fun replaceLine(text: String, lineNumber: Int, replacementLine: String): String

sec1EncodeFieldElementAsOctetString

fun sec1EncodeFieldElementAsOctetString(octetStringSize: Int, fieldValue: BigInteger?): ByteArray

signPublicKeyWithPrivateKey

fun signPublicKeyWithPrivateKey(keyToSignAlias: String, keyToSignWithAlias: String): X509Certificate

stripLeadingZeroes

fun stripLeadingZeroes(value: ByteArray): ByteArray

fun toHex(bytes: ByteArray): String

fun toHex(bytes: ByteArray, from: Int, to: Int): String

fun uuidFromBytes(bytes: ByteArray): UUID

fun uuidToBytes(uuid: UUID): ByteArray

validateCertificateChain

fun validateCertificateChain(certificateChain: Collection<X509Certificate>): Boolean

Helper function to check if a given certificate chain is valid.