1 /*
2  * Copyright (c) 2022 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_CONTEXT_CALLBACK_H
17 #define IAM_CONTEXT_CALLBACK_H
18 
19 #include <cstdint>
20 #include <chrono>
21 #include <functional>
22 #include <memory>
23 #include <optional>
24 #include <vector>
25 
26 #include "context.h"
27 #include "iam_defines.h"
28 #include "iam_callback_interface.h"
29 #include "user_auth_common_defines.h"
30 
31 namespace OHOS {
32 namespace UserIam {
33 namespace UserAuth {
34 class ContextCallbackNotifyListener {
35 public:
36     struct MetaData {
37         OperationType operationType;
38         int32_t operationResult = -1;
39         std::optional<int32_t> userId;
40         std::optional<int32_t> remainTime;
41         std::optional<int32_t> freezingTime;
42         std::optional<int32_t> sdkVersion;
43         std::optional<uint64_t> requestContextId;
44         std::optional<uint64_t> authContextId;
45         std::optional<AuthTrustLevel> atl;
46         std::optional<int32_t> authType;
47         std::optional<uint32_t> authWidgetType;
48         std::optional<std::string> callerName;
49         std::optional<int32_t> callerType;
50         std::chrono::time_point<std::chrono::steady_clock> startTime;
51         std::chrono::time_point<std::chrono::steady_clock> endTime;
52         std::optional<uint32_t> reuseUnlockResultMode;
53         std::optional<uint64_t> reuseUnlockResultDuration;
54         std::optional<bool> isRemoteAuth;
55         std::optional<std::string> remoteUdid;
56         std::optional<std::string> localUdid;
57         std::optional<std::string> connectionName;
58         std::optional<std::string> authFinishReason;
59         std::optional<bool> isBackgroundApplication;
60     };
61     using Notify = std::function<void(const MetaData &metaData, TraceFlag flag)>;
62     static ContextCallbackNotifyListener &GetInstance();
63     void AddNotifier(const Notify &notify);
64     void Process(const MetaData &metaData, TraceFlag flag);
65 
66 private:
67     std::vector<Notify> notifierList_;
68 };
69 
70 class ContextCallback {
71 public:
72     static std::shared_ptr<ContextCallback> NewInstance(sptr<IamCallbackInterface> iamCallback,
73         OperationType operationType);
74     static std::shared_ptr<ContextCallback> NewDummyInstance(OperationType operationType);
75     virtual ~ContextCallback() = default;
76     virtual void OnResult(int32_t resultCode, const Attributes &finalResult) = 0;
77     virtual void OnAcquireInfo(ExecutorRole src, int32_t moduleType, const std::vector<uint8_t> &acquireMsg) = 0;
78     virtual void SetTraceCallerName(const std::string &callerName) = 0;
79     virtual void SetTraceRequestContextId(uint64_t requestContextId) = 0;
80     virtual void SetTraceAuthContextId(uint64_t authContextId) = 0;
81     virtual void SetTraceUserId(int32_t userId) = 0;
82     virtual void SetTraceRemainTime(int32_t remainTime) = 0;
83     virtual void SetTraceFreezingTime(int32_t freezingTime) = 0;
84     virtual void SetTraceSdkVersion(int32_t version) = 0;
85     virtual void SetTraceAuthType(int32_t authType) = 0;
86     virtual void SetTraceAuthWidgetType(uint32_t authWidgetType) = 0;
87     virtual void SetTraceAuthTrustLevel(AuthTrustLevel atl) = 0;
88     virtual void SetTraceReuseUnlockResultMode(uint32_t reuseUnlockResultMode) = 0;
89     virtual void SetTraceReuseUnlockResultDuration(uint64_t reuseUnlockResultDuration) = 0;
90     virtual void SetCleaner(Context::ContextStopCallback callback) = 0;
91     virtual void SetTraceCallerType(int32_t callerType) = 0;
92     virtual void SetTraceIsRemoteAuth(bool isRemoteAuth) = 0;
93     virtual void SetTraceLocalUdid(const std::string &localUdid) = 0;
94     virtual void SetTraceRemoteUdid(const std::string &remoteUdid) = 0;
95     virtual void SetTraceConnectionName(const std::string &connectionName) = 0;
96     virtual void SetTraceAuthFinishReason(const std::string &authFinishReason) = 0;
97     virtual void SetTraceIsBackgroundApplication(bool isBackgroundApplication) = 0;
98     virtual void ProcessAuthResult(int32_t tip, const std::vector<uint8_t> &extraInfo) = 0;
99     virtual sptr<IamCallbackInterface> GetIamCallback() = 0;
100     virtual std::string GetCallerName() = 0;
101 };
102 } // namespace UserAuth
103 } // namespace UserIam
104 } // namespace OHOS
105 #endif // IAM_CONTEXT_CALLBACK_H