1 /* 2 * Copyright (c) 2022-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 IAM_ENROLLMENT_H 17 #define IAM_ENROLLMENT_H 18 19 #include <cstdint> 20 #include <memory> 21 #include <optional> 22 23 #include "credential_info_interface.h" 24 #include "schedule_node.h" 25 26 namespace OHOS { 27 namespace UserIam { 28 namespace UserAuth { 29 class Enrollment { 30 public: 31 struct EnrollmentPara { 32 int32_t userId {0}; 33 AuthType authType {ALL}; 34 PinSubType pinType {PIN_SIX}; 35 bool isUpdate {false}; 36 uint32_t tokenId {0}; 37 std::vector<uint8_t> token; 38 std::string callerName; 39 int32_t sdkVersion; 40 }; 41 42 virtual ~Enrollment() = default; 43 44 virtual void SetExecutorSensorHint(uint32_t executorSensorHint) = 0; 45 virtual void SetAuthToken(const std::vector<uint8_t> &authToken) = 0; 46 virtual void SetAccessTokenId(uint32_t tokenId) = 0; 47 virtual void SetPinSubType(PinSubType pinSubType) = 0; 48 virtual void SetIsUpdate(bool isUpdate) = 0; 49 virtual bool Start(std::vector<std::shared_ptr<ScheduleNode>> &scheduleList, 50 std::shared_ptr<ScheduleNodeCallback> callback) = 0; 51 virtual bool Update(const std::vector<uint8_t> &scheduleResult, uint64_t &credentialId, 52 std::shared_ptr<CredentialInfoInterface> &info, std::vector<uint8_t> &rootSecret, 53 std::optional<uint64_t> &secUserId) = 0; 54 virtual bool Cancel() = 0; 55 virtual uint32_t GetAccessTokenId() const = 0; 56 virtual int32_t GetLatestError() const = 0; 57 58 protected: 59 virtual void SetLatestError(int32_t error) = 0; 60 }; 61 } // namespace UserAuth 62 } // namespace UserIam 63 } // namespace OHOS 64 #endif // IAM_ENROLLMENT_H