n2rng_kcf.c revision 741c280d5486676df48cd5d5e8ed8d92eac714a8
3853N/A/*
3853N/A * CDDL HEADER START
3853N/A *
3853N/A * The contents of this file are subject to the terms of the
3853N/A * Common Development and Distribution License (the "License").
3853N/A * You may not use this file except in compliance with the License.
3853N/A *
3853N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
3853N/A * or http://www.opensolaris.org/os/licensing.
3853N/A * See the License for the specific language governing permissions
3853N/A * and limitations under the License.
3853N/A *
3853N/A * When distributing Covered Code, include this CDDL HEADER in each
3853N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
3853N/A * If applicable, add the following below this CDDL HEADER, with the
3853N/A * fields enclosed by brackets "[]" replaced with your own identifying
3853N/A * information: Portions Copyright [yyyy] [name of copyright owner]
3853N/A *
3853N/A * CDDL HEADER END
3853N/A */
3853N/A/*
3853N/A * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
3853N/A * Use is subject to license terms.
3853N/A */
4611N/A
3853N/A#pragma ident "%Z%%M% %I% %E% SMI"
3853N/A
3853N/A#include <sys/types.h>
3853N/A#include <sys/uio.h>
3853N/A#include <sys/stream.h>
3853N/A#include <sys/ddi.h>
3853N/A#include <sys/sunddi.h>
3853N/A#include <sys/strsun.h>
3853N/A#include <sys/kmem.h>
3853N/A#include <sys/atomic.h>
3853N/A#include <sys/random.h>
3853N/A#include <sys/crypto/common.h>
3853N/A#include <sys/crypto/spi.h>
3853N/A#include <sys/n2rng.h>
3853N/A
3853N/A#define IDENT_N2RNG "SUNW_N2_Random_Number_Generator"
3853N/A
3853N/A#define N2RNG_PROVIDER2N2RNG(x) (((n2rng_provider_private_t *)x)->mp_n2rng)
3853N/A
3853N/A
3853N/Astatic void n2rng_provider_status(crypto_provider_handle_t, uint_t *);
3853N/A
3853N/Astatic int n2rng_random_number(crypto_provider_handle_t, crypto_session_id_t,
3853N/A uchar_t *, size_t, crypto_req_handle_t);
3853N/A
3853N/Astatic int ext_info(crypto_provider_handle_t, crypto_provider_ext_info_t *,
3853N/A crypto_req_handle_t);
3853N/A
3853N/Avoid n2rng_ksinit(n2rng_t *n2rng);
3853N/Avoid n2rng_ksdeinit(n2rng_t *n2rng);
3853N/A
3853N/Astatic int fips_init(n2rng_t *n2rng);
3853N/Astatic void fips_fini(n2rng_t *n2rng);
3853N/Aint fips_random(n2rng_t *n2rng, uint8_t *out, size_t nbytes);
3853N/A
3853N/A
3853N/Astatic crypto_control_ops_t n2rng_control_ops = {
3853N/A n2rng_provider_status
3853N/A};
3853N/A
3853N/A
4721N/Astatic crypto_random_number_ops_t n2rng_rng_ops = {
3853N/A NULL, /* seed_random */
3853N/A n2rng_random_number
3853N/A};
3853N/A
3853N/Astatic crypto_provider_management_ops_t n2rng_extinfo_op = {
3853N/A ext_info, /* ext_info */
3853N/A NULL, /* init_token */
3853N/A NULL, /* init_pin */
3853N/A NULL, /* set_pin */
3853N/A};
3853N/A
4014N/Astatic crypto_ops_t n2rng_ops = {
3853N/A &n2rng_control_ops,
3853N/A NULL, /* digest_ops */
3853N/A NULL, /* cipher_ops */
3853N/A NULL, /* mac_ops */
3853N/A NULL, /* sign_ops */
3853N/A NULL, /* verify_ops */
3853N/A NULL, /* dual_ops */
3853N/A NULL, /* cipher_mac_ops */
3853N/A &n2rng_rng_ops, /* rng_ops */
3853N/A NULL, /* session_ops */
3853N/A NULL, /* object_ops */
3853N/A NULL, /* key_ops */
3853N/A &n2rng_extinfo_op, /* management_ops */
3853N/A NULL, /* ctx_ops */
3853N/A NULL /* mech_ops */
3853N/A};
3853N/A
3853N/Astatic crypto_provider_info_t n2rng_prov_info = {
3853N/A CRYPTO_SPI_VERSION_2,
3853N/A NULL, /* pi_provider_description */
3853N/A CRYPTO_HW_PROVIDER,
3853N/A NULL, /* pi_provider_dev */
3853N/A NULL, /* pi_provider_handle */
3853N/A &n2rng_ops,
3853N/A 0, /* number of mechanisms */
3853N/A NULL, /* mechanism table */
3853N/A 0, /* pi_logical_provider_count */
3853N/A NULL /* pi_logical_providers */
3853N/A};
3853N/A
3853N/Astatic void
3853N/Astrncpy_spacepad(uchar_t *s1, char *s2, int n)
3853N/A{
3853N/A int s2len = strlen(s2);
3853N/A
3853N/A (void) strncpy((char *)s1, s2, n);
3853N/A if (s2len < n)
3853N/A (void) memset(s1 + s2len, ' ', n - s2len);
3853N/A}
3853N/A
3853N/A/*ARGSUSED*/
3853N/Astatic int
3853N/Aext_info(crypto_provider_handle_t prov, crypto_provider_ext_info_t *ext_info,
3853N/A crypto_req_handle_t cfreq)
3853N/A{
4803N/A#define BUFSZ 64
3853N/A n2rng_t *n2rng = (n2rng_t *)prov;
3853N/A char buf[BUFSZ];
3853N/A
3853N/A /* handle info common to logical and hardware provider */
3853N/A
3853N/A /* Manufacturer ID */
3853N/A strncpy_spacepad(ext_info->ei_manufacturerID, N2RNG_MANUFACTURER_ID,
3853N/A CRYPTO_EXT_SIZE_MANUF);
4611N/A
3853N/A /* Model */
4611N/A strncpy_spacepad(ext_info->ei_model, "0", CRYPTO_EXT_SIZE_MODEL);
3853N/A
3853N/A /* Token flags */
3853N/A ext_info->ei_flags = CRYPTO_EXTF_RNG | CRYPTO_EXTF_SO_PIN_LOCKED |
3853N/A CRYPTO_EXTF_WRITE_PROTECTED;
3853N/A
3853N/A ext_info->ei_max_session_count = CRYPTO_EFFECTIVELY_INFINITE;
3853N/A ext_info->ei_max_pin_len = 0;
3853N/A ext_info->ei_min_pin_len = 0;
3853N/A ext_info->ei_total_public_memory = CRYPTO_UNAVAILABLE_INFO;
3853N/A ext_info->ei_free_public_memory = CRYPTO_UNAVAILABLE_INFO;
3853N/A ext_info->ei_total_private_memory = CRYPTO_UNAVAILABLE_INFO;
3853N/A ext_info->ei_free_private_memory = CRYPTO_UNAVAILABLE_INFO;
3853N/A
3853N/A /* Time. No need to be supplied for token without a clock */
3853N/A ext_info->ei_time[0] = '\000';
3853N/A
3853N/A /* handle hardware provider specific fields */
3853N/A
3853N/A /* Token label */
3853N/A (void) snprintf(buf, BUFSZ, "%s/%d SUNW_N2_RNG",
3853N/A ddi_driver_name(n2rng->n_dip),
3853N/A ddi_get_instance(n2rng->n_dip));
3853N/A
3853N/A /* Serial number */
3853N/A strncpy_spacepad(ext_info->ei_serial_number,
3853N/A "0",
3853N/A CRYPTO_EXT_SIZE_SERIAL);
3853N/A
3853N/A /* Version info */
3853N/A ext_info->ei_hardware_version.cv_major = 0;
3853N/A ext_info->ei_hardware_version.cv_minor = 0;
3853N/A ext_info->ei_firmware_version.cv_major = 0;
3853N/A ext_info->ei_firmware_version.cv_minor = 0;
3853N/A
3853N/A buf[BUFSZ - 1] = '\000';
3853N/A /* set the token label */
3853N/A strncpy_spacepad(ext_info->ei_label, buf, CRYPTO_EXT_SIZE_LABEL);
3853N/A
3853N/A#undef BUFSZ
3853N/A
3853N/A return (CRYPTO_SUCCESS);
3853N/A}
3853N/A
3853N/Astatic void
3853N/Aunregister_task(void *targ)
3853N/A{
3853N/A n2rng_t *n2rng = (n2rng_t *)targ;
3853N/A
3853N/A /* Unregister provider without checking result */
3853N/A (void) n2rng_unregister_provider(n2rng);
3853N/A}
3853N/A
3853N/A/*
3853N/A * Register with KCF if not already registered
3853N/A */
3853N/Aint
3853N/An2rng_register_provider(n2rng_t *n2rng)
3853N/A{
3853N/A int ret;
3853N/A
3853N/A if (n2rng_isregistered(n2rng)) {
3853N/A DBG0(n2rng, DKCF, "n2rng_kcf: Crypto provider already "
3853N/A "registered");
3853N/A return (DDI_SUCCESS);
3853N/A } else {
3853N/A ret = crypto_register_provider(&n2rng_prov_info,
3853N/A &n2rng->n_prov);
3853N/A if (ret == CRYPTO_SUCCESS) {
3853N/A DBG0(n2rng, DKCF, "n2rng_kcf: Crypto provider "
3853N/A "registered");
3853N/A } else {
3853N/A cmn_err(CE_WARN,
3853N/A "crypto_register_provider() failed (%d)", ret);
3853N/A n2rng->n_prov = NULL;
3853N/A return (DDI_FAILURE);
3853N/A }
3853N/A }
3853N/A n2rng_setregistered(n2rng);
3853N/A crypto_provider_notification(n2rng->n_prov, CRYPTO_PROVIDER_READY);
3853N/A
3853N/A return (DDI_SUCCESS);
3853N/A}
3853N/A
3853N/A/*
3853N/A * Unregister with KCF if not already registered
3853N/A */
3853N/Aint
3853N/An2rng_unregister_provider(n2rng_t *n2rng)
3853N/A{
3853N/A if (!n2rng_isregistered(n2rng)) {
3853N/A DBG0(n2rng, DKCF, "n2rng_kcf: Crypto provider already "
3853N/A "unregistered");
3853N/A } else {
3853N/A if (crypto_unregister_provider(n2rng->n_prov) ==
3853N/A CRYPTO_SUCCESS) {
3853N/A DBG0(n2rng, DKCF, "n2rng_kcf: Crypto provider "
3853N/A "unregistered");
3853N/A } else {
3853N/A n2rng_error(n2rng, "unable to unregister from kcf");
3853N/A return (DDI_FAILURE);
4859N/A }
3853N/A }
3853N/A n2rng->n_prov = NULL;
3853N/A n2rng_clrregistered(n2rng);
4842N/A return (DDI_SUCCESS);
4842N/A}
3853N/A
4859N/A
4859N/A/*
4859N/A * Set state to failed for all rngs if in control domain and dispatch a task
4859N/A * to unregister from kcf
3853N/A */
3853N/Avoid
3853N/An2rng_failure(n2rng_t *n2rng)
3853N/A{
3853N/A int rngid;
3853N/A rng_entry_t *rng;
3853N/A
3853N/A mutex_enter(&n2rng->n_lock);
3853N/A /* Check if error has already been detected */
3853N/A if (n2rng_isfailed(n2rng)) {
3853N/A mutex_exit(&n2rng->n_lock);
3853N/A return;
3853N/A }
3853N/A
3853N/A cmn_err(CE_WARN, "n2rng: hardware failure detected");
3853N/A n2rng_setfailed(n2rng);
3853N/A
3853N/A /* Set each rng to failed if running in control domain */
3853N/A if (n2rng_iscontrol(n2rng)) {
3853N/A for (rngid = 0; rngid < n2rng->n_ctl_data->n_num_rngs;
3853N/A rngid++) {
3853N/A rng = &n2rng->n_ctl_data->n_rngs[rngid];
3853N/A rng->n_rng_state = CTL_STATE_ERROR;
3853N/A }
3853N/A }
3853N/A mutex_exit(&n2rng->n_lock);
3853N/A
3853N/A /* Dispatch task to unregister from kcf */
3853N/A if (ddi_taskq_dispatch(n2rng->n_taskq, unregister_task,
3853N/A (void *)n2rng, DDI_SLEEP) != DDI_SUCCESS) {
3853N/A cmn_err(CE_WARN, "n2rng: ddi_taskq_dispatch() failed");
3853N/A }
3853N/A}
3853N/A
3853N/A/*
3853N/A * Set state to unconfigured for all rngs if in control domain and dispatch a
3853N/A * task to unregister from kcf.
3853N/A */
3853N/Avoid
4014N/An2rng_unconfigured(n2rng_t *n2rng)
3853N/A{
3853N/A int rngid;
3853N/A rng_entry_t *rng;
3853N/A
4721N/A mutex_enter(&n2rng->n_lock);
3853N/A /* Check if unconfigured state has already been detected */
3853N/A if (!n2rng_isconfigured(n2rng)) {
3853N/A mutex_exit(&n2rng->n_lock);
3853N/A return;
3853N/A }
3853N/A
3853N/A cmn_err(CE_WARN, "n2rng: no longer generating entropy");
3853N/A n2rng_clrconfigured(n2rng);
3853N/A
3853N/A /* Set each rng to unconfigured if running in control domain */
3853N/A if (n2rng_iscontrol(n2rng)) {
3853N/A for (rngid = 0; rngid < n2rng->n_ctl_data->n_num_rngs;
3853N/A rngid++) {
3853N/A rng = &n2rng->n_ctl_data->n_rngs[rngid];
3853N/A rng->n_rng_state = CTL_STATE_UNCONFIGURED;
3853N/A }
3853N/A }
3853N/A mutex_exit(&n2rng->n_lock);
3853N/A
3853N/A /* Dispatch task to unregister from kcf */
3853N/A if (ddi_taskq_dispatch(n2rng->n_taskq, unregister_task,
3853N/A (void *)n2rng, DDI_SLEEP) != DDI_SUCCESS) {
3853N/A cmn_err(CE_WARN, "n2rng: ddi_taskq_dispatch() failed");
3853N/A } else {
3853N/A /* Schedule a configuration retry */
3853N/A n2rng_config_retry(n2rng, RNG_CFG_RETRY_SECS);
3853N/A }
3853N/A}
3853N/A
3853N/A/*
3853N/A * Setup and also register to kCF
3853N/A */
3853N/Aint
3853N/An2rng_init(n2rng_t *n2rng)
3853N/A{
3853N/A int ret;
3853N/A char ID[64];
3853N/A dev_info_t *dip;
3853N/A
3853N/A dip = n2rng->n_dip;
3853N/A
3853N/A /* Initialize data structures if not already done */
3853N/A if (!n2rng_isinitialized(n2rng)) {
3853N/A /* initialize kstats */
3853N/A n2rng_ksinit(n2rng);
3853N/A
3853N/A /* initialize the FIPS data and mutexes */
3853N/A ret = fips_init(n2rng);
3853N/A if (ret) {
3853N/A n2rng_ksdeinit(n2rng);
3853N/A return (DDI_FAILURE);
3853N/A }
3853N/A }
3853N/A
3853N/A /*
3853N/A * Register with crypto framework if not already registered.
3853N/A * Be careful not to exceed 32 characters.
3853N/A */
3853N/A (void) sprintf(ID, "%s/%d %s",
3853N/A ddi_driver_name(dip), ddi_get_instance(dip),
3853N/A IDENT_N2RNG);
3853N/A n2rng_prov_info.pi_provider_description = ID;
3853N/A n2rng_prov_info.pi_provider_dev.pd_hw = dip;
3853N/A n2rng_prov_info.pi_provider_handle = n2rng;
3853N/A n2rng_setinitialized(n2rng);
3853N/A ret = n2rng_register_provider(n2rng);
3853N/A if (ret != DDI_SUCCESS) {
3853N/A fips_fini(n2rng);
3853N/A n2rng_ksdeinit(n2rng);
3853N/A n2rng_clrinitialized(n2rng);
3853N/A return (DDI_FAILURE);
3853N/A }
3853N/A
3853N/A return (DDI_SUCCESS);
3853N/A}
3853N/A
3853N/A/*
3853N/A * Unregister from kCF and cleanup
3853N/A */
3853N/Aint
3853N/An2rng_uninit(n2rng_t *n2rng)
3853N/A{
3853N/A /* Un-initialize data structures if they exist */
3853N/A if (n2rng_isinitialized(n2rng)) {
3853N/A /*
3853N/A * Unregister from kCF.
3853N/A * This needs to be done at the beginning of detach.
3853N/A */
3853N/A if (n2rng_unregister_provider(n2rng) != DDI_SUCCESS) {
3853N/A return (DDI_FAILURE);
3853N/A }
3853N/A
3853N/A fips_fini(n2rng);
3853N/A
3853N/A /* deinitialize kstats */
3853N/A n2rng_ksdeinit(n2rng);
3853N/A n2rng_clrinitialized(n2rng);
3853N/A }
3853N/A
3853N/A return (DDI_SUCCESS);
3853N/A}
3853N/A
3853N/A/*
3853N/A * At this time there are no periodic health checks. If the health
3853N/A * check done at attrach time fails, the driver does not even attach.
3853N/A * So there are no failure conditions to report, and this provider is
3853N/A * never busy.
3853N/A */
3853N/A/* ARGSUSED */
3853N/Astatic void
3853N/An2rng_provider_status(crypto_provider_handle_t provider, uint_t *status)
3853N/A{
3853N/A *status = CRYPTO_PROVIDER_READY;
3853N/A}
3853N/A
3853N/A/*ARGSUSED*/
3853N/Astatic int
3853N/An2rng_random_number(crypto_provider_handle_t provider,
3853N/A crypto_session_id_t sess, unsigned char *buf, size_t buflen,
3853N/A crypto_req_handle_t cfreq)
3853N/A{
3853N/A n2rng_t *n2rng = (n2rng_t *)provider;
3853N/A int rv;
3853N/A
3853N/A rv = fips_random(n2rng, buf, buflen);
3853N/A
atomic_add_64(&n2rng->n_stats[DS_RNGBYTES], buflen);
atomic_inc_64(&n2rng->n_stats[DS_RNGJOBS]);
return (rv);
}
static int
fips_init(n2rng_t *n2rng)
{
int i;
int rv;
n2rng->n_frs.fips_round_robin_j = 0;
for (i = 0; i < N2RNG_FIPS_INSTANCES; i++) {
rv = n2rng_fips_random_init(n2rng, &n2rng->n_frs.fipsarray[i]);
if (rv) {
/* finalize all the FIPS structures allocated so far */
for (--i; i >= 0; --i) {
n2rng_fips_random_fini(
&n2rng->n_frs.fipsarray[i]);
}
return (rv);
}
}
return (0);
}
static void
fips_fini(n2rng_t *n2rng)
{
int i;
for (i = 0; i < N2RNG_FIPS_INSTANCES; i++) {
n2rng_fips_random_fini(&n2rng->n_frs.fipsarray[i]);
}
}