Skip to content

added upgrade support #89

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
mdwivedi merged 1 commit into from
Mar 8, 2022
Merged

added upgrade support #89

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
96 changes: 62 additions & 34 deletions Applet/AndroidSEProvider/src/com/android/javacard/keymaster/KMAndroidSEApplet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@
import javacard.security.CryptoException;

public class KMAndroidSEApplet extends KMKeymasterApplet implements OnUpgradeListener {
// Magic number version
private static final byte KM_MAGIC_NUMBER = (byte) 0x82;
// MSB byte is for Major version and LSB byte is for Minor version.
private static final short CURRENT_PACKAGE_VERSION = 0x0009; // 0.9

private static final byte KM_BEGIN_STATE = 0x00;
private static final byte ILLEGAL_STATE = KM_BEGIN_STATE + 1;
Expand Down Expand Up @@ -69,9 +73,14 @@ public class KMAndroidSEApplet extends KMKeymasterApplet implements OnUpgradeLis

private static byte keymasterState = ILLEGAL_STATE;
private static byte provisionStatus = NOT_PROVISIONED;
// Package version.
protected short packageVersion;

KMAndroidSEApplet() {
super(new KMAndroidSEProvider());
if (!UpgradeManager.isUpgrading()) {
packageVersion = CURRENT_PACKAGE_VERSION;
}
}

/**
Expand Down Expand Up @@ -107,7 +116,7 @@ public void process(APDU apdu) {

case INS_SET_BOOT_ENDED_CMD:
//set the flag to mark boot ended
repository.setBootEndedStatus(true);
kmDataStore.setBootEndedStatus(true);
sendError(apdu, KMError.OK);
break;

Expand Down Expand Up @@ -184,12 +193,12 @@ private static void processProvisionDeviceUniqueKey(APDU apdu) {
short pubKeyLen = KMCoseKey.cast(coseKey).getEcdsa256PublicKey(scratchPad, (short) 0);
short privKeyLen = KMCoseKey.cast(coseKey).getPrivateKey(scratchPad, pubKeyLen);
//Store the Device unique Key.
seProvider.createDeviceUniqueKey(false, scratchPad, (short) 0, pubKeyLen, scratchPad,
kmDataStore.createDeviceUniqueKey(scratchPad, (short) 0, pubKeyLen, scratchPad,
pubKeyLen, privKeyLen);
short bcc = generateBcc(false, scratchPad);
short len = KMKeymasterApplet.encodeToApduBuffer(bcc, scratchPad, (short) 0,
MAX_COSE_BUF_SIZE);
((KMAndroidSEProvider) seProvider).persistBootCertificateChain(scratchPad, (short) 0, len);
kmDataStore.persistBootCertificateChain(scratchPad, (short) 0, len);
sendError(apdu, KMError.OK);
}

Expand Down Expand Up @@ -226,7 +235,7 @@ private static void processProvisionAdditionalCertChain(APDU apdu) {
srcBuffer, null);
// Compare the DK_Pub.
short pubKeyLen = KMCoseKey.cast(leafCoseKey).getEcdsa256PublicKey(srcBuffer, (short) 0);
KMDeviceUniqueKey uniqueKey = seProvider.getDeviceUniqueKey(false);
KMDeviceUniqueKey uniqueKey = kmDataStore.getDeviceUniqueKey(false);
if (uniqueKey == null) {
KMException.throwIt(KMError.STATUS_FAILED);
}
Expand All @@ -235,7 +244,7 @@ private static void processProvisionAdditionalCertChain(APDU apdu) {
(0 != Util.arrayCompare(srcBuffer, (short) 0, srcBuffer, pubKeyLen, pubKeyLen))) {
KMException.throwIt(KMError.STATUS_FAILED);
}
seProvider.persistAdditionalCertChain(buffer, bufferStartOffset, bufferLength);
kmDataStore.persistAdditionalCertChain(buffer, bufferStartOffset, bufferLength);
//reclaim memory
repository.reclaimMemory(bufferLength);
sendError(apdu, KMError.OK);
Expand Down Expand Up @@ -269,7 +278,7 @@ public void setAttestationIds(short attIdVals) {
KMException.throwIt(KMError.INVALID_ARGUMENT);
}
obj = KMByteTag.cast(obj).getValue();
((KMAndroidSEProvider) seProvider).setAttestationId(key, KMByteBlob.cast(obj).getBuffer(),
kmDataStore.setAttestationId(key, KMByteBlob.cast(obj).getBuffer(),
KMByteBlob.cast(obj).getStartOff(), KMByteBlob.cast(obj).length());
index++;
}
Expand All @@ -288,7 +297,7 @@ private void processProvisionPreSharedSecretCmd(APDU apdu) {
KMException.throwIt(KMError.INVALID_ARGUMENT);
}
// Persist shared Hmac.
((KMAndroidSEProvider) seProvider).createPresharedKey(
kmDataStore.createPresharedKey(
KMByteBlob.cast(val).getBuffer(),
KMByteBlob.cast(val).getStartOff(),
KMByteBlob.cast(val).length());
Expand Down Expand Up @@ -345,38 +354,38 @@ private void processSetBootParamsCmd(APDU apdu) {

short bootParam = KMArray.cast(args).get((short) 0);

((KMAndroidSEProvider) seProvider).setBootPatchLevel(KMInteger.cast(bootParam).getBuffer(),
kmDataStore.setBootPatchLevel(KMInteger.cast(bootParam).getBuffer(),
KMInteger.cast(bootParam).getStartOff(),
KMInteger.cast(bootParam).length());

bootParam = KMArray.cast(args).get((short) 1);
if (KMByteBlob.cast(bootParam).length() > BOOT_KEY_MAX_SIZE) {
KMException.throwIt(KMError.INVALID_ARGUMENT);
}
((KMAndroidSEProvider) seProvider).setBootKey(KMByteBlob.cast(bootParam).getBuffer(),
kmDataStore.setBootKey(KMByteBlob.cast(bootParam).getBuffer(),
KMByteBlob.cast(bootParam).getStartOff(),
KMByteBlob.cast(bootParam).length());

bootParam = KMArray.cast(args).get((short) 2);
if (KMByteBlob.cast(bootParam).length() > BOOT_HASH_MAX_SIZE) {
KMException.throwIt(KMError.INVALID_ARGUMENT);
}
((KMAndroidSEProvider) seProvider).setVerifiedBootHash(KMByteBlob.cast(bootParam).getBuffer(),
kmDataStore.setVerifiedBootHash(KMByteBlob.cast(bootParam).getBuffer(),
KMByteBlob.cast(bootParam).getStartOff(),
KMByteBlob.cast(bootParam).length());

bootParam = KMArray.cast(args).get((short) 3);
byte enumVal = KMEnum.cast(bootParam).getVal();
((KMAndroidSEProvider) seProvider).setBootState(enumVal);
kmDataStore.setBootState(enumVal);

bootParam = KMArray.cast(args).get((short) 4);
enumVal = KMEnum.cast(bootParam).getVal();
((KMAndroidSEProvider) seProvider).setDeviceLocked(enumVal == KMType.DEVICE_LOCKED_TRUE);
kmDataStore.setDeviceLocked(enumVal == KMType.DEVICE_LOCKED_TRUE);


// Clear the Computed SharedHmac and Hmac nonce from persistent memory.
Util.arrayFillNonAtomic(scratchPad, (short) 0, KMRepository.COMPUTED_HMAC_KEY_SIZE, (byte) 0);
seProvider.createComputedHmacKey(scratchPad, (short) 0, KMRepository.COMPUTED_HMAC_KEY_SIZE);
Util.arrayFillNonAtomic(scratchPad, (short) 0, KMKeymintDataStore.COMPUTED_HMAC_KEY_SIZE, (byte) 0);
kmDataStore.createComputedHmacKey(scratchPad, (short) 0, KMKeymintDataStore.COMPUTED_HMAC_KEY_SIZE);

super.reboot();
sendError(apdu, KMError.OK);
Expand All @@ -394,36 +403,55 @@ public void onCleanup() {
@Override
public void onConsolidate() {
}

private boolean isUpgradeAllowed(short version) {
boolean upgradeAllowed = false;
short oldMajorVersion = (short) ((version >> 8) & 0x00FF);
short oldMinorVersion = (short) (version & 0x00FF);
short currentMajorVersion = (short) (CURRENT_PACKAGE_VERSION >> 8 & 0x00FF);
short currentMinorVersion = (short) (CURRENT_PACKAGE_VERSION & 0x00FF);
// Downgrade of the Applet is not allowed.
// Upgrade is not allowed to a next version which is not immediate.
if ((short) (currentMajorVersion - oldMajorVersion) == 1) {
if (currentMinorVersion == 0) {
upgradeAllowed = true;
}
} else if ((short) (currentMajorVersion - oldMajorVersion) == 0) {
if (currentMinorVersion >= oldMinorVersion) {
upgradeAllowed = true;
}
}
return upgradeAllowed;
}

@Override
public void onRestore(Element element) {
element.initRead();
provisionStatus = element.readByte();
keymasterState = element.readByte();
repository.onRestore(element);
seProvider.onRestore(element);
byte magicNumber = element.readByte();
if (magicNumber != KM_MAGIC_NUMBER) {
ISOException.throwIt(ISO7816.SW_CONDITIONS_NOT_SATISFIED);
}
short packageVersion = element.readShort();
// Validate version.
if (0 != packageVersion && !isUpgradeAllowed(packageVersion)) {
ISOException.throwIt(ISO7816.SW_CONDITIONS_NOT_SATISFIED);
}
kmDataStore.onRestore(element);
}

@Override
public Element onSave() {
// SEProvider count
short primitiveCount = seProvider.getBackupPrimitiveByteCount();
short objectCount = seProvider.getBackupObjectCount();
//Repository count
primitiveCount += repository.getBackupPrimitiveByteCount();
objectCount += repository.getBackupObjectCount();
//KMKeymasterApplet count
primitiveCount += computePrimitveDataSize();
objectCount += computeObjectCount();

// Create element.
short primitiveCount = 3;
primitiveCount += kmDataStore.getBackupPrimitiveByteCount();
short objectCount = kmDataStore.getBackupObjectCount();
// Create element.
Element element = UpgradeManager.createElement(Element.TYPE_SIMPLE,
primitiveCount, objectCount);
element.write(provisionStatus);
element.write(keymasterState);
repository.onSave(element);
seProvider.onSave(element);
return element;
element.write(KM_MAGIC_NUMBER);
element.write(packageVersion);
kmDataStore.onSave(element);
return element;
}

private short computePrimitveDataSize() {
Expand Down
9 changes: 5 additions & 4 deletions Applet/AndroidSEProviderLib/src/com/android/javacard/seprovider/KMAESKey.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,11 @@ public static void onSave(Element element, KMAESKey kmKey) {
element.write(kmKey.aesKey);
}

public static KMAESKey onRestore(Element element) {
AESKey aesKey = (AESKey) element.readObject();
KMAESKey kmKey = new KMAESKey(aesKey);
return kmKey;
public static KMAESKey onRestore(AESKey aesKey) {
if (aesKey == null) {
return null;
}
return new KMAESKey(aesKey);
}

public static short getBackupPrimitiveByteCount() {
Expand Down
Loading