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