1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
* Copyright(C) 2020 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.javacard.keymaster;
import javacard.framework.ISO7816;
import javacard.framework.ISOException;
import javacard.framework.Util;
/**
* KMEnum represents an enumeration specified in android keymaster hal specifications. It
* corresponds to uint CBOR type and it is a byte value. struct{byte ENUM_TYPE; short length;
* struct{short enumType; byte val}}
*/
public class KMEnum extends KMType {
private static KMEnum prototype;
// The allowed enum types.
private static short[] types = {
HARDWARE_TYPE,
KEY_FORMAT,
KEY_DERIVATION_FUNCTION,
VERIFIED_BOOT_STATE,
DEVICE_LOCKED,
USER_AUTH_TYPE,
PURPOSE,
ECCURVE,
RULE
};
private static Object[] enums = null;
private KMEnum() {}
private static KMEnum proto(short ptr) {
if (prototype == null) {
prototype = new KMEnum();
}
KMType.instanceTable[KM_ENUM_OFFSET] = ptr;
return prototype;
}
// pointer to an empty instance used as expression
public static short exp() {
return KMType.exp(ENUM_TYPE);
}
public static KMEnum cast(short ptr) {
if (heap[ptr] != ENUM_TYPE) {
ISOException.throwIt(ISO7816.SW_CONDITIONS_NOT_SATISFIED);
}
if (Util.getShort(heap, (short) (ptr + 1)) == INVALID_VALUE) {
ISOException.throwIt(ISO7816.SW_CONDITIONS_NOT_SATISFIED);
}
return proto(ptr);
}
public static short instance(short enumType) {
if (!validateEnum(enumType, NO_VALUE)) {
ISOException.throwIt(ISO7816.SW_DATA_INVALID);
}
short ptr = KMType.instance(ENUM_TYPE, (short) 2 /* TAG_KEY */);
Util.setShort(heap, (short) (ptr + TLV_HEADER_SIZE), enumType);
return ptr;
}
public static short instance(short enumType, byte val) {
if (!validateEnum(enumType, val)) {
ISOException.throwIt(ISO7816.SW_DATA_INVALID);
}
short ptr = KMType.instance(ENUM_TYPE, (short) (2 /* TAG_KEY */ + 1 /* Byte value */));
Util.setShort(heap, (short) (ptr + TLV_HEADER_SIZE), enumType);
heap[(short) (ptr + TLV_HEADER_SIZE + 2)] = val;
return ptr;
}
public static short instance(short key, byte[] num, short srcOff, short length) {
if (length == 1) {
return instance(key, num[srcOff]);
}
if (!validateEnum(key, num, srcOff, length)) {
ISOException.throwIt(ISO7816.SW_DATA_INVALID);
}
short ptr = KMType.instance(ENUM_TYPE, (short) (2 /* TAG_KEY */ + KMInteger.UINT_32));
Util.setShort(heap, (short) (ptr + TLV_HEADER_SIZE), key);
short destValOff = (short) (ptr + TLV_HEADER_SIZE + 2);
Util.arrayFillNonAtomic(heap, destValOff, KMInteger.UINT_32, (byte) 0);
Util.arrayCopyNonAtomic(
num, srcOff, heap, (short) (destValOff + KMInteger.UINT_32 - length), length);
return ptr;
}
private static void create() {
// The allowed enum values to corresponding enum types in the types array.
if (enums == null) {
enums =
new Object[] {
new byte[] {SOFTWARE, TRUSTED_ENVIRONMENT, STRONGBOX},
new byte[] {X509, PKCS8, RAW},
new byte[] {
DERIVATION_NONE,
RFC5869_SHA256,
ISO18033_2_KDF1_SHA1,
ISO18033_2_KDF1_SHA256,
ISO18033_2_KDF2_SHA1,
ISO18033_2_KDF2_SHA256
},
new byte[] {SELF_SIGNED_BOOT, VERIFIED_BOOT, UNVERIFIED_BOOT, FAILED_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, AGREE_KEY},
new byte[] {P_224, P_256, P_384, P_521},
new byte[] {IGNORE_INVALID_TAGS, FAIL_ON_INVALID_TAGS}
};
}
}
// isValidTag enumeration keys and values.
private static boolean validateEnum(short key, byte value) {
create();
byte[] vals;
short enumInd;
// check if key exists
short index = (short) types.length;
while (--index >= 0) {
if (types[index] == key) {
// check if value given
if (value != NO_VALUE) {
// check if the value exist
vals = (byte[]) enums[index];
enumInd = (short) vals.length;
while (--enumInd >= 0) {
if (vals[enumInd] == value) {
// return true if value exist
return true;
}
}
// return false if value does not exist
return false;
}
// return true if key exist and value not given
return true;
}
}
// return false if key does not exist
return false;
}
public short length() {
return (short) (Util.getShort(heap, (short) (KMType.instanceTable[KM_ENUM_OFFSET] + 1)) - 2);
}
public byte getVal() {
return heap[(short) (KMType.instanceTable[KM_ENUM_OFFSET] + TLV_HEADER_SIZE + 2)];
}
public short value(byte[] dest, short destOff) {
return copyToUint32(heap, getStartOffset(), length(), dest, destOff);
}
public short getStartOffset() {
return (short) (KMType.instanceTable[KM_ENUM_OFFSET] + TLV_HEADER_SIZE + 2);
}
public void setVal(byte val) {
heap[(short) (KMType.instanceTable[KM_ENUM_OFFSET] + TLV_HEADER_SIZE + 2)] = val;
}
public short getEnumType() {
return Util.getShort(heap, (short) (KMType.instanceTable[KM_ENUM_OFFSET] + TLV_HEADER_SIZE));
}
public void setEnumType(short type) {
Util.setShort(heap, (short) (KMType.instanceTable[KM_ENUM_OFFSET] + TLV_HEADER_SIZE), type);
}
public static boolean validateEnum(short key, byte[] buf, short off, short len) {
if (len != KMInteger.UINT_32) {
return false;
}
switch (key) {
case KMType.USER_AUTH_TYPE:
// HardwareAuthenticatorType::ANY - 0xFFFFFFFF
short highShort = Util.getShort(buf, off);
short lowShort = Util.getShort(buf, (short) (off + 2));
return ((short) 0xFFFF == (short) (highShort & lowShort));
default:
return false;
}
}
}
|
