Class RSAESOAEPParams

RSAES-OAEP-params ::= SEQUENCE { hashAlgorithm [0] HashAlgorithm DEFAULT sha1, maskGenAlgorithm [1] MaskGenAlgorithm DEFAULT mgf1SHA1, pSourceAlgorithm [2] PSourceAlgorithm DEFAULT pSpecifiedEmpty }

HashAlgorithm ::= AlgorithmIdentifier

MaskGenAlgorithm ::= AlgorithmIdentifier

PSourceAlgorithm ::= AlgorithmIdentifier

Implementation based on RFC 3447 (PKCS #1 v2.1)

Hierarchy (View Summary)

PkiBase<RSAESOAEPParams>
- RSAESOAEPParams

Constructors

constructor

new RSAESOAEPParams(
    options?: {
        hashAlgorithm?: AlgorithmIdentifier;
        maskGenAlgorithm?: AlgorithmIdentifier;
        pSourceAlgorithm?: AlgorithmIdentifier;
    },
): RSAESOAEPParams
Creates a new instance of RSAESOAEPParams
Parameters
- options: {
      hashAlgorithm?: AlgorithmIdentifier;
      maskGenAlgorithm?: AlgorithmIdentifier;
      pSourceAlgorithm?: AlgorithmIdentifier;
  } = {}
  Configuration options for RSA OAEP parameters
  - OptionalhashAlgorithm?: AlgorithmIdentifier
    Hash algorithm to use (defaults to SHA-1)
  - OptionalmaskGenAlgorithm?: AlgorithmIdentifier
    Mask generation algorithm to use (defaults to MGF1 with SHA-1)
  - OptionalpSourceAlgorithm?: AlgorithmIdentifier
    Source algorithm for encoding parameters (defaults to pSpecified with empty string)
Returns RSAESOAEPParams
Overrides PkiBase.constructor
- Defined in packages/pki-lite/src/algorithms/RSAESOAEPParams.ts:57

Properties

`Optional`hashAlgorithm

hashAlgorithm?: AlgorithmIdentifier

`Optional`maskGenAlgorithm

maskGenAlgorithm?: AlgorithmIdentifier

`Optional`pSourceAlgorithm

pSourceAlgorithm?: PSourceAlgorithm

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

getEffectiveHashAlgorithm

getEffectiveHashAlgorithm(): AlgorithmIdentifier
Get effective hash algorithm (either specified or default)

Returns AlgorithmIdentifier
- Defined in packages/pki-lite/src/algorithms/RSAESOAEPParams.ts:163

getEffectiveMaskGenAlgorithm

getEffectiveMaskGenAlgorithm(): AlgorithmIdentifier
Get effective mask generation algorithm (either specified or default)

Returns AlgorithmIdentifier
- Defined in packages/pki-lite/src/algorithms/RSAESOAEPParams.ts:170

getEffectivePSourceAlgorithm

getEffectivePSourceAlgorithm(): AlgorithmIdentifier
Get effective P source algorithm (either specified or default)

Returns AlgorithmIdentifier
- Defined in packages/pki-lite/src/algorithms/RSAESOAEPParams.ts:179

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 to ASN.1 structure

Returns Asn1BaseBlock
Overrides PkiBase.toAsn1
- Defined in packages/pki-lite/src/algorithms/RSAESOAEPParams.ts:77

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

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 a string representation of this PKI object. Includes the type name and ASN.1 structure.

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

`Static`createDefault

createDefault(): RSAESOAEPParams
Creates a default instance with all parameters set to their defaults

Returns RSAESOAEPParams
- Defined in packages/pki-lite/src/algorithms/RSAESOAEPParams.ts:188

Class RSAESOAEPParams

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalhashAlgorithm?: AlgorithmIdentifier

OptionalmaskGenAlgorithm?: AlgorithmIdentifier

OptionalpSourceAlgorithm?: AlgorithmIdentifier

Returns RSAESOAEPParams

Properties

OptionalhashAlgorithm

OptionalmaskGenAlgorithm

OptionalpSourceAlgorithm

Accessors

pemHeader

Returns string

pkiType

Returns string

Methods

equals

Parameters

Returns boolean

getEffectiveHashAlgorithm

Returns AlgorithmIdentifier

getEffectiveMaskGenAlgorithm

Returns AlgorithmIdentifier

getEffectivePSourceAlgorithm

Returns AlgorithmIdentifier

parseAs

Type Parameters

Parameters

Returns T

toAsn1

Returns Asn1BaseBlock

toDer

Returns Uint8Array

toHumanString

Returns string

toJSON

Returns ToJson<T>

toPem

Returns string

toString

Returns string

StaticcreateDefault

Returns RSAESOAEPParams

StaticdefaultHashAlgorithm

Returns DigestAlgorithmIdentifier

StaticdefaultMaskGenAlgorithm

Returns AlgorithmIdentifier

StaticdefaultPSourceAlgorithm

Returns AlgorithmIdentifier

StaticfromAsn1

Parameters

Returns RSAESOAEPParams

Settings

On This Page

`Optional`hashAlgorithm?: AlgorithmIdentifier

`Optional`maskGenAlgorithm?: AlgorithmIdentifier

`Optional`pSourceAlgorithm?: AlgorithmIdentifier

`Optional`hashAlgorithm

`Optional`maskGenAlgorithm

`Optional`pSourceAlgorithm

`Static`createDefault

`Static`defaultHashAlgorithm

`Static`defaultMaskGenAlgorithm

`Static`defaultPSourceAlgorithm

`Static`fromAsn1