xref: /xnu-8019.80.24/bsd/dev/random/randomdev.c (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1*a325d9c4SApple OSS Distributions /*
2*a325d9c4SApple OSS Distributions  * Copyright (c) 1999-2009 Apple, Inc. All rights reserved.
3*a325d9c4SApple OSS Distributions  *
4*a325d9c4SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*a325d9c4SApple OSS Distributions  *
6*a325d9c4SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*a325d9c4SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*a325d9c4SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*a325d9c4SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*a325d9c4SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*a325d9c4SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*a325d9c4SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*a325d9c4SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*a325d9c4SApple OSS Distributions  *
15*a325d9c4SApple OSS Distributions  * Please obtain a copy of the License at
16*a325d9c4SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*a325d9c4SApple OSS Distributions  *
18*a325d9c4SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*a325d9c4SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*a325d9c4SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*a325d9c4SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*a325d9c4SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*a325d9c4SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*a325d9c4SApple OSS Distributions  * limitations under the License.
25*a325d9c4SApple OSS Distributions  *
26*a325d9c4SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*a325d9c4SApple OSS Distributions  */
28*a325d9c4SApple OSS Distributions 
29*a325d9c4SApple OSS Distributions 
30*a325d9c4SApple OSS Distributions #include <sys/param.h>
31*a325d9c4SApple OSS Distributions #include <sys/systm.h>
32*a325d9c4SApple OSS Distributions #include <sys/proc.h>
33*a325d9c4SApple OSS Distributions #include <sys/errno.h>
34*a325d9c4SApple OSS Distributions #include <sys/ioctl.h>
35*a325d9c4SApple OSS Distributions #include <sys/conf.h>
36*a325d9c4SApple OSS Distributions #include <sys/fcntl.h>
37*a325d9c4SApple OSS Distributions #include <string.h>
38*a325d9c4SApple OSS Distributions #include <miscfs/devfs/devfs.h>
39*a325d9c4SApple OSS Distributions #include <kern/locks.h>
40*a325d9c4SApple OSS Distributions #include <kern/clock.h>
41*a325d9c4SApple OSS Distributions #include <sys/time.h>
42*a325d9c4SApple OSS Distributions #include <sys/malloc.h>
43*a325d9c4SApple OSS Distributions #include <sys/sysproto.h>
44*a325d9c4SApple OSS Distributions #include <sys/uio_internal.h>
45*a325d9c4SApple OSS Distributions 
46*a325d9c4SApple OSS Distributions #include <dev/random/randomdev.h>
47*a325d9c4SApple OSS Distributions 
48*a325d9c4SApple OSS Distributions #include <libkern/OSByteOrder.h>
49*a325d9c4SApple OSS Distributions #include <libkern/OSAtomic.h>
50*a325d9c4SApple OSS Distributions 
51*a325d9c4SApple OSS Distributions #include <mach/mach_time.h>
52*a325d9c4SApple OSS Distributions 
53*a325d9c4SApple OSS Distributions #define RANDOM_MAJOR  -1 /* let the kernel pick the device number */
54*a325d9c4SApple OSS Distributions #define RANDOM_MINOR   0
55*a325d9c4SApple OSS Distributions #define URANDOM_MINOR  1
56*a325d9c4SApple OSS Distributions 
57*a325d9c4SApple OSS Distributions d_ioctl_t       random_ioctl;
58*a325d9c4SApple OSS Distributions 
59*a325d9c4SApple OSS Distributions static const struct cdevsw random_cdevsw =
60*a325d9c4SApple OSS Distributions {
61*a325d9c4SApple OSS Distributions 	.d_open = random_open,
62*a325d9c4SApple OSS Distributions 	.d_close = random_close,
63*a325d9c4SApple OSS Distributions 	.d_read = random_read,
64*a325d9c4SApple OSS Distributions 	.d_write = random_write,
65*a325d9c4SApple OSS Distributions 	.d_ioctl = random_ioctl,
66*a325d9c4SApple OSS Distributions 	.d_stop = (stop_fcn_t *)nulldev,
67*a325d9c4SApple OSS Distributions 	.d_reset = (reset_fcn_t *)nulldev,
68*a325d9c4SApple OSS Distributions 	.d_select = eno_select,
69*a325d9c4SApple OSS Distributions 	.d_mmap = eno_mmap,
70*a325d9c4SApple OSS Distributions 	.d_strategy = eno_strat,
71*a325d9c4SApple OSS Distributions 	.d_reserved_1 = eno_getc,
72*a325d9c4SApple OSS Distributions 	.d_reserved_2 = eno_putc,
73*a325d9c4SApple OSS Distributions };
74*a325d9c4SApple OSS Distributions 
75*a325d9c4SApple OSS Distributions 
76*a325d9c4SApple OSS Distributions /*
77*a325d9c4SApple OSS Distributions  * Called to initialize our device,
78*a325d9c4SApple OSS Distributions  * and to register ourselves with devfs
79*a325d9c4SApple OSS Distributions  */
80*a325d9c4SApple OSS Distributions void
random_init(void)81*a325d9c4SApple OSS Distributions random_init(void)
82*a325d9c4SApple OSS Distributions {
83*a325d9c4SApple OSS Distributions 	int ret;
84*a325d9c4SApple OSS Distributions 
85*a325d9c4SApple OSS Distributions 	ret = cdevsw_add(RANDOM_MAJOR, &random_cdevsw);
86*a325d9c4SApple OSS Distributions 	if (ret < 0) {
87*a325d9c4SApple OSS Distributions 		panic("random_init: failed to allocate a major number!");
88*a325d9c4SApple OSS Distributions 	}
89*a325d9c4SApple OSS Distributions 
90*a325d9c4SApple OSS Distributions 	devfs_make_node(makedev(ret, RANDOM_MINOR), DEVFS_CHAR,
91*a325d9c4SApple OSS Distributions 	    UID_ROOT, GID_WHEEL, 0666, "random", 0);
92*a325d9c4SApple OSS Distributions 
93*a325d9c4SApple OSS Distributions 	/*
94*a325d9c4SApple OSS Distributions 	 * also make urandom
95*a325d9c4SApple OSS Distributions 	 * (which is exactly the same thing in our context)
96*a325d9c4SApple OSS Distributions 	 */
97*a325d9c4SApple OSS Distributions 	devfs_make_node(makedev(ret, URANDOM_MINOR), DEVFS_CHAR,
98*a325d9c4SApple OSS Distributions 	    UID_ROOT, GID_WHEEL, 0666, "urandom", 0);
99*a325d9c4SApple OSS Distributions }
100*a325d9c4SApple OSS Distributions 
101*a325d9c4SApple OSS Distributions int
random_ioctl(__unused dev_t dev,u_long cmd,__unused caddr_t data,__unused int flag,__unused struct proc * p)102*a325d9c4SApple OSS Distributions random_ioctl(   __unused dev_t dev, u_long cmd, __unused caddr_t data,
103*a325d9c4SApple OSS Distributions     __unused int flag, __unused struct proc *p  )
104*a325d9c4SApple OSS Distributions {
105*a325d9c4SApple OSS Distributions 	switch (cmd) {
106*a325d9c4SApple OSS Distributions 	case FIONBIO:
107*a325d9c4SApple OSS Distributions 	case FIOASYNC:
108*a325d9c4SApple OSS Distributions 		break;
109*a325d9c4SApple OSS Distributions 	default:
110*a325d9c4SApple OSS Distributions 		return ENODEV;
111*a325d9c4SApple OSS Distributions 	}
112*a325d9c4SApple OSS Distributions 
113*a325d9c4SApple OSS Distributions 	return 0;
114*a325d9c4SApple OSS Distributions }
115*a325d9c4SApple OSS Distributions 
116*a325d9c4SApple OSS Distributions /*
117*a325d9c4SApple OSS Distributions  * Open the device.  Make sure init happened, and make sure the caller is
118*a325d9c4SApple OSS Distributions  * authorized.
119*a325d9c4SApple OSS Distributions  */
120*a325d9c4SApple OSS Distributions 
121*a325d9c4SApple OSS Distributions int
random_open(__unused dev_t dev,int flags,__unused int devtype,__unused struct proc * p)122*a325d9c4SApple OSS Distributions random_open(__unused dev_t dev, int flags, __unused int devtype, __unused struct proc *p)
123*a325d9c4SApple OSS Distributions {
124*a325d9c4SApple OSS Distributions 	/*
125*a325d9c4SApple OSS Distributions 	 * if we are being opened for write,
126*a325d9c4SApple OSS Distributions 	 * make sure that we have privledges do so
127*a325d9c4SApple OSS Distributions 	 */
128*a325d9c4SApple OSS Distributions 	if (flags & FWRITE) {
129*a325d9c4SApple OSS Distributions 		if (securelevel >= 2) {
130*a325d9c4SApple OSS Distributions 			return EPERM;
131*a325d9c4SApple OSS Distributions 		}
132*a325d9c4SApple OSS Distributions #ifndef __APPLE__
133*a325d9c4SApple OSS Distributions 		if ((securelevel >= 1) && proc_suser(p)) {
134*a325d9c4SApple OSS Distributions 			return EPERM;
135*a325d9c4SApple OSS Distributions 		}
136*a325d9c4SApple OSS Distributions #endif  /* !__APPLE__ */
137*a325d9c4SApple OSS Distributions 	}
138*a325d9c4SApple OSS Distributions 
139*a325d9c4SApple OSS Distributions 	return 0;
140*a325d9c4SApple OSS Distributions }
141*a325d9c4SApple OSS Distributions 
142*a325d9c4SApple OSS Distributions 
143*a325d9c4SApple OSS Distributions /*
144*a325d9c4SApple OSS Distributions  * close the device.
145*a325d9c4SApple OSS Distributions  */
146*a325d9c4SApple OSS Distributions 
147*a325d9c4SApple OSS Distributions int
random_close(__unused dev_t dev,__unused int flags,__unused int mode,__unused struct proc * p)148*a325d9c4SApple OSS Distributions random_close(__unused dev_t dev, __unused int flags, __unused int mode, __unused struct proc *p)
149*a325d9c4SApple OSS Distributions {
150*a325d9c4SApple OSS Distributions 	return 0;
151*a325d9c4SApple OSS Distributions }
152*a325d9c4SApple OSS Distributions 
153*a325d9c4SApple OSS Distributions 
154*a325d9c4SApple OSS Distributions /*
155*a325d9c4SApple OSS Distributions  * Get entropic data from the Security Server, and use it to reseed the
156*a325d9c4SApple OSS Distributions  * prng.
157*a325d9c4SApple OSS Distributions  */
158*a325d9c4SApple OSS Distributions int
random_write(dev_t dev,struct uio * uio,__unused int ioflag)159*a325d9c4SApple OSS Distributions random_write(dev_t dev, struct uio *uio, __unused int ioflag)
160*a325d9c4SApple OSS Distributions {
161*a325d9c4SApple OSS Distributions 	int retCode = 0;
162*a325d9c4SApple OSS Distributions 	char rdBuffer[256];
163*a325d9c4SApple OSS Distributions 
164*a325d9c4SApple OSS Distributions 	if (minor(dev) != RANDOM_MINOR) {
165*a325d9c4SApple OSS Distributions 		return EPERM;
166*a325d9c4SApple OSS Distributions 	}
167*a325d9c4SApple OSS Distributions 
168*a325d9c4SApple OSS Distributions 	/* Security server is sending us entropy */
169*a325d9c4SApple OSS Distributions 
170*a325d9c4SApple OSS Distributions 	while ((size_t)uio_resid(uio) > 0 && retCode == 0) {
171*a325d9c4SApple OSS Distributions 		/* get the user's data */
172*a325d9c4SApple OSS Distributions 		size_t bytesToInput = MIN((size_t)uio_resid(uio), sizeof(rdBuffer));
173*a325d9c4SApple OSS Distributions 		retCode = uiomove(rdBuffer, (int)bytesToInput, uio);
174*a325d9c4SApple OSS Distributions 		if (retCode != 0) {
175*a325d9c4SApple OSS Distributions 			break;
176*a325d9c4SApple OSS Distributions 		}
177*a325d9c4SApple OSS Distributions 		retCode = write_random(rdBuffer, (u_int)bytesToInput);
178*a325d9c4SApple OSS Distributions 		if (retCode != 0) {
179*a325d9c4SApple OSS Distributions 			break;
180*a325d9c4SApple OSS Distributions 		}
181*a325d9c4SApple OSS Distributions 	}
182*a325d9c4SApple OSS Distributions 
183*a325d9c4SApple OSS Distributions 	return retCode;
184*a325d9c4SApple OSS Distributions }
185*a325d9c4SApple OSS Distributions 
186*a325d9c4SApple OSS Distributions /*
187*a325d9c4SApple OSS Distributions  * return data to the caller.  Results unpredictable.
188*a325d9c4SApple OSS Distributions  */
189*a325d9c4SApple OSS Distributions int
random_read(__unused dev_t dev,struct uio * uio,__unused int ioflag)190*a325d9c4SApple OSS Distributions random_read(__unused dev_t dev, struct uio *uio, __unused int ioflag)
191*a325d9c4SApple OSS Distributions {
192*a325d9c4SApple OSS Distributions 	int retCode = 0;
193*a325d9c4SApple OSS Distributions 	char buffer[512];
194*a325d9c4SApple OSS Distributions 
195*a325d9c4SApple OSS Distributions 	size_t bytes_remaining = (size_t)uio_resid(uio);
196*a325d9c4SApple OSS Distributions 	while (bytes_remaining > 0 && retCode == 0) {
197*a325d9c4SApple OSS Distributions 		size_t bytesToRead = MIN(bytes_remaining, sizeof(buffer));
198*a325d9c4SApple OSS Distributions 		read_random(buffer, (u_int)bytesToRead);
199*a325d9c4SApple OSS Distributions 
200*a325d9c4SApple OSS Distributions 		retCode = uiomove(buffer, (int)bytesToRead, uio);
201*a325d9c4SApple OSS Distributions 		if (retCode != 0) {
202*a325d9c4SApple OSS Distributions 			break;
203*a325d9c4SApple OSS Distributions 		}
204*a325d9c4SApple OSS Distributions 
205*a325d9c4SApple OSS Distributions 		bytes_remaining = (size_t)uio_resid(uio);
206*a325d9c4SApple OSS Distributions 	}
207*a325d9c4SApple OSS Distributions 
208*a325d9c4SApple OSS Distributions 	return retCode;
209*a325d9c4SApple OSS Distributions }
210*a325d9c4SApple OSS Distributions 
211*a325d9c4SApple OSS Distributions /*
212*a325d9c4SApple OSS Distributions  * Return an u_int32_t pseudo-random number.
213*a325d9c4SApple OSS Distributions  */
214*a325d9c4SApple OSS Distributions u_int32_t
RandomULong(void)215*a325d9c4SApple OSS Distributions RandomULong(void)
216*a325d9c4SApple OSS Distributions {
217*a325d9c4SApple OSS Distributions 	u_int32_t buf;
218*a325d9c4SApple OSS Distributions 	read_random(&buf, sizeof(buf));
219*a325d9c4SApple OSS Distributions 	return buf;
220*a325d9c4SApple OSS Distributions }
221*a325d9c4SApple OSS Distributions 
222*a325d9c4SApple OSS Distributions 
223*a325d9c4SApple OSS Distributions int
getentropy(__unused struct proc * p,struct getentropy_args * gap,__unused int * ret)224*a325d9c4SApple OSS Distributions getentropy(__unused struct proc * p, struct getentropy_args *gap, __unused int * ret)
225*a325d9c4SApple OSS Distributions {
226*a325d9c4SApple OSS Distributions 	user_addr_t user_addr;
227*a325d9c4SApple OSS Distributions 	user_size_t user_size;
228*a325d9c4SApple OSS Distributions 	char buffer[256];
229*a325d9c4SApple OSS Distributions 
230*a325d9c4SApple OSS Distributions 	user_addr = (user_addr_t)gap->buffer;
231*a325d9c4SApple OSS Distributions 	user_size = gap->size;
232*a325d9c4SApple OSS Distributions 	/* Can't request more than 256 random bytes
233*a325d9c4SApple OSS Distributions 	 * at once. Complying with openbsd getentropy()
234*a325d9c4SApple OSS Distributions 	 */
235*a325d9c4SApple OSS Distributions 	if (user_size > sizeof(buffer)) {
236*a325d9c4SApple OSS Distributions 		return EINVAL;
237*a325d9c4SApple OSS Distributions 	}
238*a325d9c4SApple OSS Distributions 	read_random(buffer, (u_int)user_size);
239*a325d9c4SApple OSS Distributions 	return copyout(buffer, user_addr, user_size);
240*a325d9c4SApple OSS Distributions }
241