Add a new PSA Internal Trusted Storage APIs

Author: danny4478

TESTS/psa/prot_internal_storage/its_reset/COMPONENT_PSA_SRV_EMUL/test_pits.c

@@ -0,0 +1,22 @@
+/* Copyright (c) 2018 ARM Limited
+ *
+ * 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.
+ */
+
+#include "test_pits.h"
+#include "test_pits_impl.h"
+
+psa_its_status_t test_psa_its_reset(void)
+{
+    return test_psa_its_reset_impl();
+}

TESTS/psa/prot_internal_storage/its_reset/COMPONENT_PSA_SRV_IMPL/test_pits_impl.cpp

@@ -0,0 +1,57 @@
+/* Copyright (c) 2018 ARM Limited
+ *
+ * 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.
+ */
+#include <string.h>
+#include <stdlib.h>
+#include "psa_prot_internal_storage.h"
+#include "test_pits_impl.h"
+#include "kv_config.h"
+#include "KVMap.h"
+#include "KVStore.h"
+#include "mbed_error.h"
+
+#ifdef   __cplusplus
+extern "C"
+{
+#endif
+
+using namespace mbed;
+
+#define STR_EXPAND(tok)     #tok
+
+psa_its_status_t test_psa_its_reset_impl(void)
+{
+    psa_its_status_t status = PSA_ITS_SUCCESS;
+
+    int kv_status = kv_init_storage_config();
+    if(kv_status != MBED_SUCCESS) {
+        return PSA_ITS_ERROR_STORAGE_FAILURE;
+    }
+
+    KVMap &kv_map = KVMap::get_instance();
+    KVStore *kvstore = kv_map.get_main_kv_instance(STR_EXPAND(MBED_CONF_STORAGE_DEFAULT_KV));
+    if (!kvstore) {
+        return PSA_ITS_ERROR_STORAGE_FAILURE;
+    }
+
+    if (kvstore->reset() != MBED_SUCCESS) {
+        status = PSA_ITS_ERROR_STORAGE_FAILURE;
+    }
+
+    return status;
+}
+
+#ifdef   __cplusplus
+}
+#endif

TESTS/psa/prot_internal_storage/its_reset/COMPONENT_PSA_SRV_IMPL/test_pits_impl.h

@@ -0,0 +1,32 @@
+/* Copyright (c) 2018 ARM Limited
+ *
+ * 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.
+ */
+
+#ifndef __PITS_IMPL_H__
+#define __PITS_IMPL_H__
+
+#include "psa_prot_internal_storage.h"
+
+#ifdef   __cplusplus
+extern "C"
+{
+#endif
+
+psa_its_status_t test_psa_its_reset_impl(void);
+
+#ifdef   __cplusplus
+}
+#endif
+
+#endif // __PITS_IMPL_H__

TESTS/psa/prot_internal_storage/its_reset/test_pits.h

@@ -0,0 +1,48 @@
+/* Copyright (c) 2018 ARM Limited
+ *
+ * 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.
+ */
+
+#ifndef __TEST_INTERNAL_TRUSTED_STORAGE_H__
+#define __TEST_INTERNAL_TRUSTED_STORAGE_H__
+
+/** @file
+@brief This file describes the PSA Internal Trusted Storage API
+*/
+
+#include <stddef.h>
+#include <stdint.h>
+#include "psa_prot_internal_storage.h"
+
+#ifdef   __cplusplus
+extern "C"
+{
+#endif
+
+/**
+ * \brief Remove the provided key and its associated data from the storage
+ *
+ * \param[in] uid   The uid value
+ *
+ * \return  A status indicating the success/failure of the operation
+ *
+ * \retval      PSA_ITS_SUCCESS                  The operation completed successfully
+ * \retval      PSA_ITS_ERROR_STORAGE_FAILURE    The operation failed because the physical storage has failed (Fatal error)
+ */
+psa_its_status_t test_psa_its_reset(void);
+
+#ifdef   __cplusplus
+}
+#endif
+
+#endif // __TEST_INTERNAL_TRUSTED_STORAGE_H__

TESTS/psa/prot_internal_storage/main.cpp

