1 /* 2 * Copyright (C) 2022-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef COMMON_DEFINES_H 17 #define COMMON_DEFINES_H 18 19 #include <stdint.h> 20 21 #include "adaptor_log.h" 22 23 #ifdef __cplusplus 24 extern "C" { 25 #endif 26 27 enum InnerKitResultCode { 28 INNER_RESULT_SUCCESS = 0, 29 INNER_RESULT_FAIL = 1, 30 INNER_RESULT_GENERAL_ERROR = 2, 31 INNER_RESULT_CANCELED = 3, 32 INNER_RESULT_TIMEOUT = 4, 33 INNER_RESULT_TYPE_NOT_SUPPORT = 5, 34 INNER_RESULT_TRUST_LEVEL_NOT_SUPPORT = 6, 35 INNER_RESULT_BUSY = 7, 36 INNER_RESULT_INVALID_PARAMETERS = 8, 37 INNER_RESULT_LOCKED = 9, 38 INNER_RESULT_NOT_ENROLLED = 10, 39 INNER_RESULT_HARDWARE_NOT_SUPPORTED = 11, 40 INNER_RESULT_PIN_EXPIRED = 13, 41 INNER_RESULT_AUTH_TOKEN_CHECK_FAILED = 15, 42 INNER_RESULT_AUTH_TOKEN_EXPIRED = 16, 43 INNER_RESULT_SYSTEM_ERROR_CODE_BEGIN = 1000, // error code for system 44 INNER_RESULT_IPC_ERROR = 1001, 45 INNER_RESULT_INVALID_CONTEXT_ID = 1002, 46 INNER_RESULT_READ_PARCEL_ERROR = 1003, 47 INNER_RESULT_WRITE_PARCEL_ERROR = 1004, 48 INNER_RESULT_CHECK_PERMISSION_FAILED = 1005, 49 INNER_RESULT_INVALID_HDI_INTERFACE = 1006, 50 INNER_RESULT_VENDOR_ERROR_CODE_BEGIN = 10000, // error code for vendor 51 }; 52 53 typedef enum ResultCode { 54 RESULT_SUCCESS = INNER_RESULT_SUCCESS, 55 RESULT_GENERAL_ERROR = INNER_RESULT_GENERAL_ERROR, 56 RESULT_BAD_PARAM = INNER_RESULT_INVALID_PARAMETERS, 57 RESULT_NOT_ENROLLED = INNER_RESULT_NOT_ENROLLED, 58 RESULT_TYPE_NOT_SUPPORT = INNER_RESULT_TYPE_NOT_SUPPORT, 59 RESULT_TRUST_LEVEL_NOT_SUPPORT = INNER_RESULT_TRUST_LEVEL_NOT_SUPPORT, 60 RESULT_TIMEOUT = INNER_RESULT_TIMEOUT, 61 RESULT_PIN_EXPIRED = INNER_RESULT_PIN_EXPIRED, 62 RESULT_BAD_COPY = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x3, 63 RESULT_NO_MEMORY = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x4, 64 RESULT_NEED_INIT = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x5, 65 RESULT_NOT_FOUND = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x6, 66 RESULT_REACH_LIMIT = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x7, 67 RESULT_DUPLICATE_CHECK_FAILED = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x8, 68 RESULT_BAD_READ = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x9, 69 RESULT_BAD_WRITE = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xA, 70 RESULT_BAD_DEL = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xB, 71 RESULT_UNKNOWN = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xC, 72 RESULT_BAD_MATCH = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xD, 73 RESULT_BAD_SIGN = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xE, 74 RESULT_BUSY = INNER_RESULT_BUSY, 75 RESULT_TOKEN_TIMEOUT = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x10, 76 RESULT_VERIFY_TOKEN_FAIL = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x11, 77 RESULT_EXCEED_LIMIT = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x12, 78 79 RESULT_AUTH_NOT_COMPELETED = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x10001, 80 } ResultCode; 81 82 typedef enum AuthType { 83 DEFAULT_AUTH_TYPE = 0, // default type used to cache pin 84 PIN_AUTH = 1, 85 FACE_AUTH = 2, 86 FINGER_AUTH = 4, 87 RECOVERY_KEY = 8, 88 } AuthType; 89 90 typedef enum ScheduleMode { 91 SCHEDULE_MODE_ENROLL = 0, 92 SCHEDULE_MODE_AUTH = 1, 93 SCHEDULE_MODE_IDENTIFY = 2, 94 SCHEDULE_MODE_REUSE_UNLOCK_AUTH_RESULT = 3, 95 } ScheduleMode; 96 97 typedef enum AuthSubType { 98 DEFAULT_TYPE = 0, 99 } AuthSubType; 100 101 typedef enum UserType { 102 MAIN_USER = 0, 103 SUB_USER = 1, 104 PRIVATE_USER = 2, 105 } UserType; 106 107 typedef enum AuthPropertyMode { 108 PROPERTY_INIT_ALGORITHM = 1, 109 PROPERTY_MODE_DEL = 2, 110 PROPERTY_MODE_GET = 3, 111 PROPERTY_MODE_SET = 4, 112 PROPERTY_MODE_FREEZE = 5, 113 PROPERTY_MODE_UNFREEZE = 6, 114 PROPERTY_MODE_SET_CACHED_TEMPLATES = 7, 115 } AuthPropertyMode; 116 117 typedef enum Asl { 118 ASL0 = 0, 119 ASL1 = 1, 120 ASL2 = 2, 121 ASL3 = 3, 122 MAX_ASL = 4, 123 } Asl; 124 125 typedef enum Acl { 126 ACL0 = 0, 127 ACL1 = 1, 128 ACL2 = 2, 129 ACL3 = 3, 130 } Acl; 131 132 typedef enum Atl { 133 ATL0 = 0, 134 ATL1 = 10000, 135 ATL2 = 20000, 136 ATL3 = 30000, 137 ATL4 = 40000, 138 } Atl; 139 140 typedef enum TokenType { 141 TOKEN_TYPE_LOCAL_AUTH = 0, 142 TOKEN_TYPE_LOCAL_RESIGN = 1, 143 TOKEN_TYPE_COAUTH = 2, 144 } TokenType; 145 146 typedef enum AuthIntent { 147 DEFUALT = 0, 148 UNLOCK = 1, 149 SILENT_AUTH = 2, 150 } AuthIntent; 151 152 #define IF_TRUE_LOGE_AND_RETURN_VAL(cond, retVal) \ 153 do { \ 154 if (cond) { \ 155 LOG_ERROR("(" #cond ") check fail, return"); \ 156 return (retVal); \ 157 } \ 158 } while (0) 159 160 #define IF_TRUE_LOGE_AND_RETURN(cond) \ 161 do { \ 162 if (cond) { \ 163 LOG_ERROR("(" #cond ") check fail, return"); \ 164 return; \ 165 } \ 166 } while (0) 167 168 #define MAX_DUPLICATE_CHECK 100 169 #define INVALID_SENSOR_HINT 0 170 #define MAX_TEMPLATE_OF_SCHEDULE 20 171 #define CHALLENGE_LEN 32 172 #define MAX_CREDENTIAL_OUTPUT 20 173 #define MAX_ENROLL_OUTPUT 5 174 #define MAX_AUTH_TYPE_LEN 5 175 #define UDID_LEN 64 176 #define INVALID_USER_ID (-1) 177 178 #ifdef __cplusplus 179 } 180 #endif 181 182 #endif 183