Class DilithiumSignature

Signature

Hierarchy

DilithiumSignature

Index

Constructors

Properties

Methods

getBytes toBase64 toHex verify fromBase64 fromBytes fromHex generate

Constructors

constructor

new DilithiumSignature(spec: DilithiumParameterSpec, bytes: Uint8Array): DilithiumSignature
Parameters
- spec: DilithiumParameterSpec
- bytes: Uint8Array
Returns DilithiumSignature
- Defined in signature.ts:139

Properties

bytes

bytes: Uint8Array

spec

spec: DilithiumParameterSpec

Methods

getBytes

getBytes(): Uint8Array
Returns
The private key as a byte array

Returns Uint8Array
- Defined in signature.ts:147

toBase64

toBase64(): string
Returns
The signature as a base 64 string

Returns string
- Defined in signature.ts:161

toHex

toHex(): string
Returns
The signature as a hex string

Returns string
- Defined in signature.ts:154

verify

verify(message: Uint8Array, publicKey: DilithiumPublicKey): boolean
Verifies the signature against a message + public key

Returns
True only if the signature is valid
Parameters
- message: Uint8Array
  
  The message
- publicKey: DilithiumPublicKey
  
  The public key
Returns boolean
- Defined in signature.ts:171

`Static` fromBase64

fromBase64(base64: string, level: DilithiumLevel): DilithiumSignature
Parses signature from base 64 string

Returns
The signature
Parameters
- base64: string
  
  The string
- level: DilithiumLevel
  
  The level specification
Returns DilithiumSignature
- Defined in signature.ts:135

`Static` fromBytes

fromBytes(bytes: Uint8Array, level: DilithiumLevel): DilithiumSignature
Parses signature from byte array

Returns
The signature
Parameters
- bytes: Uint8Array
  
  The byte array
- level: DilithiumLevel
  
  The level specification
Returns DilithiumSignature
- Defined in signature.ts:112

`Static` fromHex

fromHex(hex: string, level: DilithiumLevel): DilithiumSignature
Parses signature from hex string

Returns
The signature
Parameters
- hex: string
  
  The string
- level: DilithiumLevel
  
  The level specification
Returns DilithiumSignature
- Defined in signature.ts:125

`Static` generate

generate(message: Uint8Array, privateKey: DilithiumPrivateKey): DilithiumSignature
Generates a signature

Returns
The signature
Parameters
- message: Uint8Array
  
  The message to sign
- privateKey: DilithiumPrivateKey
  
  The private key to use for the signature
Returns DilithiumSignature
- Defined in signature.ts:28

Generated using TypeDoc