Class registeredID

Represents an ASN.1 OBJECT IDENTIFIER value.

Object Identifiers (OIDs) are hierarchically structured identifiers used throughout PKI and cryptographic standards to uniquely identify algorithms, attributes, and other objects. They are represented as dot-separated sequences of integers.

Asn

OBJECT IDENTIFIER ::=

Example

// Create an OID for RSA encryption
const rsaOid = new ObjectIdentifier({ value: '1.2.840.113549.1.1.1' })

// Check if it matches a known OID
if (rsaOid.is('1.2.840.113549.1.1.1')) {
    console.log('RSA algorithm detected')
}

// Get friendly name if available
console.log(rsaOid.friendlyName) // "rsaEncryption"

Hierarchy (View Summary)

ObjectIdentifier
- registeredID

Index

Constructors

constructor

new registeredID(
options: { value: ObjectIdentifierString | ObjectIdentifier },
): registeredID
Creates a new ObjectIdentifier instance.
Parameters
- options: { value: ObjectIdentifierString | ObjectIdentifier }
  Configuration object
  - value: ObjectIdentifierString | ObjectIdentifier
    The OID value as string, ObjectIdentifier, or object with toString()
Returns registeredID
Throws
Error if value is null, undefined, or invalid
Inherited from ObjectIdentifier.constructor
- Defined in packages/pki-lite/src/asn1/ObjectIdentifier.ts:50

Properties

value

value: string

The dot-separated OID value (e.g., "1.2.840.113549.1.1.1").

Accessors

friendlyName

get friendlyName(): string
Gets a human-readable name for this OID if available. Falls back to the OID value if no friendly name is known.

Returns string
A friendly name (e.g., "rsaEncryption") or the OID value
Inherited from ObjectIdentifier.friendlyName
- Defined in packages/pki-lite/src/asn1/ObjectIdentifier.ts:156

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 ObjectIdentifier.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 ObjectIdentifier.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 ObjectIdentifier.equals
- Defined in packages/pki-lite/src/core/PkiBase.ts:122

is

is(other: string | ObjectIdentifier): boolean
Checks if this OID equals another OID.
Parameters
- other: string | ObjectIdentifier
  The OID to compare with (ObjectIdentifier instance or string)
Returns boolean
true if the OIDs are equal, false otherwise
Inherited from ObjectIdentifier.is
- Defined in packages/pki-lite/src/asn1/ObjectIdentifier.ts:131

isNot

isNot(other: string | ObjectIdentifier): boolean
Checks if this OID does not equal another OID.
Parameters
- other: string | ObjectIdentifier
  The OID to compare with (ObjectIdentifier instance or string)
Returns boolean
true if the OIDs are different, false otherwise
Inherited from ObjectIdentifier.isNot
- Defined in packages/pki-lite/src/asn1/ObjectIdentifier.ts:146

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 ObjectIdentifier.parseAs
- Defined in packages/pki-lite/src/core/PkiBase.ts:134

toAsn1

toAsn1(): Sequence
Converts this ObjectIdentifier to its ASN.1 representation.

Returns Sequence
The ASN.1 OBJECT IDENTIFIER structure
Overrides ObjectIdentifier.toAsn1
- Defined in packages/pki-lite/src/x509/GeneralName.ts:259

toDer

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

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

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 ObjectIdentifier.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 ObjectIdentifier.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 ObjectIdentifier.toPem
- Defined in packages/pki-lite/src/core/PkiBase.ts:109

toString

toString(): string
Returns the string representation of this OID.

Returns string
The dot-separated OID value
Inherited from ObjectIdentifier.toString
- Defined in packages/pki-lite/src/asn1/ObjectIdentifier.ts:121

`Static`fromAsn1

fromAsn1(asn1: Asn1BaseBlock): registeredID
Creates an ObjectIdentifier from an ASN.1 structure.
Parameters
- asn1: Asn1BaseBlock
  The ASN.1 OBJECT IDENTIFIER to parse
Returns registeredID
A new ObjectIdentifier instance

Throws
Asn1ParseError if the ASN.1 structure is invalid
Overrides ObjectIdentifier.fromAsn1
- Defined in packages/pki-lite/src/x509/GeneralName.ts:266

`Static`fromDer

fromDer(bytes: Uint8Array<ArrayBuffer>): ObjectIdentifier
Creates an ObjectIdentifier from DER-encoded bytes.
Parameters
- bytes: Uint8Array<ArrayBuffer>
  The DER-encoded OBJECT IDENTIFIER bytes
Returns ObjectIdentifier
A new ObjectIdentifier instance
Inherited from ObjectIdentifier.fromDer
- Defined in packages/pki-lite/src/asn1/ObjectIdentifier.ts:112

Class registeredID

Asn

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

value: ObjectIdentifierString | ObjectIdentifier

Returns registeredID

Throws

Properties

value

Accessors

friendlyName

Returns string

pemHeader

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

is

Parameters

Returns boolean

isNot

Parameters

Returns boolean

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Sequence

toDer

Returns Uint8Array<ArrayBuffer>

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

StaticfromAsn1

Parameters

Returns registeredID

Throws

StaticfromDer

Parameters

Returns ObjectIdentifier

Settings

On This Page

`Static`fromAsn1

`Static`fromDer