Class RSAPrivateKey

Represents the PrivateKeyInfo structure described in RFC3447

Hierarchy

PkiObject
- RSAPrivateKey

Implements

IRSAPrivateKey

Index

Constructors

constructor

new RSAPrivateKey(parameters?: RSAPrivateKeyParameters): RSAPrivateKey
Initializes a new instance of the RSAPrivateKey class
Parameters
- parameters: RSAPrivateKeyParameters = {}
  
  Initialization parameters
Returns RSAPrivateKey
Overrides PkiObject.constructor
- Defined in src/RSAPrivateKey.ts:82

Properties

coefficient

coefficient: Integer

exponent1

exponent1: Integer

exponent2

exponent2: Integer

modulus

modulus: Integer

`Optional` otherPrimeInfos

otherPrimeInfos?: OtherPrimeInfo[]

prime1

prime1: Integer

prime2

prime2: Integer

privateExponent

privateExponent: Integer

publicExponent

publicExponent: Integer

version

version: number

`Static` CLASS_NAME

CLASS_NAME: string = "RSAPrivateKey"

Name of the class

Accessors

className

get className(): string
Returns string
Inherited from PkiObject.className
- Defined in src/PkiObject.ts:65

Methods

fromJSON

fromJSON(json: any): void
Converts JSON value into current object
Parameters
- json: any
  
  JSON object
Returns void
- Defined in src/RSAPrivateKey.ts:303

fromSchema

fromSchema(schema: any): void
Converts parsed ASN.1 object into current class
Parameters
- schema: any
  
  ASN.1 schema
Returns void
Overrides PkiObject.fromSchema
- Defined in src/RSAPrivateKey.ts:209

toJSON

toJSON(): RSAPrivateKeyJson
Converts the class to JSON object

Returns
JSON object

Returns RSAPrivateKeyJson
Overrides PkiObject.toJSON
- Defined in src/RSAPrivateKey.ts:281

toSchema

toSchema(): Sequence
Converts current object to ASN.1 object and sets correct values

Returns
ASN.1 object

Returns Sequence
Overrides PkiObject.toSchema
- Defined in src/RSAPrivateKey.ts:253

toString

toString(encoding?: "base64" | "base64url" | "hex"): string
Parameters
- encoding: "base64" | "base64url" | "hex" = "hex"
Returns string
Inherited from PkiObject.toString
- Defined in src/PkiObject.ts:88

`Static` blockName

blockName(): string
Returns block name

Returns
Returns string block name

Returns string
Inherited from PkiObject.blockName
- Defined in src/PkiObject.ts:27

`Static` defaultValues

defaultValues(memberName: "version"): number
Returns default values for all class members

Returns
Default value
Parameters
- memberName: "version"
  
  String name for a class member
Returns number
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:112
defaultValues(memberName: "modulus"): Integer
Parameters
- memberName: "modulus"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:113
defaultValues(memberName: "publicExponent"): Integer
Parameters
- memberName: "publicExponent"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:114
defaultValues(memberName: "privateExponent"): Integer
Parameters
- memberName: "privateExponent"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:115
defaultValues(memberName: "prime1"): Integer
Parameters
- memberName: "prime1"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:116
defaultValues(memberName: "prime2"): Integer
Parameters
- memberName: "prime2"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:117
defaultValues(memberName: "exponent1"): Integer
Parameters
- memberName: "exponent1"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:118
defaultValues(memberName: "exponent2"): Integer
Parameters
- memberName: "exponent2"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:119
defaultValues(memberName: "coefficient"): Integer
Parameters
- memberName: "coefficient"
Returns Integer
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:120
defaultValues(memberName: "otherPrimeInfos"): OtherPrimeInfo[]
Parameters
- memberName: "otherPrimeInfos"
Returns OtherPrimeInfo[]
Overrides PkiObject.defaultValues
- Defined in src/RSAPrivateKey.ts:121

`Static` fromBER

fromBER<T>(this: PkiObjectConstructor<T>, raw: BufferSource): T
Creates PKI object from the raw data

Returns
Initialized and filled current class object
Type Parameters
- T extends PkiObject<T>
Parameters
- this: PkiObjectConstructor<T>
- raw: BufferSource
  
  ASN.1 encoded raw data
Returns T
Inherited from PkiObject.fromBER
- Defined in src/PkiObject.ts:36

`Static` schema

schema(parameters?: SchemaParameters<{ coefficient?: string; exponent1?: string; exponent2?: string; modulus?: string; otherPrimeInfo?: OtherPrimeInfoSchema; otherPrimeInfosName?: string; prime1?: string; prime2?: string; privateExponent?: string; publicExponent?: string; version?: string }>): any
Returns value of pre-defined ASN.1 schema for current class

Returns
ASN.1 schema object
Parameters
- parameters: SchemaParameters<{ coefficient?: string; exponent1?: string; exponent2?: string; modulus?: string; otherPrimeInfo?: OtherPrimeInfoSchema; otherPrimeInfosName?: string; prime1?: string; prime2?: string; privateExponent?: string; publicExponent?: string; version?: string }> = {}
  
  Input parameters for the schema
Returns any
Overrides PkiObject.schema
- Defined in src/RSAPrivateKey.ts:169

Class RSAPrivateKey

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parameters: RSAPrivateKeyParameters = {}

Returns RSAPrivateKey

Properties

coefficient

exponent1

exponent2

modulus

Optional otherPrimeInfos

prime1

prime2

privateExponent

publicExponent

version

Static CLASS_NAME

Accessors

className

Returns string

Methods

fromJSON

Parameters

json: any

Returns void

fromSchema

Parameters

schema: any

Returns void

toJSON

Returns

Returns RSAPrivateKeyJson

toSchema

Returns

Returns Sequence

toString

Parameters

encoding: "base64" | "base64url" | "hex" = "hex"

Returns string

Static blockName

Returns

Returns string

Static defaultValues

Returns

Parameters

memberName: "version"

Returns number

Parameters

memberName: "modulus"

Returns Integer

Parameters

memberName: "publicExponent"

Returns Integer

Parameters

memberName: "privateExponent"

Returns Integer

Parameters

memberName: "prime1"

Returns Integer

Parameters

memberName: "prime2"

Returns Integer

Parameters

memberName: "exponent1"

Returns Integer

Parameters

memberName: "exponent2"

Returns Integer

Parameters

memberName: "coefficient"

Returns Integer

Parameters

`Optional` otherPrimeInfos

`Static` CLASS_NAME

`Static` blockName

`Static` defaultValues

`Static` fromBER

`Static` schema