• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2021-2023 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_DEFS_H
17 #define COMMON_DEFS_H
18 
19 #include "device_auth.h"
20 #include "device_auth_defines.h"
21 #include "hc_string.h"
22 #include "hc_vector.h"
23 #include "json_utils.h"
24 
25 #define FIELD_DEVICE_PK "devicePk"
26 #define FIELD_UDID "udid"
27 #define FIELD_PK_INFO_SIGNATURE "pkInfoSignature"
28 #define FIELD_CREDENTIAL "credential"
29 #define FIELD_SERVER_PK "serverPk"
30 
31 #define FIELD_ADD_TYPE "addType"
32 #define FIELD_ADD_ID "addId"
33 #define FIELD_ADD_KEY "addKey"
34 #define FIELD_AUTH_DATA "authData"
35 #define FIELD_AUTH_RETURN "authReturn"
36 #define FIELD_AUTH_ID "authId"
37 #define FIELD_AUTH_PK "authPk"
38 #define FIELD_ADD_AUTH_INFO "addAuthInfo"
39 #define FIELD_ADD_RETURN "addReturn"
40 #define FIELD_APP_ID "appId"
41 #define FIELD_BIND_SESSION_TYPE "bindSessionType"
42 #define FIELD_CHALLENGE "challenge"
43 #define FIELD_CHANNEL_ID "channelId"
44 #define FIELD_CHANNEL_TYPE "channelType"
45 #define FIELD_CONN_DEVICE_ID "connDeviceId"
46 #define FIELD_CONNECT_PARAMS "connectParams"
47 #define FIELD_CROSS_USER_ID_LIST "crossUserIdList"
48 #define FIELD_CURRENT_VERSION "currentVersion"
49 #define FIELD_DELETE_ID "deleteId"
50 #define FIELD_DELETED_RESULT "deletedResult"
51 #define FIELD_DEVICE_CLOUD_CREDENTIAL "devCloudCred"
52 #define FIELD_DEV_ID "devId"
53 #define FIELD_DEVICES_CREDENTIAL "devicesCredential"
54 #define FIELD_ENC_AUTH_TOKEN "encAuthToken"
55 #define FIELD_ENC_RESULT "encResult"
56 #define FIELD_ENC_DATA "encData"
57 #define FIELD_EPK "epk"
58 #define FIELD_EPK_LEN "epkLen"
59 #define FIELD_EX_AUTH_INFO "exAuthInfo"
60 #define FIELD_EXPIRE_TIME "expireTime"
61 #define FIELD_ERROR_CODE "errorCode"
62 #define FIELD_GROUP_INFO "groupInfo"
63 #define FIELD_GROUP_MANAGERS "groupManagers"
64 #define FIELD_GROUP_NAME "groupName"
65 #define FIELD_GROUP_OP "groupOp"
66 #define FIELD_GROUP_TYPE "groupType"
67 #define FIELD_GROUP_VISIBILITY "groupVisibility"
68 #define FIELD_IS_ADMIN "isAdmin"
69 #define FIELD_IS_ACCOUNT_BIND "isAccountBind"
70 #define FIELD_IS_BIND "isBind"
71 #define FIELD_IS_FORCE_DELETE "isForceDelete"
72 #define FIELD_IS_CREDENTIAL_EXISTS "isCredentialExists"
73 #define FIELD_IS_DIRECT_AUTH "isDirectAuth"
74 #define FIELD_KCF_DATA "kcfData"
75 #define FIELD_KEY_TYPE "keyType"
76 #define FIELD_TRUST_TYPE "trustType"
77 #define FIELD_MESSAGE "message"
78 #define FIELD_GROUP_ERROR_MSG "groupErrorMsg"
79 #define FIELD_MIN_VERSION "minVersion"
80 #define FIELD_GROUP_AND_MODULE_VERSION "groupAndModuleVersion"
81 #define FIELD_NONCE "nonce"
82 #define FIELD_OP_CODE "opCode"
83 #define FIELD_OPERATION_CODE "operationCode"
84 #define FIELD_OPERATION_PARAMS "operationParams"
85 #define FIELD_OWNER_ID "ownerId"
86 #define FIELD_OWNER_NAME "ownerName"
87 #define FIELD_PERMISSION "Permission"
88 #define FIELD_PAYLOAD "payload"
89 #define FIELD_PIN_CODE "pinCode"
90 #define FIELD_PUBLIC_KEY "publicKey"
91 #define FIELD_SIGN_ALG "signAlg"
92 #define FIELD_PK_INFO "pkInfo"
93 #define FIELD_REAL_INFO "realInfo"
94 #define FIELD_PSEUDONYM_ID "pseudonymId"
95 #define FIELD_INDEX_KEY "indexKey"
96 #define FIELD_PKG_NAME "pkgName"
97 #define FIELD_SELF_AUTH_ID "selfAuthId"
98 #define FIELD_SELF_DEVICE_ID "selfDeviceId"
99 #define FIELD_SELF_DEV_ID "selfDevId"
100 #define FIELD_SELF_USER_ID "selfUserId"
101 #define FIELD_REQUEST_ID "requestId"
102 #define FIELD_RECEIVED_DATA "receivedData"
103 #define FIELD_RETURN_CODE "returnCode"
104 #define FIELD_RETURN_DATA "returnData"
105 #define FIELD_RETURN_CODE_MAC "returnCodeMac"
106 #define FIELD_RMV_TYPE "rmvType"
107 #define FIELD_RMV_ID "rmvId"
108 #define FIELD_RMV_AUTH_INFO "rmvAuthInfo"
109 #define FIELD_RMV_RETURN "rmvReturn"
110 #define FIELD_SALT "salt"
111 #define FIELD_ISO_SALT "isoSalt"
112 #define FIELD_SEED "seed"
113 #define FIELD_SELF_TYPE "selfType"
114 #define FIELD_SEND_TO_PEER "sendToPeer"
115 #define FIELD_SEND_TO_SELF "sendToSelf"
116 #define FIELD_SHARED_USER_ID_LIST "sharedUserIdList"
117 #define FIELD_SUPPORT_256_MOD "support256mod"
118 #define FIELD_TOKEN "token"
119 #define FIELD_IS_UUID "uuIdAsDeviceId"
120 #define FIELD_VERSION "version"
121 #define FIELD_MK_AGREE_MSG "mkaMsg"
122 #define FIELD_PEER_ID_FROM_REQUEST "peerIdFromRequest"
123 #define FIELD_STEP "step"
124 #define FIELD_DATA "data"
125 #define FIELD_EPK "epk"
126 #define FIELD_AUTH_KEY_ALG_ENCODE "authKeyAlgEncode"
127 #define FIELD_AUTH_PK_INFO "authPkInfo"
128 #define FIELD_AUTH_PK_INFO_SIGN "authPkInfoSign"
129 #define FIELD_AUTH_RESULT_MAC "authResultMac"
130 #define FIELD_LOCAL_DEVICE_TYPE "localDeviceType"
131 #define FIELD_PLUGIN_EXT_DATA "originPeerData"
132 #define FIELD_META_NODE_TYPE "metaNodeType"
133 #define FIELD_UPGRADE_FLAG "upgradeFlag"
134 #define FIELD_COMMON_EVENT_NAME "commonEventName"
135 #define FIELD_COMMON_EVENT_CODE "commonEventCode"
136 #define FIELD_IS_SINGLE_CRED "isSingleCred"
137 #define FIELD_ACCOUNT_PEER_PK "peerPk"
138 #define FIELD_ACCOUNT_SERVICE_ID "serviceId"
139 #define FIELD_ACCOUNT_SHARED_KEY_LEN "sharedKeyLen"
140 #define FIELD_ACCOUNT_SHARED_KEY_VAL "sharedKeyVal"
141 #define FIELD_ACCOUNT_RANDOM_LEN "randomLen"
142 #define FIELD_ACCOUNT_RANDOM_VAL "randomVal"
143 
144 #define INVALID_MODULE_TYPE (-1)
145 #define GROUP_ERR_MSG 0x8080
146 
147 #define CLIENT 1
148 #define SERVER 0
149 
150 #define CREATE_KEY_PAIR 1
151 #define DELETE_KEY_PAIR 2
152 
153 /* DefaultValue */
154 #define DEFAULT_MEMORY_SIZE 64
155 #define DEFAULT_USER_ID_HASH ""
156 #define DEFAULT_REQUEST_ID 0
157 #define DEFAULT_CHANNEL_ID (-1)
158 #define DEFAULT_EXPIRE_TIME 90
159 #define DEFAULT_SERVICE_TYPE "service.type.default"
160 #define SERVICE_TYPE_IMPORT "service.type.import"
161 #define DEFAULT_PACKAGE_NAME "deviceauth_service"
162 #define GROUP_MANAGER_PACKAGE_NAME "com.huawei.devicegroupmanage"
163 #define DM_APP_ID "ohos.distributedhardware.devicemanager"
164 #define SOFTBUS_APP_ID "softbus_auth"
165 #define DEFAULT_RETURN_KEY_LENGTH 32
166 #define MAX_BUFFER_LEN 1024
167 #define MAX_DATA_BUFFER_SIZE 4096
168 #define MAX_AUTH_ID_LEN 256
169 #define MAX_REQUEST_ID_LEN 128
170 
171 #define IS_UPGRADE 1
172 #define IS_NOT_UPGRADE 0
173 
174 #define COMPATIBLE_GROUP 512
175 #define GROUP_TYPE_INVALID (-1)
176 #define INVALID_OS_ACCOUNT (-1)
177 #define ALL_GROUP_VISIBILITY (-2)
178 #define INVALID_CRED 0
179 #define PUBLIC_KEY_MAX_LENGTH 128
180 #define PIN_CODE_LEN_SHORT 6
181 #define PIN_CODE_LEN_LONG 128
182 #define INVALID_PROTOCOL_EXPAND_VALUE (-1)
183 
184 typedef enum {
185     NO_CHANNEL = 1,
186     SERVICE_CHANNEL = 2,
187     SOFT_BUS = 3,
188 } ChannelType;
189 
190 typedef enum {
191     SELF_CREATED = 0,
192     IMPORTED_FROM_CLOUD = 1,
193 } RelationShipSource;
194 
195 #define MAX_IN_PARAM_LEN 4096
196 
197 #define CHECK_PTR_RETURN_NULL(ptr, paramTag) \
198     do { \
199         if ((ptr) == NULL) { \
200             LOGE(paramTag " is null ptr"); \
201             return NULL; \
202         } \
203     } while (0)
204 
205 #define CHECK_PTR_RETURN_ERROR_CODE(ptr, paramTag) \
206     do { \
207         if ((ptr) == NULL) { \
208             LOGE(paramTag " is null ptr"); \
209             return HC_ERR_NULL_PTR; \
210         } \
211     } while (0)
212 
213 #define CHECK_PTR_RETURN_NONE(ptr, paramTag) \
214         do { \
215             if ((ptr) == NULL) { \
216                 LOGE(paramTag " is null ptr"); \
217                 return; \
218             } \
219         } while (0)
220 
221 #define GOTO_IF_ERR(x) do { \
222         int32_t res = x; \
223         if ((res) != HC_SUCCESS) { \
224             goto ERR; \
225         } \
226     } while (0)
227 
228 #define GOTO_IF_CHECK_NULL(ptr, paramTag) \
229     do { \
230         if ((ptr) == NULL) { \
231             LOGE(paramTag " is null ptr"); \
232             goto ERR; \
233         } \
234     } while (0)
235 
236 #define GOTO_ERR_AND_SET_RET(x, res) do { \
237         res = x; \
238         if ((res) != HC_SUCCESS) { \
239             goto ERR; \
240         } \
241     } while (0)
242 
243 #define RETURN_IF_ERR(x) do { \
244         int32_t res = x; \
245         if ((res) != HC_SUCCESS) { \
246             return res; \
247         } \
248     } while (0)
249 
250 typedef enum {
251     ACCOUNT_RELATED_PLUGIN = 0x0010,
252 } EnumCredPluginType;
253 
254 typedef enum {
255     DAS_MODULE = 0x0001,
256     ACCOUNT_MODULE = 0x0010,
257 } EnumModuleType;
258 
259 typedef enum {
260     CONTINUE = 0,
261     IGNORE_MSG = 1,
262     FINISH,
263 } TaskStatus;
264 
265 typedef enum {
266     CODE_NULL = 0,
267     OP_BIND = 1,
268     AUTHENTICATE = 2,
269     ADD_AUTH_INFO = 3,
270     REMOVE_AUTH_INFO = 4,
271     OP_UNBIND = 5,
272     AUTH_KEY_AGREEMENT = 6,
273     REGISTER = 7,
274     SECURE_CLONE = 8,
275 } OperationCode;
276 
277 typedef enum {
278     IMPORT_SELF_CREDENTIAL = 0,
279     DELETE_SELF_CREDENTIAL = 1,
280     QUERY_SELF_CREDENTIAL_INFO = 2,
281     IMPORT_TRUSTED_CREDENTIALS = 3,
282     DELETE_TRUSTED_CREDENTIALS = 4,
283     QUERY_TRUSTED_CREDENTIALS = 5,
284     REQUEST_SIGNATURE = 6,
285     GET_SHARED_SECRET_BY_PEER_CERT = 8,
286     UPGRADE_DATA = 10,
287     CHECK_UPGRADE_IDENTITY = 11,
288     CHECK_UPGRADE_DATA = 12,
289     HANDLE_COMMON_EVENT = 13,
290     RELOAD_CRED_MGR = 14,
291     ACCOUNT_GET_CLIENT_SHARED_KEY = 15,
292     ACCOUNT_GET_SERVER_SHARED_KEY = 16,
293 } CredentialCode;
294 
295 #endif
296