asymmetric_key.hpp

/*
 * Copyright (c) 2024 The RefValue Project
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
 
#pragma once
 
#include "../abi/string.hpp"
#include "../compat.hpp"
#include "../zstring_view.hpp"
#include "common_types.hpp"
 
#include <cstddef>
#include <memory>
#include <span>
#include <string_view>
 
namespace essence::crypto {
    class asymmetric_key {
    public:
        ES_API(CPPESSENCE) explicit asymmetric_key(void* blob);
 
        ES_API(CPPESSENCE)
        asymmetric_key(use_public_tag tag, zstring_view path, const password_request_handler& handler = {});
 
        ES_API(CPPESSENCE)
        asymmetric_key(
            use_public_tag tag, std::span<const std::byte> buffer, const password_request_handler& handler = {});
 
        ES_API(CPPESSENCE)
        asymmetric_key(use_private_tag tag, zstring_view path, const password_request_handler& handler = {});
 
        ES_API(CPPESSENCE)
        asymmetric_key(
            use_private_tag tag, std::span<const std::byte> buffer, const password_request_handler& handler = {});
 
        ES_API(CPPESSENCE) asymmetric_key(asymmetric_key&&) noexcept;
        ES_API(CPPESSENCE) ~asymmetric_key();
        ES_API(CPPESSENCE) asymmetric_key& operator=(asymmetric_key&&) noexcept;
 
        [[nodiscard]] ES_API(CPPESSENCE) asymmetric_key_type type() const;
 
        [[nodiscard]] ES_API(CPPESSENCE) abi::string name() const;
 
        [[nodiscard]] ES_API(CPPESSENCE) abi::string description() const;
 
        [[nodiscard]] ES_API(CPPESSENCE) void* to_blob() const noexcept;
 
        [[nodiscard]] ES_API(CPPESSENCE) abi::string save_public() const;
 
        ES_API(CPPESSENCE) void save_public(zstring_view path) const;
 
        [[nodiscard]] ES_API(CPPESSENCE) abi::string save_private() const;
 
        [[nodiscard]] ES_API(CPPESSENCE) abi::string
            save_private(zstring_view cipher_name, std::string_view password) const;
 
        ES_API(CPPESSENCE) void save_private(zstring_view path) const;
 
        ES_API(CPPESSENCE)
        void save_private(zstring_view path, zstring_view cipher_name, std::string_view password) const;
 
    private:
        class impl;
 
        std::unique_ptr<impl> impl_;
    };
 
    template <pubkey_keygen_param T>
    asymmetric_key generate_asymmetric_key_pair(const T& param) {
        return asymmetric_key{param.generate_key_blob()};
    }
} // namespace essence::crypto