Skip to content

Added deviceLocked command#12

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
BKSSMVenkateswarlu merged 1 commit into from
Jun 24, 2020
Merged

Added deviceLocked command #12

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
5 changes: 3 additions & 2 deletions Applet/Applet/src/com/android/javacard/keymaster/KMEnum.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,7 +25,7 @@ public class KMEnum extends KMType {
private static short instPtr;

private static short[] types = {HARDWARE_TYPE, KEY_FORMAT, KEY_DERIVATION_FUNCTION,
VERIFIED_BOOT_STATE, DEVICE_LOCKED, USER_AUTH_TYPE, PURPOSE};
VERIFIED_BOOT_STATE, DEVICE_LOCKED, USER_AUTH_TYPE, PURPOSE,ECCURVE};

private static Object[] enums = null;

Expand DownExpand Up@@ -92,7 +92,8 @@ private static void create() {
new byte[] {SELF_SIGNED_BOOT, VERIFIED_BOOT},
new byte[] {DEVICE_LOCKED_TRUE, DEVICE_LOCKED_FALSE},
new byte[] {USER_AUTH_NONE,PASSWORD,FINGERPRINT, BOTH},
new byte[] {ENCRYPT, DECRYPT, SIGN, VERIFY, WRAP_KEY, ATTEST_KEY}
new byte[] {ENCRYPT, DECRYPT, SIGN, VERIFY, WRAP_KEY, ATTEST_KEY},
new byte[] {P_224, P_256, P_384, P_521}
};
}
}
Expand Down
5 changes: 5 additions & 0 deletions Applet/Applet/src/com/android/javacard/keymaster/KMInteger.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -119,6 +119,11 @@ public short getStartOff() {
}

