Introduce KeyStore Persistence Manager and KeyStore Registry Persistence Manager implementations

core/org.wso2.carbon.core/pom.xml

@@ -225,10 +225,11 @@
                         <Bundle-SymbolicName>org.wso2.carbon.core</Bundle-SymbolicName>
                         <Bundle-Activator>org.wso2.carbon.core.internal.CarbonCoreActivator</Bundle-Activator>
                         <Private-Package>
-                            org.wso2.carbon.core.internal, org.wso2.carbon.core.encryption
+                            org.wso2.carbon.core.internal, org.wso2.carbon.core.encryption, org.wso2.carbon.core.keystore.persistence
                         </Private-Package>
                         <Export-Package>
                             !org.wso2.carbon.core.internal,
+                            !org.wso2.carbon.core.keystore.persistence,
                             org.wso2.carbon.core.*; version="${carbon.kernel.exp.pkg.version}",
                         </Export-Package>
                         <Import-Package>

core/org.wso2.carbon.core/src/main/java/org/wso2/carbon/core/keystore/persistence/KeyStorePersistenceManager.java

@@ -0,0 +1,110 @@
+/*
+ * Copyright (c) 2024, WSO2 LLC. (http://www.wso2.com).
+ *
+ * WSO2 LLC. licenses this file to you 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.
+ */
+
+package org.wso2.carbon.core.keystore.persistence;
+
+import org.wso2.carbon.core.security.KeyStoreMetadata;
+
+import java.security.KeyStore;
+import java.util.Date;
+import java.util.List;
+
+/**
+ * This interface supports the persistence/storage related logics of key stores.
+ */
+public interface KeyStorePersistenceManager {
+
+    /**
+     * Add the key store to the data storage.
+     *
+     * @param keyStoreName           Name of the key store.
+     * @param keystoreContent        Content of the key store.
+     * @param provider               Provider of the key store.
+     * @param keyStorePasswordChar   Key Store Password as a character string.
+     * @param privateKeyPasswordChar Private key password as a character string.
+     * @param tenantId               Tenant ID.
+     * @throws SecurityException If an error occurs while adding the key store.
+     */
+    void addKeystore(String keyStoreName, byte[] keystoreContent, String provider, String type,
+                     char[] keyStorePasswordChar, char[] privateKeyPasswordChar, int tenantId);
+
+    /**
+     * Get the key store from the data storage.
+     *
+     * @param keyStoreName Name of the key store.
+     * @param tenantId     Tenant Id.
+     * @return Key store.
+     * @throws SecurityException If an error occurs while getting the key store.
+     */
+    KeyStore getKeyStore(String keyStoreName, int tenantId) throws SecurityException;
+
+    /**
+     * Method to retrieve list of keystore metadata of all the keystores in a tenant.
+     *
+     * @param tenantId tenantId.
+     * @return List of KeyStoreMetaData objects.
+     * @throws SecurityException If an error occurs while retrieving the keystore data.
+     */
+    List<KeyStoreMetadata> listKeyStores(int tenantId) throws SecurityException;
+
+    /**
+     * Update the key store in the data storage.
+     *
+     * @param keyStoreName Key store name.
+     * @param keyStore     Updated key store.
+     * @param tenantId     Tenant Id.
+     */
+    void updateKeyStore(String keyStoreName, KeyStore keyStore, int tenantId);
+
+    /**
+     * Delete the key store from the data storage.
+     *
+     * @param keyStoreName Name of the key store.
+     * @param tenantId     Tenant Id.
+     * @throws SecurityException If an error occurs while deleting the key store.
+     */
+    void deleteKeyStore(String keyStoreName, int tenantId) throws SecurityException;
+
+    /**
+     * Get the last modified date of the key store.
+     *
+     * @param keyStoreName Key store name.
+     * @return Last modified date of the key store.
+     */
+    Date getKeyStoreLastModifiedDate(String keyStoreName, int tenantId);
+
+    /**
+     * Get the password as a character array for the given key store name.
+     *
+     * @param keyStoreName key store name.
+     * @param tenantId     Tenant Id.
+     * @return KeyStore Password as a character array.
+     * @throws SecurityException If there is an error while getting the key store password.
+     */
+    char[] getKeyStorePassword(String keyStoreName, int tenantId) throws SecurityException;
+
+    /**
+     * Get the private key password as a character array for the given key store name.
+     *
+     * @param keyStoreName Key store name.
+     * @param tenantId     Tenant Id.
+     * @return Private key password as a character array.
+     * @throws SecurityException If an error occurs while getting the private key password.
+     */
+    char[] getPrivateKeyPassword(String keyStoreName, int tenantId) throws SecurityException;
+}