git ssb

0+

wanderer🌟 / bls-lib



Tree: 786bbae243555dcf10819e786d535cd40788c12b

Files: 786bbae243555dcf10819e786d535cd40788c12b / index.js

11983 bytesRaw
1const nop = require('nop')
2const Buffer = require('safe-buffer').Buffer
3const mod = require('./build/bls_lib.js')
4
5let init = false
6let initCb = nop
7
8exports.mod = mod
9
10/**
11 * takes a callback that is called once the module is setup
12 * @params {Function} cb - the callback tobe called once the module is intailized
13 */
14exports.onModuleInit = function (cb) {
15 if (init) {
16 cb()
17 } else {
18 init = true
19 initCb = cb
20 }
21}
22
23/**
24 * the FP254BNB curve
25 */
26exports.MCLBN_CURVE_FP254BNB = 0
27
28/**
29 * the FP382_1 curve
30 */
31exports.MCLBN_CURVE_FP382_1 = 1
32
33/**
34 * the FP382_2 curve
35 */
36exports.MCLBN_CURVE_FP382_2 = 2
37
38const MCLBN_FP_UNIT_SIZE = 6
39const FR_SIZE = MCLBN_FP_UNIT_SIZE * 8
40const ID_SIZE = FR_SIZE
41const G1_SIZE = FR_SIZE * 3
42const G2_SIZE = FR_SIZE * 3 * 2
43
44mod.onRuntimeInitialized = function () {
45 /**
46 * intailizes the libary to use a given curve
47 * @param {number} curve - the curves that can be used are MCLBN_CURVE_FP254BNB, MCLBN_CURVE_FP382_1 or MCLBN_CURVE_FP382_2
48 */
49 exports.init = function (curve = exports.MCLBN_CURVE_FP254BNB) {
50 return mod._blsInit(curve, MCLBN_FP_UNIT_SIZE)
51 }
52
53 /**
54 * allocates a secret key
55 * @returns {number} the pointer to the key
56 */
57 exports.secretKey = function () {
58 return mod._malloc(FR_SIZE)
59 }
60
61 /**
62 * allocates a secret key
63 * @returns {number} the pointer to the key
64 */
65 exports.publicKey = function () {
66 return mod._malloc(G2_SIZE)
67 }
68
69 /**
70 * allocates a signature
71 * @returns {number} the pointer to the signture
72 */
73 exports.signature = function () {
74 return mod._malloc(G1_SIZE)
75 }
76
77 /**
78 * frees a pointer
79 */
80 exports.free = function (x) {
81 mod._free(x)
82 }
83
84 /**
85 * frees an array of pointers
86 */
87 exports.freeArray = function (a) {
88 a.forEach(el => mod._free(el))
89 }
90
91 /**
92 * creates an ID from an int to use in with threshold groups
93 * @param {number} sk - a pointer to the secret key, secret key stuct is used to hold the id
94 * @param {number} n - a int repsenting the ID. n cannot be zero.
95 */
96 exports.idSetInt = function (sk, n) {
97 if (n === 0) {
98 throw new Error('id cannot be zero')
99 }
100 mod._blsIdSetInt(sk, n)
101 }
102
103 /**
104 * creates an ID from an int and returns a pointer to it
105 * @param {number} n - a int repsenting the ID. n cannot be zero.
106 * @return {number}
107 */
108 exports.idImportFromInt = function (n) {
109 const sk = exports.secretKey()
110 exports.idSetInt(sk, n)
111 return sk
112 }
113
114 /**
115 * creates an ID from an int and returns a pointer to it
116 * @param {number} n - a int repsenting the ID. n cannot be zero.
117 * @return {number}
118 */
119 exports.idImport = function (n) {
120 if (Number.isInteger(n)) {
121 return exports.idImportFromInt(n)
122 } else {
123 const sk = exports.secretKey()
124 mod._blsHashToSecretKey(sk, n)
125 return sk
126 }
127 }
128
129 /**
130 * signs a message
131 * @param {number} sig - a pointer to the a signature
132 * @param {number} sk - a pointer to the secret key
133 * @param {TypedArray|String} msg - the message to sign
134 */
135 exports.sign = wrapInput(mod._blsSign)
136
137 /**
138 * verifies a signature
139 * @param {number} sig - a pointer to the a signature
140 * @param {number} pk - a pointer to the secret key
141 * @param {TypedArray|String} msg - the message that was signed
142 * @returns {Boolean}
143 */
144 exports.verify = returnBool(wrapInput(mod._blsVerify))
145
146 /**
147 * given a pointer to a public key this returns 64 byte Int8Array containing the key
148 * @param {number} pk - a pointer to the secret key
149 * @return {TypedArray}
150 */
151 exports.publicKeyExport = wrapOutput(mod._blsPublicKeySerialize, 64)
152
153 /**
154 * given a pointer to a secret key this returns 32 byte Int8Array containing the key
155 * @param {number} pk - a pointer to the secret key
156 * @return {TypedArray}
157 */
158 exports.secretKeyExport = wrapOutput(mod._blsSecretKeySerialize, 32)
159
160 /**
161 * given a pointer to a signature this returns 32 byte Int8Array containing the signature
162 * @param {number} pk - a pointer to the secret key
163 * @return {TypedArray}
164 */
165 exports.signatureExport = wrapOutput(mod._blsSignatureSerialize, 32)
166
167 /**
168 * generates a secret key given a seed phrase.
169 * @param {number} sk - a pointer to a secret key
170 * @param {String|TypedArray} seed - the seed phrase
171 */
172 exports.hashToSecretKey = wrapInput(mod._blsHashToSecretKey)
173
174 /**
175 * write a secretKey to memory
176 * @param {number} sk - a pointer to a secret key
177 * @param {TypedArray} array - the secret key as a 32 byte TypedArray
178 */
179 exports.secretKeyDeserialize = wrapDeserialize(mod._blsSecretKeyDeserialize)
180
181 /**
182 * write a secretKey to memory and returns a pointer to it
183 * @param {number} sk - a pointer to a secret key
184 * @param {TypedArray} array - the secret key as a 32 byte TypedArray
185 * @return {Number}
186 */
187 exports.secretKeyImport = function (buf) {
188 const sk = exports.secretKey()
189 exports.secretKeyDeserialize(sk, buf)
190 return sk
191 }
192
193 /**
194 * write a publicKey to memory
195 * @param {number} sk - a pointer to a public key
196 * @param {TypedArray} array - the secret key as a 64 byte TypedArray
197 */
198 exports.publicKeyDeserialize = wrapDeserialize(mod._blsPublicKeyDeserialize)
199
200 /**
201 * write a publicKey to memory and returns a pointer to it
202 * @param {TypedArray} array - the secret key as a 64 byte TypedArray
203 * @return {Number}
204 */
205 exports.publicKeyImport = function (buf) {
206 const pk = exports.publicKey()
207 exports.publicKeyDeserialize(pk, buf)
208 return pk
209 }
210
211 /**
212 * write a signature to memory
213 * @param {number} sig - a pointer to a signature
214 * @param {TypedArray} array - the signature as a 32 byte TypedArray
215 */
216 exports.signatureDeserialize = wrapDeserialize(mod._blsSignatureDeserialize)
217
218 /**
219 * write a signature to memory and returns a pointer to it
220 * @param {TypedArray} array - the signature as a 32 byte TypedArray
221 * @return {Number}
222 */
223 exports.signatureImport = function (buf) {
224 const sig = exports.signature()
225 exports.signatureDeserialize(sig, buf)
226 return sig
227 }
228
229 /**
230 * Initialize a secret key by a Cryptographically Secure Pseudo Random Number Generator
231 * @param {TypedArray} array - the secret key as a TypedArray
232 */
233 exports.secretKeySetByCSPRNG = mod._blsSecretKeySetByCSPRNG
234
235 /**
236 * Create a public key from the secret key
237 * @param {TypedArray} array - the public key as a TypedArray
238 * @param {TypedArray} array - the secret key as a TypedArray
239 */
240 exports.getPublicKey = mod._blsGetPublicKey
241
242 /**
243 * Recovers a secret key for a group given the groups secret keys shares and the groups ids
244 * @param {number} sk - a pointer to a secret key that will be generated
245 * @param {Array<number>} sksArray - an array of pointers to the groups secret key shares. The length of the array should be the threshold number for the group
246 * @param {Array<numbers>} idArrah - an array of pointers to ids in the groups. The length of the array should be the threshold number for the group
247 */
248 exports.secretKeyRecover = wrapRecover(mod._blsSecretKeyRecover, FR_SIZE, ID_SIZE)
249
250 /**
251 * Recovers a public key for a group given the groups public keys shares and the groups ids
252 * @param {number} pk - a pointer to a public key that will be generated
253 * @param {Array<number>} pksArray - an array of pointers to the groups public key shares. The length of the array should be the threshold number for the group
254 * @param {Array<numbers>} idArrah - an array of pointers to ids in the groups. The length of the array should be the threshold number for the group
255 */
256 exports.publicKeyRecover = wrapRecover(mod._blsPublicKeyRecover, G2_SIZE, ID_SIZE)
257
258 /**
259 * Recovers a signature for a group given the groups public keys shares and the groups ids
260 * @param {number} sig - a pointer to the signature that will be generated
261 * @param {Array<number>} sigArray - an array of pointers to signature shares. The length of the array should be the threshold number for the group
262 * @param {Array<numbers>} idArrah - an array of pointers to ids in the groups. The length of the array should be the threshold number for the group
263 */
264 exports.signatureRecover = wrapRecover(mod._blsSignatureRecover, G1_SIZE, ID_SIZE)
265
266 /**
267 * 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
268 * @param {number} skshare - a pointer to a secret key that will be generated
269 * @param {Array<number>} msk - an array of master secret keys. The number of keys is the threshould of the group.
270 * @param {number} id - the id of the member
271 */
272 exports.secretKeyShare = wrapKeyShare(mod._blsSecretKeyShare, FR_SIZE)
273
274 /**
275 * 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
276 * @param {number} pkshare - a pointer to a secret key that will be generated
277 * @param {Array<number>} mpk - an array of master public keys. The number of keys is the threshould of the group.
278 * @param {number} id - the id of the member
279 */
280 exports.publicKeyShare = wrapKeyShare(mod._blsPublicKeyShare, G2_SIZE)
281
282 /**
283 * Take two publicKeys and adds them together. pubkey1 = pubkey1 + pubkey2
284 * @param {number} pubkey1 - a pointer to a public key
285 * @param {number} pubkey2 - a pointer to a public key
286 */
287 exports.publicKeyAdd = mod._blsPublicKeyAdd
288
289 /**
290 * Take two secretKeys and adds them together. seckey1 = seckey1 + seckey2
291 * @param {number} seckey1 - a pointer to a secret key
292 * @param {number} seckey2 - a pointer to a secret key
293 */
294 exports.secretKeyAdd = mod._blsSecretKeyAdd
295
296 /**
297 * Take two publicKeys and tests thier equality
298 * @param {number} pubkey1 - a pointer to a public key
299 * @param {number} pubkey2 - a pointer to a public key
300 * return {Boolean}
301 */
302 exports.publicKeyIsEqual = returnBool(mod._blsPublicKeyIsEqual)
303
304 /**
305 * Does Diffie–Hellman key exchange
306 * @param {number} sharedSecretKey - a pointer to a secretKey that will be populated with the shared secret
307 * @param {number} secretKey - a pointer to a secret key
308 * @param {number} pubkey - a pointer to a public key
309 */
310 exports.dhKeyExchange = mod._blsDHKeyExchange
311
312 initCb()
313}
314
315function returnBool (func) {
316 return function () {
317 return func.apply(null, arguments) === 1
318 }
319}
320
321function wrapInput (func) {
322 return function () {
323 const args = [...arguments]
324 let buf = args.pop()
325 if (typeof buf === 'string') {
326 buf = Buffer.from(buf)
327 }
328 const pos = mod._malloc(buf.length)
329
330 mod.HEAP8.set(buf, pos)
331 let r = func(...args, pos, buf.length)
332 mod._free(pos)
333 return r
334 }
335}
336
337function wrapDeserialize (func) {
338 return function (p, buf) {
339 const pos = mod._malloc(buf.length)
340 mod.HEAP8.set(buf, pos)
341 const r = func(p, pos, buf.length)
342 mod._free(pos)
343 if (r === 0) {
344 throw new Error('Deserialize err')
345 }
346 }
347}
348
349function wrapOutput (func, size) {
350 return function (x) {
351 const pos = mod._malloc(size)
352 const n = func(pos, size, x)
353 const a = mod.HEAP8.slice(pos, pos + n)
354 mod._free(pos)
355 return a
356 }
357}
358
359function wrapKeyShare (func, dataSize) {
360 return function (x, vec, id) {
361 const k = vec.length
362 const p = mod._malloc(dataSize * k)
363 for (let i = 0; i < k; i++) {
364 mod._memcpy(p + i * dataSize, vec[i], dataSize)
365 }
366 const r = func(x, p, k, id)
367 mod._free(p)
368 return r
369 }
370}
371
372function wrapRecover (func, dataSize, idDataSize) {
373 return function (x, vec, idVec) {
374 const n = vec.length
375 const p = mod._malloc(dataSize * n)
376 const q = mod._malloc(idDataSize * n)
377 for (let i = 0; i < n; i++) {
378 mod._memcpy(p + i * dataSize, vec[i], dataSize)
379 mod._memcpy(q + i * idDataSize, idVec[i], idDataSize)
380 }
381 const r = func(x, p, q, n)
382 mod._free(q)
383 mod._free(p)
384 return r
385 }
386}
387

Built with git-ssb-web