rngd_entsource.c

/*
 * rngd_entsource.c -- Entropy source and conditioning
 *
 * Copyright (C) 2001 Philipp Rumpf
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335  USA
 */

#define _GNU_SOURCE

#ifndef HAVE_CONFIG_H
#error Invalid or missing autoconf build environment
#endif

#include "rng-tools-config.h"

#include <unistd.h>
#include <stdint.h>
#include <stdlib.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <syslog.h>
#include <string.h>
#include <stddef.h>

#include "rngd.h"
#include "fips.h"
#include "exits.h"
#include "rngd_entsource.h"


/* The overhead incured when tpm returns the random nos as per TCG spec
 * it is 14 bytes.*/
#define TPM_GET_RNG_OVERHEAD	14

/* Read data from the entropy source */
int xread(void *buf, size_t size, struct rng *ent_src)
{
	size_t off = 0;
	ssize_t r;

	while (size > 0) {
		do {
			r = read(ent_src->rng_fd, buf + off, size);
		} while ((r == -1) && (errno == EINTR));
		if (r <= 0)
			break;
		off += r;
		size -= r;
	}

	if (size) {
		message_entsrc(ent_src,LOG_DAEMON|LOG_DEBUG, "read error\n");
		return -1;
	}
	return 0;
}

/* tpm rng read call to kernel has 13 bytes of overhead
 * the logic to process this involves reading to a temporary_buf
 * and copying the no generated to buf */
int xread_tpm(void *buf, size_t size, struct rng *ent_src)
{
	size_t bytes_read = 0;
	ssize_t r, r2;
	int retval = 0;
	unsigned char *temp_buf = NULL;
	unsigned char rng_cmd[] = {
		0, 193,            /* TPM_TAG_RQU_COMMAND */
		0, 0, 0, 14,       /* length */
		0, 0, 0, 70,       /* TPM_ORD_GetRandom */
		0, 0, 0, 0,        /* number of bytes to return */
	};
	char *offset;

	ent_src->rng_fd = open(ent_src->rng_fname, O_RDWR);
	if (ent_src->rng_fd == -1) {
		message_entsrc(ent_src,LOG_DAEMON|LOG_DEBUG,"Unable to open file: %s\n",ent_src->rng_fname);
		return -1;
	}

	temp_buf = (unsigned char *) malloc(size + TPM_GET_RNG_OVERHEAD);
	if (temp_buf == NULL) {
		message_entsrc(ent_src,LOG_ERR|LOG_INFO,"No memory for TPM buffer\n");
		close(ent_src->rng_fd);
		return -1;
	}
	memset(temp_buf, 0, (size+TPM_GET_RNG_OVERHEAD));

	/* 32 bits has been reserved for random byte size */
	rng_cmd[13] = (unsigned char)(size & 0xFF);
	rng_cmd[12] = (unsigned char)((size >> 8) & 0xFF);
	rng_cmd[11] = (unsigned char)((size >> 16) & 0xFF);
	rng_cmd[10] = (unsigned char)((size >> 24) & 0xFF);
	offset = buf;
	while (bytes_read < size) {
		r=0;
		while (r < sizeof(rng_cmd)) {
			r2 = write(ent_src->rng_fd,
				       rng_cmd + r,
				       sizeof(rng_cmd) - r);
			if (r2 < 0) {
				message_entsrc(ent_src,LOG_ERR|LOG_INFO,
					"Error writing %s\n",
					ent_src->rng_name);
				retval = -1;
				goto error_out;
			}
			r += r2;
		}
		if (r < sizeof(rng_cmd)) {
			message_entsrc(ent_src,LOG_ERR|LOG_INFO,
				"Error writing %s\n", ent_src->rng_name);
			retval = -1;
			goto error_out;
		}
		r = read(ent_src->rng_fd, temp_buf,size);
		if (r <= TPM_GET_RNG_OVERHEAD) {
			message_entsrc(ent_src,LOG_ERR|LOG_INFO,
			"Error reading from TPM, no entropy gathered\n");
			retval = -1;
			goto error_out;
		}
		r -= TPM_GET_RNG_OVERHEAD;
		bytes_read = bytes_read + r;
		if (bytes_read > size) {
			memcpy(offset,temp_buf + TPM_GET_RNG_OVERHEAD,
				r - (bytes_read - size));
			break;
		}
		memcpy(offset, temp_buf + TPM_GET_RNG_OVERHEAD, r);
		offset = offset + r;
	}

error_out:
	close(ent_src->rng_fd);
	free(temp_buf);
	return retval;
}

#define RNG_AVAIL "/sys/devices/virtual/misc/hw_random/rng_available"

/*
 * Open entropy source, and initialize it
 */
int init_entropy_source(struct rng *ent_src)
{
	int rngavail_fd;
	char buf[16];

	ent_src->rng_fd = open(ent_src->rng_fname, O_RDONLY | O_NOCTTY);
	if (ent_src->rng_fd == -1) {
		message_entsrc(ent_src,LOG_DAEMON|LOG_DEBUG, "Unable to open file: %s\n", ent_src->rng_fname);
		return 1;
	}

	/* Try to read some data from the entropy source.  If it doesn't return
 	 * an error, assume its ok to use
 	 */
	if (ent_src->xread(buf, sizeof(buf), ent_src) == 0)
		goto source_valid;

	/* RHEL7: since /dev/hwrng will exist now even if there isn't an rng backing it,
	 * check to see if rng_available is empty, and return error if it is.
	 */
	rngavail_fd = open(RNG_AVAIL, O_RDONLY | O_NOCTTY);
	if (rngavail_fd == -1) {
		message_entsrc(ent_src,LOG_DAEMON|LOG_DEBUG, "Unable to open sysfs file: %s\n", RNG_AVAIL);
		return 1;
	}

	int ret = read(rngavail_fd, buf, sizeof(buf));
	if (ret < 0) {
		message_entsrc(ent_src,LOG_DAEMON|LOG_DEBUG, "Error reading sysfs file: %s\n", RNG_AVAIL);
		close(rngavail_fd);
		return 1;
	}

	if (ret == 0 || strncmp(buf, "\n", 1) == 0) {
		message_entsrc(ent_src,LOG_DAEMON|LOG_DEBUG, "No available rng device\n");
		close(rngavail_fd);
		return 1;
	}
	close(rngavail_fd);

source_valid:
	/* Bootstrap FIPS tests */
	ent_src->fipsctx = malloc(sizeof(fips_ctx_t));
	return 0;
}

/*
 * Open tpm entropy source, and initialize it
 */
int init_tpm_entropy_source(struct rng *ent_src)
{
	message_entsrc(ent_src,LOG_CONS|LOG_INFO, "The TPM entropy source only supports TPM1.2 hardware and is "
		"deprecated.  TPM2.0 and later hardware exports entropy via /dev/hwrng, which "
		"can be collected via the hwrng entropy source in rngd\n"); 
	ent_src->rng_fd = open(ent_src->rng_fname, O_RDWR);
	if (ent_src->rng_fd == -1) {
		message_entsrc(ent_src,LOG_DAEMON|LOG_DEBUG,"Unable to open file: %s\n",ent_src->rng_fname);
		return 1;
	}
	/* Bootstrap FIPS tests */
	ent_src->fipsctx = malloc(sizeof(fips_ctx_t));
	close(ent_src->rng_fd);
	return 0;
}