Skip to content

1. In processAttestKey , call isKeyUpgradeRequired() for generated k…#49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
subrahmanyaman merged 1 commit into from
Apr 13, 2022
Merged

1. In processAttestKey , call isKeyUpgradeRequired() for generated k… #49

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Applet/src/com/android/javacard/keymaster/KMError.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -45,6 +45,7 @@ public class KMError {

public static final short KEY_USER_NOT_AUTHENTICATED = 26;
public static final short INVALID_OPERATION_HANDLE = 28;
public static final short INSUFFICIENT_BUFFER_SPACE = 29;
public static final short VERIFICATION_FAILED = 30;
public static final short TOO_MANY_OPERATIONS = 31;
public static final short INVALID_KEY_BLOB = 33;
Expand Down
27 changes: 20 additions & 7 deletions Applet/src/com/android/javacard/keymaster/KMKeymasterApplet.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -108,8 +108,9 @@ public class KMKeymasterApplet extends Applet implements AppletEvent, ExtendedLe
};

public static final short MAX_COSE_BUF_SIZE = (short) 1024;
// Maximum possible encoded keyparams size
public static final short MAX_KEY_PARAMS_BUF_SIZE = (short) 2048;
// Maximum allowed buffer size for to encode the key parameters
// which is used while creating mac for key paramters.
public static final short MAX_KEY_PARAMS_BUF_SIZE = (short) 3072; // 3K
// Top 32 commands are reserved for provisioning.
private static final byte KEYMINT_CMD_APDU_START = 0x20;

Expand DownExpand Up@@ -3491,6 +3492,10 @@ private void processAttestKeyCmd(APDU apdu) {
// Check if key requires upgrade. The KeyBlob is parsed inside isKeyUpgradeRequired
// function itself.
if (isKeyUpgradeRequired(data[KEY_BLOB], data[APP_ID], data[APP_DATA], scratchPad)) {
// This condition occurs if either any of the system properties (OsVersion, OsPatchLevel,
// VendorPatchLevel or BootPatchLevel) changes or KeyBlob format changed. So return
// KEY_REQUIRES_UPGRADE error as this scenario is application to ATTEST_KEY_BLOB as well
// as ATTEST_KEY_BLOB got generated before the KEY_BLOB.
KMException.throwIt(KMError.KEY_REQUIRES_UPGRADE);
}
// Validate KeyParams Mac
Expand DownExpand Up@@ -3786,18 +3791,26 @@ private short macKeyParams(short keyParams, byte[] scratchPad) {
if (SYM_KEY_TYPE == getKeyType(keyParams)) {
return KMByteBlob.instance((short) 0);
}
short len = encodeToApduBuffer(keyParams, scratchPad, (short) 0, MAX_KEY_PARAMS_BUF_SIZE);
short offset = repository.allocReclaimableMemory(MAX_KEY_PARAMS_BUF_SIZE);
short len = encoder.encode(keyParams, repository.getHeap(), offset);
if (len > MAX_KEY_PARAMS_BUF_SIZE) {
// KeyParamters exceeded the maximum allowed size.
KMException.throwIt(KMError.INSUFFICIENT_BUFFER_SPACE);
}

short signLen = seProvider.hmacSign(
KMByteBlob.cast(data[AUTH_TAG]).getBuffer(),
KMByteBlob.cast(data[AUTH_TAG]).getStartOff(),
KMByteBlob.cast(data[AUTH_TAG]).length(),
scratchPad,
(short) 0,
repository.getHeap(),
offset,
len,
scratchPad,
len);
return KMByteBlob.instance(scratchPad, len, signLen);
(short) 0);
//release memory
repository.reclaimMemory(MAX_KEY_PARAMS_BUF_SIZE);

return KMByteBlob.instance(scratchPad, (short) 0, signLen);
}

private boolean validateKeyParamsMac(short keyParams, short keyParamsMac, byte[] scratchPad) {
Expand Down
21 changes: 0 additions & 21 deletions HAL/JavacardKeyMintDevice.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -102,13 +102,6 @@ ScopedAStatus JavacardKeyMintDevice::generateKey(const vector<KeyParameter>& key
auto [certItem, error] = card_->sendRequest(Instruction::INS_ATTEST_KEY_CMD, attestKeyArray);
if (error != KM_ERROR_OK) {
LOG(ERROR) << "Failed in attestKey err: " << error;
if (error == KM_ERROR_KEY_REQUIRES_UPGRADE) {
// This is rare scenario where either the applet gets upgraded or system propeties
// like osVersion, OsPatch, VendorPatch and bootPatches values changes.
LOG(DEBUG) << "This error occurs in case if either the applets get upgraded or if any"
"system properties like OsVersion, OsPatch, VendorPatch or bootPatch values changes";
error = KM_ERROR_UNKNOWN_ERROR;
}
return km_utils::kmError2ScopedAStatus(error);
}
if (!cbor_.getCertificateChain(certItem, 1, creationResult->certificateChain)) {
Expand DownExpand Up@@ -171,13 +164,6 @@ ScopedAStatus JavacardKeyMintDevice::importKey(const vector<KeyParameter>& keyPa
auto [certItem, error] = card_->sendRequest(Instruction::INS_ATTEST_KEY_CMD, attestKeyArray);
if (error != KM_ERROR_OK) {
LOG(ERROR) << "Failed in attestKey err: " << error;
if (error == KM_ERROR_KEY_REQUIRES_UPGRADE) {
// This is rare scenario where either the applet gets upgraded or system propeties
// like osVersion, OsPatch, VendorPatch and bootPatches values changes.
LOG(DEBUG) << "This error occurs in case if either the applets get upgraded or if any"
"system properties like OsVersion, OsPatch, VendorPatch or bootPatch values changes";
error = KM_ERROR_UNKNOWN_ERROR;
}
return km_utils::kmError2ScopedAStatus(error);
}
if (!cbor_.getCertificateChain(certItem, 1, creationResult->certificateChain)) {
Expand DownExpand Up@@ -250,13 +236,6 @@ ScopedAStatus JavacardKeyMintDevice::importWrappedKey(const vector<uint8_t>& wra
auto [certItem, error] = card_->sendRequest(Instruction::INS_ATTEST_KEY_CMD, attestKeyArray);
if (error != KM_ERROR_OK) {
LOG(ERROR) << "Failed in attestKey err: " << error;
if (error == KM_ERROR_KEY_REQUIRES_UPGRADE) {
// This is rare scenario where either the applet gets upgraded or system propeties
// like osVersion, OsPatch, VendorPatch and bootPatches values changes.
LOG(DEBUG) << "This error occurs in case if either the applets get upgraded or if any"
"system properties like OsVersion, OsPatch, VendorPatch or bootPatch values changes";
error = KM_ERROR_UNKNOWN_ERROR;
}
return km_utils::kmError2ScopedAStatus(error);
}
if (!cbor_.getCertificateChain(certItem, 1, creationResult->certificateChain)) {
Expand Down