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 IAM_AUTHENTICATION_H 17 #define IAM_AUTHENTICATION_H 18 19 #include <cstdint> 20 #include <memory> 21 22 #include "schedule_node.h" 23 24 namespace OHOS { 25 namespace UserIam { 26 namespace UserAuth { 27 class Authentication { 28 public: 29 struct AuthenticationPara { 30 int32_t userId {0}; 31 AuthType authType {ALL}; 32 AuthTrustLevel atl {ATL1}; 33 uint32_t tokenId {0}; 34 uint32_t collectorTokenId {0}; 35 std::vector<uint8_t> challenge; 36 bool endAfterFirstFail; 37 std::string callerName; 38 int32_t sdkVersion; 39 int32_t callerType; 40 int32_t authIntent; 41 bool isOsAccountVerified; 42 }; 43 44 struct AuthResultInfo { 45 int32_t result; 46 int32_t freezingTime; 47 int32_t remainTimes; 48 std::vector<uint8_t> token; 49 std::vector<uint8_t> rootSecret; 50 uint64_t credentialDigest{0}; 51 uint16_t credentialCount{0}; 52 int32_t sdkVersion{0}; 53 int32_t userId; 54 int32_t nextFailLockoutDuration; 55 int64_t pinExpiredInfo; 56 std::vector<uint8_t> remoteAuthResultMsg; 57 uint64_t credentialId; 58 }; 59 struct AuthExecutorMsg { 60 uint64_t executorIndex; 61 int32_t commandId; 62 std::vector<uint8_t> msg; 63 }; 64 virtual ~Authentication() = default; 65 66 virtual void SetExecutor(uint32_t executorIndex) = 0; 67 virtual void SetChallenge(const std::vector<uint8_t> &challenge) = 0; 68 virtual void SetAccessTokenId(uint32_t tokenId) = 0; 69 virtual void SetEndAfterFirstFail(bool endAfterFirstFail) = 0; 70 virtual void SetCollectorUdid(std::string &collectorUdid) = 0; 71 72 virtual bool Start(std::vector<std::shared_ptr<ScheduleNode>> &scheduleList, 73 std::shared_ptr<ScheduleNodeCallback> callback) = 0; 74 virtual bool Update(const std::vector<uint8_t> &scheduleResult, AuthResultInfo &resultInfo) = 0; 75 virtual std::vector<Authentication::AuthExecutorMsg> GetAuthExecutorMsgs() const = 0; 76 virtual bool Cancel() = 0; 77 virtual uint32_t GetAccessTokenId() const = 0; 78 virtual int32_t GetLatestError() const = 0; 79 virtual int32_t GetUserId() const = 0; 80 virtual int32_t GetAuthType() const = 0; 81 82 protected: 83 virtual void SetLatestError(int32_t error) = 0; 84 }; 85 } // namespace UserAuth 86 } // namespace UserIam 87 } // namespace OHOS 88 #endif // IAM_AUTHENTICATION_H