mtrandapi.hpp

Go to the documentation of this file.

//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2012- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
 
// Non-cryptographic random number generator
 
#ifndef OPENVPN_RANDOM_MTRANDAPI_H
#define OPENVPN_RANDOM_MTRANDAPI_H
 
#include <random>
 
#include <openvpn/common/size.hpp>
#include <openvpn/random/randapi.hpp>
#include <openvpn/random/randbytestore.hpp>
 
 
//
// Prevent compiler from inlining MTRand byte-fill loops into
// larger call chains, which confuses the optimiser and triggers
// false-positive -Warray-bounds / -Wstringop-overflow warnings.
// This issue appeared first with GCC 16.1 with -O2
//
#if defined(__GNUC__) && !defined(__clang__) && __GNUC__ >= 16
#define MTRAND_GCC_NO_INLINE __attribute__((noinline))
#else
#define MTRAND_GCC_NO_INLINE
#endif
 
 
namespace openvpn {
 
class MTRand : public WeakRandomAPI
{
  public:
    OPENVPN_EXCEPTION(mtrand_error);
 
    using Ptr = RCPtr<MTRand>;
    using rand_type = std::mt19937_64;
 
    MTRand(RandomAPI &seed)
        : rng(gen_seed(seed))
    {
    }
 
    MTRand()
        : rng(gen_seed())
    {
    }
 
    MTRand(const rand_type::result_type seed)
        : rng(seed)
    {
    }
 
    // Random algorithm name
    std::string name() const override
    {
        return "MTRand";
    }
 
    // Fill buffer with random bytes
    MTRAND_GCC_NO_INLINE void rand_bytes(unsigned char *buf, size_t size) override
    {
        while (size--)
            *buf++ = rbs.get_byte(rng);
    }
 
    MTRAND_GCC_NO_INLINE bool rand_bytes_noexcept(unsigned char *buf, size_t size) override
    {
        rand_bytes(buf, size);
        return true;
    }
 
    rand_type::result_type rand()
    {
        return rng();
    }
 
  private:
    static rand_type::result_type gen_seed(RandomAPI &seed)
    {
        return seed.rand_get<rand_type::result_type>();
    }
 
    static rand_type::result_type gen_seed()
    {
        std::random_device rd;
        RandomByteStore<decltype(rd)> rbs;
        rand_type::result_type ret;
        rbs.fill(ret, rd);
        return ret;
    }
 
    rand_type rng;
    RandomByteStore<rand_type> rbs;
};
 
} // namespace openvpn
 
#endif