-
Notifications
You must be signed in to change notification settings - Fork 27
/
FuzzedDataProvider.ts
751 lines (710 loc) · 24.6 KB
/
FuzzedDataProvider.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
/*
* Copyright 2023 Code Intelligence GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Error class for functions that accept a length value which is thrown if that length is not a whole number to ensure
* the fuzzed data buffer is only ever indexed by whole numbers.
*/
export class FloatLengthError extends Error {
constructor() {
super();
this.name = "FLOAT_LENGTH_ERROR";
this.message = "length value must be an integer";
}
}
/**
* Helper class for reading primitive types from the bytes of the raw fuzzer input.
* Arrays are read from the beginning of the data buffer, whereas individual elements are read
* from the end of the data buffer.
* This implementation is based on the FuzzedDataProvider.h from the libFuzzer library
* https://github.com/llvm-mirror/compiler-rt/blob/master/include/fuzzer/FuzzedDataProvider.h
*/
export class FuzzedDataProvider {
private readonly data: Buffer;
private dataPtr = -1;
/** The number of remaining bytes that can be consumed from the fuzzer input data. */
_remainingBytes = 0;
/**
* A lookup table that maps input values to output characters in a cyclical manner.
* The output characters are evenly distributed across the range of printable ASCII characters (32-126)
*/
private lookupTable = new Uint8Array(256);
static readonly min_float = -3.4028235e38;
static readonly max_float = 3.4028235e38;
static readonly min_double = -Number.MAX_VALUE;
static readonly max_double = Number.MAX_VALUE;
/**
* @param data - a buffer containing the fuzzer input
*/
constructor(data: Buffer) {
this.data = data;
if (data.length > 0) {
this.dataPtr = 0;
this._remainingBytes = data.length;
}
/**
* Populate the lookup table with a mapping of input values to output characters
*/
let nextChar = 32;
for (let i = 0; i < 256; i++) {
this.lookupTable[i] = nextChar;
nextChar++;
if (nextChar > 126) {
nextChar = 32;
}
}
}
/**
* @returns the number of remaining bytes in the fuzzer input.
*/
get remainingBytes(): number {
return this._remainingBytes;
}
/**
* -----------------------------------------------------
* Functions for reading data from the back of fuzzer input in
* little-endian order.
* -----------------------------------------------------
*/
/**
* Consumes a byte from fuzzer input and converts it into boolean.
* @returns a `boolean` - if LSB is 0, returns `false`, otherwise `true`
*/
consumeBoolean(): boolean {
return (this.consumeIntegral(1) & 1) == 1;
}
/**
* Consumes an Integral number from the fuzzer input.
* @param maxNumBytes - the maximum number of bytes to consume from the fuzzer input data
* @param isSigned - whether the number is signed
* @returns an integral
*/
consumeIntegral(maxNumBytes: number, isSigned = false): number {
if (!Number.isInteger(maxNumBytes)) {
throw new FloatLengthError();
}
return this.consumeIntegralLEorBE(maxNumBytes, isSigned, true);
}
/**
* Consumes several bytes from fuzzer data and converts them to a number that is
* in the range of [min, max]. The number of bytes consumed is determined by
* the size of the range. If there is no more fuzzer data available, the returned
* number will be `min`.
* @param min lower bound of the range (inclusive)
* @param max upper bound of the range (inclusive)
* @returns a number in the provided range
*/
consumeIntegralInRange(min: number, max: number): number {
return this.consumeIntegralInRangeLEorBE(min, max, true);
}
/**
* Consumes a big integral from the fuzzer input.
* @param maxNumBytesToConsume - the maximum number of bytes to consume from the fuzzer input data
* @param isSigned - whether the number is signed
* @returns a big integral
*/
consumeBigIntegral(maxNumBytesToConsume: number, isSigned = false): bigint {
if (!Number.isInteger(maxNumBytesToConsume)) {
throw new FloatLengthError();
}
return this.consumeBigIntegralLEorBE(maxNumBytesToConsume, isSigned, true);
}
/**
* Consumes several bytes from fuzzer data and converts them to a bigint that is
* in the range of [min, max]. The number of bytes consumed is determined by
* the size of the range. If there is no more fuzzer data available, the returned
* number will be `min`.
* @param min lower bound of the range (inclusive)
* @param max upper bound of the range (inclusive)
* @returns a number in the provided range
*/
consumeBigIntegralInRange(min: bigint, max: bigint): bigint {
return this.consumeBigIntegralInRangeLEorBE(min, max, true);
}
/**
* Consumes am IEEE 754 floating-point number from the fuzzer input.
* The number is read as is, without any conversion.
* @returns a `number` that may have a special value (e.g. a NaN or infinity)
*/
consumeNumber(): number {
if (this._remainingBytes == 0) return 0;
if (this._remainingBytes < 8) {
// not enough data: copy to a larger buffer
const copiedData = Buffer.alloc(8);
this.data.copy(
copiedData,
8 - this._remainingBytes,
this.dataPtr,
this.dataPtr + this._remainingBytes,
);
this._remainingBytes = 0;
return copiedData.readDoubleLE();
}
this._remainingBytes -= 8;
return this.data.readDoubleLE(this.dataPtr + this._remainingBytes);
}
/**
* Consumes at most 9 bytes from fuzzer input and converts them to an
* IEEE-754 number in the range [min, max].
* @param min - lower bound of the range (inclusive)
* @param max - upper bound of the range (inclusive)
* @returns a `number` in the provided range
*/
consumeNumberInRange(min: number, max: number) {
return this.consumeDoubleInRange(min, max);
}
/**
* Consumes a 32-bit `float` from the fuzzer input.
* @returns a `float` that may have a special value (e.g. a NaN or infinity)
*/
consumeFloat(): number {
return this.consumeFloatInRange(
FuzzedDataProvider.min_float,
FuzzedDataProvider.max_float,
);
}
/**
* Consumes a 32-bit `float` from fuzzer input and converts it to an
* IEEE-754 number in the range [min, max].
* @param min - lower bound of the range (inclusive)
* @param max - upper bound of the range (inclusive)
* @returns a `float` in the provided range
*/
consumeFloatInRange(min: number, max: number): number {
if (min == max) return min;
if (min > max) throw new Error("min must be less than or equal to max");
let range: number;
let result = min;
if (min < 0.0 && max > 0.0 && max > min + FuzzedDataProvider.max_float) {
range = max / 2.0 - min / 2.0;
if (this.consumeBoolean()) {
result += range;
}
} else {
range = max - min;
}
return result + range * this.consumeProbabilityFloat();
}
/**
* Consumes a 64-bit `double` from fuzzer input.
* This is the approach used by libFuzzer to get double numbers from the fuzzer input.
* @returns a IEEE-754 `double`
*/
consumeDouble(): number {
return this.consumeDoubleInRange(
FuzzedDataProvider.min_double,
FuzzedDataProvider.max_double,
);
}
/**
* Consumes at most 9 bytes from fuzzer input and converts them to an
* IEEE-754 number in the range [min, max].
* @param min - lower bound of the range (inclusive)
* @param max - upper bound of the range (inclusive)
* @returns a `number` in the provided range
*/
consumeDoubleInRange(min: number, max: number): number {
if (min == max) return min;
if (min > max) throw new Error("min must be less than or equal to max");
let range: number;
let result = min;
if (min < 0.0 && max > 0.0 && max > min + FuzzedDataProvider.max_double) {
range = max / 2.0 - min / 2.0;
if (this.consumeBoolean()) {
result += range;
}
} else {
range = max - min;
}
return result + range * this.consumeProbabilityDouble();
}
/**
* Consumes 4 bytes from the fuzzer input.
* @returns a number in the range [0.0, 1.0]
*/
consumeProbabilityFloat(): number {
return this.consumeIntegral(4) / 0xffffffff;
}
/**
* Consumes 8 bytes from the fuzzer input and converts them to an IEEE-754`number`
* in the range [0.0, 1.0].
* @returns a number in the range [0.0, 1.0]
*/
consumeProbabilityDouble(): number {
const n = this.consumeBigIntegral(8, false);
const d = (BigInt(0xffffffff) << BigInt(32)) | BigInt(0xffffffff);
return Number(n) / Number(d);
}
/**
* Picks an element from `array` based on the fuzzer input.
* Note:The distribution of picks is not perfectly uniform.
* Note: For array sizes > 48 bits, this function will throw an error.
* @param array an `array` of type T to pick an element from.
* @returns an element from `array` chosen based on the fuzzer input
*/
pickValue<Type>(array: Array<Type>): Type {
if (array.length == 0) throw new Error("provided array is empty");
return array[this.consumeIntegralInRange(0, array.length - 1)];
}
/**
* -----------------------------------------------------
* Functions for reading data from the front of fuzzer input in
* big-endian order.
* -----------------------------------------------------
*/
/**
* Consumes an array of booleans from the fuzzer input.
* The array might be shorter than requested `maxLength` if the fuzzer input
* is not sufficiently long.
* @param maxLength - the maximum length of the array
* @returns an array of booleans
*/
consumeBooleans(maxLength: number): boolean[] {
if (!Number.isInteger(maxLength)) {
throw new FloatLengthError();
}
const arrayLength = Math.min(this._remainingBytes, maxLength);
const result = new Array<boolean>(arrayLength);
for (let i = 0; i < arrayLength; i++) {
result[i] = (this.data[this.dataPtr + i] & 1) == 1;
}
this._remainingBytes -= arrayLength;
this.dataPtr += arrayLength;
return result;
}
/**
* Consumes an array of integrals from fuzzer data.
* The array might be shorter than requested `maxLength` if the fuzzer input
* is not sufficiently long.
* @param maxLength - number of integers to consume
* @param numBytesPerIntegral - number of bytes to consume for each integral
* @param isSigned - whether the integrals are signed
* @returns an array of integrals
*/
consumeIntegrals(
maxLength: number,
numBytesPerIntegral: number,
isSigned = false,
): number[] {
if (
!Number.isInteger(maxLength) ||
!Number.isInteger(numBytesPerIntegral)
) {
throw new FloatLengthError();
}
const arrayLength = this.computeArrayLength(maxLength, numBytesPerIntegral);
const result = new Array<number>();
for (let i = 0; i < arrayLength; i++) {
result[i] = this.consumeIntegralLEorBE(
numBytesPerIntegral,
isSigned,
false,
);
}
return result;
}
/**
* Consumes an array of big integrals from fuzzer data.
* The array might be shorter than requested `maxLength` if the fuzzer input
* is not sufficiently long.
* @param maxLength - maximum number of integrals to consume
* @param numBytesPerIntegral - number of bytes to consume for each integral
* @param isSigned - whether the integrals are signed
* @returns an array of big integrals
*/
consumeBigIntegrals(
maxLength: number,
numBytesPerIntegral: number,
isSigned = false,
): bigint[] {
if (
!Number.isInteger(maxLength) ||
!Number.isInteger(numBytesPerIntegral)
) {
throw new FloatLengthError();
}
const arrayLength = this.computeArrayLength(maxLength, numBytesPerIntegral);
const result: bigint[] = new Array<bigint>(arrayLength);
for (let i = 0; i < arrayLength; i++) {
result[i] = this.consumeBigIntegralLEorBE(
numBytesPerIntegral,
isSigned,
false,
);
}
return result;
}
/**
* Consumes an array of numbers from the fuzzer input.
* The array might be shorter than requested `maxLength` if the fuzzer input
* is not sufficiently long.
* @param maxLength the maximum length of the array
* @returns an array of numbers
*/
consumeNumbers(maxLength: number): number[] {
if (!Number.isInteger(maxLength)) {
throw new FloatLengthError();
}
const arrayLength = this.computeArrayLength(maxLength, 8);
const result: number[] = new Array(arrayLength);
for (let i = 0; i < arrayLength; i++) {
result[i] = this.consumeNumberBE();
}
return result;
}
/**
* Consumes a byte array from fuzzer input.
* The array might be shorter than requested `maxLength` if the fuzzer input
* is not sufficiently long.
* @param maxLength - the maximum length of the output array
* @returns a byte array of length at most `maxLength`
*/
consumeBytes(maxLength: number): number[] {
if (!Number.isInteger(maxLength)) {
throw new FloatLengthError();
}
const arrayLength = Math.min(this._remainingBytes, maxLength);
const result = new Array<number>(arrayLength);
for (let i = 0; i < arrayLength; i++) {
result[i] = this.data[this.dataPtr + i];
}
this._remainingBytes -= arrayLength;
this.dataPtr += arrayLength;
return result;
}
/**
* Consumes the remaining fuzzer input as a byte array.
* Note: After calling this method, further calls to methods of this interface will
* return fixed values only.
* @returns a `byte` array
*/
consumeRemainingAsBytes(): number[] {
return this.consumeBytes(this._remainingBytes);
}
/**
* Consumes a `string` from the fuzzer input.
* The array might be shorter than requested `maxLength` if the fuzzer input
* is not sufficiently long.
* @param maxLength the maximum length of the string
* @param encoding the encoding of the string
* @param printable - a boolean, which defaults to false that indicates whether consumed strings
* should be forced to contain only valid printable characters
* @returns a `string` of length between 0 and `maxLength` (inclusive)
*/
consumeString(
maxLength: number,
encoding: BufferEncoding | undefined = "ascii",
printable: boolean | undefined = false,
): string {
if (maxLength < 0) throw new Error("maxLength must be non-negative");
if (!Number.isInteger(maxLength)) {
throw new FloatLengthError();
}
let result;
const arrayLength = Math.min(maxLength, this._remainingBytes);
if (printable) {
result = this.bufToPrintableString(
this.data,
this.dataPtr,
this.dataPtr + arrayLength,
encoding,
);
} else {
result = this.data.toString(
encoding,
this.dataPtr,
this.dataPtr + arrayLength,
);
}
this.dataPtr += arrayLength;
this._remainingBytes -= arrayLength;
return result;
}
/**
* Helper function that converts the given string type into one that only
* contains printable characters. Elements in `buf` that are already in
* ASCII printable range are not undergoing any conversion.
* Known limitations:
* numbers [32; 97] will have the probability of about 0.01172 of occuring,
* numbers [98; 126] will have probability of 0.00781 of occurring.
* @param buf - Buffer that contains arbitrary values
* @param min - lower bound at which processing of the provided `Buffer` shall begin
* @param max - upper bound, analogous to the lower bound
* @param encoding - a valid `BufferEncoding`.
* @returns a string that was sanitized and only contains printable characters
*/
private bufToPrintableString(
buf: Buffer,
min: number,
max: number,
encoding: BufferEncoding,
): string {
const newBuf = new Uint8Array(max - min);
for (let i = min; i < max; i++) {
newBuf[i - min] = this.lookupTable[buf[i]];
}
return new TextDecoder(encoding).decode(newBuf);
}
/**
* Consumes the remaining bytes of the fuzzer input as a string.
* @param encoding - the encoding of the string
* @param printable - a boolean, which defaults to false that indicates whether consumed strings
* should be forced to contain only valid printable characters
* @returns a string constructed from the remaining bytes of the fuzzer input using the given encoding
*/
consumeRemainingAsString(
encoding: BufferEncoding | undefined = "ascii",
printable: boolean | undefined = false,
): string {
return this.consumeString(this._remainingBytes, encoding, printable);
}
/**
* Consumes an array of `string`s from the fuzzer input.
* The array and the `string`s might be shorter than requested `maxArrayLength` and `maxStringLength`,
* if the fuzzer input is not sufficiently long.
* @param maxArrayLength the maximum length of the array
* @param maxStringLength the maximum length of the strings
* @param encoding the encoding of the strings
* @param printable - a boolean, which defaults to false that indicates whether consumed strings
* should be forced to contain only valid printable characters
* @returns an array containing strings constructed from the remaining bytes of the fuzzer input using the given encoding
*/
consumeStringArray(
maxArrayLength: number,
maxStringLength: number,
encoding: BufferEncoding | undefined = "ascii",
printable: boolean | undefined = false,
) {
if (
!Number.isInteger(maxArrayLength) ||
!Number.isInteger(maxStringLength)
) {
throw new FloatLengthError();
}
const strs = [];
while (strs.length < maxArrayLength && this.remainingBytes > 0) {
const str = this.consumeString(maxStringLength, encoding, printable);
if (str || str === "") {
strs.push(str);
}
}
return strs;
}
/**
* Picks values from an array based on the fuzzer input.
* Indices picked by this method do not repeat for the duration of the function call.
* Note: The distribution of picks is not perfectly uniform.
* @param array the `array` to pick elements from.
* @param numValues the number of values to pick.
* @returns an array of size `numValues` from `array` chosen based on the
* fuzzer input
*/
pickValues<Type>(array: Array<Type>, numValues: number): Array<Type> {
if (array.length == 0) throw new Error("array must not be empty");
if (!Number.isInteger(numValues)) {
throw new FloatLengthError();
}
if (numValues < 0) throw new Error("numValues must not be negative");
if (numValues > array.length)
throw new Error("numValues must not be greater than the array length");
const result = new Array<Type>(numValues);
const remainingArray = array.slice();
for (let i = 0; i < numValues; i++) {
const index = this.consumeIntegralInRange(0, remainingArray.length - 1);
result[i] = remainingArray[index];
remainingArray.splice(index, 1);
}
return result;
}
/**
* -----------------------------------------------------
* Internal helper functions
* -----------------------------------------------------
*/
/**
* Consumes an IEEE 754 floating-point number from the front of fuzzer input.
* @private
* @returns a `number`
*/
private consumeNumberBE(): number {
if (this._remainingBytes == 0) return 0;
// check that we have enough data
if (this._remainingBytes < 8) {
const copiedData = Buffer.alloc(8);
this.data.copy(
copiedData,
0,
this.dataPtr,
this.dataPtr + this._remainingBytes,
);
this._remainingBytes = 0;
return copiedData.readDoubleBE();
}
this._remainingBytes -= 8;
const result = this.data.readDoubleBE(this.dataPtr);
this.dataPtr += 8;
return result;
}
/**
* Consumes an integral from the front of fuzzer input.
* @param maxNumBytes - maximum number of bytes to consume. Must be between 0 and 6.
* For larger numbers, use `consumeBigIntLEorBE`.
* @param isSigned - whether the integer is signed or not
* @param isLittleEndian - whether the integer is little endian or not
* @returns an integral
*/
private consumeIntegralLEorBE(
maxNumBytes: number,
isSigned = false,
isLittleEndian = true,
): number {
if (maxNumBytes < 0 || maxNumBytes > 6) {
throw new Error(
"maxNumBytes must be between 0 and 6: use the corresponding *BigIntegral function instead",
);
}
const min = isSigned ? -(2 ** (8 * maxNumBytes - 1)) : 0;
const max = isSigned
? 2 ** (8 * maxNumBytes - 1) - 1
: 2 ** (8 * maxNumBytes) - 1;
return this.consumeIntegralInRangeLEorBE(min, max, isLittleEndian);
}
/**
* Consumes several bytes from fuzzer data and converts them to a number that is
* in the range of [min, max]. The number of bytes consumed is determined by
* the size of the range. If there is no input data left, the returned number
* will be `min`
* @param min lower bound of the range (inclusive)
* @param max upper bound of the range (inclusive)
* @param isLittleEndian bytes are read in little- or big-endian order. Little-endian
* signifies that the bytes are considered parameters and thus read from the back of
* the fuzzer data. Big-endian signifies that the bytes are considered data and thus
* read from the front of the fuzzer data.
* @returns a number in the provided range
*/
private consumeIntegralInRangeLEorBE(
min: number,
max: number,
isLittleEndian = true,
): number {
if (min == max) return min;
if (min > max) throw new Error("min must be less than or equal to max");
if (this._remainingBytes == 0) return min;
if (max > Number.MAX_SAFE_INTEGER)
throw new Error(
"max is too large: use the corresponding *BigIntegral function instead",
);
const range = max - min;
const numBytesToRepresentRange = Math.ceil(Math.log2(range + 1) / 8);
const numBytesToConsume = Math.min(
this._remainingBytes,
numBytesToRepresentRange,
);
if (numBytesToConsume > 6) {
throw new Error(
"requested range exceeds 2**48-1: use the corresponding *BigIntegral function instead",
);
}
this._remainingBytes -= numBytesToConsume;
let result: number;
if (isLittleEndian) {
result = this.data.readUIntLE(
this.dataPtr + this._remainingBytes,
numBytesToConsume,
);
} else {
result = this.data.readUIntBE(this.dataPtr, numBytesToConsume);
this.dataPtr += numBytesToConsume;
}
return min + (result % (range + 1));
}
/**
* Consumes an integral from the front of fuzzer input.
* @param maxNumBytes - maximum number of bytes to consume. Must be between 1 and 6.
* For larger numbers, use `consumeBigIntLEorBE`.
* @param isSigned - whether the integer is signed or not
* @param isLittleEndian - whether the integer is little endian or not
* @returns an integral
*/
private consumeBigIntegralLEorBE(
maxNumBytes: number,
isSigned = false,
isLittleEndian = true,
): bigint {
let min, max;
if (isSigned) {
min = BigInt(-(2 ** (maxNumBytes * 8 - 1)));
max = BigInt(2 ** (maxNumBytes * 8 - 1) - 1);
} else {
min = BigInt(0);
max = (BigInt(1) << BigInt(maxNumBytes * 8)) - BigInt(1);
}
return this.consumeBigIntegralInRangeLEorBE(min, max, isLittleEndian);
}
/**
* Consumes several bytes from fuzzer data and converts them to a bigint that is
* in the range of [min, max]. The number of bytes consumed is determined by
* the size of the range. If there is no input data left, the returned number
* will be `min`
* @param min lower bound of the range (inclusive)
* @param max upper bound of the range (inclusive)
* @param isLittleEndian bytes are read in little- or big-endian order. Little-endian
* signifies that the bytes are considered parameters and thus read from the back of
* the fuzzer data. Big-endian signifies that the bytes are considered data and thus
* read from the front of the fuzzer data.
* @returns a bigint in the provided range
*/
private consumeBigIntegralInRangeLEorBE(
min: bigint,
max: bigint,
isLittleEndian = true,
): bigint {
if (min == max) return min;
if (min > max) throw new Error("min must be less than or equal to max");
const range: bigint = max - min;
let offset = BigInt(0);
let result = BigInt(0);
let nextByte: bigint;
while (range >> offset > BigInt(0) && this._remainingBytes > 0) {
this._remainingBytes--;
if (isLittleEndian) {
nextByte = BigInt(this.data[this.dataPtr + this._remainingBytes]);
} else {
nextByte = BigInt(this.data[this.dataPtr]);
this.dataPtr++;
}
result = (result << BigInt(8)) | nextByte;
offset += BigInt(8);
}
return (result % (range + BigInt(1))) + min;
}
/**
* Computes how many elements (defined by the number of bytes per element) can be read
* from the fuzzer input data.
* @param maxLength - maximum number of elements to read
* @param numBytesPerElement - number of bytes used by each element
* @returns number of elements that can be read
*/
private computeArrayLength(
maxLength: number,
numBytesPerElement: number,
): number {
const numAvailableBytes = Math.min(
this._remainingBytes,
maxLength * numBytesPerElement,
);
return Math.ceil(numAvailableBytes / numBytesPerElement);
}
}