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-2021 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 
26 #include "ndn-cxx/util/span.hpp"
27 
28 #include <random>
29 
30 namespace ndn {
31 namespace random {
32 
38 uint32_t
40 
46 uint64_t
48 
54 void
55 generateSecureBytes(span<uint8_t> buffer);
56 
60 [[deprecated("use the overload that takes a span<>")]]
61 inline void
62 generateSecureBytes(uint8_t* bytes, size_t size)
63 {
64  generateSecureBytes({bytes, size});
65 }
66 
67 using RandomNumberEngine = std::mt19937;
68 
77 
85 uint32_t
87 
95 uint64_t
97 
98 } // namespace random
99 } // namespace ndn
100 
101 #endif // NDN_CXX_UTIL_RANDOM_HPP
Common includes and macros used throughout the library.
uint32_t generateSecureWord32()
Generate a cryptographically secure random integer from the range [0, 2^32)
Definition: random.cpp:29
uint32_t generateWord32()
Generate a non-cryptographically-secure random integer in the range [0, 2^32)
Definition: random.cpp:66
void generateSecureBytes(span< uint8_t > buf)
Fill buffer with cryptographically secure random bytes.
Definition: random.cpp:45
std::mt19937 RandomNumberEngine
Definition: random.hpp:67
uint64_t generateSecureWord64()
Generate a cryptographically secure random integer from the range [0, 2^64)
Definition: random.cpp:37
uint64_t generateWord64()
Generate a non-cryptographically-secure random integer in the range [0, 2^64)
Definition: random.cpp:73
RandomNumberEngine & getRandomNumberEngine()
Returns a reference to a thread-local instance of a properly seeded PRNG.
Definition: random.cpp:54
Definition: data.cpp:25