public void getValue(byte[] dest, short destOff, short length){
if(length < length()) KMException.throwIt(KMError.UNKNOWN_ERROR);
if(length > length()) {
length = length();
destOff +=length;
}
Util.arrayCopyNonAtomic(heap, (short)(instPtr+TLV_HEADER_SIZE), dest, destOff, length);
}
public void setValue(byte[] src, short srcOff){
Expand Down
3 changes: 2 additions & 1 deletion Applet/Applet/src/com/android/javacard/keymaster/KMKeyParameters.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -133,7 +133,8 @@ public static short makeHwEnforced(
KMType.BOOL_TAG, KMType.TRUSTED_CONFIRMATION_REQUIRED,
KMType.BOOL_TAG, KMType.INCLUDE_UNIQUE_ID,
KMType.BOOL_TAG, KMType.ROLLBACK_RESISTANCE,
KMType.ENUM_TAG, KMType.USER_AUTH_TYPE
KMType.ENUM_TAG, KMType.USER_AUTH_TYPE,
KMType.BOOL_TAG, KMType.UNLOCKED_DEVICE_REQUIRED
};
byte index = 0;
short tagInd = 0;
Expand Down
150 changes: 113 additions & 37 deletions Applet/Applet/src/com/android/javacard/keymaster/KMKeymasterApplet.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -97,6 +97,9 @@ public class KMKeymasterApplet extends Applet implements AppletEvent, ExtendedLe
private static final byte INS_ABORT_OPERATION_CMD = 0x22;
private static final byte INS_PROVISION_CMD = 0x23;
private static final byte INS_SET_BOOT_PARAMS_CMD = 0x24;
private static final byte INS_DEVICE_LOCKED_CMD = 0x25;
private static final byte INS_EARLY_BOOT_ENDED_CMD = 0x26;

// Data Dictionary items
public static final byte DATA_ARRAY_SIZE = 30;
public static final byte TMP_VARIABLE_ARRAY_SIZE = 20;
Expand DownExpand Up@@ -276,7 +279,7 @@ public void process(APDU apdu) {
ISOException.throwIt(ISO7816.SW_INCORRECT_P1P2);
}
// Validate whether INS can be supported
if (!(apduIns >= INS_GENERATE_KEY_CMD && apduIns <= INS_SET_BOOT_PARAMS_CMD)) {
if (!(apduIns >= INS_GENERATE_KEY_CMD && apduIns <= INS_EARLY_BOOT_ENDED_CMD)) {
ISOException.throwIt(ISO7816.SW_INS_NOT_SUPPORTED);
}
// Validate if INS is provision command if applet is in FIRST_SELECT_STATE.
Expand DownExpand Up@@ -358,6 +361,12 @@ public void process(APDU apdu) {
case INS_SET_BOOT_PARAMS_CMD:
processSetBootParamsCmd(apdu);
break;
case INS_DEVICE_LOCKED_CMD:
processDeviceLockedCmd(apdu);
break;
case INS_EARLY_BOOT_ENDED_CMD:
processEarlyBootEndedCmd(apdu);
break;
default:
ISOException.throwIt(ISO7816.SW_INS_NOT_SUPPORTED);
}
Expand All@@ -375,6 +384,37 @@ public void process(APDU apdu) {
repository.clean();
}
}

private void processEarlyBootEndedCmd(APDU apdu) {
KMException.throwIt(KMError.UNIMPLEMENTED);
}

private void processDeviceLockedCmd(APDU apdu) {
receiveIncoming(apdu);
byte[] scratchPad = apdu.getBuffer();
tmpVariables[0] = KMArray.instance((short) 2);
KMArray.cast(tmpVariables[0]).add((short) 0, KMInteger.exp());
tmpVariables[1] = KMVerificationToken.exp();
KMArray.cast(tmpVariables[0]).add((short) 1, tmpVariables[1]);
// Decode the arguments
tmpVariables[0] = decoder.decode(tmpVariables[0], buffer, bufferStartOffset, bufferLength);
tmpVariables[1] = KMArray.cast(tmpVariables[0]).get((short) 0);
tmpVariables[1] = KMInteger.cast(tmpVariables[1]).getByte();
data[VERIFICATION_TOKEN] = KMArray.cast(tmpVariables[0]).get((short)1);
validateVerificationToken(data[VERIFICATION_TOKEN],scratchPad);
short verTime = KMVerificationToken.cast(data[VERIFICATION_TOKEN]).getTimestamp();
short lastDeviceLockedTime = KMInteger.uint_64(repository.deviceLockedTimestamp, (short)0);
if(KMInteger.compare(verTime,lastDeviceLockedTime) > 0){
Util.arrayFillNonAtomic(scratchPad,(short)0, (short)8, (byte)0);
KMInteger.cast(verTime).getValue(scratchPad,(short)0,(short)8);
repository.deviceLockedFlag = true;
if(tmpVariables[1] == 0x01) repository.deviceUnlockPasswordOnly = true;
else repository.deviceUnlockPasswordOnly = false;
Util.arrayCopy(scratchPad,(short)0,repository.deviceLockedTimestamp,(short)0,(short)repository.deviceLockedTimestamp.length);
}
sendError(apdu,KMError.OK);
}

private void resetData(){
short index = 0;
while (index < data.length){
Expand DownExpand Up@@ -1460,7 +1500,7 @@ private void finishTrustedConfirmationOperation(KMOperationState op) {
}

private void authorizeUpdateFinishOperation(KMOperationState op, byte[] scratchPad) {
// User Authentication
// If one time user Authentication is required
if (op.isSecureUserIdReqd() && !op.isAuthTimeoutValidated()) {
validateVerificationToken(op, data[VERIFICATION_TOKEN], scratchPad);
tmpVariables[0] = KMInteger.uint_64(op.getAuthTime(), (short) 0);
Expand All@@ -1472,12 +1512,41 @@ private void authorizeUpdateFinishOperation(KMOperationState op, byte[] scratchP
KMException.throwIt(KMError.KEY_USER_NOT_AUTHENTICATED);
}
op.setAuthTimeoutValidated(true);
} else if(op.isAuthPerOperationReqd()){ // Auth per operation
} else if(op.isAuthPerOperationReqd()){ // If Auth per operation is required
tmpVariables[0] = KMHardwareAuthToken.cast(data[HW_TOKEN]).getChallenge();
if (KMInteger.compare(data[OP_HANDLE], tmpVariables[0]) != 0) {
KMException.throwIt(KMError.KEY_USER_NOT_AUTHENTICATED);
}
authorizeHwAuthToken(scratchPad);
authenticateUser(scratchPad);
}
}

private void authorizeDeviceUnlock(short hwToken) {
// If device is locked and key characteristics requires unlocked device then check whether
// HW auth token has correct timestamp.
short ptr =
KMKeyParameters.findTag(
KMType.BOOL_TAG, KMType.UNLOCKED_DEVICE_REQUIRED, data[HW_PARAMETERS]);
if (ptr != KMType.INVALID_VALUE && repository.deviceLockedFlag) {
if (hwToken == KMType.INVALID_VALUE) KMException.throwIt(KMError.DEVICE_LOCKED);
ptr = KMHardwareAuthToken.cast(hwToken).getTimestamp();
// Check if the current auth time stamp is greater then device locked time stamp
if (KMInteger.compare(ptr, KMInteger.uint_64(repository.deviceLockedTimestamp, (short) 0))
<= 0) {
KMException.throwIt(KMError.DEVICE_LOCKED);
}
// Now check if the device unlock requires password only authentication and whether
// auth token is generated through password authentication or not.
if (repository.deviceUnlockPasswordOnly) {
ptr = KMHardwareAuthToken.cast(hwToken).getHwAuthenticatorType();
ptr = KMEnum.cast(ptr).getVal();
if (((byte) ptr & KMType.PASSWORD) == 0) {
KMException.throwIt(KMError.DEVICE_LOCKED);
}
}
// Unlock the device
repository.deviceLockedFlag = false;
Util.arrayFillNonAtomic(repository.deviceLockedTimestamp, (short) 0, (short) 8, (byte) 0);
}
}

Expand All@@ -1489,15 +1558,25 @@ private void validateVerificationToken(KMOperationState op, short verToken, byte
if (KMByteBlob.cast(ptr).length() == 0) {
return;
}
validateVerificationToken(verToken, scratchPad);
// validate operation handle.
ptr = KMVerificationToken.cast(verToken).getChallenge();
if(op.getHandle() != KMInteger.cast(ptr).getShort()){
KMException.throwIt(KMError.VERIFICATION_FAILED);
}
// concatenation length will be 37 + length of verified parameters list.
}

private void validateVerificationToken(short verToken, byte[] scratchPad) {
short ptr = KMVerificationToken.cast(verToken).getMac();
short len = 0;
// If mac length is zero then token is empty.
if (KMByteBlob.cast(ptr).length() == 0) {
return;
}
// concatenation length will be 37 + length of verified parameters list - which is typically empty
Util.arrayFillNonAtomic(scratchPad, (short) 0, (short) 256, (byte) 0);
short params = KMVerificationToken.cast(verToken).getParametersVerified();
Util.arrayFillNonAtomic(scratchPad, (short) 0,
(short) (37+KMByteBlob.cast(params).length()), (byte) 0);

// Add "Auth Verification" - 17 bytes.
Util.arrayCopy(authVerification,(short)0, scratchPad, (short)0, (short)authVerification.length);
len = (short)authVerification.length;
Expand All@@ -1517,8 +1596,9 @@ private void validateVerificationToken(KMOperationState op, short verToken, byte
len += 4;
// concatenate Parameters verified - blob of encoded data.
ptr = KMVerificationToken.cast(verToken).getParametersVerified();
len += KMByteBlob.cast(ptr).getValues(scratchPad, (short)0);
len += 4;
if (KMByteBlob.cast(ptr).length() != 0) {
len += KMByteBlob.cast(ptr).getValues(scratchPad, (short) 0);
}
// hmac the data
HMACKey key =
cryptoProvider.createHMACKey(
Expand DownExpand Up@@ -1875,7 +1955,11 @@ private void authorizeAndBeginOperation(KMOperationState op, byte[] scratchPad)
authorizePadding(op);
authorizeBlockModeAndMacLength(op);
authorizeKeyUsageForCount();
if(!validateHwToken(data[HW_TOKEN],scratchPad)){
data[HW_TOKEN] = KMType.INVALID_VALUE;
}
authorizeUserSecureIdAuthTimeout(op, scratchPad);
authorizeDeviceUnlock(data[HW_TOKEN]);
// Authorize Caller Nonce - if caller nonce absent in key char and nonce present in
// key params then fail if it is not a Decrypt operation
data[IV] = KMType.INVALID_VALUE;
Expand DownExpand Up@@ -2136,26 +2220,27 @@ private void authorizeUserSecureIdAuthTimeout(KMOperationState op, byte[] scratc
KMKeyParameters.findTag(KMType.UINT_TAG, KMType.AUTH_TIMEOUT, data[HW_PARAMETERS]);
if (tmpVariables[0] != KMType.INVALID_VALUE) {
// check if hw token is empty - mac should not be empty.
tmpVariables[1] = KMHardwareAuthToken.cast(data[HW_TOKEN]).getMac();
if (KMByteBlob.cast(tmpVariables[1]).length() == 0) {
KMException.throwIt(KMError.INVALID_MAC_LENGTH);
}
if(data[HW_TOKEN] == KMType.INVALID_VALUE) KMException.throwIt(KMError.INVALID_MAC_LENGTH);
authTime = KMIntegerTag.cast(tmpVariables[0]).getValue();
authorizeHwAuthToken(scratchPad);
// authenticate user
authenticateUser(scratchPad);
// set the one time auth
op.setOneTimeAuthReqd(true);
// set the authentication time stamp in operation state
authTime = addIntegers(authTime, KMHardwareAuthToken.cast(data[HW_TOKEN]).getTimestamp());
op.setAuthTime(KMInteger.cast(authTime).getBuffer(), KMInteger.cast(authTime).getStartOff());
op.setAuthTimeoutValidated(false); // auth time validation will happen in update or finish
} else { // auth per operation required
// auth time validation will happen in update or finish
op.setAuthTimeoutValidated(false);
} else {
// auth per operation required
op.setOneTimeAuthReqd(false);
op.setAuthPerOperationReqd(true);
}
}
}


private void authorizeHwAuthToken(byte[] scratchPad) {
validateHwToken(data[HW_TOKEN], scratchPad);
private void authenticateUser(byte[] scratchPad) {
tmpVariables[0] = KMHardwareAuthToken.cast(data[HW_TOKEN]).getUserId();
if (KMInteger.cast(tmpVariables[0]).isZero()) {
tmpVariables[0] = KMHardwareAuthToken.cast(data[HW_TOKEN]).getAuthenticatorId();
Expand All@@ -2176,16 +2261,16 @@ private void authorizeHwAuthToken(byte[] scratchPad) {
}
}

private void validateHwToken(short hwToken, byte[] scratchPad) {
private boolean validateHwToken(short hwToken, byte[] scratchPad) {
// CBOR Encoding is always big endian
short ptr = KMHardwareAuthToken.cast(hwToken).getMac();
short len = 0;
// If mac length is zero then token is empty.
if (KMByteBlob.cast(ptr).length() == 0) {
return;
return false;
}
// add 0
Util.arrayFillNonAtomic(scratchPad, (short) 0, (short) 37, (byte) 0);
Util.arrayFillNonAtomic(scratchPad, (short) 0, (short) 256, (byte) 0);
len = 1;
// concatenate challenge - 8 bytes
ptr = KMHardwareAuthToken.cast(hwToken).getChallenge();
Expand All@@ -2194,12 +2279,12 @@ private void validateHwToken(short hwToken, byte[] scratchPad) {
len += 8;
// concatenate user id - 8 bytes
ptr = KMHardwareAuthToken.cast(hwToken).getUserId();
KMInteger.cast(tmpVariables[0])
KMInteger.cast(ptr)
.value(scratchPad, (short) (len + (short) (8 - KMInteger.cast(ptr).length())));
len += 8;
// concatenate authenticator id - 8 bytes
ptr = KMHardwareAuthToken.cast(hwToken).getAuthenticatorId();
KMInteger.cast(tmpVariables[0])
KMInteger.cast(ptr)
.value(scratchPad, (short) (len + (short) (8 - KMInteger.cast(ptr).length())));
len += 8;
// concatenate authenticator type - 4 bytes
Expand All@@ -2208,7 +2293,7 @@ private void validateHwToken(short hwToken, byte[] scratchPad) {
len += 4;
// concatenate timestamp -8 bytes
ptr = KMHardwareAuthToken.cast(hwToken).getTimestamp();
KMInteger.cast(tmpVariables[0])
KMInteger.cast(ptr)
.value(scratchPad, (short) (len + (short) (8 - KMInteger.cast(ptr).length())));
len += 8;
// hmac the data
Expand All@@ -2223,9 +2308,7 @@ private void validateHwToken(short hwToken, byte[] scratchPad) {
KMByteBlob.cast(ptr).getBuffer(),
KMByteBlob.cast(ptr).getStartOff(),
KMByteBlob.cast(ptr).length());
if(!verified){
KMException.throwIt(KMError.VERIFICATION_FAILED);
}
return verified;
/*
len =
cryptoProvider.hmac(key, scratchPad, (short) 0, len, scratchPad, (short) (len + 1) );
Expand DownExpand Up@@ -2371,10 +2454,9 @@ private void importKey(APDU apdu, byte[] scratchPad) {

private void importECKeys(byte[] scratchPad) {
// Decode key material
tmpVariables[0] = KMArray.instance((short) 3);
tmpVariables[0] = KMArray.instance((short) 2);
KMArray.cast(tmpVariables[0]).add((short) 0, KMByteBlob.exp()); // secret
KMArray.cast(tmpVariables[0]).add((short) 1, KMByteBlob.exp()); // public key
KMArray.cast(tmpVariables[0]).add((short) 2, KMEnumTag.exp()); // curve
tmpVariables[0] =
decoder.decode(
tmpVariables[0],
Expand All@@ -2383,12 +2465,6 @@ private void importECKeys(byte[] scratchPad) {
KMByteBlob.cast(data[IMPORTED_KEY_BLOB]).length());
data[SECRET] = KMArray.cast(tmpVariables[0]).get((short) 0);
data[PUB_KEY] = KMArray.cast(tmpVariables[0]).get((short) 1);
tmpVariables[1] = KMArray.cast(tmpVariables[0]).get((short) 2);
tmpVariables[1] = KMEnumTag.cast(tmpVariables[1]).getValue();
// curve must be P_256
if (tmpVariables[1] != KMType.P_256) {
KMException.throwIt(KMError.UNSUPPORTED_EC_CURVE);
}
// initialize 256 bit p256 key for given private key and public key.
ECPrivateKey ecKey =
cryptoProvider.createEcKey(
Expand All@@ -2413,8 +2489,8 @@ private void importECKeys(byte[] scratchPad) {
// check the curve if present in key parameters.
tmpVariables[3] = KMEnumTag.getValue(KMType.ECCURVE, data[KEY_PARAMETERS]);
if (tmpVariables[3] != KMType.INVALID_VALUE) {
if (tmpVariables[3] != tmpVariables[1]) {
KMException.throwIt(KMError.IMPORT_PARAMETER_MISMATCH);
if (tmpVariables[3] != KMType.P_256) {
KMException.throwIt(KMError.UNSUPPORTED_EC_CURVE);
}
} else {
// add the curve to scratchPad
Expand Down
11 changes: 6 additions & 5 deletions Applet/Applet/src/com/android/javacard/keymaster/KMRepository.java
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -36,8 +36,8 @@ public class KMRepository {
public static final byte BOOT_HASH_MAX_SIZE = 32;
// Repository attributes
private static KMRepository repository;
public boolean deviceUnlockPasswordOnly;
private byte[] masterKey;
private byte[] hmacSeed;
private byte[] sharedKey;
private byte[] computedHmacKey;
private byte[] hmacNonce;
Expand All@@ -56,6 +56,7 @@ public class KMRepository {
public boolean verifiedBootFlag;
public boolean selfSignedBootFlag;
public boolean deviceLockedFlag;
public byte[] deviceLockedTimestamp;

public static KMRepository instance() {
return repository;
Expand DownExpand Up@@ -83,6 +84,10 @@ public KMRepository() {
((KMOperationState)operationStateTable[index]).reset();
index++;
}
deviceLockedFlag = false;
deviceLockedTimestamp = new byte[8];
deviceUnlockPasswordOnly = false;
Util.arrayFillNonAtomic(deviceLockedTimestamp,(short)0,(short)8,(byte)0);
repository = this;
}

Expand DownExpand Up@@ -177,10 +182,6 @@ public byte[] getHeap() {
return heap;
}

public byte[] getHmacSeed() {
return hmacSeed;
}

public byte[] getSharedKey() {
return sharedKey;
}
Expand Down
Loading