2N/A/*
2N/A * CDDL HEADER START
2N/A *
2N/A * The contents of this file are subject to the terms of the
2N/A * Common Development and Distribution License (the "License").
2N/A * You may not use this file except in compliance with the License.
2N/A *
2N/A * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
2N/A * or http://www.opensolaris.org/os/licensing.
2N/A * See the License for the specific language governing permissions
2N/A * and limitations under the License.
2N/A *
2N/A * When distributing Covered Code, include this CDDL HEADER in each
2N/A * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
2N/A * If applicable, add the following below this CDDL HEADER, with the
2N/A * fields enclosed by brackets "[]" replaced with your own identifying
2N/A * information: Portions Copyright [yyyy] [name of copyright owner]
2N/A *
2N/A * CDDL HEADER END
2N/A */
2N/A
2N/A/*
2N/A * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
2N/A */
2N/A
2N/A
2N/A#include <stdlib.h>
2N/A#include <strings.h>
2N/A#include <security/cryptoki.h>
2N/A#include <cryptoutil.h>
2N/A#include <errno.h>
2N/A#include <aes_impl.h>
2N/A
2N/A#include "kmsGlobal.h"
2N/A#include "kmsSlot.h"
2N/A#include "kmsKeystoreUtil.h"
2N/A
2N/A/*
2N/A * Just basic AES mechanisms (for now...)
2N/A */
2N/Astatic CK_MECHANISM_TYPE kms_mechanisms[] = {
2N/A CKM_AES_KEY_GEN,
2N/A CKM_AES_CBC,
2N/A CKM_AES_CBC_PAD
2N/A};
2N/A
2N/A/*
2N/A * KMS only supports 256 bit keys, so the range below is MAX-MAX
2N/A * instead of MIN-MAX.
2N/A */
2N/Astatic CK_MECHANISM_INFO kms_mechanism_info[] = {
2N/A {AES_MAX_KEY_BYTES, AES_MAX_KEY_BYTES, CKF_GENERATE},
2N/A {AES_MAX_KEY_BYTES, AES_MAX_KEY_BYTES, CKF_ENCRYPT|CKF_DECRYPT|
2N/A CKF_WRAP|CKF_UNWRAP}, /* CKM_AES_CBC */
2N/A {AES_MAX_KEY_BYTES, AES_MAX_KEY_BYTES, CKF_ENCRYPT|CKF_DECRYPT|
2N/A CKF_WRAP|CKF_UNWRAP} /* CKM_AES_CBC_PAD */
2N/A};
2N/A
2N/A/* ARGSUSED */
2N/ACK_RV
2N/AC_GetSlotList(CK_BBOOL tokenPresent, CK_SLOT_ID_PTR pSlotList,
2N/A CK_ULONG_PTR pulCount)
2N/A{
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A if (pulCount == NULL) {
2N/A return (CKR_ARGUMENTS_BAD);
2N/A }
2N/A
2N/A /*
2N/A * If KMS is not available or initialized, return 0 slots
2N/A * but CKR_OK status.
2N/A */
2N/A if (!kms_is_initialized()) {
2N/A *pulCount = 0;
2N/A return (CKR_OK);
2N/A }
2N/A
2N/A if (pSlotList == NULL) {
2N/A *pulCount = KMS_SLOTS;
2N/A return (CKR_OK);
2N/A }
2N/A
2N/A if (*pulCount < KMS_SLOTS) {
2N/A *pulCount = KMS_SLOTS;
2N/A return (CKR_BUFFER_TOO_SMALL);
2N/A }
2N/A
2N/A *pulCount = 1;
2N/A pSlotList[0] = KMS_TOKEN_SLOTID;
2N/A
2N/A return (CKR_OK);
2N/A}
2N/A
2N/ACK_RV
2N/AC_GetSlotInfo(CK_SLOT_ID slotID, CK_SLOT_INFO_PTR pInfo)
2N/A{
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A if (slotID != KMS_TOKEN_SLOTID ||
2N/A !kms_is_initialized()) {
2N/A return (CKR_SLOT_ID_INVALID);
2N/A }
2N/A
2N/A if (pInfo == NULL)
2N/A return (CKR_ARGUMENTS_BAD);
2N/A
2N/A /* Provide information about the slot in the provided buffer */
2N/A (void) strncpy((char *)pInfo->slotDescription, SLOT_DESCRIPTION,
2N/A 64);
2N/A (void) strncpy((char *)pInfo->manufacturerID, MANUFACTURER_ID, 32);
2N/A pInfo->flags = CKF_TOKEN_PRESENT;
2N/A pInfo->hardwareVersion.major = HARDWARE_VERSION_MAJOR;
2N/A pInfo->hardwareVersion.minor = HARDWARE_VERSION_MINOR;
2N/A pInfo->firmwareVersion.major = FIRMWARE_VERSION_MAJOR;
2N/A pInfo->firmwareVersion.minor = FIRMWARE_VERSION_MINOR;
2N/A
2N/A return (CKR_OK);
2N/A}
2N/A
2N/ACK_RV
2N/AC_GetTokenInfo(CK_SLOT_ID slotID, CK_TOKEN_INFO_PTR pInfo)
2N/A{
2N/A kms_cfg_info_t kmscfg;
2N/A KMSAGENT_PROFILE_FLAGS kmsflags = 0;
2N/A
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A if (slotID != KMS_TOKEN_SLOTID ||
2N/A !kms_is_initialized())
2N/A return (CKR_SLOT_ID_INVALID);
2N/A
2N/A if (pInfo == NULL)
2N/A return (CKR_ARGUMENTS_BAD);
2N/A
2N/A /* Provide information about a token in the provided buffer */
2N/A (void) strncpy((char *)pInfo->label, KMS_TOKEN_LABEL, 32);
2N/A (void) strncpy((char *)pInfo->manufacturerID, MANUFACTURER_ID, 32);
2N/A (void) strncpy((char *)pInfo->model, KMS_TOKEN_MODEL, 16);
2N/A (void) strncpy((char *)pInfo->serialNumber, KMS_TOKEN_SERIAL, 16);
2N/A
2N/A pInfo->flags = KMS_TOKEN_FLAGS;
2N/A pInfo->ulMaxSessionCount = CK_EFFECTIVELY_INFINITE;
2N/A pInfo->ulSessionCount = kms_session_cnt;
2N/A pInfo->ulMaxRwSessionCount = CK_EFFECTIVELY_INFINITE;
2N/A pInfo->ulRwSessionCount = kms_session_rw_cnt;
2N/A pInfo->ulMaxPinLen = MAX_PIN_LEN;
2N/A pInfo->ulMinPinLen = MIN_PIN_LEN;
2N/A pInfo->ulTotalPublicMemory = CK_UNAVAILABLE_INFORMATION;
2N/A pInfo->ulFreePublicMemory = CK_UNAVAILABLE_INFORMATION;
2N/A pInfo->ulTotalPrivateMemory = CK_UNAVAILABLE_INFORMATION;
2N/A pInfo->ulFreePrivateMemory = CK_UNAVAILABLE_INFORMATION;
2N/A pInfo->hardwareVersion.major = HARDWARE_VERSION_MAJOR;
2N/A pInfo->hardwareVersion.minor = HARDWARE_VERSION_MINOR;
2N/A pInfo->firmwareVersion.major = FIRMWARE_VERSION_MAJOR;
2N/A pInfo->firmwareVersion.minor = FIRMWARE_VERSION_MINOR;
2N/A (void) memset(pInfo->utcTime, ' ', 16);
2N/A
2N/A if (KMS_GetConfigInfo(&kmscfg) == CKR_OK &&
2N/A KMSAgent_GetProfileStatus(kmscfg.name, &kmsflags) ==
2N/A KMS_AGENT_STATUS_OK) {
2N/A
2N/A if ((kmsflags & KMSAGENT_PROFILE_EXISTS_FLAG) &&
2N/A (kmsflags & KMSAGENT_CLIENTKEY_EXISTS_FLAG))
2N/A pInfo->flags |= CKF_TOKEN_INITIALIZED;
2N/A else
2N/A pInfo->flags &= ~CKF_TOKEN_INITIALIZED;
2N/A }
2N/A return (CKR_OK);
2N/A}
2N/A
2N/A/*ARGSUSED*/
2N/ACK_RV
2N/AC_WaitForSlotEvent(CK_FLAGS flags, CK_SLOT_ID_PTR pSlot, CK_VOID_PTR pReserved)
2N/A{
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A return (CKR_FUNCTION_NOT_SUPPORTED);
2N/A}
2N/A
2N/A
2N/ACK_RV
2N/AC_GetMechanismList(CK_SLOT_ID slotID,
2N/A CK_MECHANISM_TYPE_PTR pMechanismList,
2N/A CK_ULONG_PTR pulCount)
2N/A{
2N/A int i;
2N/A ulong_t mechnum;
2N/A
2N/A /*
2N/A * Just check to see if the library has been
2N/A * properly initialized.
2N/A */
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A /*
2N/A * This is different from above check, this verifies that
2N/A * the KMS token is actually configured.
2N/A */
2N/A if (slotID != KMS_TOKEN_SLOTID ||
2N/A !kms_is_initialized())
2N/A return (CKR_SLOT_ID_INVALID);
2N/A
2N/A mechnum = sizeof (kms_mechanisms) / sizeof (CK_MECHANISM_TYPE);
2N/A if (pMechanismList == NULL) {
2N/A *pulCount = mechnum;
2N/A return (CKR_OK);
2N/A }
2N/A if (*pulCount < mechnum) {
2N/A *pulCount = mechnum;
2N/A return (CKR_BUFFER_TOO_SMALL);
2N/A }
2N/A for (i = 0; i < mechnum; i++)
2N/A pMechanismList[i] = kms_mechanisms[i];
2N/A
2N/A *pulCount = mechnum;
2N/A
2N/A return (CKR_OK);
2N/A}
2N/A
2N/ACK_RV
2N/AC_GetMechanismInfo(CK_SLOT_ID slotID, CK_MECHANISM_TYPE type,
2N/A CK_MECHANISM_INFO_PTR pInfo)
2N/A{
2N/A CK_ULONG mechnum, i;
2N/A
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A if (slotID != KMS_TOKEN_SLOTID ||
2N/A !kms_is_initialized())
2N/A return (CKR_SLOT_ID_INVALID);
2N/A
2N/A if (pInfo == NULL) {
2N/A return (CKR_ARGUMENTS_BAD);
2N/A }
2N/A
2N/A mechnum = sizeof (kms_mechanisms) / sizeof (CK_MECHANISM_TYPE);
2N/A for (i = 0; i < mechnum; i++) {
2N/A if (kms_mechanisms[i] == type)
2N/A break;
2N/A }
2N/A
2N/A if (i == mechnum)
2N/A /* unsupported mechanism */
2N/A return (CKR_MECHANISM_INVALID);
2N/A
2N/A pInfo->ulMinKeySize = kms_mechanism_info[i].ulMinKeySize;
2N/A pInfo->ulMaxKeySize = kms_mechanism_info[i].ulMaxKeySize;
2N/A pInfo->flags = kms_mechanism_info[i].flags;
2N/A
2N/A return (CKR_OK);
2N/A}
2N/A
2N/A/*ARGSUSED*/
2N/ACK_RV
2N/AC_InitToken(CK_SLOT_ID slotID, CK_UTF8CHAR_PTR pPin, CK_ULONG ulPinLen,
2N/A CK_UTF8CHAR_PTR pLabel)
2N/A{
2N/A CK_RV rv = CKR_FUNCTION_FAILED;
2N/A kms_cfg_info_t kmscfg;
2N/A KMSAGENT_PROFILE_FLAGS kmsflags;
2N/A
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A if (slotID != KMS_TOKEN_SLOTID ||
2N/A !kms_is_initialized())
2N/A return (CKR_SLOT_ID_INVALID);
2N/A
2N/A if (KMS_GetConfigInfo(&kmscfg) != CKR_OK ||
2N/A KMSAgent_GetProfileStatus(kmscfg.name, &kmsflags) !=
2N/A KMS_AGENT_STATUS_OK)
2N/A return (CKR_FUNCTION_FAILED);
2N/A
2N/A if (!(kmsflags & KMSAGENT_PROFILE_EXISTS_FLAG) ||
2N/A !(kmsflags & KMSAGENT_CLIENTKEY_EXISTS_FLAG)) {
2N/A KMSClientProfile kmsProfile;
2N/A /*
2N/A * Attempt to enroll and load a KMS profile.
2N/A * This will force the KMSAgent library to fetch
2N/A * the profile, the CA certificate, and the
2N/A * client private key and store them locally so that
2N/A * the KMS agent API can be used later.
2N/A */
2N/A rv = KMS_LoadProfile(
2N/A &kmsProfile,
2N/A &kmscfg,
2N/A (const char *)pPin,
2N/A (size_t)ulPinLen);
2N/A
2N/A if (rv == CKR_OK)
2N/A KMS_UnloadProfile(&kmsProfile);
2N/A }
2N/A return (rv);
2N/A}
2N/A
2N/A/*ARGSUSED*/
2N/ACK_RV
2N/AC_InitPIN(CK_SESSION_HANDLE hSession, CK_UTF8CHAR_PTR pPin, CK_ULONG ulPinLen)
2N/A{
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A /*
2N/A * Could be supported once the agent library supports
2N/A * storing the client certificate in a PKCS#12 file.
2N/A */
2N/A return (CKR_FUNCTION_NOT_SUPPORTED);
2N/A}
2N/A
2N/ACK_RV
2N/AC_SetPIN(CK_SESSION_HANDLE hSession, CK_UTF8CHAR_PTR pOldPin,
2N/A CK_ULONG ulOldLen, CK_UTF8CHAR_PTR pNewPin, CK_ULONG ulNewLen)
2N/A{
2N/A CK_RV rv = CKR_OK;
2N/A kms_session_t *session_p;
2N/A boolean_t ses_lock_held = B_FALSE;
2N/A
2N/A if (!kms_initialized)
2N/A return (CKR_CRYPTOKI_NOT_INITIALIZED);
2N/A
2N/A /*
2N/A * Obtain the session pointer. Also, increment the session
2N/A * reference count.
2N/A */
2N/A rv = handle2session(hSession, &session_p);
2N/A if (rv != CKR_OK)
2N/A return (rv);
2N/A
2N/A /* Make sure it is a RW session. */
2N/A if (session_p->ses_RO) {
2N/A rv = CKR_SESSION_READ_ONLY;
2N/A REFRELE(session_p, ses_lock_held);
2N/A return (rv);
2N/A }
2N/A
2N/A /*
2N/A * If the token is not yet initialized, we cannot set the pin.
2N/A */
2N/A if (!kms_is_initialized()) {
2N/A REFRELE(session_p, ses_lock_held);
2N/A return (CKR_FUNCTION_FAILED);
2N/A }
2N/A
2N/A if (pOldPin == NULL || ulOldLen == 0 ||
2N/A pNewPin == NULL || ulNewLen == 0) {
2N/A REFRELE(session_p, ses_lock_held);
2N/A return (CKR_ARGUMENTS_BAD);
2N/A }
2N/A
2N/A if (!kms_is_pin_set()) {
2N/A /*
2N/A * We don't yet support this mode since
2N/A * the KMS private key file will automatically
2N/A * be generated using the KMS Agent passphrase
2N/A * which is initialized out-of-band.
2N/A */
2N/A rv = CKR_FUNCTION_NOT_SUPPORTED;
2N/A
2N/A } else {
2N/A /*
2N/A * Login to KMS by attempting to load the profile using
2N/A * the given password.
2N/A */
2N/A rv = KMS_LoadProfile(&session_p->kmsProfile,
2N/A &session_p->configInfo,
2N/A (const char *)pOldPin,
2N/A (size_t)ulOldLen);
2N/A if (rv == CKR_USER_ANOTHER_ALREADY_LOGGED_IN)
2N/A rv = CKR_OK;
2N/A
2N/A if (rv == CKR_OK)
2N/A rv = KMS_ChangeLocalPWD(session_p,
2N/A (const char *)pOldPin,
2N/A (const char *)pNewPin);
2N/A }
2N/A
2N/A REFRELE(session_p, ses_lock_held);
2N/A return (rv);
2N/A}