Class SignatureAlgorithmIdentifier

Represents a signature algorithm identifier.

Asn

SignatureAlgorithmIdentifier ::= AlgorithmIdentifier

Hierarchy (View Summary)

AlgorithmIdentifier
- SignatureAlgorithmIdentifier

Constructors

constructor

new SignatureAlgorithmIdentifier(
options: { algorithm: ObjectIdentifierString; parameters?: Asn1Any },
): SignatureAlgorithmIdentifier
Creates a new AlgorithmIdentifier instance.
Parameters
- options: { algorithm: ObjectIdentifierString; parameters?: Asn1Any }
  Configuration object
  - algorithm: ObjectIdentifierString
    The algorithm OID as string or ObjectIdentifier
  - Optionalparameters?: Asn1Any
    Optional algorithm-specific parameters
Returns SignatureAlgorithmIdentifier
Inherited from AlgorithmIdentifier.constructor
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:89

Properties

algorithm

algorithm: ObjectIdentifier

The algorithm object identifier (OID).

`Protected` `Internal`noPadding

noPadding: boolean = false

Internal flag indicating whether this algorithm uses padding.

`Optional`parameters

parameters?: Any

Algorithm-specific parameters (optional). The format depends on the specific algorithm.

Accessors

friendlyName

get friendlyName(): string
Gets a human-readable name for this algorithm. Returns the friendly name if known, otherwise the OID.

Returns string
The algorithm name (e.g., "rsaEncryption", "sha256")
Inherited from AlgorithmIdentifier.friendlyName
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:126

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

getEcNamedCurve

getEcNamedCurve(publicKeyInfo?: SubjectPublicKeyInfo): NamedCurve
Parameters
- OptionalpublicKeyInfo: SubjectPublicKeyInfo
Returns NamedCurve
Inherited from AlgorithmIdentifier.getEcNamedCurve
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:172

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

sign

sign(
data: Uint8Array<ArrayBufferLike> | PkiBase<any>,
privateKeyInfo: PrivateKeyInfo,
): Promise<Uint8Array<ArrayBufferLike>>
Parameters
- data: Uint8Array<ArrayBufferLike> | PkiBase<any>
- privateKeyInfo: PrivateKeyInfo
Returns Promise<Uint8Array<ArrayBufferLike>>
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:304

toAsn1

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

Returns Asn1BaseBlock
The ASN.1 SEQUENCE structure
Inherited from AlgorithmIdentifier.toAsn1
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:108

toAsymmetricEncryptionAlgorithmParams

toAsymmetricEncryptionAlgorithmParams(
publicKeyInfo?: SubjectPublicKeyInfo,
): AsymmetricEncryptionAlgorithmParams
Parameters
- OptionalpublicKeyInfo: SubjectPublicKeyInfo
Returns AsymmetricEncryptionAlgorithmParams
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:295

toDer

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

Returns Uint8Array
The DER-encoded bytes of this object
Inherited from AlgorithmIdentifier.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 AlgorithmIdentifier.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 AlgorithmIdentifier.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 AlgorithmIdentifier.toPem
- Defined in packages/pki-lite/src/core/PkiBase.ts:109

toString

toString(): string
Returns a string representation of this PKI object. Includes the type name and ASN.1 structure.

Returns string
A string representation for debugging
Inherited from AlgorithmIdentifier.toString
- Defined in packages/pki-lite/src/core/PkiBase.ts:79

verify

verify(
    data: Uint8Array<ArrayBufferLike> | PkiBase<any>,
    signature: Uint8Array<ArrayBufferLike> | PkiBase<any>,
    publicKeyInfo: SubjectPublicKeyInfo,
): Promise<boolean>
Parameters
- data: Uint8Array<ArrayBufferLike> | PkiBase<any>
- signature: Uint8Array<ArrayBufferLike> | PkiBase<any>
- publicKeyInfo: SubjectPublicKeyInfo
Returns Promise<boolean>
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:322

`Static`contentEncryptionAlgorithm

contentEncryptionAlgorithm(
encryptionParams: SymmetricEncryptionAlgorithmParams,
): ContentEncryptionAlgorithmIdentifier
Parameters
- encryptionParams: SymmetricEncryptionAlgorithmParams
Returns ContentEncryptionAlgorithmIdentifier
Inherited from AlgorithmIdentifier.contentEncryptionAlgorithm
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:213

`Static`digestAlgorithm

digestAlgorithm(params: HashAlgorithm): DigestAlgorithmIdentifier
Parameters
- params: HashAlgorithm
Returns DigestAlgorithmIdentifier
Inherited from AlgorithmIdentifier.digestAlgorithm
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:176

`Static`fromAsn1

fromAsn1(asn1: BaseBlock): SignatureAlgorithmIdentifier
Creates an AlgorithmIdentifier from an ASN.1 structure
Parameters
- asn1: BaseBlock
  The ASN.1 structure
Returns SignatureAlgorithmIdentifier
An AlgorithmIdentifier
Overrides AlgorithmIdentifier.fromAsn1
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:349

`Static`randomBytes

randomBytes(length: number): Uint8Array
Parameters
- length: number
Returns Uint8Array
Inherited from AlgorithmIdentifier.randomBytes
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:168

`Static`signatureAlgorithm

signatureAlgorithm(
encryptionParams: AsymmetricEncryptionAlgorithmParams,
): SignatureAlgorithmIdentifier
Parameters
- encryptionParams: AsymmetricEncryptionAlgorithmParams
Returns SignatureAlgorithmIdentifier
Inherited from AlgorithmIdentifier.signatureAlgorithm
- Defined in packages/pki-lite/src/algorithms/AlgorithmIdentifier.ts:187

Class SignatureAlgorithmIdentifier

Asn

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

algorithm: ObjectIdentifierString

Optionalparameters?: Asn1Any

Returns SignatureAlgorithmIdentifier

Properties

algorithm

Protected InternalnoPadding

Optionalparameters

Accessors

friendlyName

Returns string

pemHeader

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

getEcNamedCurve

Parameters

Returns NamedCurve

parseAs

Type Parameters

Parameters

Returns T

sign

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

toAsn1

Returns Asn1BaseBlock

toAsymmetricEncryptionAlgorithmParams

Parameters

Returns AsymmetricEncryptionAlgorithmParams

toDer

Returns Uint8Array

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

verify

Parameters

Returns Promise<boolean>

StaticcontentEncryptionAlgorithm

Parameters

Returns ContentEncryptionAlgorithmIdentifier

StaticdigestAlgorithm

Parameters

Returns DigestAlgorithmIdentifier

StaticfromAsn1

Parameters

Returns SignatureAlgorithmIdentifier

StaticfromDer

Parameters

Returns SignatureAlgorithmIdentifier

StaticgetEcCurveParameters

Parameters

Returns ObjectIdentifier

StatickeyEncryptionAlgorithm

Parameters

Returns KeyEncryptionAlgorithmIdentifier

StaticrandomBytes

Parameters

Returns Uint8Array

StaticsignatureAlgorithm

Parameters

`Optional`parameters?: Asn1Any

`Protected` `Internal`noPadding

`Optional`parameters

`Static`contentEncryptionAlgorithm

`Static`digestAlgorithm

`Static`fromAsn1

`Static`fromDer

`Static`getEcCurveParameters

`Static`keyEncryptionAlgorithm

`Static`randomBytes

`Static`signatureAlgorithm