c3ac3608fb83090f110177b6dcf92f0a2d2b7387
[openssl.git] / fips / fipsalgtest.pl
1 #!/usr/bin/perl -w
2 # Perl utility to run or verify FIPS 140-2 CAVP algorithm tests based on the
3 # pathnames of input algorithm test files actually present (the unqualified
4 # file names are consistent but the pathnames are not).
5 #
6
7 # FIPS test definitions
8 # List of all the unqualified file names we expect and command lines to run
9
10 # DSA tests
11 my @fips_dsa_test_list = (
12
13     "DSA",
14
15     [ "PQGGen",  "fips_dssvs pqg" ],
16     [ "KeyPair", "fips_dssvs keypair" ],
17     [ "SigGen",  "fips_dssvs siggen" ],
18     [ "SigVer",  "fips_dssvs sigver" ]
19
20 );
21
22 my @fips_dsa_pqgver_test_list = (
23
24     [ "PQGVer",  "fips_dssvs pqgver" ]
25
26 );
27
28 # RSA tests
29
30 my @fips_rsa_test_list = (
31
32     "RSA",
33
34     [ "SigGen15",  "fips_rsastest" ],
35     [ "SigVer15",  "fips_rsavtest" ],
36     [ "SigVerRSA", "fips_rsavtest -x931" ],
37     [ "KeyGenRSA", "fips_rsagtest" ],
38     [ "SigGenRSA", "fips_rsastest -x931" ]
39
40 );
41
42 # Special cases for PSS. The filename itself is
43 # not sufficient to determine the test. Addditionally we
44 # need to examine the file contents to determine the salt length
45 # In these cases the test filename has (saltlen) appended.
46
47 # RSA PSS salt length 0 tests
48
49 my @fips_rsa_pss0_test_list = (
50
51     [ "SigGenPSS(0)", "fips_rsastest -saltlen 0",
52                                         '^\s*#\s*salt\s+len:\s+0\s*$' ],
53     [ "SigVerPSS(0)", "fips_rsavtest -saltlen 0",
54                                         '^\s*#\s*salt\s+len:\s+0\s*$' ],
55
56 );
57
58 # RSA PSS salt length 62 tests
59
60 my @fips_rsa_pss62_test_list = (
61     [ "SigGenPSS(62)", "fips_rsastest -saltlen 62",
62                                         '^\s*#\s*salt\s+len:\s+62\s*$' ],
63     [ "SigVerPSS(62)", "fips_rsavtest -saltlen 62",
64                                         '^\s*#\s*salt\s+len:\s+62\s*$' ],
65 );
66
67 # SHA tests
68
69 my @fips_sha_test_list = (
70
71     "SHA",
72
73     [ "SHA1LongMsg",    "fips_shatest" ],
74     [ "SHA1Monte",      "fips_shatest" ],
75     [ "SHA1ShortMsg",   "fips_shatest" ],
76     [ "SHA224LongMsg",  "fips_shatest" ],
77     [ "SHA224Monte",    "fips_shatest" ],
78     [ "SHA224ShortMsg", "fips_shatest" ],
79     [ "SHA256LongMsg",  "fips_shatest" ],
80     [ "SHA256Monte",    "fips_shatest" ],
81     [ "SHA256ShortMsg", "fips_shatest" ],
82     [ "SHA384LongMsg",  "fips_shatest" ],
83     [ "SHA384Monte",    "fips_shatest" ],
84     [ "SHA384ShortMsg", "fips_shatest" ],
85     [ "SHA512LongMsg",  "fips_shatest" ],
86     [ "SHA512Monte",    "fips_shatest" ],
87     [ "SHA512ShortMsg", "fips_shatest" ]
88
89 );
90
91 # HMAC
92
93 my @fips_hmac_test_list = (
94
95     "HMAC",
96
97     [ "HMAC", "fips_hmactest" ]
98
99 );
100
101 # CMAC
102
103 my @fips_cmac_test_list = (
104
105     "CMAC",
106
107     [ "CMACGenAES128", "fips_cmactest -a aes128 -g" ],
108     [ "CMACVerAES128", "fips_cmactest -a aes128 -v" ],
109     [ "CMACGenAES192", "fips_cmactest -a aes192 -g" ],
110     [ "CMACVerAES192", "fips_cmactest -a aes192 -v" ],
111     [ "CMACGenAES256", "fips_cmactest -a aes256 -g" ],
112     [ "CMACVerAES256", "fips_cmactest -a aes256 -v" ],
113     [ "CMACGenTDES3", "fips_cmactest -a tdes3 -g" ],
114     [ "CMACVerTDES3", "fips_cmactest -a tdes3 -v" ],
115
116 );
117
118 # RAND tests, AES version
119
120 my @fips_rand_aes_test_list = (
121
122     "RAND (AES)",
123
124     [ "ANSI931_AES128MCT", "fips_rngvs mct" ],
125     [ "ANSI931_AES192MCT", "fips_rngvs mct" ],
126     [ "ANSI931_AES256MCT", "fips_rngvs mct" ],
127     [ "ANSI931_AES128VST", "fips_rngvs vst" ],
128     [ "ANSI931_AES192VST", "fips_rngvs vst" ],
129     [ "ANSI931_AES256VST", "fips_rngvs vst" ]
130
131 );
132
133 # RAND tests, DES2 version
134
135 my @fips_rand_des2_test_list = (
136
137     "RAND (DES2)",
138
139     [ "ANSI931_TDES2MCT", "fips_rngvs mct" ],
140     [ "ANSI931_TDES2VST", "fips_rngvs vst" ]
141
142 );
143
144 # AES tests
145
146 my @fips_aes_test_list = (
147
148     "AES",
149
150     [ "CBCGFSbox128",     "fips_aesavs -f" ],
151     [ "CBCGFSbox192",     "fips_aesavs -f" ],
152     [ "CBCGFSbox256",     "fips_aesavs -f" ],
153     [ "CBCKeySbox128",    "fips_aesavs -f" ],
154     [ "CBCKeySbox192",    "fips_aesavs -f" ],
155     [ "CBCKeySbox256",    "fips_aesavs -f" ],
156     [ "CBCMCT128",        "fips_aesavs -f" ],
157     [ "CBCMCT192",        "fips_aesavs -f" ],
158     [ "CBCMCT256",        "fips_aesavs -f" ],
159     [ "CBCMMT128",        "fips_aesavs -f" ],
160     [ "CBCMMT192",        "fips_aesavs -f" ],
161     [ "CBCMMT256",        "fips_aesavs -f" ],
162     [ "CBCVarKey128",     "fips_aesavs -f" ],
163     [ "CBCVarKey192",     "fips_aesavs -f" ],
164     [ "CBCVarKey256",     "fips_aesavs -f" ],
165     [ "CBCVarTxt128",     "fips_aesavs -f" ],
166     [ "CBCVarTxt192",     "fips_aesavs -f" ],
167     [ "CBCVarTxt256",     "fips_aesavs -f" ],
168     [ "CFB128GFSbox128",  "fips_aesavs -f" ],
169     [ "CFB128GFSbox192",  "fips_aesavs -f" ],
170     [ "CFB128GFSbox256",  "fips_aesavs -f" ],
171     [ "CFB128KeySbox128", "fips_aesavs -f" ],
172     [ "CFB128KeySbox192", "fips_aesavs -f" ],
173     [ "CFB128KeySbox256", "fips_aesavs -f" ],
174     [ "CFB128MCT128",     "fips_aesavs -f" ],
175     [ "CFB128MCT192",     "fips_aesavs -f" ],
176     [ "CFB128MCT256",     "fips_aesavs -f" ],
177     [ "CFB128MMT128",     "fips_aesavs -f" ],
178     [ "CFB128MMT192",     "fips_aesavs -f" ],
179     [ "CFB128MMT256",     "fips_aesavs -f" ],
180     [ "CFB128VarKey128",  "fips_aesavs -f" ],
181     [ "CFB128VarKey192",  "fips_aesavs -f" ],
182     [ "CFB128VarKey256",  "fips_aesavs -f" ],
183     [ "CFB128VarTxt128",  "fips_aesavs -f" ],
184     [ "CFB128VarTxt192",  "fips_aesavs -f" ],
185     [ "CFB128VarTxt256",  "fips_aesavs -f" ],
186     [ "CFB8GFSbox128",    "fips_aesavs -f" ],
187     [ "CFB8GFSbox192",    "fips_aesavs -f" ],
188     [ "CFB8GFSbox256",    "fips_aesavs -f" ],
189     [ "CFB8KeySbox128",   "fips_aesavs -f" ],
190     [ "CFB8KeySbox192",   "fips_aesavs -f" ],
191     [ "CFB8KeySbox256",   "fips_aesavs -f" ],
192     [ "CFB8MCT128",       "fips_aesavs -f" ],
193     [ "CFB8MCT192",       "fips_aesavs -f" ],
194     [ "CFB8MCT256",       "fips_aesavs -f" ],
195     [ "CFB8MMT128",       "fips_aesavs -f" ],
196     [ "CFB8MMT192",       "fips_aesavs -f" ],
197     [ "CFB8MMT256",       "fips_aesavs -f" ],
198     [ "CFB8VarKey128",    "fips_aesavs -f" ],
199     [ "CFB8VarKey192",    "fips_aesavs -f" ],
200     [ "CFB8VarKey256",    "fips_aesavs -f" ],
201     [ "CFB8VarTxt128",    "fips_aesavs -f" ],
202     [ "CFB8VarTxt192",    "fips_aesavs -f" ],
203     [ "CFB8VarTxt256",    "fips_aesavs -f" ],
204
205     [ "ECBGFSbox128",  "fips_aesavs -f" ],
206     [ "ECBGFSbox192",  "fips_aesavs -f" ],
207     [ "ECBGFSbox256",  "fips_aesavs -f" ],
208     [ "ECBKeySbox128", "fips_aesavs -f" ],
209     [ "ECBKeySbox192", "fips_aesavs -f" ],
210     [ "ECBKeySbox256", "fips_aesavs -f" ],
211     [ "ECBMCT128",     "fips_aesavs -f" ],
212     [ "ECBMCT192",     "fips_aesavs -f" ],
213     [ "ECBMCT256",     "fips_aesavs -f" ],
214     [ "ECBMMT128",     "fips_aesavs -f" ],
215     [ "ECBMMT192",     "fips_aesavs -f" ],
216     [ "ECBMMT256",     "fips_aesavs -f" ],
217     [ "ECBVarKey128",  "fips_aesavs -f" ],
218     [ "ECBVarKey192",  "fips_aesavs -f" ],
219     [ "ECBVarKey256",  "fips_aesavs -f" ],
220     [ "ECBVarTxt128",  "fips_aesavs -f" ],
221     [ "ECBVarTxt192",  "fips_aesavs -f" ],
222     [ "ECBVarTxt256",  "fips_aesavs -f" ],
223     [ "OFBGFSbox128",  "fips_aesavs -f" ],
224     [ "OFBGFSbox192",  "fips_aesavs -f" ],
225     [ "OFBGFSbox256",  "fips_aesavs -f" ],
226     [ "OFBKeySbox128", "fips_aesavs -f" ],
227     [ "OFBKeySbox192", "fips_aesavs -f" ],
228     [ "OFBKeySbox256", "fips_aesavs -f" ],
229     [ "OFBMCT128",     "fips_aesavs -f" ],
230     [ "OFBMCT192",     "fips_aesavs -f" ],
231     [ "OFBMCT256",     "fips_aesavs -f" ],
232     [ "OFBMMT128",     "fips_aesavs -f" ],
233     [ "OFBMMT192",     "fips_aesavs -f" ],
234     [ "OFBMMT256",     "fips_aesavs -f" ],
235     [ "OFBVarKey128",  "fips_aesavs -f" ],
236     [ "OFBVarKey192",  "fips_aesavs -f" ],
237     [ "OFBVarKey256",  "fips_aesavs -f" ],
238     [ "OFBVarTxt128",  "fips_aesavs -f" ],
239     [ "OFBVarTxt192",  "fips_aesavs -f" ],
240     [ "OFBVarTxt256",  "fips_aesavs -f" ]
241
242 );
243
244 my @fips_aes_cfb1_test_list = (
245
246     # AES CFB1 tests
247
248     [ "CFB1GFSbox128",  "fips_aesavs -f" ],
249     [ "CFB1GFSbox192",  "fips_aesavs -f" ],
250     [ "CFB1GFSbox256",  "fips_aesavs -f" ],
251     [ "CFB1KeySbox128", "fips_aesavs -f" ],
252     [ "CFB1KeySbox192", "fips_aesavs -f" ],
253     [ "CFB1KeySbox256", "fips_aesavs -f" ],
254     [ "CFB1MCT128",     "fips_aesavs -f" ],
255     [ "CFB1MCT192",     "fips_aesavs -f" ],
256     [ "CFB1MCT256",     "fips_aesavs -f" ],
257     [ "CFB1MMT128",     "fips_aesavs -f" ],
258     [ "CFB1MMT192",     "fips_aesavs -f" ],
259     [ "CFB1MMT256",     "fips_aesavs -f" ],
260     [ "CFB1VarKey128",  "fips_aesavs -f" ],
261     [ "CFB1VarKey192",  "fips_aesavs -f" ],
262     [ "CFB1VarKey256",  "fips_aesavs -f" ],
263     [ "CFB1VarTxt128",  "fips_aesavs -f" ],
264     [ "CFB1VarTxt192",  "fips_aesavs -f" ],
265     [ "CFB1VarTxt256",  "fips_aesavs -f" ]
266
267 );
268
269 my @fips_aes_ccm_test_list = (
270
271     # AES CCM tests
272
273     "AES CCM",
274
275     [ "DVPT128",  "fips_gcmtest -ccm" ],
276     [ "DVPT192",  "fips_gcmtest -ccm" ],
277     [ "DVPT256",  "fips_gcmtest -ccm" ],
278     [ "VADT128",  "fips_gcmtest -ccm" ],
279     [ "VADT192",  "fips_gcmtest -ccm" ],
280     [ "VADT256",  "fips_gcmtest -ccm" ],
281     [ "VNT128",  "fips_gcmtest -ccm" ],
282     [ "VNT192",  "fips_gcmtest -ccm" ],
283     [ "VNT256",  "fips_gcmtest -ccm" ],
284     [ "VPT128",  "fips_gcmtest -ccm" ],
285     [ "VPT192",  "fips_gcmtest -ccm" ],
286     [ "VPT256",  "fips_gcmtest -ccm" ],
287     [ "VTT128",  "fips_gcmtest -ccm" ],
288     [ "VTT192",  "fips_gcmtest -ccm" ],
289     [ "VTT256",  "fips_gcmtest -ccm" ]
290
291 );
292
293 my @fips_aes_gcm_test_list = (
294
295     # AES GCM tests
296
297     "AES GCM",
298
299     [ "gcmDecrypt128",  "fips_gcmtest -decrypt" ],
300     [ "gcmDecrypt192",  "fips_gcmtest -decrypt" ],
301     [ "gcmDecrypt256",  "fips_gcmtest -decrypt" ],
302
303 );
304
305 my @fips_aes_xts_test_list = (
306     # AES XTS tests
307
308     "AES XTS",
309
310     [ "XTSGenAES128",  "fips_gcmtest -xts" ],
311     [ "XTSGenAES256",  "fips_gcmtest -xts" ],
312
313 );
314
315 # Triple DES tests
316
317 my @fips_des3_test_list = (
318
319     "Triple DES",
320
321     [ "TCBCinvperm",   "fips_desmovs -f" ],
322     [ "TCBCMMT1",      "fips_desmovs -f" ],
323     [ "TCBCMMT2",      "fips_desmovs -f" ],
324     [ "TCBCMMT3",      "fips_desmovs -f" ],
325     [ "TCBCMonte1",    "fips_desmovs -f" ],
326     [ "TCBCMonte2",    "fips_desmovs -f" ],
327     [ "TCBCMonte3",    "fips_desmovs -f" ],
328     [ "TCBCpermop",    "fips_desmovs -f" ],
329     [ "TCBCsubtab",    "fips_desmovs -f" ],
330     [ "TCBCvarkey",    "fips_desmovs -f" ],
331     [ "TCBCvartext",   "fips_desmovs -f" ],
332     [ "TCFB64invperm", "fips_desmovs -f" ],
333     [ "TCFB64MMT1",    "fips_desmovs -f" ],
334     [ "TCFB64MMT2",    "fips_desmovs -f" ],
335     [ "TCFB64MMT3",    "fips_desmovs -f" ],
336     [ "TCFB64Monte1",  "fips_desmovs -f" ],
337     [ "TCFB64Monte2",  "fips_desmovs -f" ],
338     [ "TCFB64Monte3",  "fips_desmovs -f" ],
339     [ "TCFB64permop",  "fips_desmovs -f" ],
340     [ "TCFB64subtab",  "fips_desmovs -f" ],
341     [ "TCFB64varkey",  "fips_desmovs -f" ],
342     [ "TCFB64vartext", "fips_desmovs -f" ],
343     [ "TCFB8invperm",  "fips_desmovs -f" ],
344     [ "TCFB8MMT1",     "fips_desmovs -f" ],
345     [ "TCFB8MMT2",     "fips_desmovs -f" ],
346     [ "TCFB8MMT3",     "fips_desmovs -f" ],
347     [ "TCFB8Monte1",   "fips_desmovs -f" ],
348     [ "TCFB8Monte2",   "fips_desmovs -f" ],
349     [ "TCFB8Monte3",   "fips_desmovs -f" ],
350     [ "TCFB8permop",   "fips_desmovs -f" ],
351     [ "TCFB8subtab",   "fips_desmovs -f" ],
352     [ "TCFB8varkey",   "fips_desmovs -f" ],
353     [ "TCFB8vartext",  "fips_desmovs -f" ],
354     [ "TECBinvperm",   "fips_desmovs -f" ],
355     [ "TECBMMT1",      "fips_desmovs -f" ],
356     [ "TECBMMT2",      "fips_desmovs -f" ],
357     [ "TECBMMT3",      "fips_desmovs -f" ],
358     [ "TECBMonte1",    "fips_desmovs -f" ],
359     [ "TECBMonte2",    "fips_desmovs -f" ],
360     [ "TECBMonte3",    "fips_desmovs -f" ],
361     [ "TECBpermop",    "fips_desmovs -f" ],
362     [ "TECBsubtab",    "fips_desmovs -f" ],
363     [ "TECBvarkey",    "fips_desmovs -f" ],
364     [ "TECBvartext",   "fips_desmovs -f" ],
365     [ "TOFBinvperm",   "fips_desmovs -f" ],
366     [ "TOFBMMT1",      "fips_desmovs -f" ],
367     [ "TOFBMMT2",      "fips_desmovs -f" ],
368     [ "TOFBMMT3",      "fips_desmovs -f" ],
369     [ "TOFBMonte1",    "fips_desmovs -f" ],
370     [ "TOFBMonte2",    "fips_desmovs -f" ],
371     [ "TOFBMonte3",    "fips_desmovs -f" ],
372     [ "TOFBpermop",    "fips_desmovs -f" ],
373     [ "TOFBsubtab",    "fips_desmovs -f" ],
374     [ "TOFBvarkey",    "fips_desmovs -f" ],
375     [ "TOFBvartext",   "fips_desmovs -f" ]
376
377 );
378
379 my @fips_des3_cfb1_test_list = (
380
381     # DES3 CFB1 tests
382
383     [ "TCFB1invperm",  "fips_desmovs -f" ],
384     [ "TCFB1MMT1",     "fips_desmovs -f" ],
385     [ "TCFB1MMT2",     "fips_desmovs -f" ],
386     [ "TCFB1MMT3",     "fips_desmovs -f" ],
387     [ "TCFB1Monte1",   "fips_desmovs -f" ],
388     [ "TCFB1Monte2",   "fips_desmovs -f" ],
389     [ "TCFB1Monte3",   "fips_desmovs -f" ],
390     [ "TCFB1permop",   "fips_desmovs -f" ],
391     [ "TCFB1subtab",   "fips_desmovs -f" ],
392     [ "TCFB1varkey",   "fips_desmovs -f" ],
393     [ "TCFB1vartext",  "fips_desmovs -f" ],
394
395 );
396
397 my @fips_drbg_test_list = (
398
399     # SP800-90 DRBG tests
400     "SP800-90 DRBG",
401     [ "CTR_DRBG",   "fips_drbgvs" ],
402     [ "Hash_DRBG",  "fips_drbgvs" ]
403
404 );
405
406 my @fips_dh_test_list = (
407
408     # DH
409     "DH Ephemeral Primitives Only",
410     [ "KASValidityTest_FFCEphem_NOKC_ZZOnly_init",   "fips_dhvs dhver" ],
411     [ "KASValidityTest_FFCEphem_NOKC_ZZOnly_resp",   "fips_dhvs dhver" ],
412
413 );
414
415 my @fips_ecdh_test_list = (
416
417     # ECDH
418     "ECDH Ephemeral Primitives Only",
419     [ "KASValidityTest_ECCEphemeralUnified_NOKC_ZZOnly_init",
420                                                         "fips_ecdhvs ecdhver" ],
421     [ "KASValidityTest_ECCEphemeralUnified_NOKC_ZZOnly_resp",
422                                                         "fips_ecdhvs ecdhver" ],
423
424 );
425
426
427 # Verification special cases.
428 # In most cases the output of a test is deterministic and
429 # it can be compared to a known good result. A few involve
430 # the genration and use of random keys and the output will
431 # be different each time. In thoses cases we perform special tests
432 # to simply check their consistency. For example signature generation
433 # output will be run through signature verification to see if all outputs
434 # show as valid.
435 #
436
437 my %verify_special = (
438     "PQGGen"        => "fips_dssvs pqgver",
439     "KeyPair"       => "fips_dssvs keyver",
440     "SigGen"        => "fips_dssvs sigver",
441     "SigGen15"      => "fips_rsavtest",
442     "SigGenRSA"     => "fips_rsavtest -x931",
443     "SigGenPSS(0)"  => "fips_rsavtest -saltlen 0",
444     "SigGenPSS(62)" => "fips_rsavtest -saltlen 62",
445 );
446
447 my $win32  = $^O =~ m/mswin/i;
448 my $onedir = 0;
449 my $filter = "";
450 my $tvdir;
451 my $tprefix;
452 my $debug          = 0;
453 my $quiet          = 0;
454 my $notest         = 0;
455 my $verify         = 1;
456 my $rspdir         = "rsp";
457 my $ignore_missing = 0;
458 my $ignore_bogus   = 0;
459 my $bufout         = '';
460 my $list_tests     = 0;
461 my $minimal_script = 0;
462 my $outfile        = '';
463 my $no_warn_missing = 0;
464
465 my %fips_enabled = (
466     dsa         => 1,
467     "dsa-pqgver"  => 0,
468     rsa         => 1,
469     "rsa-pss0"  => 0,
470     "rsa-pss62" => 1,
471     sha         => 1,
472     hmac        => 1,
473     cmac        => 0,
474     "rand-aes"  => 1,
475     "rand-des2" => 0,
476     aes         => 1,
477     "aes-cfb1"  => 0,
478     des3        => 1,
479     "des3-cfb1" => 0,
480     drbg        => 0,
481     ccm         => 0,
482     xts         => 0,
483     gcm         => 0,
484     dh          => 0,
485     ecdh        => 0,
486 );
487
488 foreach (@ARGV) {
489     if ( $_ eq "--win32" ) {
490         $win32 = 1;
491     }
492     elsif ( $_ eq "--onedir" ) {
493         $onedir = 1;
494     }
495     elsif ( $_ eq "--debug" ) {
496         $debug = 1;
497     }
498     elsif ( $_ eq "--quiet-missing" ) {
499         $ignore_missing = 1;
500         $no_warn_missing = 1;
501     }
502     elsif ( $_ eq "--ignore-missing" ) {
503         $ignore_missing = 1;
504     }
505     elsif ( $_ eq "--ignore-bogus" ) {
506         $ignore_bogus = 1;
507     }
508     elsif ( $_ eq "--minimal-script" ) {
509         $minimal_script = 1;
510     }
511     elsif (/--generate-script=(.*)$/) {
512         $outfile = $1;
513         $verify = 0;
514     } elsif ( $_ eq "--generate" ) {
515         $verify = 0;
516     }
517     elsif ( $_ eq "--notest" ) {
518         $notest = 1;
519     }
520     elsif ( $_ eq "--quiet" ) {
521         $quiet = 1;
522     }
523     elsif (/--dir=(.*)$/) {
524         $tvdir = $1;
525     }
526     elsif (/--rspdir=(.*)$/) {
527         $rspdir = $1;
528     }
529     elsif (/--tprefix=(.*)$/) {
530         $tprefix = $1;
531     }
532     elsif (/^--(enable|disable)-(.*)$/) {
533         if ( !exists $fips_enabled{$2} ) {
534             print STDERR "Unknown test $2\n";
535         }
536         if ( $1 eq "enable" ) {
537             $fips_enabled{$2} = 1;
538         }
539         else {
540             $fips_enabled{$2} = 0;
541         }
542     }
543     elsif (/--filter=(.*)$/) {
544         $filter = $1;
545     }
546     elsif (/^--list-tests$/) {
547         $list_tests = 1;
548     }
549     else {
550         Help();
551         exit(1);
552     }
553 }
554
555 my @fips_test_list;
556
557 push @fips_test_list, @fips_dsa_test_list       if $fips_enabled{"dsa"};
558 push @fips_test_list, @fips_dsa_pqgver_test_list if $fips_enabled{"dsa-pqgver"};
559 push @fips_test_list, @fips_rsa_test_list       if $fips_enabled{"rsa"};
560 push @fips_test_list, @fips_rsa_pss0_test_list  if $fips_enabled{"rsa-pss0"};
561 push @fips_test_list, @fips_rsa_pss62_test_list if $fips_enabled{"rsa-pss62"};
562 push @fips_test_list, @fips_sha_test_list       if $fips_enabled{"sha"};
563 push @fips_test_list, @fips_hmac_test_list      if $fips_enabled{"hmac"};
564 push @fips_test_list, @fips_cmac_test_list      if $fips_enabled{"cmac"};
565 push @fips_test_list, @fips_rand_aes_test_list  if $fips_enabled{"rand-aes"};
566 push @fips_test_list, @fips_rand_des2_test_list if $fips_enabled{"rand-des2"};
567 push @fips_test_list, @fips_aes_test_list       if $fips_enabled{"aes"};
568 push @fips_test_list, @fips_aes_cfb1_test_list  if $fips_enabled{"aes-cfb1"};
569 push @fips_test_list, @fips_des3_test_list      if $fips_enabled{"des3"};
570 push @fips_test_list, @fips_des3_cfb1_test_list if $fips_enabled{"des3-cfb1"};
571 push @fips_test_list, @fips_drbg_test_list      if $fips_enabled{"drbg"};
572 push @fips_test_list, @fips_aes_ccm_test_list   if $fips_enabled{"aes-ccm"};
573 push @fips_test_list, @fips_aes_gcm_test_list   if $fips_enabled{"aes-gcm"};
574 push @fips_test_list, @fips_aes_xts_test_list   if $fips_enabled{"aes-xts"};
575 push @fips_test_list, @fips_dh_test_list        if $fips_enabled{"dh"};
576 push @fips_test_list, @fips_ecdh_test_list      if $fips_enabled{"ecdh"};
577
578 if ($list_tests) {
579     my ( $test, $en );
580     print "=====TEST LIST=====\n";
581     foreach $test ( sort keys %fips_enabled ) {
582         $en = $fips_enabled{$test};
583         $test =~ tr/[a-z]/[A-Z]/;
584         printf "%-10s %s\n", $test, $en ? "enabled" : "disabled";
585     }
586     exit(0);
587 }
588
589 foreach (@fips_test_list) {
590     next unless ref($_);
591     my $nm = $$_[0];
592     $$_[3] = "";
593     $$_[4] = "";
594     print STDERR "Duplicate test $nm\n" if exists $fips_tests{$nm};
595     $fips_tests{$nm} = $_;
596 }
597
598 $tvdir = "." unless defined $tvdir;
599
600 if ($win32) {
601     if ( !defined $tprefix ) {
602         if ($onedir) {
603             $tprefix = ".\\";
604         }
605         else {
606             $tprefix = "..\\out32dll\\";
607         }
608     }
609 }
610 else {
611     if ($onedir) {
612         $tprefix       = "./" unless defined $tprefix;
613     }
614     else {
615         $tprefix       = "../test/" unless defined $tprefix;
616     }
617 }
618
619 sanity_check_exe( $win32, $tprefix) if $outfile eq "";
620
621 find_files( $filter, $tvdir );
622
623 sanity_check_files();
624
625 my ( $runerr, $cmperr, $cmpok, $scheckrunerr, $scheckerr, $scheckok, $skipcnt )
626   = ( 0, 0, 0, 0, 0, 0, 0 );
627
628 exit(0) if $notest;
629 print "Outputting commands to $outfile\n" if $outfile ne "";
630 run_tests( $verify, $win32, $tprefix, $filter, $tvdir, $outfile );
631
632 if ($verify) {
633     print "ALGORITHM TEST VERIFY SUMMARY REPORT:\n";
634     print "Tests skipped due to missing files:        $skipcnt\n";
635     print "Algorithm test program execution failures: $runerr\n";
636     print "Test comparisons successful:               $cmpok\n";
637     print "Test comparisons failed:                   $cmperr\n";
638     print "Test sanity checks successful:             $scheckok\n";
639     print "Test sanity checks failed:                 $scheckerr\n";
640     print "Sanity check program execution failures:   $scheckrunerr\n";
641
642     if ( $runerr || $cmperr || $scheckrunerr || $scheckerr ) {
643         print "***TEST FAILURE***\n";
644     }
645     else {
646         print "***ALL TESTS SUCCESSFUL***\n";
647     }
648 }
649 elsif ($outfile eq "") {
650     print "ALGORITHM TEST SUMMARY REPORT:\n";
651     print "Tests skipped due to missing files:        $skipcnt\n";
652     print "Algorithm test program execution failures: $runerr\n";
653
654     if ($runerr) {
655         print "***TEST FAILURE***\n";
656     }
657     else {
658         print "***ALL TESTS SUCCESSFUL***\n";
659     }
660 }
661
662 #--------------------------------
663 sub Help {
664     ( my $cmd ) = ( $0 =~ m#([^/]+)$# );
665     print <<EOF;
666 $cmd: generate run CAVP algorithm tests
667         --debug                     Enable debug output
668         --dir=<dirname>             Optional root for *.req file search
669         --filter=<regexp>
670         --onedir <dirname>          Assume all components in current directory
671         --rspdir=<dirname>          Name of subdirectories containing *.rsp files, default "rsp"
672         --tprefix=<prefix>
673         --ignore-bogus              Ignore duplicate or bogus files
674         --ignore-missing            Ignore missing test files
675         --quiet                     Shhh....
676         --generate                  Generate algorithm test output
677         --win32                     Win32 environment
678         --enable-<alg>              Enable algorithm set <alg>.
679         --disable-<alg>             Disable algorithm set <alg>.
680         Where <alg> can be one of:
681 EOF
682
683 while (my ($key, $value) = each %fips_enabled)
684         {
685         printf "\t\t%-20s(%s by default)\n", $key ,
686                         $value ? "enabled" : "disabled";
687         }
688 }
689
690 # Sanity check to see if all necessary executables exist
691
692 sub sanity_check_exe {
693     my ( $win32, $tprefix, ) = @_;
694     my %exe_list;
695     my $bad = 0;
696     foreach (@fips_test_list) {
697         next unless ref($_);
698         my $cmd = $_->[1];
699         $cmd =~ s/ .*$//;
700         $cmd = $tprefix . $cmd;
701         $cmd .= ".exe" if $win32;
702         $exe_list{$cmd} = 1;
703     }
704
705     foreach ( sort keys %exe_list ) {
706         if ( !-f $_ ) {
707             print STDERR "ERROR: can't find executable $_\n";
708             $bad = 1;
709         }
710     }
711     if ($bad) {
712         print STDERR "FATAL ERROR: executables missing\n";
713         exit(1);
714     }
715     elsif ($debug) {
716         print STDERR "Executable sanity check passed OK\n";
717     }
718 }
719
720 # Search for all request and response files
721
722 sub find_files {
723     my ( $filter, $dir ) = @_;
724     my ( $dirh, $testname, $tref );
725     opendir( $dirh, $dir );
726     while ( $_ = readdir($dirh) ) {
727         next if ( $_ eq "." || $_ eq ".." );
728         $_ = "$dir/$_";
729         if ( -f "$_" ) {
730             if (/\/([^\/]*)\.rsp$/) {
731                 $tref = find_test($1, $_);
732                 if ( defined $tref ) {
733                     $testname = $$tref[0];
734                     if ( $$tref[4] eq "" ) {
735                         $$tref[4] = $_;
736                     }
737                     else {
738                         print STDERR
739 "WARNING: duplicate response file $_ for test $testname\n";
740                         $nbogus++;
741                     }
742                 }
743                 else {
744                     print STDERR "WARNING: bogus file $_\n";
745                     $nbogus++;
746                 }
747             }
748             next unless /$filter.*\.req$/i;
749             if (/\/([^\/]*)\.req$/) {
750                 $tref = find_test($1, $_);
751                 if ( defined $tref ) {
752                     $testname = $$tref[0];
753                     if ( $$tref[3] eq "" ) {
754                         $$tref[3] = $_;
755                     }
756                     else {
757                         print STDERR
758 "WARNING: duplicate request file $_ for test $testname\n";
759                         $nbogus++;
760                     }
761
762                 }
763                 elsif ( !/SHAmix\.req$/ ) {
764                     print STDERR "WARNING: unrecognized filename $_\n";
765                     $nbogus++;
766                 }
767             }
768         }
769         elsif ( -d "$_" ) {
770             find_files( $filter, $_ );
771         }
772     }
773     closedir($dirh);
774 }
775 #
776 # Find test based on filename.
777 # In ambiguous cases search file contents for a match
778 #
779
780 sub find_test {
781     my ( $test, $path ) = @_;
782     foreach $tref (@fips_test_list) {
783         next unless ref($tref);
784         my ( $tst, $cmd, $regexp, $req, $resp ) = @$tref;
785         $tst =~ s/\(.*$//;
786         if ($tst eq $test) {
787                 return $tref if (!defined $regexp);
788                 my $found = 0;
789                 my $line;
790                 open( IN, $path ) || die "Can't Open File $path";
791                 while ($line = <IN>) {
792                     if ($line =~ /$regexp/i) {
793                         $found = 1;
794                         last;
795                     }
796                 }
797                 close IN;
798                 return $tref if $found == 1;
799         }
800     }
801     return undef;
802 }
803
804 sub sanity_check_files {
805     my $bad = 0;
806     foreach (@fips_test_list) {
807         next unless ref($_);
808         my ( $tst, $cmd, $regexp, $req, $resp ) = @$_;
809
810         #print STDERR "FILES $tst, $cmd, $req, $resp\n";
811         if ( $req eq "" ) {
812             print STDERR "WARNING: missing request file for $tst\n" unless $no_warn_missing;
813             $bad = 1;
814             next;
815         }
816         if ( $verify && $resp eq "" ) {
817             print STDERR "WARNING: no response file for test $tst\n";
818             $bad = 1;
819         }
820         elsif ( !$verify && $resp ne "" ) {
821             print STDERR "WARNING: response file $resp will be overwritten\n";
822         }
823     }
824     if ($bad) {
825         print STDERR "ERROR: test vector file set not complete\n";
826         exit(1) unless $ignore_missing;
827     }
828     if ($nbogus) {
829         print STDERR
830           "ERROR: $nbogus bogus or duplicate request and response files\n";
831         exit(1) unless $ignore_bogus;
832     }
833     if ( $debug && !$nbogus && !$bad ) {
834         print STDERR "test vector file set complete\n";
835     }
836 }
837
838 sub run_tests {
839     my ( $verify, $win32, $tprefix, $filter, $tvdir, $outfile ) = @_;
840     my ( $tname, $tref );
841     my $bad = 0;
842     my $lastdir = "";
843     if ($outfile ne "") {
844         open OUT, ">$outfile" || die "Can't open $outfile";
845     }
846     if ($outfile ne "" && !$minimal_script) {
847         if ($win32) {
848             print OUT <<\END;
849 @echo off
850 rem Test vector run script
851 rem Auto generated by fipsalgtest.pl script
852 rem Do not edit
853
854 echo Running Algorithm Tests
855
856 END
857         } else {
858             print OUT <<\END;
859 #!/bin/sh
860
861 # Test vector run script
862 # Auto generated by fipsalgtest.pl script
863 # Do not edit
864
865 echo Running Algorithm Tests
866
867 END
868         }
869
870     }
871
872     foreach (@fips_test_list) {
873         if ( !ref($_) ) {
874             if ($outfile ne "") {
875                 print "Generating script for $_ tests\n";
876                 print OUT "\n\n\necho \"Running $_ tests\"\n" unless $minimal_script;
877             } else {    
878                 print "Running $_ tests\n" unless $quiet;
879             }
880             next;
881         }
882         my ( $tname, $tcmd, $regexp, $req, $rsp ) = @$_;
883         my $out = $rsp;
884         if ($verify) {
885             $out =~ s/\.rsp$/.tst/;
886         }
887         if ( $req eq "" ) {
888             print STDERR
889               "WARNING: Request file for $tname missing: test skipped\n" unless $no_warn_missing;
890             $skipcnt++;
891             next;
892         }
893         if ( $verify && $rsp eq "" ) {
894             print STDERR
895               "WARNING: Response file for $tname missing: test skipped\n";
896             $skipcnt++;
897             next;
898         }
899         elsif ( !$verify ) {
900             if ( $rsp ne "" ) {
901                 print STDERR "WARNING: Response file for $tname deleted\n";
902                 unlink $rsp;
903             }
904             $out = $req;
905             $out =~ s|/req/(\S+)\.req|/$rspdir/$1.rsp|;
906             my $outdir = $out;
907             $outdir =~ s|/[^/]*$||;
908             if ($outfile ne "") {
909                 if ($win32) {
910                     $outdir =~ tr|/|\\|;
911                     $req =~ tr|/|\\|;
912                     $out =~ tr|/|\\|;
913                 }
914                 if ($outdir ne $lastdir && !$minimal_script) {
915                     if ($win32) {
916                     print OUT <<END
917 if exist \"$outdir\" rd /s /q "$outdir"
918 md \"$outdir\"
919
920 END
921                     } else {
922                     print OUT <<END
923 rm -rf \"$outdir\"
924 mkdir \"$outdir\"
925
926 END
927                     }
928                 $lastdir = $outdir;
929                 }
930             } elsif ( !-d $outdir ) {
931                 print STDERR "DEBUG: Creating directory $outdir\n" if $debug;
932                 mkdir($outdir) || die "Can't create directory $outdir";
933             }
934         }
935         my $cmd = "$tprefix$tcmd \"$req\" \"$out\"";
936         print STDERR "DEBUG: running test $tname\n" if ( $debug && !$verify );
937         if ($outfile ne "") {
938             print OUT "echo \"    running $tname test\"\n" unless $minimal_script;
939             print OUT "$cmd\n";
940         } else {
941             system($cmd);
942             if ( $? != 0 ) {
943                 print STDERR
944                      "WARNING: error executing test $tname for command: $cmd\n";
945                 $runerr++;
946                 next;
947             }
948         }
949         if ($verify) {
950             if ( exists $verify_special{$tname} ) {
951                 my $vout = $rsp;
952                 $vout =~ s/\.rsp$/.ver/;
953                 $tcmd = $verify_special{$tname};
954                 $cmd  = "$tprefix$tcmd ";
955                 $cmd .= "\"$out\" \"$vout\"";
956                 system($cmd);
957                 if ( $? != 0 ) {
958                     print STDERR
959                       "WARNING: error executing verify test $tname $cmd\n";
960                     $scheckrunerr++;
961                     next;
962                 }
963                 my ( $fcount, $pcount ) = ( 0, 0 );
964                 open VER, "$vout";
965                 while (<VER>) {
966                     if (/^Result\s*=\s*(\S*)\s*$/i)
967
968                     {
969                         if ( $1 eq "F" ) {
970                             $fcount++;
971                         }
972                         else {
973                             $pcount++;
974                         }
975                     }
976                 }
977                 close VER;
978
979                 unlink $vout;
980                 if ( $fcount || $debug ) {
981                     print STDERR "DEBUG: $tname, Pass=$pcount, Fail=$fcount\n";
982                 }
983                 if ( $fcount || !$pcount ) {
984                     $scheckerr++;
985                 }
986                 else {
987                     $scheckok++;
988                 }
989
990             }
991             elsif ( !cmp_file( $tname, $rsp, $out ) ) {
992                 $cmperr++;
993             }
994             else {
995                 $cmpok++;
996             }
997             unlink $out;
998         }
999     }
1000     if ($outfile ne "") {
1001         print OUT "\n\necho All Tests Completed\n" unless $minimal_script;
1002         close OUT;
1003     }
1004 }
1005
1006 sub cmp_file {
1007     my ( $tname, $rsp, $tst ) = @_;
1008     my ( $rspf,    $tstf );
1009     my ( $rspline, $tstline );
1010     if ( !open( $rspf, $rsp ) ) {
1011         print STDERR "ERROR: can't open request file $rsp\n";
1012         return 0;
1013     }
1014     if ( !open( $tstf, $tst ) ) {
1015         print STDERR "ERROR: can't open output file $tst\n";
1016         return 0;
1017     }
1018     for ( ; ; ) {
1019         $rspline = next_line($rspf);
1020         $tstline = next_line($tstf);
1021         if ( !defined($rspline) && !defined($tstline) ) {
1022             print STDERR "DEBUG: $tname file comparison OK\n" if $debug;
1023             return 1;
1024         }
1025         if ( !defined($rspline) ) {
1026             print STDERR "ERROR: $tname EOF on $rsp\n";
1027             return 0;
1028         }
1029         if ( !defined($tstline) ) {
1030             print STDERR "ERROR: $tname EOF on $tst\n";
1031             return 0;
1032         }
1033
1034         # Workaround for bug in RAND des2 test output */
1035         if ( $tstline =~ /^Key2 =/ && $rspline =~ /^Key1 =/ ) {
1036             $rspline =~ s/^Key1/Key2/;
1037         }
1038
1039         if ( $tstline ne $rspline ) {
1040             print STDERR "ERROR: $tname mismatch:\n";
1041             print STDERR "\t \"$tstline\" != \"$rspline\"\n";
1042             return 0;
1043         }
1044     }
1045     return 1;
1046 }
1047
1048 sub next_line {
1049     my ($in) = @_;
1050
1051     while (<$in>) {
1052         chomp;
1053
1054         # Delete comments
1055         s/#.*$//;
1056
1057         # Ignore blank lines
1058         next if (/^\s*$/);
1059
1060         # Translate multiple space into one
1061         s/\s+/ /g;
1062         # Delete trailing whitespace
1063         s/\s+$//;
1064         # Remove leading zeroes
1065         s/= 00/= /;
1066         # Translate to upper case
1067         return uc $_;
1068     }
1069     return undef;
1070 }