generic.hxx

Go to the documentation of this file.

/*
 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
 *
 * This file is part of StormByte-Crypto.
 *
 * StormByte-Crypto original source is dual-licensed:
 *
 * 1. GNU Lesser General Public License v3.0 (or later)
 *    You may redistribute and/or modify this file under the terms of the
 *    GNU Lesser General Public License as published by the Free Software
 *    Foundation, either version 3 of the License, or (at your option)
 *    any later version.
 *
 * 2. Commercial license
 *    Alternatively, this file may be used under the terms of a commercial
 *    license agreement with the copyright holder
 *    (David C. Manuelda <StormByte@gmail.com>).
 *
 * Both licenses apply only to original StormByte-Crypto source in this
 * repository. They do not cover other StormByte modules or any third-party
 * material shipped with this repository (including everything under
 * thirdparty/, in particular Crypto++, bundled libbzip2, the StormByte-Buffer
 * tree and the StormByte suite it vendors), which remains under its own license.
 *
 * Neither license grants any patent rights. Any patent licenses required
 * to use this software or third-party components must be obtained separately
 * from the patent holders.
 *
 * StormByte-Crypto is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with StormByte-Crypto. If not, see
 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
 *
 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
 */
 
#pragma once
 
#include <StormByte/safe/clonable.hxx>
#include <StormByte/crypto/secure/password.hxx>
#include <StormByte/crypto/typedefs.hxx>
#include <StormByte/crypto/visibility.h>
#include <StormByte/safe/string.hxx>
 
#include <filesystem>
#include <optional>
#include <string_view>
 
namespace StormByte {
    namespace Crypto {
        namespace KeyPair {
            enum class Type {
                DSA,        
                ECC,        
                ECDH,       
                ECDSA,      
                ED25519,    
                RSA,        
                X25519      
            };
 
            enum class StorageFormat {
                PEM,    
                DER     
            };
 
            class STORMBYTE_CRYPTO_PUBLIC Generic: public StormByte::Safe::Clonable<Generic> {
                public:
                    Generic(const Generic& other) = default;
 
                    Generic(Generic&& other) noexcept = default;
 
                    virtual ~Generic() noexcept;
 
                    Generic& operator=(const Generic& other) = default;
 
                    Generic& operator=(Generic&& other) noexcept = default;
                    inline enum Type Type() const noexcept {
                        return m_type;
                    }
 
                    inline const StormByte::Safe::String& PublicKey() const noexcept {
                        return m_public_key;
                    }
 
                    inline bool HasPrivateKey() const noexcept {
                        return m_private_key.has_value();
                    }
 
                    inline const std::optional<Secure::Password>& PrivateKey() const noexcept {
                        return m_private_key;
                    }
 
                    bool Save(const std::filesystem::path& directory, std::string_view baseName, StorageFormat format = StorageFormat::PEM) const noexcept;
 
                    bool Save(const std::filesystem::path& directory, std::string_view baseName, const Secure::Password& encryptPassword, StorageFormat format = StorageFormat::PEM) const noexcept;
 
                    bool SavePublic(const std::filesystem::path& filePath, StorageFormat format = StorageFormat::PEM) const noexcept;
 
                    bool SavePrivate(const std::filesystem::path& filePath, StorageFormat format = StorageFormat::PEM) const noexcept;
 
                    bool SavePrivate(const std::filesystem::path& filePath, const Secure::Password& encryptPassword, StorageFormat format = StorageFormat::PEM) const noexcept;
                protected:
                    enum Type m_type;                       
                    StormByte::Safe::String m_public_key;   
                    std::optional<Secure::Password> m_private_key;  
 
                    inline Generic(enum Type type, StormByte::Safe::String public_key, std::optional<Secure::Password> private_key = std::nullopt):
                        m_type(type),
                        m_public_key(std::move(public_key)),
                        m_private_key(std::move(private_key)) {}
            };
 
            STORMBYTE_CRYPTO_PUBLIC Generic::PointerType Create(Type type, unsigned short bits) noexcept;
 
            STORMBYTE_CRYPTO_PUBLIC Generic::PointerType Load(const std::filesystem::path& publicKeyPath, const std::filesystem::path& privateKeyPath) noexcept;
 
            STORMBYTE_CRYPTO_PUBLIC Generic::PointerType Load(const std::filesystem::path& publicKeyPath, const std::filesystem::path& privateKeyPath, const Secure::Password& password) noexcept;
 
            STORMBYTE_CRYPTO_PUBLIC Generic::PointerType Load(const std::filesystem::path& path) noexcept;
 
            STORMBYTE_CRYPTO_PUBLIC Generic::PointerType Load(const std::filesystem::path& path, const Secure::Password& password) noexcept;
        }
    }
}