Class DilithiumKeyPair

Key pair (private + public)

Hierarchy

DilithiumKeyPair

Index

Constructors

Properties

Methods

getPrivateKey getPublicKey sign verifySignature fromKeys fromPrivateKey generate

Constructors

constructor

new DilithiumKeyPair(secret: DilithiumPrivateKey, pub?: DilithiumPublicKey): DilithiumKeyPair
Parameters
- secret: DilithiumPrivateKey
- Optional pub: DilithiumPublicKey
Returns DilithiumKeyPair
- Defined in key.ts:415

Properties

`Private` pub

pub: DilithiumPublicKey

`Private` secret

secret: DilithiumPrivateKey

Methods

getPrivateKey

getPrivateKey(): DilithiumPrivateKey
Returns
The private key

Returns DilithiumPrivateKey
- Defined in key.ts:423

getPublicKey

getPublicKey(): DilithiumPublicKey
Returns
The public key

Returns DilithiumPublicKey
- Defined in key.ts:430

sign

sign(message: Uint8Array): DilithiumSignature
Signs a message

Returns
The signature
Parameters
- message: Uint8Array
  
  The message
Returns DilithiumSignature
- Defined in key.ts:439

verifySignature

verifySignature(message: Uint8Array, sig: DilithiumSignature): boolean
Verifies a signature

Returns
True only if the signature is valid
Parameters
- message: Uint8Array
  
  The message
- sig: DilithiumSignature
  
  The signature
Returns boolean
- Defined in key.ts:449

`Static` fromKeys

fromKeys(secret: DilithiumPrivateKey, pub: DilithiumPublicKey): DilithiumKeyPair
Packs keys into a key pair

Returns
Parameters
- secret: DilithiumPrivateKey
  
  The private key
- pub: DilithiumPublicKey
  
  The public key
Returns DilithiumKeyPair
- Defined in key.ts:347

`Static` fromPrivateKey

fromPrivateKey(secret: DilithiumPrivateKey): DilithiumKeyPair
Creates a key pair from a private key

Returns
The key pair
Parameters
- secret: DilithiumPrivateKey
  
  Private key
Returns DilithiumKeyPair
- Defined in key.ts:337

`Static` generate

generate(level: DilithiumLevel, seed?: Uint8Array): DilithiumKeyPair
Generates a random keypair
Parameters
- level: DilithiumLevel
  
  The security level
- Optional seed: Uint8Array
  
  The seed for the generation of the key pair (if not prodiced, a random seed is generated)
Returns DilithiumKeyPair
- Defined in key.ts:356

Generated using TypeDoc