aboutsummaryrefslogtreecommitdiff
path: root/ready_se/google/keymint/KM300/Applet/src/com/android/javacard/keymaster/KMKeyCharacteristics.java
blob: 37b8b7fcfd55ab36c0968c7f24debda40f33d349 (plain)
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
/*
 * 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;

/**
 * KMKeyCharacteristics represents KeyCharacteristics structure from android keymaster hal
 * specifications. It corresponds to CBOR array type. struct{byte KEY_CHAR_TYPE; short length=3;
 * short arrayPtr} where arrayPtr is a pointer to ordered array with 1 or 3 following elements:
 * {KMKeyParameters sb; KMKeyParameters tee; KMKeyParameters keystore}
 */
public class KMKeyCharacteristics extends KMType {

  public static final byte STRONGBOX_ENFORCED = 0x00;
  public static final byte TEE_ENFORCED = 0x01;
  public static final byte KEYSTORE_ENFORCED = 0x02;
  private static KMKeyCharacteristics prototype;

  private KMKeyCharacteristics() {}

  public static short exp() {
    short keyParamExp = KMKeyParameters.exp();
    short arrPtr = KMArray.instance((short) 3);

    KMArray arr = KMArray.cast(arrPtr);
    arr.add(STRONGBOX_ENFORCED, keyParamExp);
    arr.add(TEE_ENFORCED, keyParamExp);
    arr.add(KEYSTORE_ENFORCED, keyParamExp);
    return instance(arrPtr);
  }

  private static KMKeyCharacteristics proto(short ptr) {
    if (prototype == null) {
      prototype = new KMKeyCharacteristics();
    }
    KMType.instanceTable[KM_KEY_CHARACTERISTICS_OFFSET] = ptr;
    return prototype;
  }

  public static short instance() {
    short arrPtr = KMArray.instance((short) 3);
    return instance(arrPtr);
  }

  public static short instance(short vals) {
    short ptr = KMType.instance(KEY_CHAR_TYPE, (short) 3);
    if (KMArray.cast(vals).length() != 3) {
      ISOException.throwIt(ISO7816.SW_WRONG_LENGTH);
    }
    Util.setShort(heap, (short) (ptr + TLV_HEADER_SIZE), vals);
    return ptr;
  }

  public static KMKeyCharacteristics cast(short ptr) {
    if (heap[ptr] != KEY_CHAR_TYPE) {
      ISOException.throwIt(ISO7816.SW_CONDITIONS_NOT_SATISFIED);
    }
    short arrPtr = Util.getShort(heap, (short) (ptr + TLV_HEADER_SIZE));
    if (heap[arrPtr] != ARRAY_TYPE) {
      ISOException.throwIt(ISO7816.SW_CONDITIONS_NOT_SATISFIED);
    }
    return proto(ptr);
  }

  public short getVals() {
    return Util.getShort(
        heap, (short) (KMType.instanceTable[KM_KEY_CHARACTERISTICS_OFFSET] + TLV_HEADER_SIZE));
  }

  public short length() {
    short arrPtr = getVals();
    return KMArray.cast(arrPtr).length();
  }

  public short getKeystoreEnforced() {
    short arrPtr = getVals();
    return KMArray.cast(arrPtr).get(KEYSTORE_ENFORCED);
  }

  public void setKeystoreEnforced(short ptr) {
    KMKeyParameters.cast(ptr);
    short arrPtr = getVals();
    KMArray.cast(arrPtr).add(KEYSTORE_ENFORCED, ptr);
  }

  public short getTeeEnforced() {
    short arrPtr = getVals();
    return KMArray.cast(arrPtr).get(TEE_ENFORCED);
  }

  public void setTeeEnforced(short ptr) {
    KMKeyParameters.cast(ptr);
    short arrPtr = getVals();
    KMArray.cast(arrPtr).add(TEE_ENFORCED, ptr);
  }

  public short getStrongboxEnforced() {
    short arrPtr = getVals();
    return KMArray.cast(arrPtr).get(STRONGBOX_ENFORCED);
  }

  public void setStrongboxEnforced(short ptr) {
    KMKeyParameters.cast(ptr);
    short arrPtr = getVals();
    KMArray.cast(arrPtr).add(STRONGBOX_ENFORCED, ptr);
  }
}