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