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