82710b55b6
The general idea here is to provide userspace programs with well-defined sources of entropy, in a fashion that doesn't require opening a new file descriptor (ulimits) or accessing paths (/dev/urandom may be restricted by chroot or capsicum). getrandom(2) is the more general API, and comes from the Linux world. Since our urandom and random devices are identical, the GRND_RANDOM flag is ignored. getentropy(3) is added as a compatibility shim for the OpenBSD API. truss(1) support is included. Tests for both system calls are provided. Coverage is believed to be at least as comprehensive as LTP getrandom(2) test coverage. Additionally, instructions for running the LTP tests directly against FreeBSD are provided in the "Test Plan" section of the Differential revision linked below. (They pass, of course.) PR: 194204 Reported by: David CARLIER <david.carlier AT hardenedbsd.org> Discussed with: cperciva, delphij, jhb, markj Relnotes: maybe Differential Revision: https://reviews.freebsd.org/D14500
135 lines
4.3 KiB
C
135 lines
4.3 KiB
C
/*-
|
|
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
|
*
|
|
* Copyright (c) 2000-2015, 2017 Mark R. V. Murray
|
|
* All rights reserved.
|
|
*
|
|
* 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
|
|
* in this position and unchanged.
|
|
* 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 ``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 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$
|
|
*/
|
|
|
|
#ifndef _SYS_RANDOM_H_
|
|
#define _SYS_RANDOM_H_
|
|
|
|
#include <sys/types.h>
|
|
|
|
#ifdef _KERNEL
|
|
|
|
#if !defined(KLD_MODULE)
|
|
#if defined(RANDOM_LOADABLE) && defined(RANDOM_YARROW)
|
|
#error "Cannot define both RANDOM_LOADABLE and RANDOM_YARROW"
|
|
#endif
|
|
#endif
|
|
|
|
struct uio;
|
|
|
|
#if defined(DEV_RANDOM)
|
|
u_int read_random(void *, u_int);
|
|
int read_random_uio(struct uio *, bool);
|
|
#else
|
|
static __inline int
|
|
read_random_uio(void *a __unused, u_int b __unused)
|
|
{
|
|
return (0);
|
|
}
|
|
static __inline u_int
|
|
read_random(void *a __unused, u_int b __unused)
|
|
{
|
|
return (0);
|
|
}
|
|
#endif
|
|
|
|
/*
|
|
* Note: if you add or remove members of random_entropy_source, remember to
|
|
* also update the strings in the static array random_source_descr[] in
|
|
* random_harvestq.c.
|
|
*
|
|
* NOTE: complain loudly to markm@ or on the lists if this enum gets more than 32
|
|
* distinct values (0-31)! ENTROPYSOURCE may be == 32, but not > 32.
|
|
*/
|
|
enum random_entropy_source {
|
|
RANDOM_START = 0,
|
|
RANDOM_CACHED = 0,
|
|
/* Environmental sources */
|
|
RANDOM_ATTACH,
|
|
RANDOM_KEYBOARD,
|
|
RANDOM_MOUSE,
|
|
RANDOM_NET_TUN,
|
|
RANDOM_NET_ETHER,
|
|
RANDOM_NET_NG,
|
|
RANDOM_INTERRUPT,
|
|
RANDOM_SWI,
|
|
RANDOM_FS_ATIME,
|
|
RANDOM_UMA, /* Special!! UMA/SLAB Allocator */
|
|
RANDOM_ENVIRONMENTAL_END = RANDOM_UMA,
|
|
/* Fast hardware random-number sources from here on. */
|
|
RANDOM_PURE_START,
|
|
RANDOM_PURE_OCTEON = RANDOM_PURE_START,
|
|
RANDOM_PURE_SAFE,
|
|
RANDOM_PURE_GLXSB,
|
|
RANDOM_PURE_UBSEC,
|
|
RANDOM_PURE_HIFN,
|
|
RANDOM_PURE_RDRAND,
|
|
RANDOM_PURE_NEHEMIAH,
|
|
RANDOM_PURE_RNDTEST,
|
|
RANDOM_PURE_VIRTIO,
|
|
RANDOM_PURE_BROADCOM,
|
|
RANDOM_PURE_CCP,
|
|
ENTROPYSOURCE
|
|
};
|
|
|
|
#define RANDOM_HARVEST_EVERYTHING_MASK ((1 << (RANDOM_ENVIRONMENTAL_END + 1)) - 1)
|
|
#define RANDOM_HARVEST_PURE_MASK (((1 << ENTROPYSOURCE) - 1) & (-1UL << RANDOM_PURE_START))
|
|
|
|
#define RANDOM_LEGACY_BOOT_ENTROPY_MODULE "/boot/entropy"
|
|
#define RANDOM_CACHED_BOOT_ENTROPY_MODULE "boot_entropy_cache"
|
|
#define RANDOM_CACHED_SKIP_START 256
|
|
|
|
#if defined(DEV_RANDOM)
|
|
void random_harvest_queue(const void *, u_int, u_int, enum random_entropy_source);
|
|
void random_harvest_fast(const void *, u_int, u_int, enum random_entropy_source);
|
|
void random_harvest_direct(const void *, u_int, u_int, enum random_entropy_source);
|
|
void random_harvest_register_source(enum random_entropy_source);
|
|
void random_harvest_deregister_source(enum random_entropy_source);
|
|
#else
|
|
#define random_harvest_queue(a, b, c, d) do {} while (0)
|
|
#define random_harvest_fast(a, b, c, d) do {} while (0)
|
|
#define random_harvest_direct(a, b, c, d) do {} while (0)
|
|
#define random_harvest_register_source(a) do {} while (0)
|
|
#define random_harvest_deregister_source(a) do {} while (0)
|
|
#endif
|
|
|
|
#if defined(RANDOM_ENABLE_UMA)
|
|
#define random_harvest_fast_uma(a, b, c, d) random_harvest_fast(a, b, c, d)
|
|
#else /* !defined(RANDOM_ENABLE_UMA) */
|
|
#define random_harvest_fast_uma(a, b, c, d) do {} while (0)
|
|
#endif /* defined(RANDOM_ENABLE_UMA) */
|
|
|
|
#endif /* _KERNEL */
|
|
|
|
#define GRND_NONBLOCK 0x1
|
|
#define GRND_RANDOM 0x2
|
|
ssize_t getrandom(void *buf, size_t buflen, unsigned int flags);
|
|
|
|
#endif /* _SYS_RANDOM_H_ */
|