core/at.asitplus.awesn1/Asn1String

Asn1String

@Serializable(with = Asn1String.Companion::class)

sealed class Asn1String : Asn1Encodable<Asn1Primitive> (source)

ASN.1 String class used as wrapper do discriminate between different ASN.1 string types By default, the string value is decoded using UTF-8. If a different charset or custom decoding is needed, the rawValue property can be used directly.

Under DER serialization with awesn1.kxs, generic Asn1String values are decoded by their universal ASN.1 string tag. This means generic Asn1String must not be used together with implicit tag overrides such as @Asn1Tag, because the concrete string subtype would no longer be recoverable from the wire representation. Use a concrete subtype like UTF8, IA5, Printable, Visible, or Numeric when implicit tagging is required.

String values are internally represented as raw ByteArray. Generic Asn1String decoding preserves even malformed string content and reports its status through isValid. Decoding to a concrete subtype is strict and throws when validation returns false; null means that no complete validator exists and is therefore accepted.

Inheritors

Types

BMP

@Serializable(with = Asn1StringSerializer::class)

class BMP : Asn1String

BMP STRING, encoded as big-endian UCS-2 (surrogate code units are forbidden).

Companion

object Companion : Asn1Serializable<Asn1Primitive, Asn1String> , StringFallbackSerializer<Asn1String>

General

@Serializable(with = Asn1StringSerializer::class)

class General : Asn1String

GENERAL STRING.

Graphic

@Serializable(with = Asn1StringSerializer::class)

class Graphic : Asn1String

GRAPHIC STRING.

IA5

@Serializable(with = Asn1Ia5StringSerializer::class)

class IA5 : Asn1String

IA5 STRING.

Numeric

@Serializable(with = Asn1NumericStringSerializer::class)

class Numeric : Asn1String

NUMERIC STRING.

Printable

@Serializable(with = Asn1PrintableStringSerializer::class)

class Printable : Asn1String

PRINTABLE STRING.

Teletex

@Serializable(with = Asn1StringSerializer::class)

class Teletex : Asn1String

TELETEX (T61) STRING.

Universal

@Serializable(with = Asn1StringSerializer::class)

class Universal : Asn1String

UNIVERSAL STRING, encoded as big-endian 32-bit Unicode scalar values.

Unrestricted

@Serializable(with = Asn1StringSerializer::class)

class Unrestricted : Asn1String

CHARACTER/UNRESTRICTED STRING (no checks)

UTF8

@Serializable(with = Asn1Utf8StringSerializer::class)

class UTF8 : Asn1String

UTF8 STRING (ISO/IEC 10646, encoded as UTF-8 per RFC 3629).

Videotex

@Serializable(with = Asn1StringSerializer::class)

class Videotex : Asn1String

VIDEOTEX STRING (no checks) Validation is not implemented. This type is no longer used in practice.

Visible

@Serializable(with = Asn1VisibleStringSerializer::class)

class Visible : Asn1String

VISIBLE STRING (a.k.a. ISO646String).

Properties

isValid

abstract val isValid: Boolean?

Returns whether this string's rawValue is valid for its concrete ASN.1 string type:

performValidation

val performValidation: Boolean

rawValue

val rawValue: ByteArray

tag

abstract val tag: ULong

value

open val value: String

The UTF-8 interpretation of rawValue by default; wide-character subtypes override this. The decoding is performed via String.decodeFromAsn1ContentBytes(rawValue), which internally uses the standard library's ByteArray.decodeToString.

Functions

encodeToDer

fun Asn1Encodable<*>.encodeToDer(): ByteArray

Convenience function to directly get the DER-encoded representation of the implementing object

fun Asn1Encodable<*>.encodeToDer(sink: Sink)

encodeToDerOrNull

fun Asn1Encodable<*>.encodeToDerOrNull(): ByteArray?

Exception-free version of encodeToDer

encodeToTlv

open override fun encodeToTlv(): Asn1Primitive

Encodes the implementing object into an A

encodeToTlvOrNull

fun <A : Asn1Element> Asn1Encodable<A>.encodeToTlvOrNull(): A?

Exception-free version of Asn1Encodable.encodeToTlv

equals

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

hashCode

open override fun hashCode(): Int

prettyPrintAsn1

open fun prettyPrintAsn1(): String

shorthand for Asn1Element.prettyPrint, hence, a call to this function encodes this encodable to an Asn1Element, holds it in memory, pretty prints it, and discards it. This characteristic may be relevant in memory-constrained environments.

toDerHexString

fun Asn1Encodable<*>.toDerHexString(lineLen: Int? = null): String

withImplicitTag

open infix fun withImplicitTag(tag: Asn1Element.Tag): Asn1Element

Creates a new implicitly tagged ASN.1 Element from this ASN.1 Element. NOTE: The TagClass of the provided tag will be used! If you want the result to have TagClass.CONTEXT_SPECIFIC, also invoke tag withClass TagClass.CONTEXT_SPECIFIC!. If a CONSTRUCTED Tag is applied to an ASN.1 Primitive, the CONSTRUCTED bit is overridden and set to zero

open infix fun withImplicitTag(template: Asn1Element.Tag.Template): Asn1Element

Creates a new implicitly tagged ASN.1 Element from this ASN.1 Structure. If the provided template's tagClass is not set, the class of the resulting structure defaults to TagClass.CONTEXT_SPECIFIC. If a CONSTRUCTED Tag is applied to an ASN.1 Primitive, the CONSTRUCTED bit is overridden and set to zero

open infix fun withImplicitTag(tagValue: ULong): Asn1Element

Creates a new implicitly tagged ASN.1 Element from this ASN.1 Element. Sets the class of the resulting structure to TagClass.CONTEXT_SPECIFIC