Pseudorandom number generators use mathematical algorithms to produce a sequence of numbers with good statistical properties, but the numbers produced are not genuinely random.
The C Standard function Standard rand()
(available in stdlib.h
) does not have good random number properties function, exposed through the C++ standard library through <cstdlib>
as std::rand()
, makes no guarantees as to the quality of the random sequence produced. The numbers generated by some implementations of std::rand()
have have a comparatively short cycle, and the numbers can be predictable. Applications that have strong pseudorandom number requirements must use a generator that is known to be sufficient for their needs.
Noncompliant Code Example
The following noncompliant code generates an ID with a numeric part produced by calling the rand()
function. The IDs produced are predictable and have limited randomness. Further, depending on the value of RAND_MAX
, the resulting value can have modulo bias.
Code Block | ||||
---|---|---|---|---|
| ||||
enum#include <cstdlib> #include <string> void f() {len = 12}; char id[len]; /* id will hold std::string id("ID"); // Holds the ID, starting with * the characters "ID" followed by a * random integer */ int r; int num; /* ... */ r = rand(); /* generate a random integer */ num = snprintf(id, len, "ID%-d", r); /* generate the ID */ /* ... */ |
Compliant Solution (POSIX)
// by a random integer in the range [0-10000].
id += std::to_string(std::rand() % 10000);
// ...
} |
Compliant Solution
The C++ standard library provides mechanisms for fine-grained control over pseudorandom number generation. It breaks random number generation into two parts: one is the algorithm responsible for providing random values (the engine), and the other is responsible for distribution of the random values via a density function (the distribution). The distribution object is not strictly required, but it works to ensure that values are properly distributed within a given range instead of improperly distributed due to bias issues. This compliant solution uses the Mersenne Twister algorithm as the engine for generating random values and a uniform distribution to negate the modulo bias from the noncompliant code exampleIn this compliant solution, a better pseudorandom number generator is the random()
function. While the low-dozen bits generated by rand()
go through a cyclical pattern, all the bits generated by random()
are usable.
Code Block | ||||
---|---|---|---|---|
| ||||
enum#include <random> #include <string> void f() {len = 12}; char id[len]; /* id will hold std::string id("ID"); // Holds the ID, starting with * the characters "ID" followed by a * random integer */ int r; int num; /* ... */ time_t now = time(NULL); if (now == (time_t) -1) { /* handle error */ } srandom(now); /* seed the PRNG with by a random integer in the current time */ /* ... */ r = random(); /* generate a random integer */ num = snprintf(id, len, "ID%-d", r); /* generate the ID */ /* ... */ |
The rand48
family of functions provides another alternative for pseudorandom numbers.
Although not specified by POSIX, arc4random()
is an option on systems that support it. The arc4random(3)
manual page says that
arc4random()
fits into a middle ground not covered by other subsystems such as the strong, slow, and resource expensive random devices described inrandom(4)
versus the fast but poor quality interfaces described inrand(3)
,random(3)
, anddrand48(3)
.
To achieve the best random numbers possible, an implementation-specific function must be used. When unpredictability matters and speed is not an issue, such as in the creation of strong cryptographic keys, a true entropy source such as /dev/random
or a hardware device capable of generating random numbers should be used. Note that the /dev/random
device can block for a long time if there are not enough events going on to generate sufficient entropy.
Compliant Solution (Windows)
In the compliant solution, on Windows platforms, the CryptGenRandom()
function can be used to generate cryptographically strong random numbers. It is important to note that the exact details of the implementation are unknown, and it is unknown what source of entropy the CryptGenRandom()
uses. The Microsoft Developer Network CryptGenRandom()
reference [MSDN 2010] says,
If an application has access to a good random source, it can fill the
pbBuffer
buffer with some random data before callingCryptGenRandom()
. The CSP [cryptographic service provider] then uses this data to further randomize its internal seed. It is acceptable to omit the step of initializing thepbBuffer
buffer before callingCryptGenRandom()
.
Code Block | ||||
---|---|---|---|---|
| ||||
#include<Wincrypt.h>
HCRYPTPROV hCryptProv;
union {
BYTE bs[sizeof(long int)];
long int li;
} rand_buf;
if (!CryptGenRandom(hCryptProv, sizeof(rand_buf), &rand_buf) {
/* Handle error */
} else {
printf("Random number: %ld\n", rand_buf.li);
}
|
Risk Assessment
range [0-10000].
std::uniform_int_distribution<int> distribution(0, 10000);
std::random_device rd;
std::mt19937 engine(rd());
id += std::to_string(distribution(engine));
// ...
}
|
This compliant solution also seeds the random number engine, in conformance with MSC51-CPP. Ensure your random number generator is properly seeded.
Risk Assessment
Using the std::
Using the rand()
function could lead to predictable random numbers.
Rule | Severity | Likelihood | Remediation Cost | Priority | Level |
---|
MSC50-CPP |
Medium |
Unlikely |
Low | P6 | L2 |
Automated Detection
Tool | Version | Checker | Description |
---|
Section |
---|
LDRA tool suite |
7.6.0
Section |
---|
Fortify SCA |
Section |
---|
V. 5.0 |
Section |
---|
Can detect violations of this rule with CERT C Rule Pack. |
Section |
---|
Compass/ROSE |
Astrée |
| bad-function (AUTOSAR.26.5.1A) | Fully checked | ||||||
Axivion Bauhaus Suite |
| CertC++-MSC50 | |||||||
Clang |
| cert-msc50-cpp | Checked by clang-tidy | ||||||
CodeSonar |
| BADFUNC.RANDOM.RAND | Use of rand | ||||||
Compass/ROSE | |||||||||
| CC2.MSC30 | Fully implemented | |||||||
Helix QAC |
| C++5028 | |||||||
Klocwork |
| CERT.MSC.STD_RAND_CALL | |||||||
LDRA tool suite |
| 44 S | Enhanced Enforcement | ||||||
Parasoft C/C++test |
| CERT_CPP-MSC50-a | Do not use the rand() function for generating pseudorandom numbers | ||||||
Polyspace Bug Finder |
| CERT C++: MSC50-CPP | Checks for use of vulnerable pseudo-random number generator (rule partially covered) | ||||||
RuleChecker |
| bad-function (AUTOSAR.26.5.1A) | Fully checked |
Section |
---|
ECLAIR |
Section |
---|
stlibuse |
Related Vulnerabilities
Search for vulnerabilities resulting from the violation of this rule on the CERT website.
Other Languages
...
Related Guidelines
SEI CERT C++ Coding Standard | MSC51-CPP. Ensure your random number generator is properly seeded |
SEI CERT C Coding Standard | MSC30-C. Do not use the rand() function for generating pseudorandom numbers |
...
...
...
...
Bibliography
...
Use of a Broken or Risky Cryptographic Algorithm |
...
...
-330, |
...
Use of Insufficiently Random Values |
...
Bibliography
[ISO/IEC 9899:2011] | Subclause 7.22.2, "Pseudo-random Sequence Generation Functions" |
[ISO/IEC 14882-2014] | Subclause 26.5, "Random Number Generation" |
...
MSDN 2010] "CryptGenRandom Function."CON04-CPP. Ensure objects are fully initialized before allowing access 49. Miscellaneous (MSC) MSC31-CPP. Ensure that return values are compared against the proper type