Friday, 15 December 2017
arrow JDiceChecker 5.0.0.1 arrow RandomTest arrow ApproximateEntropyTest.java
ApproximateEntropyTest.java (Approximate Entropy random number test class) Print E-mail
Get C++ DiceLock cipher architecture source code packages of DiceLock for Microsoft Visual Studio 2013 and DiceLock-x for Linux with Test Driver Programs and Response Test Vector files to verify that both them work as expected.
DiceLock for Windows and Linux
DiceLock Security governing software licenses are Free/Libre Source Code License and Educational and Research License
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
 
//
// Creator:    http://www.dicelocksecurity.com
// Version:    vers.5.0.0.1
//
// Copyright 2011 DiceLock Security, LLC. All rights reserved.
//
//                               DISCLAIMER
//
// THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// DICELOCK IS A REGISTERED TRADEMARK OR TRADEMARK OF THE OWNERS.
// 
// Environment:
// java version "1.6.0_29"
// Java(TM) SE Runtime Environment (build 1.6.0_29-b11)
// Java HotSpot(TM) Server VM (build 20.4-b02, mixed mode)
// 
 
package com.dicelocksecurity.jdicechecker.RandomTest;
 
import com.dicelocksecurity.jdicechecker.CryptoRandomStream.*;
 
/**
 * Class implementing Approximate Entropy random number test
 * 
 * @author      Angel Ferré @ DiceLock Security
 * @version     5.0.0.1
 * @since       2011-09-30
 */
public class ApproximateEntropyTest extends BaseRandomTest {
 
  /**
   * Random Test Class enumerator name
   */
    protected static final RandomTests  TEST =  RandomTests.ApproximateEntropy;
  /**
   * Random Test Class minimum stream length
   */
    protected static final int MINIMUMLENGTH = 1024;
 
  /**
   * "blockLength" length in bits of block division
   */
    protected int     blockLength;
  /**
   * "chiSquared" result
   */
    protected double  chiSquared;
  /**
   * "phi" result
   */
    protected double  phi;
  /**
   * "phiPlusOne" result
   */
    protected double  phiPlusOne;
  /**
   * "apEn" result
   */
    protected double  apEn;
  /**
   * "blockSizeExceeded" result
   * true:  if "blockLength" greater than recommended
   * false: if "blockLength" can be used to verify Approximate Entropy test
   */
    protected boolean blockSizeExceeded;    
  /**
   * "maximumBlockSizeRecommended" based on stream length in bits
   */
    protected int     maximumBlockSizeRecommended;   
 
  /**
   * Constructor, default 
   */ 
    public ApproximateEntropyTest() {
 
      super();
 
        this.blockLength = 10;
        this.chiSquared = 0.0;
        this.phi = 0.0;
        this.phiPlusOne = 0.0;
        this.apEn = 0.0;
        this.blockSizeExceeded = false;    
        this.maximumBlockSizeRecommended = 0;   
    }
 
  /**
   * Constructor with a MathematicalFunctions object instantiated 
   * 
   * @param     mathFuncObj   mathematicalFunctions object that will be used by this object
   */ 
    public ApproximateEntropyTest(MathematicalFunctions mathFuncObj) {
    
        super(mathFuncObj);
    
        this.blockLength = 10;
    this.chiSquared = 0.0;
    this.phi = 0.0;
    this.phiPlusOne = 0.0;
    this.apEn = 0.0;
    this.blockSizeExceeded = false;    
    this.maximumBlockSizeRecommended = 0;   
    }
 
  /**
   * Destructor, zeroes all data
   * 
   */ 
    public void finalize() {
    
    this.blockLength = 0;
    this.chiSquared = 0.0;
    this.phi = 0.0;
    this.phiPlusOne = 0.0;
    this.apEn = 0.0;
    this.blockSizeExceeded = false;    
    this.maximumBlockSizeRecommended = 0;   
    }
 
  /**
   * Gets the BaseRandomTest random state of the last executed BaseCryptoRandomStream
   * 
   * @return    boolean indication if last computed CryptoRandomStream was a randomized stream
   *            true:   last verified stream was randomized
   *            false:  last verified stream was not randomized
   */ 
    public boolean IsRandom() {
    
    return super.IsRandom();
    }
 
