kxs/at.asitplus.awesn1.serialization

Package-level declarations

Types

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.PROPERTY])

Marks ByteArray properties to encode/decode as ASN.1 BIT STRING. The resulting bit string will have zero padding bytes, corresponding to byte-alignment. If deserialization encounters >0 padding bits, it will throw.

Asn1OpenPolymorphismByOidBuilder

class Asn1OpenPolymorphismByOidBuilder<T : Identifiable>

DSL builder for OID-discriminated open polymorphism.

Asn1OpenPolymorphismByTagBuilder

class Asn1OpenPolymorphismByTagBuilder<T : Any>

DSL builder for tag-discriminated open polymorphism.

Asn1OpenPolymorphismDsl

@DslMarker

annotation class Asn1OpenPolymorphismDsl

Marker for ASN.1 open-polymorphism registration DSL scopes.

Asn1Tag

@SerialInfo

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])

annotation class Asn1Tag(val tagNumber: ULong, val tagClass: Asn1Tag.Class = Class.CONTEXT_SPECIFIC, val constructed: Asn1Tag.ConstructedBit = Asn1Tag.ConstructedBit.INFER)

ASN.1 implicit tag override annotation.

DefaultDer

@ExperimentalSerializationApi

object DefaultDer

Der

class Der : BinaryFormat

Marker format type for ASN.1 DER serialization via kotlinx.serialization.

DerBuilder

class DerBuilder

Builder for DerConfiguration, used by DER { ... }.

DerConfiguration

data class DerConfiguration(val encodeDefaults: Boolean = true, val explicitNulls: Boolean = false, val maxInputLength: Long = UInt.MAX_VALUE.toLong(), val serializersModule: SerializersModule = EmptySerializersModule())

DER format options.

DerDecoder

interface DerDecoder : Decoder, Asn1DerDecoder

DerEncoder

interface DerEncoder : Encoder, Asn1DerEncoder

ExplicitlyTagged

@Serializable

data class ExplicitlyTagged<T>(val value: T)

Explicit-tag modelling wrapper.

OctetStringEncapsulated

@Serializable

data class OctetStringEncapsulated<T>(val value: T)

OCTET STRING encapsulation wrapper.

OidProvider

interface OidProvider<out S : Identifiable> : Identifiable

Supplies discriminator OIDs for OID-discriminated open polymorphism DSL registrations.

Properties

DER

val DER: Der

Functions

asn1OpenPolymorphicByOidSerializer

fun <T : Identifiable> asn1OpenPolymorphicByOidSerializer(serialName: String, oidSelector: (Asn1Element) -> ObjectIdentifier? = ::oidFrom, block: Asn1OpenPolymorphismByOidBuilder<T>.() -> Unit): KSerializer<T>

Builds an OID-discriminated ASN.1 open-polymorphic serializer.

asn1OpenPolymorphicByTagSerializer

fun <T : Any> asn1OpenPolymorphicByTagSerializer(serialName: String, block: Asn1OpenPolymorphismByTagBuilder<T>.() -> Unit): KSerializer<T>

Builds a tag-discriminated ASN.1 open-polymorphic serializer.

decodeFromDer

@ExperimentalSerializationApi

inline fun <T> Der.decodeFromDer(source: ByteArray): T

Decodes source from DER bytes using the inferred deserializer for T.

decodeFromPem

@ExperimentalSerializationApi

inline fun <T : WithPemLabel> PemLabelSpec<T>.decodeFromPem(source: PemBlock, der: Der = DER): T

decodeFromTlv

@ExperimentalSerializationApi

inline fun <T> Der.decodeFromTlv(source: Asn1Element): T

Decodes source from a single ASN.1 TLV element using the inferred deserializer for T.

DER

fun DER(config: DerBuilder.() -> Unit = {}): Der

Factory for the ASN.1 DER kotlinx-serialization format.

encodeToPem

@ExperimentalSerializationApi

inline fun <T : WithPemLabel> T.encodeToPem(der: Der = DER): String

encodeToPemBlock

@ExperimentalSerializationApi

inline fun <T : WithPemLabel> T.encodeToPemBlock(der: Der = DER): PemBlock

encodeToTlv

@ExperimentalSerializationApi

inline fun <T> Der.encodeToTlv(value: T): Asn1Element?

@ExperimentalSerializationApi

@JvmName(name = "encodeToTlvNonNull")

inline fun <T : Any> Der.encodeToTlv(value: T): Asn1Element

Encodes value into a single ASN.1 TLV element using the inferred serializer for T.

getValue

operator fun <T> ExplicitlyTagged<T>?.getValue(thisRef: Any?, property: Any?): T?

operator fun <T> OctetStringEncapsulated<T>?.getValue(thisRef: Any?, property: Any?): T?

orValue

fun <T> ExplicitlyTagged<T>?.orValue(default: T): ExplicitlyTagged<T>

Use like so: val foo by explicitlyTaggedProperty.orValue("Some sane default that must not even align on nullability")

fun <T> OctetStringEncapsulated<T>?.orValue(default: T): OctetStringEncapsulated<T>

Use like so: val foo by octetStringEncapsulated.orValue("Some sane default that must not even align on nullability")

polymorphicByOid

fun <T : Identifiable> SerializersModuleBuilder.polymorphicByOid(baseClass: KClass<T>, serialName: String = "Asn1OpenPolymorphicByOid", oidSelector: (Asn1Element) -> ObjectIdentifier? = ::oidFrom, block: Asn1OpenPolymorphismByOidBuilder<T>.() -> Unit)

Registers an OID-discriminated ASN.1 open-polymorphic serializer as contextual serializer.

polymorphicByTag

fun <T : Any> SerializersModuleBuilder.polymorphicByTag(baseClass: KClass<T>, serialName: String = "Asn1OpenPolymorphicByTag", block: Asn1OpenPolymorphismByTagBuilder<T>.() -> Unit)

Registers a tag-discriminated ASN.1 open-polymorphic serializer as contextual serializer.

withAsn1LeadingTags

fun SerialDescriptor.withAsn1LeadingTags(leadingTags: Set<Asn1Element.Tag>): SerialDescriptor

withDynamicAsn1LeadingTags

fun SerialDescriptor.withDynamicAsn1LeadingTags(leadingTagsProvider: () -> Set<Asn1Element.Tag>): SerialDescriptor