master
1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2000-2015, 2017 Mark R. V. Murray
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer
12 * in this position and unchanged.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29#ifndef _SYS_RANDOM_H_
30#define _SYS_RANDOM_H_
31
32#include <sys/types.h>
33
34#ifdef _KERNEL
35
36struct uio;
37
38/*
39 * In the loadable random world, there are set of dangling pointers left in the
40 * core kernel:
41 * * read_random, read_random_uio, is_random_seeded are function pointers,
42 * rather than functions.
43 * * p_random_alg_context is a true pointer in loadable random kernels.
44 *
45 * These are initialized at SI_SUB_RANDOM:SI_ORDER_SECOND during boot. The
46 * read-type pointers are initialized by random_alg_context_init() in
47 * randomdev.c and p_random_alg_context in the algorithm, e.g., fortuna.c's
48 * random_fortuna_init_alg(). The nice thing about function pointers is they
49 * have a similar calling convention to ordinary functions.
50 *
51 * (In !loadable, the read_random, etc, routines are just plain functions;
52 * p_random_alg_context is a macro for the public visibility
53 * &random_alg_context.)
54 */
55#if defined(RANDOM_LOADABLE)
56extern void (*_read_random)(void *, u_int);
57extern int (*_read_random_uio)(struct uio *, bool);
58extern bool (*_is_random_seeded)(void);
59#define read_random(a, b) (*_read_random)(a, b)
60#define read_random_uio(a, b) (*_read_random_uio)(a, b)
61#define is_random_seeded() (*_is_random_seeded)()
62#else
63void read_random(void *, u_int);
64int read_random_uio(struct uio *, bool);
65bool is_random_seeded(void);
66#endif
67
68/*
69 * Note: if you add or remove members of random_entropy_source, remember to
70 * also update the strings in the static array random_source_descr[] in
71 * random_harvestq.c.
72 */
73enum random_entropy_source {
74 RANDOM_START = 0,
75 RANDOM_CACHED = 0,
76 /* Environmental sources */
77 RANDOM_ATTACH,
78 RANDOM_KEYBOARD,
79 RANDOM_MOUSE,
80 RANDOM_NET_TUN,
81 RANDOM_NET_ETHER,
82 RANDOM_NET_NG,
83 RANDOM_INTERRUPT,
84 RANDOM_SWI,
85 RANDOM_FS_ATIME,
86 RANDOM_UMA, /* Special!! UMA/SLAB Allocator */
87 RANDOM_CALLOUT,
88 RANDOM_ENVIRONMENTAL_END = RANDOM_CALLOUT,
89 /* Fast hardware random-number sources from here on. */
90 RANDOM_PURE_START,
91 RANDOM_PURE_OCTEON = RANDOM_PURE_START,
92 RANDOM_PURE_SAFE,
93 RANDOM_PURE_GLXSB,
94 RANDOM_PURE_HIFN,
95 RANDOM_PURE_RDRAND,
96 RANDOM_PURE_NEHEMIAH,
97 RANDOM_PURE_RNDTEST,
98 RANDOM_PURE_VIRTIO,
99 RANDOM_PURE_BROADCOM,
100 RANDOM_PURE_CCP,
101 RANDOM_PURE_DARN,
102 RANDOM_PURE_TPM,
103 RANDOM_PURE_VMGENID,
104 RANDOM_PURE_QUALCOMM,
105 RANDOM_PURE_ARMV8,
106 ENTROPYSOURCE
107};
108_Static_assert(ENTROPYSOURCE <= 32,
109 "hardcoded assumption that values fit in a typical word-sized bitset");
110
111#define RANDOM_CACHED_BOOT_ENTROPY_MODULE "boot_entropy_cache"
112#define RANDOM_PLATFORM_BOOT_ENTROPY_MODULE "boot_entropy_platform"
113
114extern u_int hc_source_mask;
115void random_harvest_queue_(const void *, u_int, enum random_entropy_source);
116void random_harvest_fast_(const void *, u_int);
117void random_harvest_direct_(const void *, u_int, enum random_entropy_source);
118
119static __inline void
120random_harvest_queue(const void *entropy, u_int size, enum random_entropy_source origin)
121{
122
123 if (hc_source_mask & (1 << origin))
124 random_harvest_queue_(entropy, size, origin);
125}
126
127static __inline void
128random_harvest_fast(const void *entropy, u_int size, enum random_entropy_source origin)
129{
130
131 if (hc_source_mask & (1 << origin))
132 random_harvest_fast_(entropy, size);
133}
134
135static __inline void
136random_harvest_direct(const void *entropy, u_int size, enum random_entropy_source origin)
137{
138
139 if (hc_source_mask & (1 << origin))
140 random_harvest_direct_(entropy, size, origin);
141}
142
143void random_harvest_register_source(enum random_entropy_source);
144void random_harvest_deregister_source(enum random_entropy_source);
145
146#if defined(RANDOM_ENABLE_UMA)
147#define random_harvest_fast_uma(a, b, c) random_harvest_fast(a, b, c)
148#else /* !defined(RANDOM_ENABLE_UMA) */
149#define random_harvest_fast_uma(a, b, c) do {} while (0)
150#endif /* defined(RANDOM_ENABLE_UMA) */
151
152#if defined(RANDOM_ENABLE_ETHER)
153#define random_harvest_queue_ether(a, b) random_harvest_queue(a, b, RANDOM_NET_ETHER)
154#else /* !defined(RANDOM_ENABLE_ETHER) */
155#define random_harvest_queue_ether(a, b) do {} while (0)
156#endif /* defined(RANDOM_ENABLE_ETHER) */
157
158#endif /* _KERNEL */
159
160#define GRND_NONBLOCK 0x1
161#define GRND_RANDOM 0x2
162#define GRND_INSECURE 0x4
163
164__BEGIN_DECLS
165ssize_t getrandom(void *buf, size_t buflen, unsigned int flags);
166__END_DECLS
167
168#endif /* _SYS_RANDOM_H_ */