  /**
   * Tests the BaseCryptoRandomStream executed and returns the random value
   * 
   * @param     bitStream   bitStream to be verified for randomness properties
   * @return    boolean     indication if CryptoRandomStream is a randomized stream
   *            true:       last verified stream was randomized
   *            false:      last verified stream was not randomized
   */ 
    public boolean IsRandom(BaseCryptoRandomStream bitStream) {
      int     i, j, k, r, blockSize;
    int     powLen, index;
        double  sum, numOfBlocks;
    double  ApEn[];
    int     P[];
 
        ApEn = new double[2];
    if ( bitStream.GetBitLength() < this.GetMinimumLength() ) {
      this.error = RandomTestErrors.InsufficientNumberOfBits;
      this.random = false;
      return this.random;
    }
    this.error = RandomTestErrors.NoError;
    if (this.blockLength > (int)this.MaximumBlockSizeRecommended(bitStream.GetBitLength())) {
      this.blockSizeExceeded = true;
      this.maximumBlockSizeRecommended = this.MaximumBlockSizeRecommended(bitStream.GetBitLength());
      this.error = RandomTestErrors.ResultsInaccurate;
      this.random = false;
      return this.random ;
        } 
        r = 0;
        for(blockSize = this.blockLength; blockSize <= this.blockLength+1; blockSize++) {
          if (blockSize == 0) {
            ApEn[0] = 0.00;
            r++;
          }
          else {
            numOfBlocks = bitStream.GetBitLength();
            powLen = (int)Math.pow(2, blockSize+1)-1;
            P = new int[powLen];
            if ( P == null ){
              this.error = RandomTestErrors.InsufficientMemory;
              this.random = false;
              return this.random;
            }
            for(i = 1; i < powLen-1; i++) P[i] = 0;
            for(i = 0; i < numOfBlocks; i++) { 
              k = 1;
              for(j = 0; j < blockSize; j++) {
                if (bitStream.GetBitPosition((i+j)%bitStream.GetBitLength()) == 0)
                  k *= 2;
                else if (bitStream.GetBitPosition((i+j)%bitStream.GetBitLength()) == 1)
                  k = 2*k+1;
              }
              P[k-1]++;
            }
            sum = 0.0;
            index = (int)Math.pow(2,blockSize)-1;
            for(i = 0; i < (int)Math.pow(2,blockSize); i++) {
              if (P[index] > 0) sum += P[index]*Math.log(P[index]/numOfBlocks);
              index++;
            }
            sum /= numOfBlocks;
            ApEn[r] = sum;
            r++;
            P = null;
          }
        }
        this.apEn = ApEn[0] - ApEn[1];
    this.phi = ApEn[0];
    this.phiPlusOne = ApEn[1];
    this.chiSquared = 2.0*bitStream.GetBitLength()*(Math.log(2) - this.apEn);
    this.pValue = this.mathFuncs.IGammaC(Math.pow(2,this.blockLength-1),this.chiSquared/2.);
    if (Double.isNaN(this.pValue)) {
      this.pValue = 0;
      this.error = RandomTestErrors.MathematicianNAN;
      this.random = false;
    }
    else {
      if (this.pValue < this.alpha) {
        this.random = false;
      }
      else {
        this.random = true;
      }
    }
    return this.random;
    }
 
  /**
   * Initializes the object
   * 
   */ 
    public void Initialize() {
    
    super.Initialize();
    
    this.chiSquared = 0.0;
    this.phi = 0.0;
    this.phiPlusOne = 0.0;
    this.apEn = 0.0;
    this.blockSizeExceeded = false;    
    this.maximumBlockSizeRecommended = 0;   
    }
 
  /**
   * Gets the type of the object
   * 
   * @return    RandomTests:     the concrete type class of the random number test, ApproximateEntroy test for this class
   */ 
    public RandomTests GetType() {
    
    return ApproximateEntropyTest.TEST;
    }
 
  /**
   * Gets the minimum random stream length
   * 
   * @return    int:    minimum length in bits of streams that can be checked by this test 
   */ 
    public int GetMinimumLength() {
    
      return ApproximateEntropyTest.MINIMUMLENGTH;
    }
 
  /**
   * Sets the "m" parameter, block length in bits
   * 
   * @param     blockLength    sets the block length in bits that Approximate Entropy test will use for checking randomness
   */ 
    public void SetBlockLength(int blockLength) {
    
    this.blockLength = blockLength;
    }
 
  /**
   * Gets the "m" parameter, block length in bits
   * 
   * @return    int:    gets the block length that Approximate Entropy test is using for checking randomness
   */ 
    public int GetBlockLength() {
    
    return this.blockLength;
    }
 
  /**
   * Gets the "ChiSquared" result
   * 
   * @return    double:    gets the "chi squared" result of last random test computed
   */ 
    public double GetChiSquared() {
    
      return this.chiSquared;
    }
 
  /**
   * Gets the "Phi" result
   * 
   * @return    double:    gets the "phi" result of last random test computed
   */ 
    public double GetPhi() {
    
      return this.phi;
    }
 
  /**
   * Gets the "PhiPlusOne" result
   * 
   * @return    double:    gets the "phi plus one" result of last random test computed
   */ 
    public double GetPhiPlusOne() {
    
      return this.phiPlusOne;
    }
 
  /**
   * Gets the "apEn" result
   * 
   * @return    double:    gets the "ApEn" result of last random test computed
   */ 
    public double GetApEn() {
    
      return this.apEn;
    }
 
  /**
   * Gets the "BlockSizeExceeded" result
   * 
   * @return    boolean:    gets if block size has been exceeded
   */ 
    public boolean GetBlockSizeExceeded() {
    
      return this.blockSizeExceeded;
    }
 
  /**
   * Gets the "BlockSizeRecommended" result
   * 
   * @return    int:      gets maximum block size recommended to perform random number test
   */ 
    public int GetMaximumBlockSizeRecommended() {
    
      return this.maximumBlockSizeRecommended;
    }   
 
  /**
   * Gets the "BlockSizeRecommended" for the indicated stream length
   * 
   * @param     length  length in bits of the stream for which to perform randomness checking
   * @return    int:    gets maximum block size recommended according to length 
   */ 
    public int MaximumBlockSizeRecommended(int length) {
    
        return (int)this.mathFuncs.max(1,(Math.log(length)/Math.log(2)-2));
    }
 
}