core/at.asitplus.awesn1/Asn1BitString

Asn1BitString

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

data class Asn1BitString : Asn1Encodable<Asn1Primitive> (source)

ASN.1 BIT STRING, enforcing strict DER rules:

The number of padding bits must be in range 0..7
The raw bytes must not be empty if padding bits are set
The padding bits must be zero

When serialized to a non-DER format, the following representation is used:"$numPaddingBits:${base64Strict(bitCarryingBytes)}"

val bitSet = BitSet.fromString("001")
val bitString = Asn1BitString(bitSet)

Json.encodeToString(bitString)  //produces "5:IA=="

Constructors

Asn1BitString

constructor(source: BitSet)

Creates an ASN.1 BIT STRING from the provided bitSet. The transformation to bitCarryingBytes and the calculation of numPaddingBits happens immediately in the constructor. Hence, modifications to the source BitSet have no effect on the resulting Asn1BitString.

constructor(source: ByteArray)

Constructs an ASN.1 BIT STRING with source used for bitCarryingBytes and zero padding bits

Types

Companion

object Companion : Asn1Serializer<Asn1Primitive, Asn1BitString>

Properties

bitCarryingBytes

val bitCarryingBytes: ByteArray

numPaddingBits

val numPaddingBits: Byte

overallContent

val overallContent: ByteArray

The DER content octets of the bit string, including the padding-bit-count byte.

overallContentLength

val overallContentLength: Int

The total length of the bit string content octets, including the padding-bit-count byte.

rawBytes

val ~~rawBytes~~: ByteArray

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.

toBitSet

fun toBitSet(): BitSet

Transforms bitCarryingBytes and wraps into a BitSet. The last numPaddingBits bits are ignored. This is a deep copy and mirrors the bits in every byte to match the native bitset layout where bit and byte indices run in opposite direction. Hence, modifications to the resulting bitset do not affect bitCarryingBytes

toDerHexString

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

toString

open override fun toString(): 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