freebsd-dev/sys/dev/random/fenestrasX/fx_rng.h
Conrad Meyer a3c41f8bfb Add "Fenestras X" alternative /dev/random implementation
Fortuna remains the default; no functional change to GENERIC.

Big picture:
- Scalable entropy generation with per-CPU, buffered local generators.
- "Push" system for reseeding child generators when root PRNG is
  reseeded.  (Design can be extended to arc4random(9) and userspace
  generators.)
- Similar entropy pooling system to Fortuna, but starts with a single
  pool to quickly bootstrap as much entropy as possible early on.
- Reseeding from pooled entropy based on time schedule.  The time
  interval starts small and grows exponentially until reaching a cap.
  Again, the goal is to have the RNG state depend on as much entropy as
  possible quickly, but still periodically incorporate new entropy for
  the same reasons as Fortuna.

Notable design choices in this implementation that differ from those
specified in the whitepaper:
- Blake2B instead of SHA-2 512 for entropy pooling
- Chacha20 instead of AES-CTR DRBG
- Initial seeding.  We support more platforms and not all of them use
  loader(8).  So we have to grab the initial entropy sources in kernel
  mode instead, as much as possible.  Fortuna didn't have any mechanism
  for this aside from the special case of loader-provided previous-boot
  entropy, so most of these sources remain TODO after this commit.

Reviewed by:	markm
Approved by:	csprng (markm)
Differential Revision:	https://reviews.freebsd.org/D22837
2020-10-10 21:45:59 +00:00

73 lines
2.7 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2019 Conrad Meyer <cem@FreeBSD.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#pragma once
#include <crypto/chacha20/chacha.h>
#include <dev/random/fenestrasX/fx_priv.h>
#define FX_CHACHA20_KEYSIZE 32
struct fxrng_basic_rng {
struct mtx rng_lk;
#define FXRNG_RNG_LOCK(rng) mtx_lock(&(rng)->rng_lk)
#define FXRNG_RNG_UNLOCK(rng) mtx_unlock(&(rng)->rng_lk)
#define FXRNG_RNG_ASSERT(rng) mtx_assert(&(rng)->rng_lk, MA_OWNED)
#define FXRNG_RNG_ASSERT_NOT(rng) mtx_assert(&(rng)->rng_lk, MA_NOTOWNED)
/* CTR-mode cipher state, including 128-bit embedded counter. */
struct chacha_ctx rng_prf;
};
/*
* Initialize a basic rng instance (half of a buffered FX BRNG).
* Memory should be zero initialized before this routine.
*/
static inline void
fxrng_rng_init(struct fxrng_basic_rng *rng, bool is_root_rng)
{
if (is_root_rng)
mtx_init(&rng->rng_lk, "fx root brng lk", NULL, MTX_DEF);
else
mtx_init(&rng->rng_lk, "fx pcpu brng lk", NULL, MTX_DEF);
}
static inline void
fxrng_rng_setkey(struct fxrng_basic_rng *rng, const void *newkey, size_t len)
{
ASSERT_DEBUG(len == FX_CHACHA20_KEYSIZE, "chacha20 uses 256 bit keys");
chacha_keysetup(&rng->rng_prf, newkey, len * 8);
}
void fxrng_rng_genrandom_internal(struct fxrng_basic_rng *, void *, size_t,
bool return_unlocked);
void fxrng_rng_reseed(struct fxrng_basic_rng *, bool seeded, const void *,
size_t);
void fxrng_rng_src_reseed(struct fxrng_basic_rng *,
const struct harvest_event *);