d0s3t3ch/RandomWOW
1
0
Fork 0
mirror of https://git.wownero.com/wownero/RandomWOW.git synced 2024-08-15 00:23:14 +00:00
Code Issues Projects Releases Wiki Activity

Changes recommended by Quarkslab (#111)

Browse source 
* Corrected bounds for some configuration parameters
* Clarifications in the specification
* Check validity of Argon2 parameters
This commit is contained in:
tevador 2019-08-25 13:47:21 +02:00 • committed by GitHub
parent 91f3edb5eb
commit 971f10c9c2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 30 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

8
doc/configuration.md
View file

@ -33,7 +33,7 @@ Not all of the parameters can be changed safely and most parameters have some co
This parameter determines the amount of memory needed in the light mode. Memory is specified in KiB (1 KiB = 1024 bytes).
#### Permitted values
Integer powers of 2 in the range 1 - 2097152.
Integer powers of 2 in the range 8 - 2097152.
#### Notes
Lower sizes will reduce the memory-hardness of the algorithm.
@ -43,7 +43,7 @@ Lower sizes will reduce the memory-hardness of the algorithm.
Determines the number of passes of Argon2 that are used to generate the Cache.
#### Permitted values
Any positive integer.
Any positive 32-bit integer.
#### Notes
The time needed to initialize the Cache is proportional to the value of this constant.
@ -53,7 +53,7 @@ The time needed to initialize the Cache is proportional to the value of this con
The number of parallel lanes for Cache initialization.
#### Permitted values
Any positive integer.
Integers in the range 1 - 16777215.
#### Notes
This parameter determines how many threads can be used for Cache initialization.
@ -63,7 +63,7 @@ This parameter determines how many threads can be used for Cache initialization.
Salt value for Cache initialization.
#### Permitted values
Any string of byte values.
A string of at least 8 characters.
#### Note
Every implementation should choose a unique salt value.

6
doc/specs.md
View file

@ -329,7 +329,7 @@ Floating point registers `f0`-`f3` are the "additive" registers, which can be th
Floating point registers `e0`-`e3` are the "multiplicative" registers, which can be the destination of floating point multiplication, division and square root instructions. Their value is always positive.
`ma` and `mx` are the memory registers. Both are 32 bits wide. `ma` contains the memory address of the next Dataset read and `mx` contains the address of the next Dataset prefetch.
`ma` and `mx` are the memory registers. Both are 32 bits wide. `ma` contains the memory address of the next Dataset read and `mx` contains the address of the next Dataset prefetch. The values of `ma` and `mx` registers are always aligned to be a multiple of 64.
The 2-bit `fprc` register determines the rounding mode of all floating point operations according to Table 4.3.1. The four rounding modes are defined by the IEEE 754 standard.
@ -422,7 +422,7 @@ Bits 0-3 of quadword 12 are used to select 4 address registers for program execu
#### 4.5.5 Dataset offset
The `datasetOffset` is calculated by bitwise AND of quadword 13 and the value `RANDOMX_DATASET_EXTRA_SIZE / 64`. The result is multiplied by `64`. This offset is used when reading values from the Dataset.
The `datasetOffset` is calculated as the remainder of dividing quadword 13 by `RANDOMX_DATASET_EXTRA_SIZE / 64 + 1`. The result is multiplied by `64`. This offset is used when reading values from the Dataset.
#### 4.5.6 Group E register masks
@ -882,7 +882,7 @@ The Dataset is a read-only memory structure that is used during program executio
In order to allow PoW verification with a lower amount of memory, the Dataset is constructed in two steps using an intermediate structure called the "Cache", which can be used to calculate Dataset items on the fly.
The whole Dataset is constructed from the key value `K`, which is an input parameter of RandomX. The whole Dataset needs to be recalculated everytime the key value changes. Fig. 7.1 shows the process of Dataset construction.
The whole Dataset is constructed from the key value `K`, which is an input parameter of RandomX. The whole Dataset needs to be recalculated everytime the key value changes. Fig. 7.1 shows the process of Dataset construction. Note: the maximum supported length of `K` is 60 bytes. Using a longer key results in implementation-defined behavior.
*Figure 7.1 - Dataset construction*