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
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
|
/*
* (C) 2009,2010,2014,2015,2017,2018 Jack Lloyd
* (C) 2015 Simon Warta (Kullo GmbH)
*
* Botan is released under the Simplified BSD License (see license.txt)
*/
#include "cli.h"
#include "../tests/test_rng.h" // FIXME
#include <sstream>
#include <iomanip>
#include <chrono>
#include <functional>
#include <algorithm>
#include <map>
#include <set>
// Always available:
#include <botan/entropy_src.h>
#include <botan/parsing.h>
#include <botan/cpuid.h>
#include <botan/internal/os_utils.h>
#include <botan/version.h>
#if defined(BOTAN_HAS_BLOCK_CIPHER)
#include <botan/block_cipher.h>
#endif
#if defined(BOTAN_HAS_STREAM_CIPHER)
#include <botan/stream_cipher.h>
#endif
#if defined(BOTAN_HAS_HASH)
#include <botan/hash.h>
#endif
#if defined(BOTAN_HAS_CIPHER_MODES)
#include <botan/cipher_mode.h>
#endif
#if defined(BOTAN_HAS_MAC)
#include <botan/mac.h>
#endif
#if defined(BOTAN_HAS_AUTO_SEEDING_RNG)
#include <botan/auto_rng.h>
#endif
#if defined(BOTAN_HAS_SYSTEM_RNG)
#include <botan/system_rng.h>
#endif
#if defined(BOTAN_HAS_HMAC_DRBG)
#include <botan/hmac_drbg.h>
#endif
#if defined(BOTAN_HAS_RDRAND_RNG)
#include <botan/rdrand_rng.h>
#endif
#if defined(BOTAN_HAS_CHACHA_RNG)
#include <botan/chacha_rng.h>
#endif
#if defined(BOTAN_HAS_FPE_FE1)
#include <botan/fpe_fe1.h>
#endif
#if defined(BOTAN_HAS_RFC3394_KEYWRAP)
#include <botan/rfc3394.h>
#endif
#if defined(BOTAN_HAS_COMPRESSION)
#include <botan/compression.h>
#endif
#if defined(BOTAN_HAS_PUBLIC_KEY_CRYPTO)
#include <botan/pkcs8.h>
#include <botan/pubkey.h>
#include <botan/pk_algs.h>
#include <botan/x509_key.h>
#include <botan/workfactor.h>
#endif
#if defined(BOTAN_HAS_NUMBERTHEORY)
#include <botan/numthry.h>
#include <botan/pow_mod.h>
#include <botan/reducer.h>
#endif
#if defined(BOTAN_HAS_ECC_GROUP)
#include <botan/ec_group.h>
#endif
#if defined(BOTAN_HAS_DL_GROUP)
#include <botan/dl_group.h>
#endif
#if defined(BOTAN_HAS_MCELIECE)
#include <botan/mceliece.h>
#endif
#if defined(BOTAN_HAS_NEWHOPE)
#include <botan/newhope.h>
#endif
namespace Botan_CLI {
namespace {
class Timer final
{
public:
Timer(const std::string& name,
const std::string& provider,
const std::string& doing,
uint64_t event_mult,
size_t buf_size,
double clock_cycle_ratio,
uint64_t clock_speed)
: m_name(name + ((provider.empty() || provider == "base") ? "" : " [" + provider + "]"))
, m_doing(doing)
, m_buf_size(buf_size)
, m_event_mult(event_mult)
, m_clock_cycle_ratio(clock_cycle_ratio)
, m_clock_speed(clock_speed)
{}
Timer(const Timer& other) = default;
static uint64_t get_system_timestamp_ns()
{
return Botan::OS::get_system_timestamp_ns();
}
static uint64_t get_cpu_cycle_counter()
{
return Botan::OS::get_processor_timestamp();
}
void start()
{
stop();
m_timer_start = Timer::get_system_timestamp_ns();
m_cpu_cycles_start = Timer::get_cpu_cycle_counter();
}
void stop();
bool under(std::chrono::milliseconds msec)
{
return (milliseconds() < msec.count());
}
class Timer_Scope final
{
public:
explicit Timer_Scope(Timer& timer)
: m_timer(timer)
{
m_timer.start();
}
~Timer_Scope()
{
try
{
m_timer.stop();
}
catch(...) {}
}
private:
Timer& m_timer;
};
template<typename F>
auto run(F f) -> decltype(f())
{
Timer_Scope timer(*this);
return f();
}
template<typename F>
void run_until_elapsed(std::chrono::milliseconds msec, F f)
{
while(this->under(msec))
{
run(f);
}
}
uint64_t value() const
{
return m_time_used;
}
double seconds() const
{
return milliseconds() / 1000.0;
}
double milliseconds() const
{
return value() / 1000000.0;
}
double ms_per_event() const
{
return milliseconds() / events();
}
uint64_t cycles_consumed() const
{
if(m_clock_speed != 0)
{
return (static_cast<double>(m_clock_speed) * value()) / 1000;
}
return m_cpu_cycles_used;
}
uint64_t events() const
{
return m_event_count * m_event_mult;
}
const std::string& get_name() const
{
return m_name;
}
const std::string& doing() const
{
return m_doing;
}
size_t buf_size() const
{
return m_buf_size;
}
double bytes_per_second() const
{
return seconds() > 0.0 ? events() / seconds() : 0.0;
}
double events_per_second() const
{
return seconds() > 0.0 ? events() / seconds() : 0.0;
}
double seconds_per_event() const
{
return events() > 0 ? seconds() / events() : 0.0;
}
void set_custom_msg(const std::string& s)
{
m_custom_msg = s;
}
bool operator<(const Timer& other) const
{
if(this->doing() != other.doing())
return (this->doing() < other.doing());
return (this->get_name() < other.get_name());
}
std::string to_string() const
{
if(m_custom_msg.size() > 0)
{
return m_custom_msg;
}
else if(this->buf_size() == 0)
{
return result_string_ops();
}
else
{
return result_string_bps();
}
}
private:
std::string result_string_bps() const;
std::string result_string_ops() const;
// const data
std::string m_name, m_doing;
size_t m_buf_size;
uint64_t m_event_mult;
double m_clock_cycle_ratio;
uint64_t m_clock_speed;
// set at runtime
std::string m_custom_msg;
uint64_t m_time_used = 0, m_timer_start = 0;
uint64_t m_event_count = 0;
uint64_t m_max_time = 0, m_min_time = 0;
uint64_t m_cpu_cycles_start = 0, m_cpu_cycles_used = 0;
};
void Timer::stop()
{
if(m_timer_start)
{
const uint64_t now = Timer::get_system_timestamp_ns();
if(now > m_timer_start)
{
uint64_t dur = now - m_timer_start;
m_time_used += dur;
if(m_cpu_cycles_start != 0)
{
uint64_t cycles_taken = Timer::get_cpu_cycle_counter() - m_cpu_cycles_start;
if(cycles_taken > 0)
{
m_cpu_cycles_used += static_cast<size_t>(cycles_taken * m_clock_cycle_ratio);
}
}
if(m_event_count == 0)
{
m_min_time = m_max_time = dur;
}
else
{
m_max_time = std::max(m_max_time, dur);
m_min_time = std::min(m_min_time, dur);
}
}
m_timer_start = 0;
++m_event_count;
}
}
std::string Timer::result_string_bps() const
{
const size_t MiB = 1024 * 1024;
const double MiB_total = static_cast<double>(events()) / MiB;
const double MiB_per_sec = MiB_total / seconds();
std::ostringstream oss;
oss << get_name();
if(!doing().empty())
{
oss << " " << doing();
}
if(buf_size() > 0)
{
oss << " buffer size " << buf_size() << " bytes:";
}
if(events() == 0)
oss << " " << "N/A";
else
oss << " " << std::fixed << std::setprecision(3) << MiB_per_sec << " MiB/sec";
if(cycles_consumed() != 0)
{
const double cycles_per_byte = static_cast<double>(cycles_consumed()) / events();
oss << " " << std::fixed << std::setprecision(2) << cycles_per_byte << " cycles/byte";
}
oss << " (" << MiB_total << " MiB in " << milliseconds() << " ms)\n";
return oss.str();
}
std::string Timer::result_string_ops() const
{
std::ostringstream oss;
oss << get_name() << " ";
if(events() == 0)
{
oss << "no events\n";
}
else
{
oss << static_cast<uint64_t>(events_per_second())
<< ' ' << doing() << "/sec; "
<< std::setprecision(2) << std::fixed
<< ms_per_event() << " ms/op";
if(cycles_consumed() != 0)
{
const double cycles_per_op = static_cast<double>(cycles_consumed()) / events();
const size_t precision = (cycles_per_op < 10000) ? 2 : 0;
oss << " " << std::fixed << std::setprecision(precision) << cycles_per_op << " cycles/op";
}
oss << " (" << events() << " " << (events() == 1 ? "op" : "ops")
<< " in " << milliseconds() << " ms)\n";
}
return oss.str();
}
class JSON_Output final
{
public:
void add(const Timer& timer) { m_results.push_back(timer); }
std::string print() const
{
std::ostringstream out;
out << "[\n";
for(size_t i = 0; i != m_results.size(); ++i)
{
if(i != 0)
out << ",";
const Timer& t = m_results[i];
out << '{';
out << "\"algo\": \"" << t.get_name() << "\", ";
out << "\"op\": \"" << t.doing() << "\", ";
out << "\"events\": " << t.events() << ", ";
if(t.cycles_consumed() > 0)
out << "\"cycles\": " << t.cycles_consumed() << ", ";
if(t.buf_size() > 0)
{
out << "\"bps\": " << static_cast<uint64_t>(t.events() / (t.value() / 1000000000.0)) << ", ";
out << "\"buf_size\": " << t.buf_size() << ", ";
}
out << "\"nanos\": " << t.value();
out << "}\n";
}
out << "]\n";
return out.str();
}
private:
std::vector<Timer> m_results;
};
class Summary final
{
public:
Summary() {}
void add(const Timer& t)
{
if(t.buf_size() == 0)
{
m_ops_entries.push_back(t);
}
else
{
m_bps_entries[std::make_pair(t.doing(), t.get_name())].push_back(t);
}
}
std::string print()
{
const size_t name_padding = 35;
const size_t op_name_padding = 16;
const size_t op_padding = 16;
std::ostringstream result_ss;
result_ss << std::fixed;
if(m_bps_entries.size() > 0)
{
result_ss << "\n";
// add table header
result_ss << std::setw(name_padding) << std::left << "algo"
<< std::setw(op_name_padding) << std::left << "operation";
for(const Timer& t : m_bps_entries.begin()->second)
{
result_ss << std::setw(op_padding) << std::right << (std::to_string(t.buf_size()) + " bytes");
}
result_ss << "\n";
// add table entries
for(const auto& entry : m_bps_entries)
{
if(entry.second.empty())
continue;
result_ss << std::setw(name_padding) << std::left << (entry.first.second)
<< std::setw(op_name_padding) << std::left << (entry.first.first);
for(const Timer& t : entry.second)
{
if(t.events() == 0)
{
result_ss << std::setw(op_padding) << std::right << "N/A";
}
else
{
result_ss << std::setw(op_padding) << std::right
<< std::setprecision(2) << (t.bytes_per_second() / 1000.0);
}
}
result_ss << "\n";
}
result_ss << "\n[results are the number of 1000s bytes processed per second]\n";
}
if(m_ops_entries.size() > 0)
{
result_ss << std::setprecision(6) << "\n";
// sort entries
std::sort(m_ops_entries.begin(), m_ops_entries.end());
// add table header
result_ss << std::setw(name_padding) << std::left << "algo"
<< std::setw(op_name_padding) << std::left << "operation"
<< std::setw(op_padding) << std::right << "sec/op"
<< std::setw(op_padding) << std::right << "op/sec"
<< "\n";
// add table entries
for(const Timer& entry : m_ops_entries)
{
result_ss << std::setw(name_padding) << std::left << entry.get_name()
<< std::setw(op_name_padding) << std::left << entry.doing()
<< std::setw(op_padding) << std::right << entry.seconds_per_event()
<< std::setw(op_padding) << std::right << entry.events_per_second()
<< "\n";
}
}
return result_ss.str();
}
private:
std::map<std::pair<std::string, std::string>, std::vector<Timer>> m_bps_entries;
std::vector<Timer> m_ops_entries;
};
std::vector<size_t> unique_buffer_sizes(const std::string& cmdline_arg)
{
std::set<size_t> buf;
for(std::string size_str : Botan::split_on(cmdline_arg, ','))
{
size_t x = 0;
try
{
size_t converted = 0;
x = static_cast<size_t>(std::stoul(size_str, &converted, 0));
if(converted != size_str.size())
throw CLI_Usage_Error("Invalid integer");
}
catch(std::exception& e)
{
throw CLI_Usage_Error("Invalid integer value '" + size_str + "' for option buf-size");
}
if(x == 0 || x > 16*1024*1024)
throw CLI_Usage_Error("Invalid integer value '" + size_str + "' for option buf-size");
buf.insert(x);
}
return std::vector<size_t>(buf.begin(), buf.end());
}
}
class Speed final : public Command
{
public:
Speed()
: Command("speed --msec=500 --format=default --ecc-groups= --provider= --buf-size=1024 --clear-cpuid= --cpu-clock-speed=0 --cpu-clock-ratio=1.0 *algos") {}
std::vector<std::string> default_benchmark_list()
{
/*
This is not intended to be exhaustive: it just hits the high
points of the most interesting or widely used algorithms.
*/
return {
/* Block ciphers */
"AES-128",
"AES-192",
"AES-256",
"ARIA-128",
"ARIA-192",
"ARIA-256",
"Blowfish",
"CAST-128",
"CAST-256",
"Camellia-128",
"Camellia-192",
"Camellia-256",
"DES",
"TripleDES",
"GOST-28147-89",
"IDEA",
"KASUMI",
"MISTY1",
"Noekeon",
"SHACAL2",
"SM4",
"Serpent",
"Threefish-512",
"Twofish",
"XTEA",
/* Cipher modes */
"AES-128/CBC",
"AES-128/CTR-BE",
"AES-128/EAX",
"AES-128/OCB",
"AES-128/GCM",
"AES-128/XTS",
"Serpent/CBC",
"Serpent/CTR-BE",
"Serpent/EAX",
"Serpent/OCB",
"Serpent/GCM",
"Serpent/XTS",
"ChaCha20Poly1305",
/* Stream ciphers */
"RC4",
"Salsa20",
/* Hashes */
"Tiger",
"RIPEMD-160",
"SHA-160",
"SHA-256",
"SHA-512",
"Skein-512",
"Keccak-1600(512)",
"Whirlpool",
/* MACs */
"CMAC(AES-128)",
"HMAC(SHA-256)",
/* Misc */
"random_prime",
/* pubkey */
"RSA",
"DH",
"ECDH",
"ECDSA",
"ECKCDSA",
"ECGDSA",
"Ed25519",
"Curve25519",
"NEWHOPE",
"McEliece",
};
}
std::string group() const override
{
return "misc";
}
std::string description() const override
{
return "Measures the speed of algorithms";
}
void go() override
{
std::chrono::milliseconds msec(get_arg_sz("msec"));
const std::string provider = get_arg("provider");
std::vector<std::string> ecc_groups = Botan::split_on(get_arg("ecc-groups"), ',');
const std::string format = get_arg("format");
const std::string clock_ratio = get_arg("cpu-clock-ratio");
m_clock_speed = get_arg_sz("cpu-clock-speed");
m_clock_cycle_ratio = std::strtod(clock_ratio.c_str(), nullptr);
/*
* This argument is intended to be the ratio between the cycle counter
* and the actual machine cycles. It is extremely unlikely that there is
* any machine where the cycle counter increments faster than the actual
* clock.
*/
if(m_clock_cycle_ratio < 0.0 || m_clock_cycle_ratio > 1.0)
throw CLI_Usage_Error("Unlikely CPU clock ratio of " + clock_ratio);
m_clock_cycle_ratio = 1.0 / m_clock_cycle_ratio;
if(m_clock_speed != 0 && Botan::OS::get_processor_timestamp() != 0)
{
error_output() << "The --cpu-clock-speed option is only intended to be used on "
"platforms without access to a cycle counter.\n"
"Expected incorrect results\n\n";;
}
if(format == "table")
m_summary.reset(new Summary);
else if(format == "json")
m_json.reset(new JSON_Output);
else if(format != "default")
throw CLI_Usage_Error("Unknown --format type '" + format + "'");
if(ecc_groups.empty())
ecc_groups = { "secp256r1", "brainpool256r1",
"secp384r1", "brainpool384r1",
"secp521r1", "brainpool512r1" };
std::vector<std::string> algos = get_arg_list("algos");
const std::vector<size_t> buf_sizes = unique_buffer_sizes(get_arg("buf-size"));
Botan::CPUID::initialize();
for(std::string cpuid_to_clear : Botan::split_on(get_arg("clear-cpuid"), ','))
{
for(auto bit : Botan::CPUID::bit_from_string(cpuid_to_clear))
{
Botan::CPUID::clear_cpuid_bit(bit);
}
}
if(verbose() || m_summary)
{
output() << Botan::version_string() << "\n"
<< "CPUID: " << Botan::CPUID::to_string() << "\n\n";
}
const bool using_defaults = (algos.empty());
if(using_defaults)
{
algos = default_benchmark_list();
}
for(auto algo : algos)
{
using namespace std::placeholders;
if(false)
{
}
#if defined(BOTAN_HAS_HASH)
else if(Botan::HashFunction::providers(algo).size() > 0)
{
bench_providers_of<Botan::HashFunction>(
algo, provider, msec, buf_sizes,
std::bind(&Speed::bench_hash, this, _1, _2, _3, _4));
}
#endif
#if defined(BOTAN_HAS_BLOCK_CIPHER)
else if(Botan::BlockCipher::providers(algo).size() > 0)
{
bench_providers_of<Botan::BlockCipher>(
algo, provider, msec, buf_sizes,
std::bind(&Speed::bench_block_cipher, this, _1, _2, _3, _4));
}
#endif
#if defined(BOTAN_HAS_STREAM_CIPHER)
else if(Botan::StreamCipher::providers(algo).size() > 0)
{
bench_providers_of<Botan::StreamCipher>(
algo, provider, msec, buf_sizes,
std::bind(&Speed::bench_stream_cipher, this, _1, _2, _3, _4));
}
#endif
#if defined(BOTAN_HAS_CIPHER_MODES)
else if(auto enc = Botan::Cipher_Mode::create(algo, Botan::ENCRYPTION))
{
auto dec = Botan::Cipher_Mode::create_or_throw(algo, Botan::DECRYPTION);
bench_cipher_mode(*enc, *dec, msec, buf_sizes);
}
#endif
#if defined(BOTAN_HAS_MAC)
else if(Botan::MessageAuthenticationCode::providers(algo).size() > 0)
{
bench_providers_of<Botan::MessageAuthenticationCode>(
algo, provider, msec, buf_sizes,
std::bind(&Speed::bench_mac, this, _1, _2, _3, _4));
}
#endif
#if defined(BOTAN_HAS_RSA)
else if(algo == "RSA")
{
bench_rsa(provider, msec);
}
#endif
#if defined(BOTAN_HAS_ECDSA)
else if(algo == "ECDSA")
{
bench_ecdsa(ecc_groups, provider, msec);
}
#endif
#if defined(BOTAN_HAS_SM2)
else if(algo == "SM2")
{
bench_sm2(ecc_groups, provider, msec);
}
#endif
#if defined(BOTAN_HAS_ECKCDSA)
else if(algo == "ECKCDSA")
{
bench_eckcdsa(ecc_groups, provider, msec);
}
#endif
#if defined(BOTAN_HAS_GOST_34_10_2001)
else if(algo == "GOST-34.10")
{
bench_gost_3410(provider, msec);
}
#endif
#if defined(BOTAN_HAS_ECGDSA)
else if(algo == "ECGDSA")
{
bench_ecgdsa(ecc_groups, provider, msec);
}
#endif
#if defined(BOTAN_HAS_ED25519)
else if(algo == "Ed25519")
{
bench_ed25519(provider, msec);
}
#endif
#if defined(BOTAN_HAS_DIFFIE_HELLMAN)
else if(algo == "DH")
{
bench_dh(provider, msec);
}
#endif
#if defined(BOTAN_HAS_DSA)
else if(algo == "DSA")
{
bench_dsa(provider, msec);
}
#endif
#if defined(BOTAN_HAS_ELGAMAL)
else if(algo == "ElGamal")
{
bench_elgamal(provider, msec);
}
#endif
#if defined(BOTAN_HAS_ECDH)
else if(algo == "ECDH")
{
bench_ecdh(ecc_groups, provider, msec);
}
#endif
#if defined(BOTAN_HAS_CURVE_25519)
else if(algo == "Curve25519")
{
bench_curve25519(provider, msec);
}
#endif
#if defined(BOTAN_HAS_MCELIECE)
else if(algo == "McEliece")
{
bench_mceliece(provider, msec);
}
#endif
#if defined(BOTAN_HAS_XMSS)
else if(algo == "XMSS")
{
bench_xmss(provider, msec);
}
#endif
#if defined(BOTAN_HAS_NEWHOPE) && defined(BOTAN_HAS_CHACHA_RNG)
else if(algo == "NEWHOPE")
{
bench_newhope(provider, msec);
}
#endif
#if defined(BOTAN_HAS_DL_GROUP)
else if(algo == "modexp")
{
bench_modexp(msec);
}
#endif
#if defined(BOTAN_HAS_NUMBERTHEORY)
else if(algo == "random_prime")
{
bench_random_prime(msec);
}
else if(algo == "inverse_mod")
{
bench_inverse_mod(msec);
}
else if(algo == "bn_redc")
{
bench_bn_redc(msec);
}
#endif
#if defined(BOTAN_HAS_FPE_FE1)
else if(algo == "fpe_fe1")
{
bench_fpe_fe1(msec);
}
#endif
#if defined(BOTAN_HAS_RFC3394_KEYWRAP)
else if(algo == "rfc3394")
{
bench_rfc3394(msec);
}
#endif
#if defined(BOTAN_HAS_ECC_GROUP)
else if(algo == "ecc_mult")
{
bench_ecc_mult(ecc_groups, msec);
}
else if(algo == "os2ecp")
{
bench_os2ecp(ecc_groups, msec);
}
#endif
else if(algo == "RNG")
{
#if defined(BOTAN_HAS_AUTO_SEEDING_RNG)
Botan::AutoSeeded_RNG auto_rng;
bench_rng(auto_rng, "AutoSeeded_RNG (with reseed)", msec, buf_sizes);
#endif
#if defined(BOTAN_HAS_SYSTEM_RNG)
bench_rng(Botan::system_rng(), "System_RNG", msec, buf_sizes);
#endif
#if defined(BOTAN_HAS_RDRAND_RNG)
if(Botan::CPUID::has_rdrand())
{
Botan::RDRAND_RNG rdrand;
bench_rng(rdrand, "RDRAND", msec, buf_sizes);
}
#endif
#if defined(BOTAN_HAS_HMAC_DRBG)
for(std::string hash : { "SHA-256", "SHA-384", "SHA-512" })
{
Botan::HMAC_DRBG hmac_drbg(hash);
bench_rng(hmac_drbg, hmac_drbg.name(), msec, buf_sizes);
}
#endif
#if defined(BOTAN_HAS_CHACHA_RNG)
// Provide a dummy seed
Botan::ChaCha_RNG chacha_rng(Botan::secure_vector<uint8_t>(32));
bench_rng(chacha_rng, "ChaCha_RNG", msec, buf_sizes);
#endif
}
else if(algo == "entropy")
{
bench_entropy_sources(msec);
}
else
{
if(verbose() || !using_defaults)
{
error_output() << "Unknown algorithm '" << algo << "'\n";
}
}
}
if(m_json)
{
output() << m_json->print();
}
if(m_summary)
{
output() << m_summary->print() << "\n";
}
if(verbose() && m_clock_speed == 0 && m_cycles_consumed > 0 && m_ns_taken > 0)
{
const double seconds = static_cast<double>(m_ns_taken) / 1000000000;
const double Hz = static_cast<double>(m_cycles_consumed) / seconds;
const double MHz = Hz / 1000000;
output() << "\nEstimated clock speed " << MHz << " MHz\n";
}
}
private:
size_t m_clock_speed = 0;
double m_clock_cycle_ratio = 0.0;
uint64_t m_cycles_consumed = 0;
uint64_t m_ns_taken = 0;
std::unique_ptr<Summary> m_summary;
std::unique_ptr<JSON_Output> m_json;
void record_result(const std::unique_ptr<Timer>& t)
{
m_ns_taken += t->value();
m_cycles_consumed += t->cycles_consumed();
if(m_json)
{
m_json->add(*t);
}
else
{
output() << t->to_string() << std::flush;
if(m_summary)
m_summary->add(*t);
}
}
template<typename T>
using bench_fn = std::function<void (T&,
std::string,
std::chrono::milliseconds,
const std::vector<size_t>&)>;
template<typename T>
void bench_providers_of(const std::string& algo,
const std::string& provider, /* user request, if any */
const std::chrono::milliseconds runtime,
const std::vector<size_t>& buf_sizes,
bench_fn<T> bench_one)
{
for(auto const& prov : T::providers(algo))
{
if(provider.empty() || provider == prov)
{
auto p = T::create(algo, prov);
if(p)
{
bench_one(*p, prov, runtime, buf_sizes);
}
}
}
}
std::unique_ptr<Timer> make_timer(const std::string& name,
uint64_t event_mult = 1,
const std::string& what = "",
const std::string& provider = "",
size_t buf_size = 0)
{
return std::unique_ptr<Timer>(
new Timer(name, provider, what, event_mult, buf_size,
m_clock_cycle_ratio, m_clock_speed));
}
std::unique_ptr<Timer> make_timer(const std::string& algo,
const std::string& provider,
const std::string& what)
{
return make_timer(algo, 1, what, provider, 0);
}
#if defined(BOTAN_HAS_BLOCK_CIPHER)
void bench_block_cipher(Botan::BlockCipher& cipher,
const std::string& provider,
std::chrono::milliseconds runtime,
const std::vector<size_t>& buf_sizes)
{
std::unique_ptr<Timer> ks_timer = make_timer(cipher.name(), provider, "key schedule");
const Botan::SymmetricKey key(rng(), cipher.maximum_keylength());
ks_timer->run([&]() { cipher.set_key(key); });
const size_t bs = cipher.block_size();
std::set<size_t> buf_sizes_in_blocks;
for(size_t buf_size : buf_sizes)
{
if(buf_size % bs == 0)
buf_sizes_in_blocks.insert(buf_size);
else
buf_sizes_in_blocks.insert(buf_size + bs - (buf_size % bs));
}
for(size_t buf_size : buf_sizes_in_blocks)
{
std::vector<uint8_t> buffer(buf_size);
std::unique_ptr<Timer> encrypt_timer = make_timer(cipher.name(), buffer.size(), "encrypt", provider, buf_size);
std::unique_ptr<Timer> decrypt_timer = make_timer(cipher.name(), buffer.size(), "decrypt", provider, buf_size);
encrypt_timer->run_until_elapsed(runtime, [&]() { cipher.encrypt(buffer); });
record_result(encrypt_timer);
decrypt_timer->run_until_elapsed(runtime, [&]() { cipher.decrypt(buffer); });
record_result(decrypt_timer);
}
}
#endif
#if defined(BOTAN_HAS_STREAM_CIPHER)
void bench_stream_cipher(
Botan::StreamCipher& cipher,
const std::string& provider,
const std::chrono::milliseconds runtime,
const std::vector<size_t>& buf_sizes)
{
for(auto buf_size : buf_sizes)
{
Botan::secure_vector<uint8_t> buffer = rng().random_vec(buf_size);
std::unique_ptr<Timer> encrypt_timer = make_timer(cipher.name(), buffer.size(), "encrypt", provider, buf_size);
const Botan::SymmetricKey key(rng(), cipher.maximum_keylength());
cipher.set_key(key);
if(cipher.valid_iv_length(12))
{
const Botan::InitializationVector iv(rng(), 12);
cipher.set_iv(iv.begin(), iv.size());
}
while(encrypt_timer->under(runtime))
{
encrypt_timer->run([&]() { cipher.encipher(buffer); });
}
record_result(encrypt_timer);
}
}
#endif
#if defined(BOTAN_HAS_HASH)
void bench_hash(
Botan::HashFunction& hash,
const std::string& provider,
const std::chrono::milliseconds runtime,
const std::vector<size_t>& buf_sizes)
{
std::vector<uint8_t> output(hash.output_length());
for(auto buf_size : buf_sizes)
{
Botan::secure_vector<uint8_t> buffer = rng().random_vec(buf_size);
std::unique_ptr<Timer> timer = make_timer(hash.name(), buffer.size(), "hash", provider, buf_size);
timer->run_until_elapsed(runtime, [&]() { hash.update(buffer); hash.final(output.data()); });
record_result(timer);
}
}
#endif
#if defined(BOTAN_HAS_MAC)
void bench_mac(
Botan::MessageAuthenticationCode& mac,
const std::string& provider,
const std::chrono::milliseconds runtime,
const std::vector<size_t>& buf_sizes)
{
std::vector<uint8_t> output(mac.output_length());
for(auto buf_size : buf_sizes)
{
Botan::secure_vector<uint8_t> buffer = rng().random_vec(buf_size);
const Botan::SymmetricKey key(rng(), mac.maximum_keylength());
mac.set_key(key);
mac.start(nullptr, 0);
std::unique_ptr<Timer> timer = make_timer(mac.name(), buffer.size(), "mac", provider, buf_size);
timer->run_until_elapsed(runtime, [&]() { mac.update(buffer); });
timer->run([&]() { mac.final(output.data()); });
record_result(timer);
}
}
#endif
#if defined(BOTAN_HAS_CIPHER_MODES)
void bench_cipher_mode(
Botan::Cipher_Mode& enc,
Botan::Cipher_Mode& dec,
const std::chrono::milliseconds runtime,
const std::vector<size_t>& buf_sizes)
{
std::unique_ptr<Timer> ks_timer = make_timer(enc.name(), enc.provider(), "key schedule");
const Botan::SymmetricKey key(rng(), enc.key_spec().maximum_keylength());
ks_timer->run([&]() { enc.set_key(key); });
ks_timer->run([&]() { dec.set_key(key); });
record_result(ks_timer);
for(auto buf_size : buf_sizes)
{
Botan::secure_vector<uint8_t> buffer = rng().random_vec(buf_size);
std::unique_ptr<Timer> encrypt_timer = make_timer(enc.name(), buffer.size(), "encrypt", enc.provider(), buf_size);
std::unique_ptr<Timer> decrypt_timer = make_timer(dec.name(), buffer.size(), "decrypt", dec.provider(), buf_size);
Botan::secure_vector<uint8_t> iv = rng().random_vec(enc.default_nonce_length());
if(buf_size >= enc.minimum_final_size())
{
while(encrypt_timer->under(runtime) && decrypt_timer->under(runtime))
{
// Must run in this order, or AEADs will reject the ciphertext
encrypt_timer->run([&]() { enc.start(iv); enc.finish(buffer); });
decrypt_timer->run([&]() { dec.start(iv); dec.finish(buffer); });
if(iv.size() > 0)
{
iv[0] += 1;
}
}
}
record_result(encrypt_timer);
record_result(decrypt_timer);
}
}
#endif
void bench_rng(
Botan::RandomNumberGenerator& rng,
const std::string& rng_name,
const std::chrono::milliseconds runtime,
const std::vector<size_t>& buf_sizes)
{
for(auto buf_size : buf_sizes)
{
Botan::secure_vector<uint8_t> buffer(buf_size);
#if defined(BOTAN_HAS_SYSTEM_RNG)
rng.reseed_from_rng(Botan::system_rng(), 256);
#endif
std::unique_ptr<Timer> timer = make_timer(rng_name, buffer.size(), "generate", "", buf_size);
timer->run_until_elapsed(runtime, [&]() { rng.randomize(buffer.data(), buffer.size()); });
record_result(timer);
}
}
void bench_entropy_sources(const std::chrono::milliseconds)
{
Botan::Entropy_Sources& srcs = Botan::Entropy_Sources::global_sources();
for(auto src : srcs.enabled_sources())
{
size_t entropy_bits = 0;
Botan_Tests::SeedCapturing_RNG rng;
std::unique_ptr<Timer> timer = make_timer(src, "", "bytes");
timer->run([&]() { entropy_bits = srcs.poll_just(rng, src); });
size_t compressed_size = 0;
#if defined(BOTAN_HAS_ZLIB)
std::unique_ptr<Botan::Compression_Algorithm> comp(Botan::make_compressor("zlib"));
if(comp)
{
Botan::secure_vector<uint8_t> compressed;
compressed.assign(rng.seed_material().begin(), rng.seed_material().end());
comp->start(9);
comp->finish(compressed);
compressed_size = compressed.size();
}
#endif
std::ostringstream msg;
msg << "Entropy source " << src << " output " << rng.seed_material().size() << " bytes"
<< " estimated entropy " << entropy_bits << " in " << timer->milliseconds() << " ms";
if(compressed_size > 0)
{
msg << " output compressed to " << compressed_size << " bytes";
}
msg << " total samples " << rng.samples() << "\n";
timer->set_custom_msg(msg.str());
record_result(timer);
}
}
#if defined(BOTAN_HAS_ECC_GROUP)
void bench_ecc_mult(const std::vector<std::string>& groups, const std::chrono::milliseconds runtime)
{
for(std::string group_name : groups)
{
const Botan::EC_Group group(group_name);
std::unique_ptr<Timer> mult_timer = make_timer(group_name + " Montgomery ladder");
std::unique_ptr<Timer> blinded_mult_timer = make_timer(group_name + " blinded comb");
std::unique_ptr<Timer> blinded_var_mult_timer = make_timer(group_name + " blinded window");
const Botan::PointGFp& base_point = group.get_base_point();
std::vector<Botan::BigInt> ws;
while(mult_timer->under(runtime) &&
blinded_mult_timer->under(runtime) &&
blinded_var_mult_timer->under(runtime))
{
const Botan::BigInt scalar(rng(), group.get_p_bits());
const Botan::PointGFp r1 = mult_timer->run([&]() { return base_point * scalar; });
const Botan::PointGFp r2 = blinded_mult_timer->run(
[&]() { return group.blinded_base_point_multiply(scalar, rng(), ws); });
const Botan::PointGFp r3 = blinded_var_mult_timer->run(
[&]() { return group.blinded_var_point_multiply(base_point, scalar, rng(), ws); });
BOTAN_ASSERT_EQUAL(r1, r2, "Same point computed by Montgomery and comb");
BOTAN_ASSERT_EQUAL(r1, r3, "Same point computed by Montgomery and window");
}
record_result(mult_timer);
record_result(blinded_mult_timer);
record_result(blinded_var_mult_timer);
}
}
void bench_os2ecp(const std::vector<std::string>& groups, const std::chrono::milliseconds runtime)
{
std::unique_ptr<Timer> uncmp_timer = make_timer("OS2ECP uncompressed");
std::unique_ptr<Timer> cmp_timer = make_timer("OS2ECP compressed");
for(std::string group_name : groups)
{
const Botan::EC_Group group(group_name);
while(uncmp_timer->under(runtime) && cmp_timer->under(runtime))
{
const Botan::BigInt k(rng(), 256);
const Botan::PointGFp p = group.get_base_point() * k;
const std::vector<uint8_t> os_cmp = p.encode(Botan::PointGFp::COMPRESSED);
const std::vector<uint8_t> os_uncmp = p.encode(Botan::PointGFp::UNCOMPRESSED);
uncmp_timer->run([&]() { group.OS2ECP(os_uncmp); });
cmp_timer->run([&]() { group.OS2ECP(os_cmp); });
}
record_result(uncmp_timer);
record_result(cmp_timer);
}
}
#endif
#if defined(BOTAN_HAS_FPE_FE1)
void bench_fpe_fe1(const std::chrono::milliseconds runtime)
{
const Botan::BigInt n = 1000000000000000;
std::unique_ptr<Timer> enc_timer = make_timer("FPE_FE1 encrypt");
std::unique_ptr<Timer> dec_timer = make_timer("FPE_FE1 decrypt");
const Botan::SymmetricKey key(rng(), 32);
const std::vector<uint8_t> tweak(8); // 8 zeros
Botan::BigInt x = 1;
Botan::FPE_FE1 fpe_fe1(n);
fpe_fe1.set_key(key);
while(enc_timer->under(runtime))
{
enc_timer->start();
x = fpe_fe1.encrypt(x, tweak.data(), tweak.size());
enc_timer->stop();
}
for(size_t i = 0; i != enc_timer->events(); ++i)
{
dec_timer->start();
x = fpe_fe1.decrypt(x, tweak.data(), tweak.size());
dec_timer->stop();
}
BOTAN_ASSERT(x == 1, "FPE works");
record_result(enc_timer);
record_result(dec_timer);
}
#endif
#if defined(BOTAN_HAS_RFC3394_KEYWRAP)
void bench_rfc3394(const std::chrono::milliseconds runtime)
{
std::unique_ptr<Timer> wrap_timer = make_timer("RFC3394 AES-256 key wrap");
std::unique_ptr<Timer> unwrap_timer = make_timer("RFC3394 AES-256 key unwrap");
const Botan::SymmetricKey kek(rng(), 32);
Botan::secure_vector<uint8_t> key(64, 0);
while(wrap_timer->under(runtime))
{
wrap_timer->start();
key = Botan::rfc3394_keywrap(key, kek);
wrap_timer->stop();
unwrap_timer->start();
key = Botan::rfc3394_keyunwrap(key, kek);
unwrap_timer->stop();
key[0] += 1;
}
record_result(wrap_timer);
record_result(unwrap_timer);
}
#endif
#if defined(BOTAN_HAS_DL_GROUP)
void bench_modexp(const std::chrono::milliseconds runtime)
{
for(size_t group_bits : { 1024, 1536, 2048, 3072, 4096 })
{
const std::string group_bits_str = std::to_string(group_bits);
const Botan::DL_Group group("modp/srp/" + group_bits_str);
const size_t e_bits = Botan::dl_exponent_size(group_bits);
const size_t f_bits = group_bits - 1;
const Botan::BigInt random_e(rng(), e_bits);
const Botan::BigInt random_f(rng(), f_bits);
std::unique_ptr<Timer> e_timer = make_timer(group_bits_str + " short exponent", "", "modexp");
std::unique_ptr<Timer> f_timer = make_timer(group_bits_str + " full exponent", "", "modexp");
while(f_timer->under(runtime))
{
e_timer->run([&]() { Botan::power_mod(group.get_g(), random_e, group.get_p()); });
f_timer->run([&]() { Botan::power_mod(group.get_g(), random_f, group.get_p()); });
}
record_result(e_timer);
record_result(f_timer);
}
}
#endif
#if defined(BOTAN_HAS_NUMBERTHEORY)
void bench_bn_redc(const std::chrono::milliseconds runtime)
{
Botan::BigInt p;
p.set_bit(521);
p--;
std::unique_ptr<Timer> barrett_timer = make_timer("Barrett");
std::unique_ptr<Timer> schoolbook_timer = make_timer("Schoolbook");
Botan::Modular_Reducer mod_p(p);
while(schoolbook_timer->under(runtime))
{
const Botan::BigInt x(rng(), p.bits() * 2 - 2);
const Botan::BigInt r1 = barrett_timer->run(
[&] { return mod_p.reduce(x); });
const Botan::BigInt r2 = schoolbook_timer->run(
[&] { return x % p; });
BOTAN_ASSERT(r1 == r2, "Computed different results");
}
record_result(barrett_timer);
record_result(schoolbook_timer);
}
void bench_inverse_mod(const std::chrono::milliseconds runtime)
{
for(size_t bits : { 256, 384, 512 })
{
const Botan::BigInt p = Botan::random_prime(rng(), bits);
const std::string bit_str = std::to_string(bits);
std::unique_ptr<Timer> invmod_timer = make_timer("binext-" + bit_str);
std::unique_ptr<Timer> monty_timer = make_timer("monty-" + bit_str);
std::unique_ptr<Timer> ct_invmod_timer = make_timer("ct-" + bit_str);
std::unique_ptr<Timer> powm_timer = make_timer("powm-" + bit_str);
Botan::Fixed_Exponent_Power_Mod powm_p(p - 2, p);
while(invmod_timer->under(runtime))
{
const Botan::BigInt x(rng(), p.bits() - 1);
const Botan::BigInt x_inv1 = invmod_timer->run(
[&] { return Botan::inverse_euclid(x, p); });
const Botan::BigInt x_inv2 = monty_timer->run(
[&] { return Botan::normalized_montgomery_inverse(x, p); });
const Botan::BigInt x_inv3 = ct_invmod_timer->run(
[&] { return Botan::ct_inverse_mod_odd_modulus(x, p); });
const Botan::BigInt x_inv4 = powm_timer->run(
[&] { return powm_p(x); });
BOTAN_ASSERT_EQUAL(x_inv1, x_inv2, "Same result");
BOTAN_ASSERT_EQUAL(x_inv1, x_inv3, "Same result");
BOTAN_ASSERT_EQUAL(x_inv1, x_inv4, "Same result");
}
record_result(invmod_timer);
record_result(monty_timer);
record_result(ct_invmod_timer);
record_result(powm_timer);
}
}
void bench_random_prime(const std::chrono::milliseconds runtime)
{
const size_t coprime = 65537; // simulates RSA key gen
for(size_t bits : { 1024, 1536 })
{
std::unique_ptr<Timer> genprime_timer = make_timer("random_prime " + std::to_string(bits));
std::unique_ptr<Timer> is_prime_timer = make_timer("is_prime " + std::to_string(bits));
while(genprime_timer->under(runtime) && is_prime_timer->under(runtime))
{
const Botan::BigInt p = genprime_timer->run([&]
{
return Botan::random_prime(rng(), bits, coprime);
});
const bool ok = is_prime_timer->run([&]
{
return Botan::is_prime(p, rng(), 64, true);
});
if(!ok)
{
error_output() << "Generated prime " << p
<< " which then failed primality test";
}
// Now test p+2, p+4, ... which may or may not be prime
for(size_t i = 2; i != 64; i += 2)
{
is_prime_timer->run([&]() { Botan::is_prime(p, rng(), 64, true); });
}
}
record_result(genprime_timer);
record_result(is_prime_timer);
}
}
#endif
#if defined(BOTAN_HAS_PUBLIC_KEY_CRYPTO)
void bench_pk_enc(
const Botan::Private_Key& key,
const std::string& nm,
const std::string& provider,
const std::string& padding,
std::chrono::milliseconds msec)
{
std::vector<uint8_t> plaintext, ciphertext;
Botan::PK_Encryptor_EME enc(key, rng(), padding, provider);
Botan::PK_Decryptor_EME dec(key, rng(), padding, provider);
std::unique_ptr<Timer> enc_timer = make_timer(nm + " " + padding, provider, "encrypt");
std::unique_ptr<Timer> dec_timer = make_timer(nm + " " + padding, provider, "decrypt");
while(enc_timer->under(msec) || dec_timer->under(msec))
{
// Generate a new random ciphertext to decrypt
if(ciphertext.empty() || enc_timer->under(msec))
{
plaintext = unlock(rng().random_vec(enc.maximum_input_size()));
ciphertext = enc_timer->run([&]() { return enc.encrypt(plaintext, rng()); });
}
if(dec_timer->under(msec))
{
auto dec_pt = dec_timer->run([&]() { return dec.decrypt(ciphertext); });
if(dec_pt != plaintext) // sanity check
{
error_output() << "Bad roundtrip in PK encrypt/decrypt bench\n";
}
}
}
record_result(enc_timer);
record_result(dec_timer);
}
void bench_pk_ka(const std::string& algo,
const std::string& nm,
const std::string& params,
const std::string& provider,
std::chrono::milliseconds msec)
{
const std::string kdf = "KDF2(SHA-256)"; // arbitrary choice
std::unique_ptr<Timer> keygen_timer = make_timer(nm, provider, "keygen");
std::unique_ptr<Botan::Private_Key> key1(keygen_timer->run([&]
{
return Botan::create_private_key(algo, rng(), params);
}));
std::unique_ptr<Botan::Private_Key> key2(keygen_timer->run([&]
{
return Botan::create_private_key(algo, rng(), params);
}));
record_result(keygen_timer);
const Botan::PK_Key_Agreement_Key& ka_key1 = dynamic_cast<const Botan::PK_Key_Agreement_Key&>(*key1);
const Botan::PK_Key_Agreement_Key& ka_key2 = dynamic_cast<const Botan::PK_Key_Agreement_Key&>(*key2);
Botan::PK_Key_Agreement ka1(ka_key1, rng(), kdf, provider);
Botan::PK_Key_Agreement ka2(ka_key2, rng(), kdf, provider);
const std::vector<uint8_t> ka1_pub = ka_key1.public_value();
const std::vector<uint8_t> ka2_pub = ka_key2.public_value();
std::unique_ptr<Timer> ka_timer = make_timer(nm, provider, "key agreements");
while(ka_timer->under(msec))
{
Botan::SymmetricKey symkey1 = ka_timer->run([&]() { return ka1.derive_key(32, ka2_pub); });
Botan::SymmetricKey symkey2 = ka_timer->run([&]() { return ka2.derive_key(32, ka1_pub); });
if(symkey1 != symkey2)
{
error_output() << "Key agreement mismatch in PK bench\n";
}
}
record_result(ka_timer);
}
void bench_pk_kem(const Botan::Private_Key& key,
const std::string& nm,
const std::string& provider,
const std::string& kdf,
std::chrono::milliseconds msec)
{
Botan::PK_KEM_Decryptor dec(key, rng(), kdf, provider);
Botan::PK_KEM_Encryptor enc(key, rng(), kdf, provider);
std::unique_ptr<Timer> kem_enc_timer = make_timer(nm, provider, "KEM encrypt");
std::unique_ptr<Timer> kem_dec_timer = make_timer(nm, provider, "KEM decrypt");
while(kem_enc_timer->under(msec) && kem_dec_timer->under(msec))
{
Botan::secure_vector<uint8_t> encap_key, enc_shared_key;
Botan::secure_vector<uint8_t> salt = rng().random_vec(16);
kem_enc_timer->start();
enc.encrypt(encap_key, enc_shared_key, 64, rng(), salt);
kem_enc_timer->stop();
kem_dec_timer->start();
Botan::secure_vector<uint8_t> dec_shared_key = dec.decrypt(encap_key, 64, salt);
kem_dec_timer->stop();
if(enc_shared_key != dec_shared_key)
{
error_output() << "KEM mismatch in PK bench\n";
}
}
record_result(kem_enc_timer);
record_result(kem_dec_timer);
}
void bench_pk_sig_ecc(const std::string& algo,
const std::string& emsa,
const std::string& provider,
const std::vector<std::string>& params,
std::chrono::milliseconds msec)
{
for(std::string grp : params)
{
const std::string nm = grp.empty() ? algo : (algo + "-" + grp);
std::unique_ptr<Timer> keygen_timer = make_timer(nm, provider, "keygen");
std::unique_ptr<Botan::Private_Key> key(keygen_timer->run([&]
{
return Botan::create_private_key(algo, rng(), grp);
}));
record_result(keygen_timer);
bench_pk_sig(*key, nm, provider, emsa, msec);
}
}
void bench_pk_sig(const Botan::Private_Key& key,
const std::string& nm,
const std::string& provider,
const std::string& padding,
std::chrono::milliseconds msec)
{
std::vector<uint8_t> message, signature, bad_signature;
Botan::PK_Signer sig(key, rng(), padding, Botan::IEEE_1363, provider);
Botan::PK_Verifier ver(key, padding, Botan::IEEE_1363, provider);
std::unique_ptr<Timer> sig_timer = make_timer(nm + " " + padding, provider, "sign");
std::unique_ptr<Timer> ver_timer = make_timer(nm + " " + padding, provider, "verify");
while(ver_timer->under(msec) || sig_timer->under(msec))
{
if(signature.empty() || sig_timer->under(msec))
{
/*
Length here is kind of arbitrary, but 48 bytes fits into a single
hash block so minimizes hashing overhead versus the PK op itself.
*/
message = unlock(rng().random_vec(48));
signature = sig_timer->run([&]() { return sig.sign_message(message, rng()); });
bad_signature = signature;
bad_signature[rng().next_byte() % bad_signature.size()] ^= rng().next_nonzero_byte();
}
if(ver_timer->under(msec))
{
const bool verified = ver_timer->run([&]
{
return ver.verify_message(message, signature);
});
if(!verified)
{
error_output() << "Correct signature rejected in PK signature bench\n";
}
const bool verified_bad = ver_timer->run([&]
{
return ver.verify_message(message, bad_signature);
});
if(verified_bad)
{
error_output() << "Bad signature accepted in PK signature bench\n";
}
}
}
record_result(sig_timer);
record_result(ver_timer);
}
#endif
#if defined(BOTAN_HAS_RSA)
void bench_rsa(const std::string& provider,
std::chrono::milliseconds msec)
{
for(size_t keylen : { 1024, 2048, 3072, 4096 })
{
const std::string nm = "RSA-" + std::to_string(keylen);
std::unique_ptr<Timer> keygen_timer = make_timer(nm, provider, "keygen");
std::unique_ptr<Botan::Private_Key> key(keygen_timer->run([&]
{
return Botan::create_private_key("RSA", rng(), std::to_string(keylen));
}));
record_result(keygen_timer);
// Using PKCS #1 padding so OpenSSL provider can play along
bench_pk_sig(*key, nm, provider, "EMSA-PKCS1-v1_5(SHA-256)", msec);
//bench_pk_sig(*key, nm, provider, "PSSR(SHA-256)", msec);
//bench_pk_enc(*key, nm, provider, "EME-PKCS1-v1_5", msec);
//bench_pk_enc(*key, nm, provider, "OAEP(SHA-1)", msec);
}
}
#endif
#if defined(BOTAN_HAS_ECDSA)
void bench_ecdsa(const std::vector<std::string>& groups,
const std::string& provider,
std::chrono::milliseconds msec)
{
return bench_pk_sig_ecc("ECDSA", "EMSA1(SHA-256)", provider, groups, msec);
}
#endif
#if defined(BOTAN_HAS_ECKCDSA)
void bench_eckcdsa(const std::vector<std::string>& groups,
const std::string& provider,
std::chrono::milliseconds msec)
{
return bench_pk_sig_ecc("ECKCDSA", "EMSA1(SHA-256)", provider, groups, msec);
}
#endif
#if defined(BOTAN_HAS_GOST_34_10_2001)
void bench_gost_3410(const std::string& provider,
std::chrono::milliseconds msec)
{
return bench_pk_sig_ecc("GOST-34.10", "EMSA1(GOST-34.11)", provider, {"gost_256A"}, msec);
}
#endif
#if defined(BOTAN_HAS_SM2)
void bench_sm2(const std::vector<std::string>& groups,
const std::string& provider,
std::chrono::milliseconds msec)
{
return bench_pk_sig_ecc("SM2_Sig", "SM3", provider, groups, msec);
}
#endif
#if defined(BOTAN_HAS_ECGDSA)
void bench_ecgdsa(const std::vector<std::string>& groups,
const std::string& provider,
std::chrono::milliseconds msec)
{
return bench_pk_sig_ecc("ECGDSA", "EMSA1(SHA-256)", provider, groups, msec);
}
#endif
#if defined(BOTAN_HAS_ED25519)
void bench_ed25519(const std::string& provider,
std::chrono::milliseconds msec)
{
return bench_pk_sig_ecc("Ed25519", "Pure", provider, std::vector<std::string>{""}, msec);
}
#endif
#if defined(BOTAN_HAS_DIFFIE_HELLMAN)
void bench_dh(const std::string& provider,
std::chrono::milliseconds msec)
{
for(size_t bits : { 1024, 2048, 3072, 4096, 6144, 8192 })
{
bench_pk_ka("DH",
"DH-" + std::to_string(bits),
"modp/ietf/" + std::to_string(bits),
provider, msec);
}
}
#endif
#if defined(BOTAN_HAS_DSA)
void bench_dsa(const std::string& provider, std::chrono::milliseconds msec)
{
for(size_t bits : { 1024, 2048, 3072 })
{
const std::string nm = "DSA-" + std::to_string(bits);
const std::string params =
(bits == 1024) ? "dsa/jce/1024" : ("dsa/botan/" + std::to_string(bits));
std::unique_ptr<Timer> keygen_timer = make_timer(nm, provider, "keygen");
std::unique_ptr<Botan::Private_Key> key(keygen_timer->run([&]
{
return Botan::create_private_key("DSA", rng(), params);
}));
record_result(keygen_timer);
bench_pk_sig(*key, nm, provider, "EMSA1(SHA-256)", msec);
}
}
#endif
#if defined(BOTAN_HAS_ELGAMAL)
void bench_elgamal(const std::string& provider, std::chrono::milliseconds msec)
{
for(size_t keylen : { 1024, 2048, 3072, 4096 })
{
const std::string nm = "ElGamal-" + std::to_string(keylen);
const std::string params = "modp/ietf/" + std::to_string(keylen);
std::unique_ptr<Timer> keygen_timer = make_timer(nm, provider, "keygen");
std::unique_ptr<Botan::Private_Key> key(keygen_timer->run([&]
{
return Botan::create_private_key("ElGamal", rng(), params);
}));
record_result(keygen_timer);
bench_pk_enc(*key, nm, provider, "EME-PKCS1-v1_5", msec);
}
}
#endif
#if defined(BOTAN_HAS_ECDH)
void bench_ecdh(const std::vector<std::string>& groups,
const std::string& provider,
std::chrono::milliseconds msec)
{
for(std::string grp : groups)
{
bench_pk_ka("ECDH", "ECDH-" + grp, grp, provider, msec);
}
}
#endif
#if defined(BOTAN_HAS_CURVE_25519)
void bench_curve25519(const std::string& provider,
std::chrono::milliseconds msec)
{
bench_pk_ka("Curve25519", "Curve25519", "", provider, msec);
}
#endif
#if defined(BOTAN_HAS_MCELIECE)
void bench_mceliece(const std::string& provider,
std::chrono::milliseconds msec)
{
/*
SL=80 n=1632 t=33 - 59 KB pubkey 140 KB privkey
SL=107 n=2480 t=45 - 128 KB pubkey 300 KB privkey
SL=128 n=2960 t=57 - 195 KB pubkey 459 KB privkey
SL=147 n=3408 t=67 - 265 KB pubkey 622 KB privkey
SL=191 n=4624 t=95 - 516 KB pubkey 1234 KB privkey
SL=256 n=6624 t=115 - 942 KB pubkey 2184 KB privkey
*/
const std::vector<std::pair<size_t, size_t>> mce_params =
{
{ 2480, 45 },
{ 2960, 57 },
{ 3408, 67 },
{ 4624, 95 },
{ 6624, 115 }
};
for(auto params : mce_params)
{
size_t n = params.first;
size_t t = params.second;
const std::string nm = "McEliece-" + std::to_string(n) + "," + std::to_string(t) +
" (WF=" + std::to_string(Botan::mceliece_work_factor(n, t)) + ")";
std::unique_ptr<Timer> keygen_timer = make_timer(nm, provider, "keygen");
std::unique_ptr<Botan::Private_Key> key(keygen_timer->run([&]
{
return new Botan::McEliece_PrivateKey(rng(), n, t);
}));
record_result(keygen_timer);
bench_pk_kem(*key, nm, provider, "KDF2(SHA-256)", msec);
}
}
#endif
#if defined(BOTAN_HAS_XMSS)
void bench_xmss(const std::string& provider,
std::chrono::milliseconds msec)
{
// H16 and H20 signatures take an hour or more to generate
std::vector<std::string> xmss_params
{
"XMSS_SHA2-256_W16_H10",
"XMSS_SHA2-512_W16_H10",
"XMSS_SHAKE128_W16_H10",
"XMSS_SHAKE256_W16_H10",
};
for(std::string params : xmss_params)
{
std::unique_ptr<Timer> keygen_timer = make_timer(params, provider, "keygen");
std::unique_ptr<Botan::Private_Key> key(keygen_timer->run([&]
{
return Botan::create_private_key("XMSS", rng(), params);
}));
record_result(keygen_timer);
bench_pk_sig(*key, params, provider, "", msec);
}
}
#endif
#if defined(BOTAN_HAS_NEWHOPE) && defined(BOTAN_HAS_CHACHA_RNG)
void bench_newhope(const std::string& /*provider*/,
std::chrono::milliseconds msec)
{
const std::string nm = "NEWHOPE";
std::unique_ptr<Timer> keygen_timer = make_timer(nm, "", "keygen");
std::unique_ptr<Timer> shareda_timer = make_timer(nm, "", "shareda");
std::unique_ptr<Timer> sharedb_timer = make_timer(nm, "", "sharedb");
Botan::ChaCha_RNG nh_rng(Botan::secure_vector<uint8_t>(32));
while(sharedb_timer->under(msec))
{
std::vector<uint8_t> send_a(Botan::NEWHOPE_SENDABYTES), send_b(Botan::NEWHOPE_SENDBBYTES);
std::vector<uint8_t> shared_a(32), shared_b(32);
Botan::newhope_poly sk_a;
keygen_timer->start();
Botan::newhope_keygen(send_a.data(), &sk_a, nh_rng);
keygen_timer->stop();
sharedb_timer->start();
Botan::newhope_sharedb(shared_b.data(), send_b.data(), send_a.data(), nh_rng);
sharedb_timer->stop();
shareda_timer->start();
Botan::newhope_shareda(shared_a.data(), &sk_a, send_b.data());
shareda_timer->stop();
BOTAN_ASSERT(shared_a == shared_b, "Same derived key");
}
record_result(keygen_timer);
record_result(shareda_timer);
record_result(sharedb_timer);
}
#endif
};
BOTAN_REGISTER_COMMAND("speed", Speed);
}
|