git ssb

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

Table of Contents

• onModuleInit
• MCLBN_CURVE_FP254BNB
• MCLBN_CURVE_FP382_1
• MCLBN_CURVE_FP382_2
• init
• secretKey
• publicKey
• signature
• free
• freeArray
• idSetInt
• idImportFromInt
• idImport
• sign
• verify
• publicKeyExport
• secretKeyExport
• signatureExport
• hashToSecretKey
• secretKeyDeserialize
• secretKeyImport
• publicKeyDeserialize
• publicKeyImport
• signatureDeserialize
• signatureImport
• secretKeySetByCSPRNG
• getPublicKey
• secretKeyRecover
• publicKeyRecover
• signatureRecover
• secretKeyShare
• publicKeyShare
• publicKeyAdd
• secretKeyAdd
• publicKeyIsEqual
• dhKeyExchange

onModuleInit

index.js:14-21

takes a callback that is called once the module is setup

Parameters

• cb

MCLBN_CURVE_FP254BNB

index.js:26-26

the FP254BNB curve

MCLBN_CURVE_FP382_1

index.js:31-31

the FP382_1 curve

MCLBN_CURVE_FP382_2

index.js:36-36

the FP382_2 curve

init

index.js:49-51

intailizes the libary to use a given curve

Parameters

• curve number the curves that can be used are MCLBN_CURVE_FP254BNB, MCLBN_CURVE_FP382_1 or MCLBN_CURVE_FP382_2 (optional, default exports.MCLBN_CURVE_FP254BNB)

secretKey

index.js:57-59

allocates a secret key

Returns number the pointer to the key

publicKey

index.js:65-67

allocates a secret key

Returns number the pointer to the key

signature

index.js:73-75

allocates a signature

Returns number the pointer to the signture

free

index.js:80-82

frees a pointer

Parameters

• x

freeArray

index.js:87-89

frees an array of pointers

Parameters

• a

idSetInt

index.js:96-101

creates an ID from an int to use in with threshold groups

Parameters

• sk number a pointer to the secret key, secret key stuct is used to hold the id
• n number a int repsenting the ID. n cannot be zero.

idImportFromInt

index.js:108-112

creates an ID from an int and returns a pointer to it

Parameters

• n number a int repsenting the ID. n cannot be zero.

Returns number

idImport

index.js:119-127

creates an ID from an int and returns a pointer to it

Parameters

• n number a int repsenting the ID. n cannot be zero.

Returns number

sign

index.js:135-135

signs a message

Parameters

• sig number a pointer to the a signature
• sk number a pointer to the secret key
• msg (TypedArray | String) the message to sign

verify

index.js:144-144

verifies a signature

Parameters

• sig number a pointer to the a signature
• pk number a pointer to the secret key
• msg (TypedArray | String) the message that was signed

Returns Boolean

publicKeyExport

index.js:151-151

given a pointer to a public key this returns 64 byte Int8Array containing the key

Parameters

• pk number a pointer to the secret key

Returns TypedArray

secretKeyExport

index.js:158-158

given a pointer to a secret key this returns 32 byte Int8Array containing the key

Parameters

• pk number a pointer to the secret key

Returns TypedArray

signatureExport

index.js:165-165

given a pointer to a signature this returns 32 byte Int8Array containing the signature

Parameters

• pk number a pointer to the secret key

Returns TypedArray

hashToSecretKey

index.js:172-172

generates a secret key given a seed phrase.

Parameters

• sk number a pointer to a secret key
• seed (String | TypedArray) the seed phrase

secretKeyDeserialize

index.js:179-179

write a secretKey to memory

Parameters

• sk number a pointer to a secret key
• array TypedArray the secret key as a 32 byte TypedArray

secretKeyImport

index.js:187-191

write a secretKey to memory and returns a pointer to it

Parameters

• buf
• sk number a pointer to a secret key
• array TypedArray the secret key as a 32 byte TypedArray

Returns Number

publicKeyDeserialize

index.js:198-198

write a publicKey to memory

Parameters

• sk number a pointer to a public key
• array TypedArray the secret key as a 64 byte TypedArray

publicKeyImport

index.js:205-209

write a publicKey to memory and returns a pointer to it

Parameters

• buf
• array TypedArray the secret key as a 64 byte TypedArray

Returns Number

signatureDeserialize

index.js:216-216

write a signature to memory

Parameters

• sig number a pointer to a signature
• array TypedArray the signature as a 32 byte TypedArray

signatureImport

index.js:223-227

write a signature to memory and returns a pointer to it

Parameters

• buf
• array TypedArray the signature as a 32 byte TypedArray

Returns Number

secretKeySetByCSPRNG

index.js:233-233

Initialize a secret key by a Cryptographically Secure Pseudo Random Number Generator

Parameters

• array TypedArray the secret key as a TypedArray

getPublicKey

index.js:240-240

Create a public key from the secret key

Parameters

• array TypedArray the public key as a TypedArray
• array TypedArray the secret key as a TypedArray

secretKeyRecover

index.js:248-248

Recovers a secret key for a group given the groups secret keys shares and the groups ids

Parameters

• sk number a pointer to a secret key that will be generated
• sksArray Array&lt;number> an array of pointers to the groups secret key shares. The length of the array should be the threshold number for the group
• idArrah Array&lt;numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group

publicKeyRecover

index.js:256-256

Recovers a public key for a group given the groups public keys shares and the groups ids

Parameters

• pk number a pointer to a public key that will be generated
• pksArray Array&lt;number> an array of pointers to the groups public key shares. The length of the array should be the threshold number for the group
• idArrah Array&lt;numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group

signatureRecover

index.js:264-264

Recovers a signature for a group given the groups public keys shares and the groups ids

Parameters

• sig number a pointer to the signature that will be generated
• sigArray Array&lt;number> an array of pointers to signature shares. The length of the array should be the threshold number for the group
• idArrah Array&lt;numbers> an array of pointers to ids in the groups. The length of the array should be the threshold number for the group

secretKeyShare

index.js:272-272

Creates a secket key share for a group member given the groups members id (which is a the secret key) and array of master secret keys

Parameters

• skshare number a pointer to a secret key that will be generated
• msk Array&lt;number> an array of master secret keys. The number of keys is the threshould of the group.
• id number the id of the member

publicKeyShare

index.js:280-280

Creates a public key share for a group member given the groups members id (which is a the secret key) and array of master public keys

Parameters

• pkshare number a pointer to a secret key that will be generated
• mpk Array&lt;number> an array of master public keys. The number of keys is the threshould of the group.
• id number the id of the member

publicKeyAdd

index.js:287-287

Take two publicKeys and adds them together. pubkey1 = pubkey1 + pubkey2

Parameters

• pubkey1 number a pointer to a public key
• pubkey2 number a pointer to a public key

secretKeyAdd

index.js:294-294

Take two secretKeys and adds them together. seckey1 = seckey1 + seckey2

Parameters

• seckey1 number a pointer to a secret key
• seckey2 number a pointer to a secret key

publicKeyIsEqual

index.js:302-302

Take two publicKeys and tests thier equality

Parameters

• pubkey1 number a pointer to a public key
• pubkey2 number a pointer to a public key return {Boolean}

dhKeyExchange

index.js:310-310

Does Diffie–Hellman key exchange

Parameters

• sharedSecretKey number a pointer to a secretKey that will be populated with the shared secret
• secretKey number a pointer to a secret key
• pubkey number a pointer to a public key