summaryrefslogtreecommitdiff
path: root/util/libreboot-utils/lib/rand.c
blob: bf090b4374c7ede36b6aed2d19c74c9f3536b98d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
/* SPDX-License-Identifier: MIT
 * Copyright (c) 2026 Leah Rowe <leah@libreboot.org>
 *
 * Random number generation
 */

#if defined(USE_ARC4) && \
    ((USE_ARC4) > 0)
#define _DEFAULT_SOURCE 1 /* for arc4random on *linux* */
			/* (not needed on bsd - on bsd,
			   it is used automatically unless
			   overridden with USE_URANDOM */
#elif defined(USE_URANDOM) && \
    ((USE_URANDOM) > 0)
#include <fcntl.h> /* if not arc4random: /dev/urandom */
#elif defined(__linux__) && \
    !(defined(USE_ARC4) && ((USE_ARC4) > 0))
#ifndef _GNU_SOURCE
#define _GNU_SOURCE 1
#endif
#include <sys/syscall.h>
#include <sys/random.h>
#endif

#ifdef __OpenBSD__
#include <sys/param.h>
#endif
#include <sys/types.h>

#include <errno.h>
#include <fcntl.h>
#include <limits.h>
#include <stddef.h>
#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#include <string.h>
#include <stdint.h>
#include <stdio.h>

#include "../include/common.h"

/* Regarding Linux getrandom/urandom:
 *
 * For maximum security guarantee, we *only*
 * use getrandom via syscall, or /dev/urandom;
 * use of urandom is ill advised. This is why
 * we use the syscall, in case the libc version
 * of getrandom() might defer to /dev/urandom
 *
 * We *abort* on error, for both /dev/urandom
 * and getrandom(), because the BSD arc4random
 * never returns with error; therefore, for the
 * most parity in terms of behaviour, we abort,
 * because otherwise the function would have two
 * return modes: always successful (BSD), or only
 * sometimes (Linux). The BSD arc4random could
 * theoretically abort; it is extremely unlikely
 * there, and just so on Linux, hence this design.
 *
 * This is important, because cryptographic code
 * for example must not rely on weak randomness.
 * We must therefore treat broken randomness as
 * though the world is broken, and burn accordingly.
 *
 * Similarly, any invalid input (NULL, zero bytes
 * requested) are treated as fatal errors; again,
 * cryptographic code must be reliable. If your
 * code erroneously requested zero bytes, you might
 * then end up with a non-randomised buffer, where
 * you likely intended otherwise.
 *
 * In other words: call rset() correctly, or your
 * program dies, and rset will behave correctly,
 * or your program dies.
 */

/* random string generator, with
 * rejection sampling. NOTE: only
 * uses ASCII-safe characters, for
 * printing on a unix terminal
 *
 * you still shouldn't use this for
 * password generation; open diceware
 * passphrases are better for that
 *
 * NOTE: the generated strings must
 * ALSO be safe for file/directory names
 * on unix-like os e.g. linux/bsd
 */
char *
rchars(size_t n) /* emulates spkmodem-decode */
{
	static char ch[] =
	    "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789";

	char *s = NULL;
	size_t i;

	smalloc(&s, n + 1);
	for (i = 0; i < n; i++)
		s[i] = ch[rsize(sizeof(ch) - 1)];

	*(s + n) = '\0';
	return s;
}

size_t
rsize(size_t n)
{
	size_t rval = SIZE_MAX;
	if (!n)
		exitf("rsize: division by zero");

	/* rejection sampling (clamp rand to eliminate modulo bias) */
	for (; rval >= SIZE_MAX - (SIZE_MAX % n); rset(&rval, sizeof(rval)));

	return rval % n;
}

void *
rmalloc(size_t n)
{
	void *buf = NULL;
	rset(vmalloc(&buf, n), n);
	return buf; /* basically malloc() but with rand */
}

void
rset(void *buf, size_t n)
{
	int saved_errno = errno;
	errno = 0;

	if (if_err(buf == NULL, EFAULT))
		goto err;

	if (n == 0)
		exitf("rset: zero-byte request");

/* on linux, getrandom is recommended,
   but you can pass -DUSE_ARC4=1 to use arc4random.
   useful for portability testing from linux.
 */
#if (defined(USE_ARC4) && ((USE_ARC4) > 0)) || \
    ((defined(__OpenBSD__) || defined(__FreeBSD__) || \
    defined(__NetBSD__) || defined(__APPLE__) || \
    defined(__DragonFly__)) && !(defined(USE_URANDOM) && \
    ((USE_URANDOM) > 0)))

	arc4random_buf(buf, n);
#else
	size_t off = 0;

retry_rand: {

#if defined(USE_URANDOM) && \
    ((USE_URANDOM) > 0)
	ssize_t rval;
	int fd = -1;

	open_file_on_eintr("/dev/urandom", &fd, O_RDONLY, 0400, NULL);

	while (rw_retry(saved_errno,
	    rval = rw(fd, (unsigned char *)buf + off, n - off, 0, IO_READ)));
#elif defined(__linux__)
	long rval;
	while (sys_retry(saved_errno,
		rval = syscall(SYS_getrandom,
		    (unsigned char *)buf + off, n - off, 0)));
#else
#error Unsupported operating system (possibly unsecure randomisation)
#endif

	if (rval < 0 || /* syscall fehler */
	    rval == 0) { /* prevent infinite loop on fatal err */
#if defined(USE_URANDOM) && \
    ((USE_URANDOM) > 0)
		xclose(&fd);
#endif
		goto err;
	}

	if ((off += (size_t)rval) < n)
		goto retry_rand;

#if defined(USE_URANDOM) && \
    ((USE_URANDOM) > 0)
	xclose(&fd);
#endif
}

#endif
	reset_caller_errno(0);
	return;
err:
	(void) with_fallback_errno(ECANCELED);
	exitf("Randomisierungsfehler");
	exit(EXIT_FAILURE);
}