RDK-45037 : Secure Storage Thunder Plugin

Reason for change: Enhancements to PersistentStore plugin to support Scope, Time To Live. Use of the RPC COM and JSON RPC interfaces. Test Procedure: None Risks: None Signed-off-by: Nikita Poltorapavlo <npoltorapavlo@productengine.com>
rdkcentral · Jan 5, 2024 · 4b940f8 · 4b940f8
1 parent f60ceb4
commit 4b940f8
Show file tree

Hide file tree

Showing 4 changed files with 592 additions and 0 deletions.
diff --git a/interfaces/IStore2.h b/interfaces/IStore2.h
@@ -0,0 +1,54 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2022 Metrological
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include "Module.h"
+
+namespace WPEFramework {
+namespace Exchange {
+
+    struct EXTERNAL IStore2 : virtual public Core::IUnknown {
+        enum { ID = ID_STORE2 };
+
+        virtual ~IStore2() override = default;
+
+        enum class ScopeType : uint8_t {
+            DEVICE,
+            ACCOUNT
+        };
+
+        struct EXTERNAL INotification : virtual public Core::IUnknown {
+            enum { ID = ID_STORE2_NOTIFICATION };
+
+            virtual ~INotification() override = default;
+
+            virtual void ValueChanged(const string& ns, const string& key, const string& value, const ScopeType scope) = 0;
+        };
+
+        virtual uint32_t Register(Exchange::IStore2::INotification* notification) = 0;
+        virtual uint32_t Unregister(Exchange::IStore2::INotification* notification) = 0;
+        virtual uint32_t SetValue(const string& ns, const string& key, const string& value, const ScopeType scope, const uint32_t ttl) = 0;
+        virtual uint32_t GetValue(const string& ns, const string& key, const ScopeType scope, string& value /* @out */, uint32_t& ttl /* @out */) = 0;
+        virtual uint32_t DeleteKey(const string& ns, const string& key, const ScopeType scope) = 0;
+        virtual uint32_t DeleteNamespace(const string& ns, const ScopeType scope) = 0;
+    };
+
+} // namespace Exchange
+} // namespace WPEFramework
diff --git a/interfaces/IStoreInspector.h b/interfaces/IStoreInspector.h
@@ -0,0 +1,54 @@
+/*
+ * If not stated otherwise in this file or this component's LICENSE file the
+ * following copyright and licenses apply:
+ *
+ * Copyright 2022 Metrological
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include "Module.h"
+
+// @stubgen:include <com/IIteratorType.h>
+
+namespace WPEFramework {
+namespace Exchange {
+
+    struct EXTERNAL IStoreInspector : virtual public Core::IUnknown {
+        enum { ID = ID_STORE_INSPECTOR };
+
+        virtual ~IStoreInspector() override = default;
+
+        enum class ScopeType : uint8_t {
+            DEVICE,
+            ACCOUNT
+        };
+
+        struct NamespaceSize {
+            string ns;
+            uint32_t size;
+        };
+
+        using INamespaceSizeIterator = RPC::IIteratorType<NamespaceSize, ID_STORE_INSPECTOR_NAMESPACE_SIZE_ITERATOR>;
+
+        virtual uint32_t SetNamespaceLimit(const string& ns, const uint32_t size, const ScopeType scope) = 0;
+        virtual uint32_t GetNamespaceLimit(const string& ns, const ScopeType scope, uint32_t& size /* @out */) = 0;
+        virtual uint32_t GetKeys(const string& ns, const ScopeType scope, RPC::IStringIterator*& keys /* @out */) = 0;
+        virtual uint32_t GetNamespaces(const ScopeType scope, RPC::IStringIterator*& namespaces /* @out */) = 0;
+        virtual uint32_t GetNamespaceSizes(const ScopeType scope, INamespaceSizeIterator*& namespaceSizes /* @out */) = 0;
+    };
+
+} // namespace Exchange
+} // namespace WPEFramework
diff --git a/interfaces/Ids.h b/interfaces/Ids.h
@@ -317,6 +317,10 @@ namespace Exchange {
         ID_STORE                                     = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x440,
         ID_STORE_NOTIFICATION                        = ID_STORE + 1,
         ID_STORE_CACHE                               = ID_STORE + 2,
+        ID_STORE2                                    = ID_STORE + 3,
+        ID_STORE2_NOTIFICATION                       = ID_STORE + 4,
+        ID_STORE_INSPECTOR                           = ID_STORE + 5,
+        ID_STORE_INSPECTOR_NAMESPACE_SIZE_ITERATOR   = ID_STORE + 6,
 
         ID_LISA                                      = RPC::IDS::ID_EXTERNAL_INTERFACE_OFFSET + 0x450,
         ID_LISA_NOTIFICATION                         = ID_LISA + 1,