blob: 03ae9d334720c01b38838ce19ca2d806f9bebd0f [file] [log] [blame]
Junxiao Shiaf6569a2014-06-14 00:01:34 -07001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Davide Pesavento5f47aa62016-10-07 22:09:09 +02003 * Copyright (c) 2014-2016, Regents of the University of California,
4 * Arizona Board of Regents,
5 * Colorado State University,
6 * University Pierre & Marie Curie, Sorbonne University,
7 * Washington University in St. Louis,
8 * Beijing Institute of Technology,
9 * The University of Memphis.
Junxiao Shiaf6569a2014-06-14 00:01:34 -070010 *
11 * This file is part of NFD (Named Data Networking Forwarding Daemon).
12 * See AUTHORS.md for complete list of NFD authors and contributors.
13 *
14 * NFD is free software: you can redistribute it and/or modify it under the terms
15 * of the GNU General Public License as published by the Free Software Foundation,
16 * either version 3 of the License, or (at your option) any later version.
17 *
18 * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20 * PURPOSE. See the GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License along with
23 * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24 */
25
26/**
Davide Pesavento5f47aa62016-10-07 22:09:09 +020027 * This file declares the global pseudorandom number generator (PRNG).
Junxiao Shiaf6569a2014-06-14 00:01:34 -070028 *
Davide Pesavento5f47aa62016-10-07 22:09:09 +020029 * All random numbers generated by NFD should use this global generator,
30 * so that it can be properly seeded when necessary.
31 *
32 * This PRNG is not suitable for security purposes; security-critical
33 * code must use a cryptographically secure PRNG, such as those provided
34 * by OpenSSL and Crypto++.
Junxiao Shiaf6569a2014-06-14 00:01:34 -070035 */
36
37#ifndef NFD_CORE_RANDOM_HPP
38#define NFD_CORE_RANDOM_HPP
39
Davide Pesavento5f47aa62016-10-07 22:09:09 +020040#include <random>
Junxiao Shiaf6569a2014-06-14 00:01:34 -070041
42namespace nfd {
43
44/** \return the global random number generator instance
45 */
Davide Pesavento5f47aa62016-10-07 22:09:09 +020046std::mt19937&
Junxiao Shiaf6569a2014-06-14 00:01:34 -070047getGlobalRng();
48
49} // namespace nfd
50
51#endif // NFD_CORE_RANDOM_HPP