kcf.c revision 735564919188238196dbd0d320770dda59b38369
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2009 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
/*
* Core KCF (Kernel Cryptographic Framework). This file implements
* the loadable module entry points and module verification routines.
*/
#ifdef DEBUG
int kcf_frmwrk_debug = 0;
#else /* DEBUG */
#define KCF_FRMWRK_DEBUG(l, x)
#endif /* DEBUG */
/*
* Door to make upcalls to kcfd. kcfd will send us this
* handle when it is coming up.
*/
/* Setup FIPS 140 support variables */
/*
* Kernel FIPS140 boundary module list
* NOTE: "swrand" must be the last entry. FIPS 140 shutdown functions stop
* before getting to swrand as it is used for non-FIPS 140
* operations to. The FIPS 140 random API separately controls access.
*/
#define FIPS140_MODULES_MAX 7
static char *fips140_module_list[FIPS140_MODULES_MAX] = {
"aes", "des", "ecc", "sha1", "sha2", "rsa", "swrand"
};
&mod_miscops, "Kernel Crypto Framework"
};
static struct modlinkage modlinkage = {
};
static int rngtimer_started;
int
_init()
{
/* initialize the mechanisms tables supported out-of-the-box */
/* initialize the providers tables */
/* initialize the policy table */
/* initialize soft_config_list */
/*
* Initialize scheduling structures. Note that this does NOT
* start any threads since it might not be safe to do so.
*/
/* initialize the RNG support structures */
rngtimer_started = 0;
kcf_rnd_init();
return (mod_install(&modlinkage));
}
int
{
}
/*
* We do not allow kcf to unload.
*/
int
_fini(void)
{
return (EBUSY);
}
/* Returns the value of global_fips140_mode */
int
kcf_get_fips140_mode(void)
{
return (global_fips140_mode);
}
/*
* If FIPS 140 has failed its tests. The providers must be disabled from the
* framework.
*/
void
{
int i;
"Shutting down FIPS 140 boundary as verification failed.");
/* Disable FIPS 140 modules, but leave swrand alone */
for (i = 0; i < (FIPS140_MODULES_MAX - 1); i++) {
/*
* Remove the predefined entries from the soft_config_list
* so the framework does not report the providers.
*/
continue;
/* Allow the unneeded providers to be unloaded */
/* Invalidate the FIPS 140 providers */
}
}
/*
* Activates the kernel providers
*
* If we are getting ready to enable FIPS 140 mode, then all providers should
* be loaded and ready.
*
* If FIPS 140 is disabled, then we can skip any errors because some crypto
* modules may not have been loaded.
*/
void
{
int i;
for (i = 0; i < (FIPS140_MODULES_MAX - 1); i++) {
continue;
/* There should never be a NULL value in FIPS 140 */
"kernel provider table", fips140_module_list[i]);
break;
}
/*
* Change the provider state so the verification functions
* can signature verify, if necessary, and ready it.
*/
}
}
/* If we in the process of validating FIPS 140, enable it */
if (global_fips140_mode != FIPS140_MODE_DISABLED) {
}
}
/*
* Perform a door call to kcfd to have it check the integrity of the
* kernel boundary. Failure of the boundary will cause a FIPS 140
* configuration to fail
*/
int
{
int ret = 0;
"available\n");
return (1);
}
if (ret != 0) {
ret = 1;
goto exit;
}
ret = 1;
goto exit;
}
exit:
if (ret)
return (ret);
}
/*
* If FIPS 140 is configured to be enabled, before it can be turned on, the
* providers must run their Power On Self Test (POST) and we must wait to sure
* userland has performed its validation tests.
*/
void
{
int post_rv[FIPS140_MODULES_MAX];
int ret = 0;
int i;
/*
* Run POST tests for FIPS 140 modules, if they aren't loaded, load them
*/
for (i = 0; i < FIPS140_MODULES_MAX; i++) {
/* If the module isn't loaded, load it */
if (ret == -1) {
"error modloading module %s.",
fips140_module_list[i]);
goto error;
}
/* Try again to get provider desc */
fips140_module_list[i]);
"Could not find module %s.",
fips140_module_list[i]);
goto error;
}
}
/* Make sure there are FIPS 140 entry points */
"No POST function entry point in %s.",
fips140_module_list[i]);
goto error;
}
/* Make sure the module is not unloaded */
/*
* With the FIPS 140 POST function provided by the module in
* SPI v4, start a thread to run the function.
*/
"for %s\n", fips140_module_list[i]));
}
/* Do integrity check of kernel boundary */
if (ret == 1)
goto error;
/* Wait for POST threads to come back and verify results */
for (i = 0; i < FIPS140_MODULES_MAX; i++) {
if (post_t_did[i] != NULL)
thread_join(post_t_did[i]);
if (post_rv[i] != 0) {
goto error;
}
}
kcf_activate();
return;
}
/*
* Return a pointer to the modctl structure of the
* provider's module.
*/
struct modctl *
{
/* Get the modctl struct for this module */
else {
char *drvmod;
if ((major =
} else
return (NULL);
}
return (mctlp);
}
/* Check if this provider requires to be verified. */
int
{
return (0);
return (1);
}
/*
* With a given provider being registered, this looks through the FIPS 140
* modules list and returns a 1 if it's part of the FIPS 140 boundary and
* the framework registration must be delayed until we know the FIPS 140 mode
* status. A zero mean the provider does not need to wait for the FIPS 140
* boundary.
*
* If the provider in the boundary only provides random (like swrand), we
* can let it register as the random API will block operations.
*/
int
{
int i, ret = 0;
return (0);
goto exit;
for (i = 0; i < FIPS140_MODULES_MAX; i++) {
continue;
/* If this module is only random, we can let it register */
if (KCF_PROV_RANDOM_OPS(pd) &&
break;
if (global_fips140_mode == FIPS140_MODE_SHUTDOWN) {
ret = -1;
break;
}
ret = 1;
break;
}
exit:
return (ret);
}
/*
* Check if signature verification is needed for a provider.
*
* Returns 0, if no verification is needed. Returns 1, if
* verification is needed. Returns -1, if there is an
* error.
*/
int
{
return (0);
return (-1);
/*
* Check if we need to verify this provider signature and if so,
* make sure it has a signature section.
*/
return (0);
/* See if this module has its required signature section. */
return (-1);
return (1);
}
/*
* Do the signature verification on the given module. This function can
* be called from user context or kernel context.
*
* We call kcfd with the full pathname of the module to be
* verified. kcfd will return success/restricted/fail, signature length
* and the actual signature in the ELF section of the module. If kcfd
* returns success or restricted, we compare the signature and the length
* with the values that krtld stored in the module structure. We log an
* error message in case of a failure.
*
* The provider state is changed to KCF_PROV_READY on success.
*/
void
kcf_verify_signature(void *arg)
{
int rv;
char *filename;
/*
* Because of FIPS 140 delays module loading, we may be running through
* this code with a non-crypto signed module; therefore, another
* check is necessary
*/
error = 0;
goto setverify;
}
for (;;) {
/* No need to do verification */
goto out;
}
goto out;
}
/*
* This check is needed since a software provider can call
* us directly from the _init->crypto_register_provider path.
*/
break;
}
/*
* We could be in a race with the register thread or
* the unregister thread. So, retry if register or
* unregister is in progress. Note that we can't do
* mod_hold_by_modctl without this check since that
* could result in a deadlock with the other threads.
*/
/* delay for 10ms and try again */
continue;
}
(void) mod_hold_by_modctl(mctlp,
break;
}
/*
* Check if the door is set up yet. This will be set when kcfd
* comes up. If not, we return and leave the provider state unchanged
* at KCF_PROV_UNVERIFIED. This will trigger the verification of
* the module later when kcfd is up. This is safe as we NEVER use
* a provider that has not been verified yet.
*/
goto out;
}
/*
* Make door upcall. door_ki_upcall() checks for validity of the handle.
*/
if (rv == 0) {
/* Check kcfd result and compare against module struct fields */
filename);
} else {
error = 0;
}
}
} else {
}
/* change state only if the original state is unchanged */
if (error == 0) {
} else {
}
}
if (do_notify) {
/* Dispatch events for this new provider */
}
out:
if (modhold_done)
}
/* called from the CRYPTO_LOAD_DOOR ioctl */
int
{
/* Start the timeout handler to get random numbers */
if (rngtimer_started == 0) {
rngtimer_started = 1;
}
return (0);
}