Class BitString

Represents an ASN.1 BIT STRING value.

A BIT STRING is used to represent sequences of bits. It's commonly used in PKI for public keys, signatures, and bit flags. The string can contain any number of bits, not necessarily a multiple of 8.

Asn

BIT STRING ::=

Example

// Create from bytes
const bitString = new BitString({ value: new Uint8Array([0x04, 0x20, 0xAB, 0xCD]) })

// Create from PKI object (e.g., public key)
const publicKeyBitString = new BitString({ value: subjectPublicKeyInfo })

// Get hex representation
console.log(bitString.toHexString()) // "0420abcd"

Hierarchy (View Summary)

PkiBase<BitString>
- BitString
  - ECPublicKey

Index

Constructors

constructor

new BitString(
    options: {
        value: string | Uint8Array<ArrayBufferLike> | PkiBase<any> | BitString;
    },
): BitString
Creates a new BitString instance.
Parameters
- options: { value: string | Uint8Array<ArrayBufferLike> | PkiBase<any> | BitString }
  Configuration object
  - value: string | Uint8Array<ArrayBufferLike> | PkiBase<any> | BitString
    The value as string, bytes, BitString, or PKI object
Returns BitString
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/asn1/BitString.ts:40

Properties

bytes

bytes: Uint8Array

The bytes representing this bit string.

Accessors

pemHeader

get pemHeader(): string
Gets the PEM header name for this object type. Converts the class name to uppercase for use in PEM encoding.

Returns string
Inherited from PkiBase.pemHeader
- Defined in packages/pki-lite/src/core/PkiBase.ts:60

pkiType

get pkiType(): string
Gets the PKI type name for this object (typically the class name). Used for PEM headers and debugging output.

Returns string
Inherited from PkiBase.pkiType
- Defined in packages/pki-lite/src/core/PkiBase.ts:52

Methods

equals

equals(other: PkiBase<any>): boolean
Compares this PKI object with another for equality. Two objects are considered equal if their DER encodings are identical.
Parameters
- other: PkiBase<any>
  The other PKI object to compare with
Returns boolean
true if the objects are equal, false otherwise
Inherited from PkiBase.equals
- Defined in packages/pki-lite/src/core/PkiBase.ts:122

parseAs

parseAs<T>(type: ParseableAsn1<T>): T
Parses this object as a different PKI type. Useful for converting between related PKI structures.
Type Parameters
- T
  The target type to parse as
Parameters
- type: ParseableAsn1<T>
  The target type constructor with parsing capabilities
Returns T
A new instance of the target type
Inherited from PkiBase.parseAs
- Defined in packages/pki-lite/src/core/PkiBase.ts:134

toAsn1

toAsn1(): Asn1BaseBlock
Converts this BitString to its ASN.1 representation.

Returns Asn1BaseBlock
The ASN.1 BIT STRING structure
Overrides PkiBase.toAsn1
- Defined in packages/pki-lite/src/asn1/BitString.ts:60

toDer

toDer(): Uint8Array
Converts this PKI object to DER (Distinguished Encoding Rules) format.

Returns Uint8Array
The DER-encoded bytes of this object
Inherited from PkiBase.toDer
- Defined in packages/pki-lite/src/core/PkiBase.ts:100

toHexString

toHexString(): string
Converts the BitString to a hexadecimal string representation. Each byte is represented as two lowercase hex digits.

Returns string
The hexadecimal string (e.g., "0420abcd")
- Defined in packages/pki-lite/src/asn1/BitString.ts:110

toHumanString

toHumanString(): string
Returns a human-readable string representation of this object. By default, returns the same as toString(), but subclasses can override for more user-friendly output.

Returns string
A human-readable string representation
Inherited from PkiBase.toHumanString
- Defined in packages/pki-lite/src/core/PkiBase.ts:90

toJSON

toJSON(): ToJson<T>
Converts this object to a JSON representation.

Returns ToJson<T>
A JSON-serializable representation of this object
Inherited from PkiBase.toJSON
- Defined in packages/pki-lite/src/core/PkiBase.ts:69

toPem

toPem(): string
Converts this PKI object to PEM (Privacy-Enhanced Mail) format.

Returns string
A PEM-encoded string with appropriate headers
Inherited from PkiBase.toPem
- Defined in packages/pki-lite/src/core/PkiBase.ts:109

toString

toString(): string
Returns the string representation of this BitString. Decodes the bytes as UTF-8 text.

Returns string
The decoded string
Overrides PkiBase.toString
- Defined in packages/pki-lite/src/asn1/BitString.ts:100

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): BitString
Creates a BitString from an ASN.1 BIT STRING structure.
Parameters
- asn1: Asn1BaseBlock
  The ASN.1 BIT STRING to parse
Returns BitString
A new BitString instance

Throws
Asn1ParseError if the ASN.1 structure is invalid
- Defined in packages/pki-lite/src/asn1/BitString.ts:73

Class BitString

Asn

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

value: string | Uint8Array<ArrayBufferLike> | PkiBase<any> | BitString

Returns BitString

Properties

bytes

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Asn1BaseBlock

toDer

Returns Uint8Array

toHexString

Returns string

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

StaticfromAsn1

Parameters

Returns BitString

Throws

Settings

On This Page

`Static`fromAsn1