@@ -0,0 +1,134 @@
+/*
+* Copyright (c) 2018 ARM Limited. All rights reserved.
+* SPDX-License-Identifier: Apache-2.0
+* 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.
+*/
+
+#ifndef TARGET_PSA
+#error [NOT_SUPPORTED] ITS tests can run only on PSA-enabled targets.
+#endif // TARGET_PSA
+
+#include "greentea-client/test_env.h"
+#include "unity/unity.h"
+#include "utest/utest.h"
+#include "psa_prot_internal_storage.h"
+#include "test_pits.h"
+
+using namespace utest::v1;
+
+#define TEST_BUFF_SIZE 16
+
+static void pits_test()
+{
+    psa_its_status_t status = PSA_ITS_SUCCESS;
+    uint8_t write_buff[TEST_BUFF_SIZE] = {0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0A, 0x0B, 0x0C, 0x0D, 0x0E, 0x0F};
+    uint8_t read_buff[TEST_BUFF_SIZE] = {0};
+    struct psa_its_info_t info = {0, PSA_ITS_WRITE_ONCE_FLAG};
+    memset(read_buff, 0, TEST_BUFF_SIZE);
+
+    status = psa_its_get_info(5, &info);
+    TEST_ASSERT_EQUAL(PSA_ITS_ERROR_KEY_NOT_FOUND, status);
+
+    status = psa_its_set(5, TEST_BUFF_SIZE, write_buff, 0);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+
+    status = psa_its_get_info(5, &info);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+    TEST_ASSERT_EQUAL(TEST_BUFF_SIZE, info.size);
+    TEST_ASSERT_EQUAL(0, info.flags);
+
+    status = psa_its_get(5, 0, TEST_BUFF_SIZE, read_buff);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+    TEST_ASSERT_EQUAL_MEMORY(write_buff, read_buff, TEST_BUFF_SIZE);
+
+    memset(read_buff, 0, TEST_BUFF_SIZE);
+    status = psa_its_get(5, 1, TEST_BUFF_SIZE, read_buff);
+    TEST_ASSERT_NOT_EQUAL(PSA_ITS_SUCCESS, status);
+
+    status = psa_its_get(5, 1, TEST_BUFF_SIZE - 1, read_buff);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+    TEST_ASSERT_EQUAL_MEMORY(write_buff + 1, read_buff, TEST_BUFF_SIZE - 1);
+
+    status = psa_its_remove(5);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+
+    status = psa_its_get_info(5, &info);
+    TEST_ASSERT_EQUAL(PSA_ITS_ERROR_KEY_NOT_FOUND, status);
+}
+
+static void pits_write_once_test()
+{
+    psa_its_status_t status = PSA_ITS_SUCCESS;
+    uint8_t write_buff[TEST_BUFF_SIZE] = {0x0F, 0x0E, 0x0D, 0x0C, 0x0B, 0x0A, 0x09, 0x08, 0x07, 0x06, 0x05, 0x04, 0x03, 0x02, 0x01, 0x00};
+    uint8_t read_buff[TEST_BUFF_SIZE] = {0};
+    struct psa_its_info_t info = {0, 0};
+
+    status = test_psa_its_reset();
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+
+    status = psa_its_get_info(5, &info);
+    TEST_ASSERT_EQUAL(PSA_ITS_ERROR_KEY_NOT_FOUND, status);
+
+    status = psa_its_set(5, TEST_BUFF_SIZE, write_buff, PSA_ITS_WRITE_ONCE_FLAG);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+
+    info.size = 0;
+    info.flags = 0;
+    status = psa_its_get_info(5, &info);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+    TEST_ASSERT_EQUAL(TEST_BUFF_SIZE, info.size);
+    TEST_ASSERT_EQUAL(PSA_ITS_WRITE_ONCE_FLAG, info.flags);
+
+    status = psa_its_get(5, 0, TEST_BUFF_SIZE, read_buff);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+    TEST_ASSERT_EQUAL_MEMORY(write_buff, read_buff, TEST_BUFF_SIZE);
+
+    status = psa_its_set(5, TEST_BUFF_SIZE, write_buff, PSA_ITS_WRITE_ONCE_FLAG);
+    TEST_ASSERT_NOT_EQUAL(PSA_ITS_SUCCESS, status);
+
+    status = psa_its_set(5, TEST_BUFF_SIZE, write_buff, 0);
+    TEST_ASSERT_NOT_EQUAL(PSA_ITS_SUCCESS, status);
+
+    status = psa_its_remove(5);
+    TEST_ASSERT_NOT_EQUAL(PSA_ITS_SUCCESS, status);
+
+    info.size = 0;
+    info.flags = 0;
+    status = psa_its_get_info(5, &info);
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+    TEST_ASSERT_EQUAL(TEST_BUFF_SIZE, info.size);
+    TEST_ASSERT_EQUAL(PSA_ITS_WRITE_ONCE_FLAG, info.flags);
+
+    status = test_psa_its_reset();
+    TEST_ASSERT_EQUAL(PSA_ITS_SUCCESS, status);
+}
+
+Case cases[] = {
+    Case("PSA prot internal storage - Basic",  pits_test),
+    Case("PSA prot internal storage - Write-once",  pits_write_once_test),
+};
+
+utest::v1::status_t greentea_test_setup(const size_t number_of_cases)
+{
+#ifndef NO_GREENTEA
+    GREENTEA_SETUP(60, "default_auto");
+#endif
+    return greentea_test_setup_handler(number_of_cases);
+}
+
+Specification specification(greentea_test_setup, cases, greentea_test_teardown_handler);
+
+int main()
+{
+    return !Harness::run(specification);
+}

