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 #include "c_array.h" 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 enum InnerKitResultCode { 29 INNER_RESULT_SUCCESS = 0, 30 INNER_RESULT_FAIL = 1, 31 INNER_RESULT_GENERAL_ERROR = 2, 32 INNER_RESULT_CANCELED = 3, 33 INNER_RESULT_TIMEOUT = 4, 34 INNER_RESULT_TYPE_NOT_SUPPORT = 5, 35 INNER_RESULT_TRUST_LEVEL_NOT_SUPPORT = 6, 36 INNER_RESULT_BUSY = 7, 37 INNER_RESULT_INVALID_PARAMETERS = 8, 38 INNER_RESULT_LOCKED = 9, 39 INNER_RESULT_NOT_ENROLLED = 10, 40 INNER_RESULT_HARDWARE_NOT_SUPPORTED = 11, 41 INNER_RESULT_PIN_EXPIRED = 13, 42 INNER_RESULT_SYSTEM_ERROR_CODE_BEGIN = 1000, // error code for system 43 INNER_RESULT_IPC_ERROR = 1001, 44 INNER_RESULT_INVALID_CONTEXT_ID = 1002, 45 INNER_RESULT_READ_PARCEL_ERROR = 1003, 46 INNER_RESULT_WRITE_PARCEL_ERROR = 1004, 47 INNER_RESULT_CHECK_PERMISSION_FAILED = 1005, 48 INNER_RESULT_INVALID_HDI_INTERFACE = 1006, 49 INNER_RESULT_VENDOR_ERROR_CODE_BEGIN = 10000, // error code for vendor 50 }; 51 52 typedef enum ResultCode { 53 RESULT_SUCCESS = INNER_RESULT_SUCCESS, 54 RESULT_GENERAL_ERROR = INNER_RESULT_GENERAL_ERROR, 55 RESULT_BAD_PARAM = INNER_RESULT_INVALID_PARAMETERS, 56 RESULT_NOT_ENROLLED = INNER_RESULT_NOT_ENROLLED, 57 RESULT_TYPE_NOT_SUPPORT = INNER_RESULT_TYPE_NOT_SUPPORT, 58 RESULT_TRUST_LEVEL_NOT_SUPPORT = INNER_RESULT_TRUST_LEVEL_NOT_SUPPORT, 59 RESULT_TIMEOUT = INNER_RESULT_TIMEOUT, 60 RESULT_PIN_EXPIRED = INNER_RESULT_PIN_EXPIRED, 61 RESULT_BAD_COPY = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x3, 62 RESULT_NO_MEMORY = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x4, 63 RESULT_NEED_INIT = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x5, 64 RESULT_NOT_FOUND = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x6, 65 RESULT_REACH_LIMIT = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x7, 66 RESULT_DUPLICATE_CHECK_FAILED = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x8, 67 RESULT_BAD_READ = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x9, 68 RESULT_BAD_WRITE = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xA, 69 RESULT_BAD_DEL = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xB, 70 RESULT_UNKNOWN = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xC, 71 RESULT_BAD_MATCH = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xD, 72 RESULT_BAD_SIGN = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0xE, 73 RESULT_BUSY = INNER_RESULT_BUSY, 74 RESULT_TOKEN_TIMEOUT = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x10, 75 RESULT_VERIFY_TOKEN_FAIL = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x11, 76 RESULT_EXCEED_LIMIT = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x12, 77 78 RESULT_AUTH_NOT_COMPELETED = INNER_RESULT_VENDOR_ERROR_CODE_BEGIN + 0x10001, 79 } ResultCode; 80 81 typedef enum AuthType { 82 DEFAULT_AUTH_TYPE = 0, // default type used to cache pin 83 PIN_AUTH = 1, 84 FACE_AUTH = 2, 85 FINGER_AUTH = 4, 86 } AuthType; 87 88 typedef enum ScheduleMode { 89 SCHEDULE_MODE_ENROLL = 0, 90 SCHEDULE_MODE_AUTH = 1, 91 SCHEDULE_MODE_IDENTIFY = 2, 92 SCHEDULE_MODE_REUSE_UNLOCK_AUTH_RESULT = 3, 93 } ScheduleMode; 94 95 typedef enum AuthSubType { 96 DEFAULT_TYPE = 0, 97 } AuthSubType; 98 99 typedef enum UserType { 100 MAIN_USER = 0, 101 SUB_USER = 1, 102 PRIVATE_USER = 2, 103 } UserType; 104 105 typedef enum AuthPropertyMode { 106 PROPERTY_INIT_ALGORITHM = 1, 107 PROPERTY_MODE_DEL = 2, 108 PROPERTY_MODE_GET = 3, 109 PROPERTY_MODE_SET = 4, 110 PROPERTY_MODE_FREEZE = 5, 111 PROPERTY_MODE_UNFREEZE = 6, 112 PROPERTY_MODE_SET_CACHED_TEMPLATES = 7, 113 } AuthPropertyMode; 114 115 typedef enum Asl { 116 ASL0 = 0, 117 ASL1 = 1, 118 ASL2 = 2, 119 ASL3 = 3, 120 MAX_ASL = 4, 121 } Asl; 122 123 typedef enum Acl { 124 ACL0 = 0, 125 ACL1 = 1, 126 ACL2 = 2, 127 ACL3 = 3, 128 } Acl; 129 130 typedef enum Atl { 131 ATL0 = 0, 132 ATL1 = 10000, 133 ATL2 = 20000, 134 ATL3 = 30000, 135 ATL4 = 40000, 136 } Atl; 137 138 typedef enum TokenType { 139 TOKEN_TYPE_LOCAL_AUTH = 0, 140 TOKEN_TYPE_LOCAL_RESIGN = 1, 141 TOKEN_TYPE_COAUTH = 2, 142 } TokenType; 143 144 #define IF_TRUE_LOGE_AND_RETURN_VAL(cond, retVal) \ 145 do { \ 146 if (cond) { \ 147 LOG_ERROR("(" #cond ") check fail, return"); \ 148 return (retVal); \ 149 } \ 150 } while (0) 151 152 #define IF_TRUE_LOGE_AND_RETURN(cond) \ 153 do { \ 154 if (cond) { \ 155 LOG_ERROR("(" #cond ") check fail, return"); \ 156 return; \ 157 } \ 158 } while (0) 159 160 #define MAX_DUPLICATE_CHECK 100 161 #define INVALID_SENSOR_HINT 0 162 #define MAX_TEMPLATE_OF_SCHEDULE 10 163 #define CHALLENGE_LEN 32 164 #define MAX_CREDENTIAL_OUTPUT 10 165 #define MAX_ENROLL_OUTPUT 5 166 #define MAX_AUTH_TYPE_LEN 3 167 #define UDID_LEN 64 168 169 #ifdef __cplusplus 170 } 171 #endif 172 173 #endif 174