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 #ifndef STORAGE_DAEMON_CRYPTO_FSCRYPT_KEYV2_H
16 #define STORAGE_DAEMON_CRYPTO_FSCRYPT_KEYV2_H
17 
18 #include "base_key.h"
19 #include "libfscrypt/key_control.h"
20 
21 namespace OHOS {
22 namespace StorageDaemon {
23 // for openharmony kernel 5.10+, prefer using the FSCRYPT_V2.
24 class FscryptKeyV2 final : public BaseKey {
25 public:
26     FscryptKeyV2() = delete;
27     FscryptKeyV2(const std::string &dir, uint8_t keyLen = CRYPTO_AES_256_XTS_KEY_SIZE) : BaseKey(dir, keyLen)
28     {
29         keyInfo_.version = FSCRYPT_V2;
30     }
31     ~FscryptKeyV2() = default;
32 
33     bool ActiveKey(uint32_t flag = 0, const std::string &mnt = MNT_DATA);
34     bool InactiveKey(uint32_t flag = 0, const std::string &mnt = MNT_DATA);
35     bool LockUserScreen(uint32_t flag = 0, uint32_t sdpClass = 0, const std::string &mnt = MNT_DATA);
36     bool UnlockUserScreen(uint32_t flag = 0, uint32_t sdpClass = 0, const std::string &mnt = MNT_DATA);
37     bool AddClassE(bool &isNeedEncryptClassE, bool &isSupport, uint32_t status = 0);
38     bool DeleteClassEPinCode(uint32_t userId = 0);
39     bool ChangePinCodeClassE(bool &isFbeSupport, uint32_t userId = 0);
40     bool DecryptClassE(const UserAuth &auth, bool &isSupport, bool &eBufferStatue, uint32_t user = 0,
41                        bool needSyncCandidate = true);
42     bool EncryptClassE(const UserAuth &auth, bool &isSupport, uint32_t user = 0, uint32_t status = 0);
43     bool GenerateAppkey(uint32_t userId, uint32_t hashId, std::string &keyId);
44     bool DeleteAppkey(const std::string KeyId);
45     bool LockUece(bool &isFbeSupport);
46 };
47 } // namespace StorageDaemon
48 } // namespace OHOS
49 #endif // STORAGE_DAEMON_CRYPTO_FSCRYPT_KEYV2_H
50