core/at.asitplus.awesn1/Asn1PemDecodable

Asn1PemDecodable

interface Asn1PemDecodable<A : Asn1Element, T : Asn1Encodable<A>> : PemDecodable<T> , Asn1Decodable<A, T> , PemLabelSpec<T> (source)

Helper class for decoding simple PEM structures, where the payload is just the DER bytes. By default, does not allow PEM headers, matching the RFC 7468 structures. Override decodeFromTlvWithPemHeaders to customize this.

Properties

alternativePemLabels

open val alternativePemLabels: Iterable<String>

Alternate PEM labels accepted for this data type when decoding

canonicalPemLabel

abstract val canonicalPemLabel: String

The standard or commonly agreed-upon PEM label for this data type.

validPemLabels

val PemLabelSpec<*>.validPemLabels: Sequence<String>

All PEM labels accepted for this data type when decoding

Functions

decodeAllFromPem

fun <T : PemEncodable> PemDecodable<T>.decodeAllFromPem(src: String): List<T>

decodeFromDer

fun <A : Asn1Element, T : Asn1Encodable<A>> Asn1Decodable<A, T>.decodeFromDer(src: ByteArray, limit: Long = src.size.toLong(), assertTag: Asn1Element.Tag? = null): T

Convenience method, directly DER-decoding a byte array to T

fun <A : Asn1Element, T : Asn1Encodable<A>> Asn1Decodable<A, T>.decodeFromDer(src: Source<*>, limit: Long?, assertTag: Asn1Element.Tag? = null): T

Decodes src as DER using this Asn1Decodable.

decodeFromDerOrNull

fun <A : Asn1Element, T : Asn1Encodable<A>> Asn1Decodable<A, T>.decodeFromDerOrNull(src: ByteArray, limit: Long = src.size.toLong(), assertTag: Asn1Element.Tag? = null): T?

Exception-free version of decodeFromDer

decodeFromDerWithPemHeaders

fun <A : Asn1Element, T : Asn1Encodable<A>> Asn1PemDecodable<A, T>.decodeFromDerWithPemHeaders(pemHeaders: Iterable<PemHeader>, der: ByteArray): T

decodeFromPem

fun <T> PemDecodable<T>.decodeFromPem(src: String): T

decodeFromPemBlock

fun <T> PemDecodable<T>.decodeFromPemBlock(src: PemBlock): T

decodeFromTlv

open fun decodeFromTlv(src: A, assertTag: Asn1Element.Tag? = null): T

Processes an A, parsing it into an instance of T

decodeFromTlvOrNull

fun <A : Asn1Element, T : Asn1Encodable<A>> Asn1Decodable<A, T>.decodeFromTlvOrNull(src: A, assertTag: Asn1Element.Tag? = null): T?

Exception-free version of Asn1Decodable.decodeFromTlv

decodeFromTlvWithPemHeaders

open fun decodeFromTlvWithPemHeaders(pemHeaders: Iterable<PemHeader>, tlv: A): T

doDecode

abstract fun doDecode(src: A): T

Actual element-specific decoding function. By default, this is invoked after verifyTag

doDecodeFromPemBlock

open override fun doDecodeFromPemBlock(src: PemBlock): T

parseFromDerHexString

fun <A : Asn1Element, T : Asn1Encodable<A>> Asn1Decodable<A, T>.parseFromDerHexString(derEncoded: String): T

fun <A : Asn1Element, T : Asn1Encodable<A>> Asn1Decodable<A, T>.parseFromDerHexString(derEncoded: String, limit: Long): T

Convenience method to directly parse a HEX-string representation of DER-encoded data. Ignores and strips all whitespace.

validate

fun PemLabelSpec<*>.validate(src: WithPemLabel)

verifyTag

open fun verifyTag(src: A, assertTag: Asn1Element.Tag?)

Specify assertTag for verifying implicitly tagged elements' tags (and better not override this function).