Skip to content

aellison5505/node-sidh

Repository files navigation

node-sidh

Globals

Build Status

node-sidh

Globals / "index" / Sha3

Class: Sha3

Hierarchy

  • Sha3

Index

Methods

Methods

shake256

shake256(input: Buffer, outLength: number): Promise<Buffer>

Defined in index.ts:177

Parameters:

Name Type
input Buffer
outLength number

Returns: Promise<Buffer>

node-sidh

Globals / "index" / SIDH

Class: SIDH

This class uses post-crypto SIDH and creates keyPairs and the shared secret.

Hierarchy

  • SIDH

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

+ new SIDH(): SIDH

Defined in index.ts:23

Returns: SIDH

Properties

PrivateKey

PrivateKey: Buffer

Defined in index.ts:20


PublicKey

PublicKey: Buffer

Defined in index.ts:21


SenderKey

SenderKey: Buffer

Defined in index.ts:22


SenderPublic

SenderPublic: Buffer

Defined in index.ts:23

Accessors

keyPair

• get keyPair(): keys

Defined in index.ts:63

Returns: keys


senderKeyPair

• get senderKeyPair(): keys

Defined in index.ts:70

Returns: keys

Methods

createKeyPair

createKeyPair(): Promise<keys>

Defined in index.ts:47

Creates a key pair

Returns: Promise<keys>

key object


createPubA

createPubA(privateKey: Buffer): Promise<Buffer>

Defined in index.ts:77

Parameters:

Name Type
privateKey Buffer

Returns: Promise<Buffer>


randomBytes

randomBytes(length: number): Promise<Buffer>

Defined in index.ts:36

Produces random bytes

Parameters:

Name Type Description
length number bytes

Returns: Promise<Buffer>


senderKeys

senderKeys(): Promise<keys>

Defined in index.ts:84

Returns: Promise<keys>


sharedKey

sharedKey(PrivateKey: Buffer, SenderPublicKey: Buffer): Promise<Buffer>

Defined in index.ts:100

Parameters:

Name Type
PrivateKey Buffer
SenderPublicKey Buffer

Returns: Promise<Buffer>


sharedKeySender

sharedKeySender(SenderPrivateKey: Buffer, PublicKey: Buffer): Promise<Buffer>

Defined in index.ts:106

Parameters:

Name Type
SenderPrivateKey Buffer
PublicKey Buffer

Returns: Promise<Buffer>

node-sidh

Globals / "index" / SIKE

Class: SIKE

This class implements the SIKE CryptoPQ.

Hierarchy

  • SIKE

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

+ new SIKE(): SIKE

Defined in index.ts:119

Returns: SIKE

Properties

PrivateKey

PrivateKey: Buffer

Defined in index.ts:118


PublicKey

PublicKey: Buffer

Defined in index.ts:119

Accessors

keyPair

• get keyPair(): keys

Defined in index.ts:139

Returns: keys

Methods

createKeyPair

createKeyPair(): Promise<keys>

Defined in index.ts:129

Returns: Promise<keys>

KeyPair as keys object


decrypt

decrypt(privateKey: Buffer, cipherBytes: Buffer): Promise<Buffer>

Defined in index.ts:166

Takes the privatekey and ciphered bytes and returns the decrypted bytes

Parameters:

Name Type Description
privateKey Buffer Key from key pair.
cipherBytes Buffer The encrypted bytes.

Returns: Promise<Buffer>

The decrypted shared bytes.


encrypt

encrypt(publicKey: Buffer): Promise<[Buffer, Buffer]>

Defined in index.ts:151

Takes a public key and returns 32 bytes of shared data, and the bytes encrypted.

Parameters:

Name Type Description
publicKey Buffer from SIKE key pair

Returns: Promise<[Buffer, Buffer]>

node-sidh

Globals

node-sidh

Index

Modules

node-sidh

Globals / "index" / keys

Interface: keys

Keys interface PrivateJey: Buffer PublicKey: Buffer

Hierarchy

  • keys

Index

Properties

Properties

PrivateKey

PrivateKey: Buffer

Defined in index.ts:11


PublicKey

PublicKey: Buffer

Defined in index.ts:12

node-sidh

Globals / "index"

Module: "index"

Index

Classes

Interfaces

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published