components/TARGET_PSA/services/psa_prot_internal_storage/COMPONENT_PSA_SRV_EMUL/psa_prot_internal_storage.cpp

@@ -0,0 +1,91 @@
+/* Copyright (c) 2018 ARM Limited
+ *
+ * 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.
+ */
+
+#include <stdlib.h>
+#include <string.h>
+
+#include "psa_prot_internal_storage.h"
+#include "pits_impl.h"
+#include "kv_config.h"
+#include "mbed_error.h"
+
+#define PSA_ITS_EMUL_PID        1   // In EMUL world, there is no real partitioning, which makes the source partition irrelevant.
+                                    // So here we set a global pid value to be used for when calling IMPL functions
+
+psa_its_status_t psa_its_set(uint32_t uid, uint32_t data_length, const void *p_data, psa_its_create_flags_t create_flags)
+{
+    if (!p_data && data_length) {
+        return PSA_ITS_ERROR_BAD_POINTER;
+    }
+
+    // KVStore initiation:
+    // - In EMUL (non-secure single core) we do it here since we don't have another context to do it inside.
+    // - Repeating calls has no effect
+    int kv_status = kv_init_storage_config();
+    if(kv_status != MBED_SUCCESS) {
+        return PSA_ITS_ERROR_STORAGE_FAILURE;
+    }
+
+    psa_its_status_t res = psa_its_set_impl(PSA_ITS_EMUL_PID, uid, data_length, p_data, create_flags);
+
+    return res;
+}
+
+psa_its_status_t psa_its_get(uint32_t uid, uint32_t data_offset, uint32_t data_length, void *p_data)
+{
+    if (!p_data && data_length) {
+        return PSA_ITS_ERROR_BAD_POINTER;
+    }
+
+    // KVStore initiation:
+    // - In EMUL (non-secure single core) we do it here since we don't have another context to do it inside.
+    // - Repeating calls has no effect
+    int kv_status = kv_init_storage_config();
+    if(kv_status != MBED_SUCCESS) {
+        return PSA_ITS_ERROR_STORAGE_FAILURE;
+    }
+
+    return psa_its_get_impl(PSA_ITS_EMUL_PID, uid, data_offset, data_length, p_data);
+}
+
+psa_its_status_t psa_its_get_info(uint32_t uid, struct psa_its_info_t *p_info)
+{
+    if (!p_info) {
+        return PSA_ITS_ERROR_BAD_POINTER;
+    }
+
+    // KVStore initiation:
+    // - In EMUL (non-secure single core) we do it here since we don't have another context to do it inside.
+    // - Repeating calls has no effect
+    int kv_status = kv_init_storage_config();
+    if(kv_status != MBED_SUCCESS) {
+        return PSA_ITS_ERROR_STORAGE_FAILURE;
+    }
+
+    return psa_its_get_info_impl(PSA_ITS_EMUL_PID, uid, p_info);
+}
+
+psa_its_status_t psa_its_remove(uint32_t uid)
+{
+    // KVStore initiation:
+    // - In EMUL (non-secure single core) we do it here since we don't have another context to do it inside.
+    // - Repeating calls has no effect
+    int kv_status = kv_init_storage_config();
+    if(kv_status != MBED_SUCCESS) {
+        return PSA_ITS_ERROR_STORAGE_FAILURE;
+    }
+
+    return psa_its_remove_impl(PSA_ITS_EMUL_PID, uid);
+}