random.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2013-2024 Regents of the University of California.
4  *
5  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6  *
7  * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8  * terms of the GNU Lesser General Public License as published by the Free Software
9  * Foundation, either version 3 of the License, or (at your option) any later version.
10  *
11  * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13  * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14  *
15  * You should have received copies of the GNU General Public License and GNU Lesser
16  * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17  * <http://www.gnu.org/licenses/>.
18  *
19  * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20  */
21 
22 #ifndef NDN_CXX_UTIL_RANDOM_HPP
23 #define NDN_CXX_UTIL_RANDOM_HPP
24 
25 #include "ndn-cxx/util/span.hpp"
26 
27 #include <cstdint>
28 #include <random>
29 
30 namespace ndn::random {
31 
37 uint32_t
38 generateSecureWord32();
39 
45 uint64_t
46 generateSecureWord64();
47 
53 void
54 generateSecureBytes(span<uint8_t> buffer);
55 
56 using RandomNumberEngine = std::mt19937;
57 
64 RandomNumberEngine&
65 getRandomNumberEngine();
66 
74 uint32_t
75 generateWord32();
76 
84 uint64_t
85 generateWord64();
86 
87 } // namespace ndn::random
88 
89 #endif // NDN_CXX_UTIL_RANDOM_HPP
ndn::random::generateSecureWord32
uint32_t generateSecureWord32()
Generate a cryptographically secure random integer in the range [0, 2^32).
Definition: random.cpp:31
ndn::random::generateWord32
uint32_t generateWord32()
Generate a non-cryptographically-secure random integer in the range [0, 2^32).
Definition: random.cpp:68
ndn::random::generateSecureBytes
void generateSecureBytes(span< uint8_t > buf)
Fill buffer with cryptographically secure random bytes.
Definition: random.cpp:47
ndn::random::RandomNumberEngine
std::mt19937 RandomNumberEngine
Definition: random.hpp:56
ndn::random::generateSecureWord64
uint64_t generateSecureWord64()
Generate a cryptographically secure random integer in the range [0, 2^64).
Definition: random.cpp:39
ndn::random::generateWord64
uint64_t generateWord64()
Generate a non-cryptographically-secure random integer in the range [0, 2^64).
Definition: random.cpp:75
ndn::random::getRandomNumberEngine
RandomNumberEngine & getRandomNumberEngine()
Returns a reference to a thread-local instance of a properly seeded PRNG.
Definition: random.cpp:56