KeymasterDefs.java revision 42abb74834dc56393fad9f32a6717269c58c1eb3
1/** 2 * Copyright (c) 2015, The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.security.keymaster; 18 19import java.util.HashMap; 20import java.util.Map; 21 22/** 23 * Class tracking all the keymaster enum values needed for the binder API to keystore. 24 * This must be kept in sync with hardware/libhardware/include/hardware/keymaster_defs.h 25 * See keymaster_defs.h for detailed descriptions of each constant. 26 * @hide 27 */ 28public final class KeymasterDefs { 29 30 private KeymasterDefs() {} 31 32 // Tag types. 33 public static final int KM_INVALID = 0 << 28; 34 public static final int KM_ENUM = 1 << 28; 35 public static final int KM_ENUM_REP = 2 << 28; 36 public static final int KM_INT = 3 << 28; 37 public static final int KM_INT_REP = 4 << 28; 38 public static final int KM_LONG = 5 << 28; 39 public static final int KM_DATE = 6 << 28; 40 public static final int KM_BOOL = 7 << 28; 41 public static final int KM_BIGNUM = 8 << 28; 42 public static final int KM_BYTES = 9 << 28; 43 public static final int KM_LONG_REP = 10 << 28; 44 45 // Tag values. 46 public static final int KM_TAG_INVALID = KM_INVALID | 0; 47 public static final int KM_TAG_PURPOSE = KM_ENUM_REP | 1; 48 public static final int KM_TAG_ALGORITHM = KM_ENUM | 2; 49 public static final int KM_TAG_KEY_SIZE = KM_INT | 3; 50 public static final int KM_TAG_BLOCK_MODE = KM_ENUM_REP | 4; 51 public static final int KM_TAG_DIGEST = KM_ENUM_REP | 5; 52 public static final int KM_TAG_PADDING = KM_ENUM_REP | 6; 53 public static final int KM_TAG_CALLER_NONCE = KM_BOOL | 7; 54 55 public static final int KM_TAG_RESCOPING_ADD = KM_ENUM_REP | 101; 56 public static final int KM_TAG_RESCOPING_DEL = KM_ENUM_REP | 102; 57 public static final int KM_TAG_BLOB_USAGE_REQUIREMENTS = KM_ENUM | 705; 58 59 public static final int KM_TAG_RSA_PUBLIC_EXPONENT = KM_LONG | 200; 60 public static final int KM_TAG_ACTIVE_DATETIME = KM_DATE | 400; 61 public static final int KM_TAG_ORIGINATION_EXPIRE_DATETIME = KM_DATE | 401; 62 public static final int KM_TAG_USAGE_EXPIRE_DATETIME = KM_DATE | 402; 63 public static final int KM_TAG_MIN_SECONDS_BETWEEN_OPS = KM_INT | 403; 64 public static final int KM_TAG_MAX_USES_PER_BOOT = KM_INT | 404; 65 66 public static final int KM_TAG_ALL_USERS = KM_BOOL | 500; 67 public static final int KM_TAG_USER_ID = KM_INT | 501; 68 public static final int KM_TAG_USER_SECURE_ID = KM_LONG_REP | 502; 69 public static final int KM_TAG_NO_AUTH_REQUIRED = KM_BOOL | 503; 70 public static final int KM_TAG_USER_AUTH_TYPE = KM_ENUM | 504; 71 public static final int KM_TAG_AUTH_TIMEOUT = KM_INT | 505; 72 73 public static final int KM_TAG_ALL_APPLICATIONS = KM_BOOL | 600; 74 public static final int KM_TAG_APPLICATION_ID = KM_BYTES | 601; 75 76 public static final int KM_TAG_APPLICATION_DATA = KM_BYTES | 700; 77 public static final int KM_TAG_CREATION_DATETIME = KM_DATE | 701; 78 public static final int KM_TAG_ORIGIN = KM_ENUM | 702; 79 public static final int KM_TAG_ROLLBACK_RESISTANT = KM_BOOL | 703; 80 public static final int KM_TAG_ROOT_OF_TRUST = KM_BYTES | 704; 81 82 public static final int KM_TAG_ASSOCIATED_DATA = KM_BYTES | 1000; 83 public static final int KM_TAG_NONCE = KM_BYTES | 1001; 84 public static final int KM_TAG_AUTH_TOKEN = KM_BYTES | 1002; 85 public static final int KM_TAG_MAC_LENGTH = KM_INT | 1003; 86 87 // Algorithm values. 88 public static final int KM_ALGORITHM_RSA = 1; 89 public static final int KM_ALGORITHM_EC = 3; 90 public static final int KM_ALGORITHM_AES = 32; 91 public static final int KM_ALGORITHM_HMAC = 128; 92 93 // Block modes. 94 public static final int KM_MODE_ECB = 1; 95 public static final int KM_MODE_CBC = 2; 96 public static final int KM_MODE_CTR = 3; 97 public static final int KM_MODE_GCM = 32; 98 99 // Padding modes. 100 public static final int KM_PAD_NONE = 1; 101 public static final int KM_PAD_RSA_OAEP = 2; 102 public static final int KM_PAD_RSA_PSS = 3; 103 public static final int KM_PAD_RSA_PKCS1_1_5_ENCRYPT = 4; 104 public static final int KM_PAD_RSA_PKCS1_1_5_SIGN = 5; 105 public static final int KM_PAD_PKCS7 = 64; 106 107 // Digest modes. 108 public static final int KM_DIGEST_NONE = 0; 109 public static final int KM_DIGEST_MD5 = 1; 110 public static final int KM_DIGEST_SHA1 = 2; 111 public static final int KM_DIGEST_SHA_2_224 = 3; 112 public static final int KM_DIGEST_SHA_2_256 = 4; 113 public static final int KM_DIGEST_SHA_2_384 = 5; 114 public static final int KM_DIGEST_SHA_2_512 = 6; 115 116 // Key origins. 117 public static final int KM_ORIGIN_GENERATED = 0; 118 public static final int KM_ORIGIN_IMPORTED = 2; 119 public static final int KM_ORIGIN_UNKNOWN = 3; 120 121 // Key usability requirements. 122 public static final int KM_BLOB_STANDALONE = 0; 123 public static final int KM_BLOB_REQUIRES_FILE_SYSTEM = 1; 124 125 // Operation Purposes. 126 public static final int KM_PURPOSE_ENCRYPT = 0; 127 public static final int KM_PURPOSE_DECRYPT = 1; 128 public static final int KM_PURPOSE_SIGN = 2; 129 public static final int KM_PURPOSE_VERIFY = 3; 130 131 // Key formats. 132 public static final int KM_KEY_FORMAT_X509 = 0; 133 public static final int KM_KEY_FORMAT_PKCS8 = 1; 134 public static final int KM_KEY_FORMAT_RAW = 3; 135 136 // User authenticators. 137 public static final int HW_AUTH_PASSWORD = 1 << 0; 138 public static final int HW_AUTH_FINGERPRINT = 1 << 1; 139 140 // Error codes. 141 public static final int KM_ERROR_OK = 0; 142 public static final int KM_ERROR_ROOT_OF_TRUST_ALREADY_SET = -1; 143 public static final int KM_ERROR_UNSUPPORTED_PURPOSE = -2; 144 public static final int KM_ERROR_INCOMPATIBLE_PURPOSE = -3; 145 public static final int KM_ERROR_UNSUPPORTED_ALGORITHM = -4; 146 public static final int KM_ERROR_INCOMPATIBLE_ALGORITHM = -5; 147 public static final int KM_ERROR_UNSUPPORTED_KEY_SIZE = -6; 148 public static final int KM_ERROR_UNSUPPORTED_BLOCK_MODE = -7; 149 public static final int KM_ERROR_INCOMPATIBLE_BLOCK_MODE = -8; 150 public static final int KM_ERROR_UNSUPPORTED_MAC_LENGTH = -9; 151 public static final int KM_ERROR_UNSUPPORTED_PADDING_MODE = -10; 152 public static final int KM_ERROR_INCOMPATIBLE_PADDING_MODE = -11; 153 public static final int KM_ERROR_UNSUPPORTED_DIGEST = -12; 154 public static final int KM_ERROR_INCOMPATIBLE_DIGEST = -13; 155 public static final int KM_ERROR_INVALID_EXPIRATION_TIME = -14; 156 public static final int KM_ERROR_INVALID_USER_ID = -15; 157 public static final int KM_ERROR_INVALID_AUTHORIZATION_TIMEOUT = -16; 158 public static final int KM_ERROR_UNSUPPORTED_KEY_FORMAT = -17; 159 public static final int KM_ERROR_INCOMPATIBLE_KEY_FORMAT = -18; 160 public static final int KM_ERROR_UNSUPPORTED_KEY_ENCRYPTION_ALGORITHM = -19; 161 public static final int KM_ERROR_UNSUPPORTED_KEY_VERIFICATION_ALGORITHM = -20; 162 public static final int KM_ERROR_INVALID_INPUT_LENGTH = -21; 163 public static final int KM_ERROR_KEY_EXPORT_OPTIONS_INVALID = -22; 164 public static final int KM_ERROR_DELEGATION_NOT_ALLOWED = -23; 165 public static final int KM_ERROR_KEY_NOT_YET_VALID = -24; 166 public static final int KM_ERROR_KEY_EXPIRED = -25; 167 public static final int KM_ERROR_KEY_USER_NOT_AUTHENTICATED = -26; 168 public static final int KM_ERROR_OUTPUT_PARAMETER_NULL = -27; 169 public static final int KM_ERROR_INVALID_OPERATION_HANDLE = -28; 170 public static final int KM_ERROR_INSUFFICIENT_BUFFER_SPACE = -29; 171 public static final int KM_ERROR_VERIFICATION_FAILED = -30; 172 public static final int KM_ERROR_TOO_MANY_OPERATIONS = -31; 173 public static final int KM_ERROR_UNEXPECTED_NULL_POINTER = -32; 174 public static final int KM_ERROR_INVALID_KEY_BLOB = -33; 175 public static final int KM_ERROR_IMPORTED_KEY_NOT_ENCRYPTED = -34; 176 public static final int KM_ERROR_IMPORTED_KEY_DECRYPTION_FAILED = -35; 177 public static final int KM_ERROR_IMPORTED_KEY_NOT_SIGNED = -36; 178 public static final int KM_ERROR_IMPORTED_KEY_VERIFICATION_FAILED = -37; 179 public static final int KM_ERROR_INVALID_ARGUMENT = -38; 180 public static final int KM_ERROR_UNSUPPORTED_TAG = -39; 181 public static final int KM_ERROR_INVALID_TAG = -40; 182 public static final int KM_ERROR_MEMORY_ALLOCATION_FAILED = -41; 183 public static final int KM_ERROR_INVALID_RESCOPING = -42; 184 public static final int KM_ERROR_IMPORT_PARAMETER_MISMATCH = -44; 185 public static final int KM_ERROR_SECURE_HW_ACCESS_DENIED = -45; 186 public static final int KM_ERROR_OPERATION_CANCELLED = -46; 187 public static final int KM_ERROR_CONCURRENT_ACCESS_CONFLICT = -47; 188 public static final int KM_ERROR_SECURE_HW_BUSY = -48; 189 public static final int KM_ERROR_SECURE_HW_COMMUNICATION_FAILED = -49; 190 public static final int KM_ERROR_UNSUPPORTED_EC_FIELD = -50; 191 public static final int KM_ERROR_MISSING_NONCE = -51; 192 public static final int KM_ERROR_INVALID_NONCE = -52; 193 public static final int KM_ERROR_MISSING_MAC_LENGTH = -53; 194 public static final int KM_ERROR_RESCOPABLE_KEY_NOT_USABLE = -54; 195 public static final int KM_ERROR_CALLER_NONCE_PROHIBITED = -55; 196 public static final int KM_ERROR_UNIMPLEMENTED = -100; 197 public static final int KM_ERROR_VERSION_MISMATCH = -101; 198 public static final int KM_ERROR_UNKNOWN_ERROR = -1000; 199 200 public static final Map<Integer, String> sErrorCodeToString = new HashMap<Integer, String>(); 201 static { 202 sErrorCodeToString.put(KM_ERROR_OK, "OK"); 203 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_PURPOSE, "Unsupported purpose"); 204 sErrorCodeToString.put(KM_ERROR_INCOMPATIBLE_PURPOSE, "Incompatible purpose"); 205 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_ALGORITHM, "Unsupported algorithm"); 206 sErrorCodeToString.put(KM_ERROR_INCOMPATIBLE_ALGORITHM, "Incompatible algorithm"); 207 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_KEY_SIZE, "Unsupported key size"); 208 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_BLOCK_MODE, "Unsupported block mode"); 209 sErrorCodeToString.put(KM_ERROR_INCOMPATIBLE_BLOCK_MODE, "Incompatible block mode"); 210 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_MAC_LENGTH, 211 "Unsupported MAC or authentication tag length"); 212 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_PADDING_MODE, "Unsupported padding mode"); 213 sErrorCodeToString.put(KM_ERROR_INCOMPATIBLE_PADDING_MODE, "Incompatible padding mode"); 214 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_DIGEST, "Unsupported digest"); 215 sErrorCodeToString.put(KM_ERROR_INCOMPATIBLE_DIGEST, "Incompatible digest"); 216 sErrorCodeToString.put(KM_ERROR_INVALID_EXPIRATION_TIME, "Invalid expiration time"); 217 sErrorCodeToString.put(KM_ERROR_INVALID_USER_ID, "Invalid user ID"); 218 sErrorCodeToString.put(KM_ERROR_INVALID_AUTHORIZATION_TIMEOUT, 219 "Invalid user authorization timeout"); 220 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_KEY_FORMAT, "Unsupported key format"); 221 sErrorCodeToString.put(KM_ERROR_INCOMPATIBLE_KEY_FORMAT, "Incompatible key format"); 222 sErrorCodeToString.put(KM_ERROR_INVALID_INPUT_LENGTH, "Invalid input length"); 223 sErrorCodeToString.put(KM_ERROR_KEY_NOT_YET_VALID, "Key not yet valid"); 224 sErrorCodeToString.put(KM_ERROR_KEY_EXPIRED, "Key expired"); 225 sErrorCodeToString.put(KM_ERROR_KEY_USER_NOT_AUTHENTICATED, "Key user not authenticated"); 226 sErrorCodeToString.put(KM_ERROR_INVALID_OPERATION_HANDLE, "Invalid operation handle"); 227 sErrorCodeToString.put(KM_ERROR_VERIFICATION_FAILED, "Signature/MAC verification failed"); 228 sErrorCodeToString.put(KM_ERROR_TOO_MANY_OPERATIONS, "Too many operations"); 229 sErrorCodeToString.put(KM_ERROR_INVALID_KEY_BLOB, "Invalid key blob"); 230 sErrorCodeToString.put(KM_ERROR_INVALID_ARGUMENT, "Invalid argument"); 231 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_TAG, "Unsupported tag"); 232 sErrorCodeToString.put(KM_ERROR_INVALID_TAG, "Invalid tag"); 233 sErrorCodeToString.put(KM_ERROR_MEMORY_ALLOCATION_FAILED, "Memory allocation failed"); 234 sErrorCodeToString.put(KM_ERROR_UNSUPPORTED_EC_FIELD, "Unsupported EC field"); 235 sErrorCodeToString.put(KM_ERROR_MISSING_NONCE, "Required IV missing"); 236 sErrorCodeToString.put(KM_ERROR_INVALID_NONCE, "Invalid IV"); 237 sErrorCodeToString.put(KM_ERROR_CALLER_NONCE_PROHIBITED, 238 "Caller-provided IV not permitted"); 239 sErrorCodeToString.put(KM_ERROR_UNIMPLEMENTED, "Not implemented"); 240 sErrorCodeToString.put(KM_ERROR_UNKNOWN_ERROR, "Unknown error"); 241 } 242 243 public static int getTagType(int tag) { 244 return tag & (0xF << 28); 245 } 246 247 public static String getErrorMessage(int errorCode) { 248 String result = sErrorCodeToString.get(errorCode); 249 if (result != null) { 250 return result; 251 } 252 return String.valueOf(errorCode); 253 } 254} 255