indispensable/at.asitplus.signum.indispensable.asn1/Asn1PrimitiveOctetString

Asn1PrimitiveOctetString

class Asn1PrimitiveOctetString(content: ByteArray) : Asn1Primitive, Asn1OctetString<Asn1PrimitiveOctetString> (source)

ASN.1 OCTET STRING 0x04 (BERTags.OCTET_STRING) containing data, which does not decode to an Asn1Element

Parameters

content

the data to hold

Constructors

Asn1PrimitiveOctetString

constructor(content: ByteArray)

Properties

open override val content: ByteArray

Raw data contained in this ASN.1 primitive in its encoded form. Requires decoding to interpret it

val derEncoded: ByteArray

val encodedLength: ByteArray

Length (already properly encoded into a byte array for writing as ASN.1) of the contained data. For a primitive, this is just the size of the held bytes. For a structure, it is the sum of the number of bytes needed to encode all held child nodes.

val length: Int

Length (as a plain Int to work with it in code) of the contained data. For a primitive, this is just the size of the held bytes. For a structure, it is the sum of the number of bytes needed to encode all held child nodes.

val overallLength: Int

Total number of bytes required to represent the ths element, when encoding to ASN.1.

Functions

inline fun <T> Asn1Primitive.decode(tag: UByte, transform: (content: ByteArray) -> T): T

Generic decoding function. Verifies that this Asn1Primitive's tag matches tag and transforms its content as per transform

inline fun <T> Asn1Primitive.decodeOrNull(tag: UByte, transform: (content: ByteArray) -> T): T?

Exception-free version of decode

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

open override fun hashCode(): Int

fun prettyPrint(): String

fun Asn1Primitive.readBigInteger(): BigInteger

Decode the Asn1Primitive as a BigInteger

readBigIntegerOrNull

inline fun Asn1Primitive.readBigIntegerOrNull(): BigInteger?

Exception-free version of readBigInteger

fun Asn1Primitive.readBitString(): Asn1BitString

decodes this Asn1Primitive's content into an ByteArray, assuming it was encoded as BIT STRING

readBitStringOrNull

fun Asn1Primitive.readBitStringOrNull(): Asn1BitString?

Exception-free version of readBitString

fun Asn1Primitive.readBool(): Boolean

decodes this Asn1Primitive's content into an Boolean

fun Asn1Primitive.readInstant(): Instant

decodes this Asn1Primitive's content into an Instant if it is encoded as UTC TIME or GENERALIZED TIME

readInstantOrNull

fun Asn1Primitive.readInstantOrNull(): Instant?

Exception-free version of readInstant

fun Asn1Primitive.readInt(): Int

decodes this Asn1Primitive's content into an Int

fun Asn1Primitive.readIntOrNull(): Int?

Exception-free version of readInt

fun Asn1Primitive.readLong(): Long

decodes this Asn1Primitive's content into a Long

fun Asn1Primitive.readLongOrNull(): Long?

Exception-free version of readLong

fun Asn1Primitive.readNull()

decodes this Asn1Primitive to null (i.e. verifies the tag to be BERTags.ASN1_NULL and the content to be empty

fun Asn1Primitive.readNullOrNull(): Unit?

Name seems odd, but this is just an exception-free version of readNull

fun Asn1Primitive.readOid(): ObjectIdentifier

decodes this Asn1Primitive's content into an ObjectIdentifier

fun Asn1Primitive.readString(): Asn1String

decodes this Asn1Primitive's content into an Asn1String

readStringOrNull

fun Asn1Primitive.readStringOrNull(): Asn1String?

Exception-free version of readString

fun toDerHexString(lineLen: Byte? = null): String

Convenience method to directly produce an HEX string of this element's ANS.1 representation

open override fun toString(): String

open override fun unwrap(): Asn1PrimitiveOctetString

Returns the actual type of this object inside the Asn1Element class hierarchy T will either be Asn1Primitive/Asn1PrimitiveOctetString or Asn1Structure/Asn1EncapsulatingOctetString