secapi-sys 0.3.0

/*
 * Copyright 2020-2023 Comcast Cable Communications Management, LLC
 *
 * 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.
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#include "client_test_helpers.h"
#include "sa.h"
#include "sa_key_common.h"
#include "gtest/gtest.h"

using namespace client_test_helpers;

namespace {
    TEST_P(SaKeyExportTest, nominal) {
        auto key_type = std::get<0>(GetParam());
        auto key_length = std::get<1>(GetParam());

        sa_rights rights;
        sa_rights_set_allow_all(&rights);

        sa_status status;
        std::vector<uint8_t> clear_key;
        sa_elliptic_curve curve;
        auto key = create_sa_key(key_type, key_length, clear_key, curve);
        ASSERT_NE(key, nullptr);
        if (*key == UNSUPPORTED_KEY)
            GTEST_SKIP() << "key type, key size, or curve not supported";

        size_t exported_key_length = 0;
        status = sa_key_export(nullptr, &exported_key_length, nullptr, 0, *key);
        ASSERT_EQ(status, SA_STATUS_OK);
        ASSERT_TRUE(exported_key_length > sizeof(sa_header));

        auto exported_key = std::vector<uint8_t>(exported_key_length);
        status = sa_key_export(exported_key.data(), &exported_key_length, nullptr, 0, *key);
        ASSERT_EQ(status, SA_STATUS_OK);

        // Reimport key and test.
        auto reimported_key = create_uninitialized_sa_key();
        ASSERT_NE(reimported_key, nullptr);
        status = sa_key_import(reimported_key.get(), SA_KEY_FORMAT_EXPORTED, exported_key.data(), exported_key.size(),
                nullptr);
        ASSERT_EQ(status, SA_STATUS_OK);

        sa_type_parameters type_parameters;
        memset(&type_parameters, 0, sizeof(sa_type_parameters));
        if (key_type == SA_KEY_TYPE_DH) {
            auto dh_parameters = get_dh_parameters(key_length);
            memcpy(type_parameters.dh_parameters.p, std::get<0>(dh_parameters).data(),
                    std::get<0>(dh_parameters).size());
            type_parameters.dh_parameters.p_length = std::get<0>(dh_parameters).size();
            memcpy(type_parameters.dh_parameters.g, std::get<1>(dh_parameters).data(),
                    std::get<1>(dh_parameters).size());
            type_parameters.dh_parameters.g_length = std::get<1>(dh_parameters).size();
        } else if (key_type == SA_KEY_TYPE_EC) {
            type_parameters.curve = curve;
        }

        auto exported_key_header = key_header(*reimported_key);
        ASSERT_NE(nullptr, exported_key_header.get());
        ASSERT_TRUE(memcmp(&rights, &exported_key_header->rights, sizeof(sa_rights)) == 0);
        ASSERT_EQ(key_length, exported_key_header->size);
        ASSERT_EQ(memcmp(&type_parameters, &exported_key_header->type_parameters, sizeof(sa_type_parameters)), 0);
        ASSERT_EQ(key_type, exported_key_header->type);
        ASSERT_TRUE(key_check(key_type, *reimported_key, clear_key));
    }

    TEST_P(SaKeyExportTest, nominalWithMixin) {
        auto key_type = std::get<0>(GetParam());
        auto key_length = std::get<1>(GetParam());

        sa_rights rights;
        sa_rights_set_allow_all(&rights);

        sa_status status;
        std::vector<uint8_t> clear_key;
        sa_elliptic_curve curve;
        auto key = create_sa_key(key_type, key_length, clear_key, curve);
        ASSERT_NE(key, nullptr);
        if (*key == UNSUPPORTED_KEY)
            GTEST_SKIP() << "key type, key size, or curve not supported";

        auto mixin = random(AES_BLOCK_SIZE);
        size_t exported_key_length = 0;
        status = sa_key_export(nullptr, &exported_key_length, mixin.data(), mixin.size(), *key);
        ASSERT_EQ(status, SA_STATUS_OK);
        ASSERT_TRUE(exported_key_length > sizeof(sa_header));

        auto exported_key = std::vector<uint8_t>(exported_key_length);
        status = sa_key_export(exported_key.data(), &exported_key_length, mixin.data(), mixin.size(), *key);
        ASSERT_EQ(status, SA_STATUS_OK);

        // Reimport key and test.
        auto reimported_key = create_uninitialized_sa_key();
        ASSERT_NE(reimported_key, nullptr);

        status = sa_key_import(reimported_key.get(), SA_KEY_FORMAT_EXPORTED, exported_key.data(), exported_key.size(),
                nullptr);
        ASSERT_EQ(status, SA_STATUS_OK);

        sa_type_parameters type_parameters;
        memset(&type_parameters, 0, sizeof(sa_type_parameters));
        if (key_type == SA_KEY_TYPE_DH) {
            auto dh_parameters = get_dh_parameters(key_length);
            memcpy(type_parameters.dh_parameters.p, std::get<0>(dh_parameters).data(),
                    std::get<0>(dh_parameters).size());
            type_parameters.dh_parameters.p_length = std::get<0>(dh_parameters).size();
            memcpy(type_parameters.dh_parameters.g, std::get<1>(dh_parameters).data(),
                    std::get<1>(dh_parameters).size());
            type_parameters.dh_parameters.g_length = std::get<1>(dh_parameters).size();
        } else if (key_type == SA_KEY_TYPE_EC) {
            type_parameters.curve = curve;
        }

        auto exported_key_header = key_header(*reimported_key);
        ASSERT_NE(nullptr, exported_key_header.get());
        ASSERT_TRUE(memcmp(&rights, &exported_key_header->rights, sizeof(sa_rights)) == 0);
        ASSERT_EQ(key_length, exported_key_header->size);
        ASSERT_EQ(memcmp(&type_parameters, &exported_key_header->type_parameters, sizeof(sa_type_parameters)), 0);
        ASSERT_EQ(key_type, exported_key_header->type);
        ASSERT_TRUE(key_check(key_type, *reimported_key, clear_key));
    }

    TEST_F(SaKeyExportTest, failsNoCacheableFlag) {
        auto clear_key = random(SYM_128_KEY_SIZE);

        sa_rights rights;
        sa_rights_set_allow_all(&rights);
        SA_USAGE_BIT_CLEAR(rights.usage_flags, SA_USAGE_FLAG_CACHEABLE);

        auto key = create_sa_key_symmetric(&rights, clear_key);
        ASSERT_NE(key, nullptr);

        size_t out_length = 0;
        sa_status const status = sa_key_export(nullptr, &out_length, nullptr, 0, *key);
        ASSERT_EQ(status, SA_STATUS_OPERATION_NOT_ALLOWED);
    }

    TEST_F(SaKeyExportTest, failsNullOutLength) {
        auto clear_key = random(SYM_128_KEY_SIZE);

        sa_rights rights;
        sa_rights_set_allow_all(&rights);

        auto key = create_sa_key_symmetric(&rights, clear_key);
        ASSERT_NE(key, nullptr);

        auto out = std::vector<uint8_t>(4096);
        sa_status const status = sa_key_export(out.data(), nullptr, nullptr, 0, *key);
        ASSERT_EQ(status, SA_STATUS_NULL_PARAMETER);
    }

    TEST_F(SaKeyExportTest, failsInvalidMixinLength) {
        auto clear_key = random(SYM_128_KEY_SIZE);

        sa_rights rights;
        sa_rights_set_allow_all(&rights);

        auto key = create_sa_key_symmetric(&rights, clear_key);
        ASSERT_NE(key, nullptr);

        auto mixin = random(17);
        auto out = std::vector<uint8_t>(4096);
        size_t out_length = out.size();
        sa_status const status = sa_key_export(out.data(), &out_length, mixin.data(), mixin.size(), *key);
        ASSERT_EQ(status, SA_STATUS_INVALID_PARAMETER);
    }

    TEST_F(SaKeyExportTest, failsInvalidKey) {
        size_t out_length = 0;
        sa_status const status = sa_key_export(nullptr, &out_length, nullptr, 0, INVALID_HANDLE);
        ASSERT_EQ(status, SA_STATUS_INVALID_PARAMETER);
    }
} // namespace