StormByte-Crypto 3.1.0
C++26 cryptography module of the StormByte suite
Loading...
Searching...
No Matches
generic.hxx
Go to the documentation of this file.
1/*
2 * Copyright (C) 2024-2026 David C. Manuelda (StormBytePP)
3 *
4 * This file is part of StormByte-Crypto.
5 *
6 * StormByte-Crypto original source is dual-licensed:
7 *
8 * 1. GNU Lesser General Public License v3.0 (or later)
9 * You may redistribute and/or modify this file under the terms of the
10 * GNU Lesser General Public License as published by the Free Software
11 * Foundation, either version 3 of the License, or (at your option)
12 * any later version.
13 *
14 * 2. Commercial license
15 * Alternatively, this file may be used under the terms of a commercial
16 * license agreement with the copyright holder
17 * (David C. Manuelda <StormByte@gmail.com>).
18 *
19 * Both licenses apply only to original StormByte-Crypto source in this
20 * repository. They do not cover other StormByte modules or any third-party
21 * material shipped with this repository (including everything under
22 * thirdparty/, in particular Crypto++, bundled libbzip2, the StormByte-Buffer
23 * tree and the StormByte suite it vendors), which remains under its own license.
24 *
25 * Neither license grants any patent rights. Any patent licenses required
26 * to use this software or third-party components must be obtained separately
27 * from the patent holders.
28 *
29 * StormByte-Crypto is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU Lesser General Public License for more details.
33 *
34 * You should have received a copy of the GNU Lesser General Public License
35 * version 3 along with StormByte-Crypto. If not, see
36 * <https://www.gnu.org/licenses/lgpl-3.0.html>.
37 *
38 * SPDX-License-Identifier: LGPL-3.0-or-later OR LicenseRef-StormByte-Commercial
39 */
40
41#pragma once
42
46#include <StormByte/safe/clonable.hxx>
47#include <StormByte/safe/optional.hxx>
48#include <StormByte/safe/string.hxx>
49#include <StormByte/type_traits/safe.hxx>
50
51#include <utility>
52
57namespace StormByte {
62 namespace Crypto {
67 namespace Secret {
72 enum class Type {
75 };
76
93 public:
102 Generic(const Generic& other) = default;
103
108 Generic(Generic&& other) noexcept = default;
109
113 virtual ~Generic() noexcept;
114
120 Generic& operator=(const Generic& other) = default;
121
127 Generic& operator=(Generic&& other) noexcept = default;
129
134 inline Type Type() const noexcept {
135 return m_type;
136 }
137
145
146 protected:
149
155 inline Generic(enum Type type, KeyPair::Generic::PointerType keypair) noexcept
156 : m_type(type), m_keypair(std::move(keypair)) {}
157 };
158
167 }
168 }
169}
170
ECDH shared-secret derivation.
Definition ecdh.hxx:68
Abstract key-agreement object.
Definition generic.hxx:92
enum Type m_type
Algorithm.
Definition generic.hxx:147
virtual StormByte::Safe::Optional< Secure::Password > Share(const StormByte::Safe::String &peerPublicKey) const =0
Derive a shared secret from a peer public key.
Generic(Generic &&other) noexcept=default
Move constructor.
Generic(enum Type type, KeyPair::Generic::PointerType keypair) noexcept
Construct with algorithm and keypair.
Definition generic.hxx:155
virtual ~Generic() noexcept
Destructor.
Generic(const Generic &other)=default
Copy constructor.
KeyPair::Generic::PointerType m_keypair
Local keypair (needs private key).
Definition generic.hxx:148
X25519 shared-secret derivation.
Definition x25519.hxx:67
STORMBYTE_DECLARE_MAYBE_SAFE(class StormByte::System::Device::Access)
Key agreement of the Crypto module.
Generic::PointerType Create(Type type, KeyPair::Generic::PointerType keypair)
Create an agreement object.
Crypto module of the StormByte suite.
Definition aead.hxx:53
Root namespace of the StormByte suite.
#define STORMBYTE_CRYPTO_PUBLIC
Definition visibility.h:53