• 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 
134 #define INVALID_MODULE_TYPE (-1)
135 #define GROUP_ERR_MSG 0x8080
136 
137 #define CLIENT 1
138 #define SERVER 0
139 
140 #define CREATE_KEY_PAIR 1
141 #define DELETE_KEY_PAIR 2
142 
143 /* DefaultValue */
144 #define DEFAULT_MEMORY_SIZE 64
145 #define DEFAULT_USER_ID_HASH ""
146 #define DEFAULT_REQUEST_ID 0
147 #define DEFAULT_CHANNEL_ID (-1)
148 #define DEFAULT_EXPIRE_TIME 90
149 #define DEFAULT_SERVICE_TYPE "service.type.default"
150 #define SERVICE_TYPE_IMPORT "service.type.import"
151 #define DEFAULT_PACKAGE_NAME "deviceauth_service"
152 #define GROUP_MANAGER_PACKAGE_NAME "com.huawei.devicegroupmanage"
153 #define DM_APP_ID "ohos.distributedhardware.devicemanager"
154 #define SOFTBUS_APP_ID "softbus_auth"
155 #define DEFAULT_RETURN_KEY_LENGTH 32
156 #define MAX_BUFFER_LEN 1024
157 #define MAX_DATA_BUFFER_SIZE 4096
158 #define MAX_AUTH_ID_LEN 256
159 
160 #define COMPATIBLE_GROUP 512
161 #define GROUP_TYPE_INVALID (-1)
162 #define INVALID_OS_ACCOUNT (-1)
163 #define ALL_GROUP_VISIBILITY (-2)
164 #define INVALID_CRED 0
165 #define PUBLIC_KEY_MAX_LENGTH 128
166 #define PIN_CODE_LEN_SHORT 6
167 #define PIN_CODE_LEN_LONG 128
168 #define INVALID_PROTOCOL_EXPAND_VALUE (-1)
169 
170 typedef enum {
171     NO_CHANNEL = 1,
172     SERVICE_CHANNEL = 2,
173     SOFT_BUS = 3,
174 } ChannelType;
175 
176 typedef enum {
177     SELF_CREATED = 0,
178     IMPORTED_FROM_CLOUD = 1,
179 } RelationShipSource;
180 
181 #define MAX_IN_PARAM_LEN 4096
182 
183 #define CHECK_PTR_RETURN_NULL(ptr, paramTag) \
184     do { \
185         if ((ptr) == NULL) { \
186             LOGE(paramTag " is null ptr"); \
187             return NULL; \
188         } \
189     } while (0)
190 
191 #define CHECK_PTR_RETURN_ERROR_CODE(ptr, paramTag) \
192     do { \
193         if ((ptr) == NULL) { \
194             LOGE(paramTag " is null ptr"); \
195             return HC_ERR_NULL_PTR; \
196         } \
197     } while (0)
198 
199 #define CHECK_PTR_RETURN_NONE(ptr, paramTag) \
200         do { \
201             if ((ptr) == NULL) { \
202                 LOGE(paramTag " is null ptr"); \
203                 return; \
204             } \
205         } while (0)
206 
207 #define GOTO_IF_ERR(x) do { \
208         int32_t res = x; \
209         if ((res) != HC_SUCCESS) { \
210             goto ERR; \
211         } \
212     } while (0)
213 
214 #define GOTO_IF_CHECK_NULL(ptr, paramTag) \
215     do { \
216         if ((ptr) == NULL) { \
217             LOGE(paramTag " is null ptr"); \
218             goto ERR; \
219         } \
220     } while (0)
221 
222 #define GOTO_ERR_AND_SET_RET(x, res) do { \
223         res = x; \
224         if ((res) != HC_SUCCESS) { \
225             goto ERR; \
226         } \
227     } while (0)
228 
229 #define RETURN_IF_ERR(x) do { \
230         int32_t res = x; \
231         if ((res) != HC_SUCCESS) { \
232             return res; \
233         } \
234     } while (0)
235 
236 typedef enum {
237     ACCOUNT_RELATED_PLUGIN = 0x0010,
238 } EnumCredPluginType;
239 
240 typedef enum {
241     DAS_MODULE = 0x0001,
242     ACCOUNT_MODULE = 0x0010,
243 } EnumModuleType;
244 
245 typedef enum {
246     CONTINUE = 0,
247     IGNORE_MSG = 1,
248     FINISH,
249 } TaskStatus;
250 
251 typedef enum {
252     CODE_NULL = 0,
253     OP_BIND = 1,
254     AUTHENTICATE = 2,
255     ADD_AUTH_INFO = 3,
256     REMOVE_AUTH_INFO = 4,
257     OP_UNBIND = 5,
258     AUTH_KEY_AGREEMENT = 6,
259     REGISTER = 7,
260     SECURE_CLONE = 8,
261 } OperationCode;
262 
263 typedef enum {
264     IMPORT_SELF_CREDENTIAL = 0,
265     DELETE_SELF_CREDENTIAL = 1,
266     QUERY_SELF_CREDENTIAL_INFO = 2,
267     IMPORT_TRUSTED_CREDENTIALS = 3,
268     DELETE_TRUSTED_CREDENTIALS = 4,
269     QUERY_TRUSTED_CREDENTIALS = 5,
270     REQUEST_SIGNATURE = 6,
271     GET_SHARED_SECRET_BY_PEER_CERT = 8,
272 } CredentialCode;
273 
274 #endif
275